KAL-9 Add support for job state change events.

Author: Slushnas

Libraries/src/Amazon.Lambda.CloudWatchEvents/Amazon.Lambda.CloudWatchEvents.csproj

@@ -17,4 +17,10 @@
     <PackageReference Include="System.Runtime" Version="4.1.0" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Reference Include="Newtonsoft.Json">
+      <HintPath>..\..\..\..\..\Program Files\dotnet\sdk\NuGetFallbackFolder\newtonsoft.json\10.0.1\lib\netstandard1.3\Newtonsoft.Json.dll</HintPath>
+    </Reference>
+  </ItemGroup>
+
 </Project>

Libraries/src/Amazon.Lambda.CloudWatchEvents/BatchEvents/ArrayPropertiesDetail.cs

@@ -0,0 +1,28 @@
+using System.Collections.Generic;
+
+namespace Amazon.Lambda.CloudWatchEvents.BatchEvents
+{
+    /// <summary>
+    /// An object representing the array properties of a job.
+    /// https://docs.aws.amazon.com/batch/latest/APIReference/API_ArrayPropertiesDetail.html
+    /// </summary>
+    public class ArrayPropertiesDetail
+    {
+        /// <summary>
+        /// The job index within the array that is associated with this job.
+        /// This parameter is returned for array job children.
+        /// </summary>
+        public int Index { get; set; }
+
+        /// <summary>
+        /// The size of the array job. This parameter is returned for parent array jobs.
+        /// </summary>
+        public int Size { get; set; }
+
+        /// <summary>
+        /// A summary of the number of array job children in each available job status.
+        /// This parameter is returned for parent array jobs.
+        /// </summary>
+        public Dictionary<string, int> StatusSummary { get; set; }
+    }
+}

Libraries/src/Amazon.Lambda.CloudWatchEvents/BatchEvents/AttemptContainerDetail.cs

@@ -0,0 +1,38 @@
+namespace Amazon.Lambda.CloudWatchEvents.BatchEvents
+{
+    /// <summary>
+    /// An object representing the details of a container that is part of a job attempt.
+    /// https://docs.aws.amazon.com/batch/latest/APIReference/API_AttemptContainerDetail.html
+    /// </summary>
+    public class AttemptContainerDetail
+    {
+        /// <summary>
+        /// The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
+        /// </summary>
+        public string ContainerInstanceArn { get; set; }
+
+        /// <summary>
+        /// The exit code for the job attempt. A non-zero exit code is considered a failure.
+        /// </summary>
+        public int ExitCode { get; set; }
+
+        /// <summary>
+        /// The name of the CloudWatch Logs log stream associated with the container. The log group for
+        /// AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when
+        /// they reach the RUNNING status.
+        /// </summary>
+        public string LogStreamName { get; set; }
+
+        /// <summary>
+        /// A short (255 max characters) human-readable string to provide additional
+        /// details about a running or stopped container.
+        /// </summary>
+        public string Reason { get; set; }
+
+        /// <summary>
+        /// The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the job attempt.
+        /// Each container attempt receives a task ARN when they reach the STARTING status.
+        /// </summary>
+        public string TaskArn { get; set; }
+    }
+}

Libraries/src/Amazon.Lambda.CloudWatchEvents/BatchEvents/AttemptDetail.cs

@@ -0,0 +1,31 @@
+namespace Amazon.Lambda.CloudWatchEvents.BatchEvents
+{
+    /// <summary>
+    /// An object representing a job attempt.
+    /// https://docs.aws.amazon.com/batch/latest/APIReference/API_AttemptDetail.html
+    /// </summary>
+    public class AttemptDetail
+    {
+        /// <summary>
+        /// Details about the container in this job attempt.
+        /// </summary>
+        public AttemptContainerDetail Container { get; set; }
+
+        /// <summary>
+        /// The Unix time stamp (in seconds and milliseconds) for when the attempt was started
+        /// (when the attempt transitioned from the STARTING state to the RUNNING state).
+        /// </summary>
+        public long StartedAt { get; set; }
+
+        /// <summary>
+        /// A short, human-readable string to provide additional details about the current status of the job attempt.
+        /// </summary>
+        public string StatusReason { get; set; }
+
+        /// <summary>
+        /// The Unix time stamp (in seconds and milliseconds) for when the attempt was stopped
+        /// (when the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
+        /// </summary>
+        public long StoppedAt { get; set; }
+    }
+}

Libraries/src/Amazon.Lambda.CloudWatchEvents/BatchEvents/BatchJobStateChangeEvent.cs

@@ -0,0 +1,11 @@
+namespace Amazon.Lambda.CloudWatchEvents.BatchEvents
+{
+    /// <summary>
+    /// AWS Batch Event
+    /// https://docs.aws.amazon.com/batch/latest/userguide/batch_cwe_events.html
+    /// </summary>
+    public class BatchJobStateChangeEvent : CloudWatchEvent<Job>
+    {
+        
+    }
+}

Libraries/src/Amazon.Lambda.CloudWatchEvents/BatchEvents/ContainerDetail.cs

@@ -0,0 +1,103 @@
+using System.Collections.Generic;
+
+namespace Amazon.Lambda.CloudWatchEvents.BatchEvents
+{
+    /// <summary>
+    /// An object representing the details of a container that is part of a job.
+    /// https://docs.aws.amazon.com/batch/latest/APIReference/API_ContainerDetail.html
+    /// </summary>
+    public class ContainerDetail
+    {
+        /// <summary>
+        /// The command that is passed to the container.
+        /// </summary>
+        public List<string> Command { get; set; }
+
+        /// <summary>
+        /// The Amazon Resource Name (ARN) of the container instance on which the container is running.
+        /// </summary>
+        public string ContainerInstanceArn { get; set; }
+
+        /// <summary>
+        /// The environment variables to pass to a container.
+        /// Note: Environment variables must not start with AWS_BATCH; this naming convention is reserved
+        /// for variables that are set by the AWS Batch service.
+        /// </summary>
+        public List<KeyValuePair<string, string>> Environment { get; set; }
+
+        /// <summary>
+        /// The exit code to return upon completion.
+        /// </summary>
+        public int ExitCode { get; set; }
+
+        /// <summary>
+        /// The image used to start the container.
+        /// </summary>
+        public string Image { get; set; }
+
+        /// <summary>
+        /// The Amazon Resource Name (ARN) associated with the job upon execution.
+        /// </summary>
+        public string JobRoleArn { get; set; }
+
+        /// <summary>
+        /// The name of the CloudWatch Logs log stream associated with the container.
+        /// The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a
+        /// log stream name when they reach the RUNNING status.
+        /// </summary>
+        public string LogStreamName { get; set; }
+
+        /// <summary>
+        /// The number of MiB of memory reserved for the job.
+        /// </summary>
+        public int Memory { get; set; }
+
+        /// <summary>
+        /// The mount points for data volumes in your container.
+        /// </summary>
+        public List<MountPoint> MountPoints { get; set; }
+
+        /// <summary>
+        /// When this parameter is true, the container is given elevated privileges on the
+        /// host container instance (similar to the root user).
+        /// </summary>
+        public bool Privileged { get; set; }
+
+        /// <summary>
+        /// When this parameter is true, the container is given read-only access to its root file system.
+        /// </summary>
+        public bool ReadonlyRootFilesystem { get; set; }
+
+        /// <summary>
+        /// A short (255 max characters) human-readable string to provide additional
+        /// details about a running or stopped container.
+        /// </summary>
+        public string Reason { get; set; }
+
+        /// <summary>
+        /// The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job.
+        /// Each container attempt receives a task ARN when they reach the STARTING status.
+        /// </summary>
+        public string TaskArn { get; set; }
+
+        /// <summary>
+        /// A list of ulimit values to set in the container.
+        /// </summary>
+        public List<Ulimit> Ulimits { get; set; }
+
+        /// <summary>
+        /// The user name to use inside the container.
+        /// </summary>
+        public string User { get; set; }
+
+        /// <summary>
+        /// The number of VCPUs allocated for the job.
+        /// </summary>
+        public int Vcpus { get; set; }
+
+        /// <summary>
+        /// A list of volumes associated with the job.
+        /// </summary>
+        public List<Volume> Volumes { get; set; }
+    }
+}

Libraries/src/Amazon.Lambda.CloudWatchEvents/BatchEvents/Host.cs

@@ -0,0 +1,21 @@
+namespace Amazon.Lambda.CloudWatchEvents.BatchEvents
+{
+    /// <summary>
+    /// The contents of the host parameter determine whether your data volume persists on the host container
+    /// instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host
+    /// path for your data volume, but the data is not guaranteed to persist after the containers associated with
+    /// it stop running.
+    /// https://docs.aws.amazon.com/batch/latest/APIReference/API_Host.html
+    /// </summary>
+    public class Host
+    {
+        /// <summary>
+        /// The path on the host container instance that is presented to the container. If this parameter is empty,
+        /// then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file
+        /// location, then the data volume persists at the specified location on the host container instance until you
+        /// delete it manually. If the sourcePath value does not exist on the host container instance, the Docker
+        /// daemon creates it. If the location does exist, the contents of the source path folder are exported.
+        /// </summary>
+        public string SourcePath { get; set; }
+    }
+}

Libraries/src/Amazon.Lambda.CloudWatchEvents/BatchEvents/Job.cs

@@ -0,0 +1,99 @@
+using System.Collections.Generic;
+
+namespace Amazon.Lambda.CloudWatchEvents.BatchEvents
+{
+    /// <summary>
+    /// https://docs.aws.amazon.com/batch/latest/userguide/batch_cwe_events.html
+    /// https://docs.aws.amazon.com/batch/latest/APIReference/API_JobDetail.html
+    /// https://docs.aws.amazon.com/batch/latest/APIReference/API_DescribeJobs.html
+    /// </summary>
+    public class Job
+    {
+        /// <summary>
+        /// The array properties of the job, if it is an array job.
+        /// </summary>
+        public ArrayPropertiesDetail ArrayProperties { get; set; }
+
+        /// <summary>
+        /// A list of job attempts associated with this job.
+        /// </summary>
+        public List<AttemptDetail> Attempts { get; set; }
+
+        /// <summary>
+        /// An object representing the details of the container that is associated with the job.
+        /// </summary>
+        public ContainerDetail Container { get; set; }
+
+        /// <summary>
+        /// The Unix time stamp (in seconds and milliseconds) for when the job was created. For non-array
+        /// jobs and parent array jobs, this is when the job entered the SUBMITTED state
+        /// (at the time SubmitJob was called). For array child jobs, this is when the child job was
+        /// spawned by its parent and entered the PENDING state.
+        /// </summary>
+        public long CreatedAt { get; set; }
+
+        /// <summary>
+        /// A list of job names or IDs on which this job depends.
+        /// </summary>
+        public List<JobDependency> DependsOn { get; set; }
+
+        /// <summary>
+        /// The job definition that is used by this job.
+        /// </summary>
+        public string JobDefinition { get; set; }
+
+        /// <summary>
+        /// The ID for the job.
+        /// </summary>
+        public string JobId { get; set; }
+
+        /// <summary>
+        /// The name of the job.
+        /// </summary>
+        public string JobName { get; set; }
+
+        /// <summary>
+        /// The Amazon Resource Name (ARN) of the job queue with which the job is associated.
+        /// </summary>
+        public string JobQueue { get; set; }
+
+        /// <summary>
+        /// Additional parameters passed to the job that replace parameter substitution placeholders or
+        /// override any corresponding parameter defaults from the job definition.
+        /// </summary>
+        public Dictionary<string, string> Parameters { get; set; }
+
+        /// <summary>
+        /// The retry strategy to use for this job if an attempt fails.
+        /// </summary>
+        public RetryStrategy RetryStrategy { get; set; }
+
+        /// <summary>
+        /// The Unix time stamp (in seconds and milliseconds) for when the job was started (when the job
+        /// transitioned from the STARTING state to the RUNNING state).
+        /// </summary>
+        public long StartedAt { get; set; }
+
+        /// <summary>
+        /// The current status for the job. Note: If your jobs do not progress to STARTING, see Jobs Stuck
+        /// in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
+        /// </summary>
+        public string Status { get; set; }
+
+        /// <summary>
+        /// A short, human-readable string to provide additional details about the current status of the job.
+        /// </summary>
+        public string StatusReason { get; set; }
+
+        /// <summary>
+        /// The Unix time stamp (in seconds and milliseconds) for when the job was stopped (when the
+        /// job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
+        /// </summary>
+        public long StoppedAt { get; set; }
+
+        /// <summary>
+        /// The timeout configuration for the job.
+        /// </summary>
+        public JobTimeout Timeout { get; set; }
+    }
+}

Libraries/src/Amazon.Lambda.CloudWatchEvents/BatchEvents/JobDependency.cs

@@ -0,0 +1,19 @@
+namespace Amazon.Lambda.CloudWatchEvents.BatchEvents
+{
+    /// <summary>
+    /// An object representing an AWS Batch job dependency.
+    /// https://docs.aws.amazon.com/batch/latest/APIReference/API_JobDependency.html
+    /// </summary>
+    public class JobDependency
+    {
+        /// <summary>
+        /// The job ID of the AWS Batch job associated with this dependency.
+        /// </summary>
+        public string JobId { get; set; }
+
+        /// <summary>
+        /// The type of the job dependency.
+        /// </summary>
+        public string Type { get; set; }
+    }
+}

Libraries/src/Amazon.Lambda.CloudWatchEvents/BatchEvents/JobTimeout.cs

@@ -0,0 +1,15 @@
+namespace Amazon.Lambda.CloudWatchEvents.BatchEvents
+{
+    /// <summary>
+    /// An object representing a job timeout configuration.
+    /// https://docs.aws.amazon.com/batch/latest/APIReference/API_JobTimeout.html
+    /// </summary>
+    public class JobTimeout
+    {
+        /// <summary>
+        /// The time duration in seconds (measured from the job attempt's startedAt timestamp) after which
+        /// AWS Batch terminates your jobs if they have not finished.
+        /// </summary>
+        public int AttemptDurationSeconds { get; set; }
+    }
+}