AWS Job

The following table describes the AWS job type attributes.

Attribute

Description

Connection profile

Defines the connection profile for the job.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Spaces

Service

Determines the service type of the AWS job, as follows:

Lambda Job Attributes

The following table describes the AWS Lambda job attributes.

Attribute

Description

Function Name

Defines the Lambda function to execute.

Variable Name: %%AWS-LAMBDA_NAME

Version

Defines the Lambda function version.

Variable Name: %%AWS-LAMBDA_VERSION

Payload

Defines the Lambda function payload in JSON format.

Variable Name: %%AWS-LAMBDA_PAYLOAD_JSON

Client Context JSON

Defines client-specific information for Lambda.

Variable Name: %%AWS-LAMBDA_CUSTOMER_CONTEXT_JSON

Append log to output

Determines whether to append the log to the outputClosedA tab in the job properties pane in the Monitoring domain that shows the output of a job, which indicates whether a job ended OK, and used, for example, with jobs that check file location.

Step Function Job Attributes

The following table describes the AWS Step Function job attributes.

Attribute

Description

State Machine

Defines the Step function State Machine to be used.

Variable Name: %%AWS-STEP_NAME

Execution Name

Defines the name for the execution for a Step function.

Variable Name: %%AWS-STEP_EXECUTION_NAME

Input

Defines the Step Function input in JSON format.

Variable Name: %%AWS-STEP_PAYLOAD_JSON

Append log to output

Determines whether to append the log to the output.

Batch Job Attributes

The following table describes the AWS Batch job attributes.

Attribute

Description

Job Name

Defines the name of the Batch job.

Variable Name: %%AWS-BATCH_JOB_NAME

Job Definition

Defines the job definition to be used for a Batch.

Variable Name: %%AWS-BATCH_JOB_DEFINITION

Job Definition Revision

Defines the job definition revision for a Batch.

Variable Name: %%AWS-BATCH_JOB_DEF_REV

Job Queue

Defines the queue where the batch job is submitted.

Variable Name: %%AWS-BATCH_JOB_QUEUE

Parameters List

Defines the parameters (Name and Value) for the batch job.

Variable Names:

  • %%AWS-BATCH_PARAMETERS-Pnnn-KEY

  • %AWS-BATCH_PARAMETERS-Pnnn-VALUE

Job Type

Determines whether the Batch job is a single job or an array job. For an array job, in the Array Size field, determine the array size (minimum 2) of the Batch job.

Variable Name: %%AWS-BATCH_JOB_TYPE

Job Dependency

Determines whether the AWS Batch job depends on another job. If it does, then define the following:

  • Dependency Type:  Determines if the Batch job depends on a Standard, Sequential or N-to-N job type.

  • Job ID: Defines the Job ID upon which the Batch job depends.

Variable Name: %%AWS-BATCH_DEPENDS_CHECK

Container overrides command

Defines a command to send to the container that overrides the default command from the Docker image or the Batch job definition.

Variable Name: %%AWS-BATCH_CONTENTS_COMMAND

Environment

Defines the environment variables (name and value) to send to the container for a Batch job.

Variable Names:

  • %%AWS-BATCH_ENV_PARAM-Pnnn-KEY

  • %%AWS-BATCH_ENV_PARAM-Pnnn-VALUE

vCPUs

Determines the number of vCPUs to reserve for the container for a Batch job.

Variable Name: %%AWS-BATCH_CONTENT_ENV_CPU

Memory

Determines the number of MB of memory reserved for the Batch job (minimum 4).

Variable Name: %%AWS-BATCH_CONTENT_ENV_MEMORY

Job Attempts

Determines the number of retry attempts fora Batch job.

Variable Name: %%AWS-BATCH_RETRY_ATTEMPTS

Execution Timeout

Determines the timeout duration in seconds for a Batch job.

Variable Name: %%AWS-BATCH_TIMEOUT

Append log to output

Determines whether to append the log to the output.

AWS Permission Requirements

The following table lists the AWS Permission Requirements for running AWS jobs:

Service

Required Actions

Lambda

  • InvokeFunction

  • ListFunctions

Step Function

  • ListStateMachines

  • StartExecution

  • DescribeExecution

  • GetExecutionHistory

  • StopExecution

Batch

  • SubmitJob

  • DescribeJobQueues

  • DescribeJobDefinitions

  • DescribeJobs

  • TerminateJob