2020/12/03 - AWS Batch - 7 updated api methods
Changes Update batch client to latest version
{'computeResources': {'type': {'FARGATE_SPOT', 'FARGATE'}}}
Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or AWS Fargate resources. UNMANAGED compute environments can only use EC2 resources.
In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. You can choose either to use EC2 On-Demand Instances and EC2 Spot Instances, or to use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price.
In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMI. However, you need to verify that your AMI meets the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it. Then, manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide.
See also: AWS API Documentation
Request Syntax
client.create_compute_environment( computeEnvironmentName='string', type='MANAGED'|'UNMANAGED', state='ENABLED'|'DISABLED', computeResources={ 'type': 'EC2'|'SPOT'|'FARGATE'|'FARGATE_SPOT', 'allocationStrategy': 'BEST_FIT'|'BEST_FIT_PROGRESSIVE'|'SPOT_CAPACITY_OPTIMIZED', 'minvCpus': 123, 'maxvCpus': 123, 'desiredvCpus': 123, 'instanceTypes': [ 'string', ], 'imageId': 'string', 'subnets': [ 'string', ], 'securityGroupIds': [ 'string', ], 'ec2KeyPair': 'string', 'instanceRole': 'string', 'tags': { 'string': 'string' }, 'placementGroup': 'string', 'bidPercentage': 123, 'spotIamFleetRole': 'string', 'launchTemplate': { 'launchTemplateId': 'string', 'launchTemplateName': 'string', 'version': 'string' }, 'ec2Configuration': [ { 'imageType': 'string', 'imageIdOverride': 'string' }, ] }, serviceRole='string', tags={ 'string': 'string' } )
string
[REQUIRED]
The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
string
[REQUIRED]
The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.
string
The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.
dict
Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.
type (string) -- [REQUIRED]
The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute Environments in the AWS Batch User Guide.
allocationStrategy (string) --
The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation Strategies in the AWS Batch User Guide.
AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, AWS Batch will wait for the additional instances to be available. If there are not enough instances available, or if the user is hitting Amazon EC2 service limits then additional jobs aren't run until currently running jobs have completed. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet IAM Role must be specified.
BEST_FIT_PROGRESSIVE
AWS Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.
SPOT_CAPACITY_OPTIMIZED
AWS Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, AWS Batch might need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxvCpus by more than a single instance.
minvCpus (integer) --
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
maxvCpus (integer) -- [REQUIRED]
The maximum number of Amazon EC2 vCPUs that an environment can reach.
desiredvCpus (integer) --
The desired number of Amazon EC2 vCPUS in the compute environment. AWS Batch modifies this value between the minimum and maximum values, based on job queue demand.
instanceTypes (list) --
The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C, M, and R instance families) on the fly that match the demand of your job queues.
(string) --
imageId (string) --
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure.
subnets (list) -- [REQUIRED]
The VPC subnets into which the compute resources are launched. These subnets must be within the same VPC. This parameter is required for jobs running on Fargate resources, where it can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
(string) --
securityGroupIds (list) --
The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. This parameter is required for jobs running on Fargate resources and must contain at least one security group. (Fargate does not support launch templates.) If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds will be used.
(string) --
ec2KeyPair (string) --
The Amazon EC2 key pair that is used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.
instanceRole (string) --
The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or ``arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole ``. For more information, see Amazon ECS Instance Role in the AWS Batch User Guide.
tags (dict) --
Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For AWS Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value—for example, { "Name": "AWS Batch Instance - C4OnDemand" }. This is helpful for recognizing your AWS Batch instances in the Amazon EC2 console. These tags can not be updated or removed after the compute environment has been created; any changes require creating a new compute environment and removing the old compute environment. These tags are not seen when using the AWS Batch ListTagsForResource API operation.
(string) --
(string) --
placementGroup (string) --
The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
bidPercentage (integer) --
The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.
spotIamFleetRole (string) --
The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For more information, see Amazon EC2 Spot Fleet Role in the AWS Batch User Guide.
launchTemplate (dict) --
The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch Template Support in the AWS Batch User Guide.
launchTemplateId (string) --
The ID of the launch template.
launchTemplateName (string) --
The name of the launch template.
version (string) --
The version number of the launch template, $Latest, or $Default.
If the value is $Latest, the latest version of the launch template is used. If the value is $Default, the default version of the launch template is used.
Default: $Default.
ec2Configuration (list) --
Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL1.
(dict) --
Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If the Ec2Configuration isn't specified, the default is ECS_AL1.
imageType (string) -- [REQUIRED]
The image type to match with the instance type to select an AMI. If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized AMI is used.
ECS_AL2
Amazon Linux 2 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami>`__− Default for all AWS Graviton-based instance families (for example, ``C6g`, M6g, R6g, and T4g) and can be used for all non-GPU instance types.
ECS_AL2_NVIDIA
Amazon Linux 2 (GPU) <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami>`__−Default for all GPU instance families (for example ``P4` and G4) and can be used for all non-AWS Graviton-based instance types.
ECS_AL1
imageIdOverride (string) --
The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the imageId set in the computeResource object.
string
[REQUIRED]
The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.
dict
The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.
These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.
(string) --
(string) --
dict
Response Syntax
{ 'computeEnvironmentName': 'string', 'computeEnvironmentArn': 'string' }
Response Structure
(dict) --
computeEnvironmentName (string) --
The name of the compute environment.
computeEnvironmentArn (string) --
The Amazon Resource Name (ARN) of the compute environment.
{'computeEnvironments': {'computeResources': {'type': {'FARGATE', 'FARGATE_SPOT'}}}}
Describes one or more of your compute environments.
If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into.
See also: AWS API Documentation
Request Syntax
client.describe_compute_environments( computeEnvironments=[ 'string', ], maxResults=123, nextToken='string' )
list
A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
(string) --
integer
The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.
string
The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
dict
Response Syntax
{ 'computeEnvironments': [ { 'computeEnvironmentName': 'string', 'computeEnvironmentArn': 'string', 'ecsClusterArn': 'string', 'tags': { 'string': 'string' }, 'type': 'MANAGED'|'UNMANAGED', 'state': 'ENABLED'|'DISABLED', 'status': 'CREATING'|'UPDATING'|'DELETING'|'DELETED'|'VALID'|'INVALID', 'statusReason': 'string', 'computeResources': { 'type': 'EC2'|'SPOT'|'FARGATE'|'FARGATE_SPOT', 'allocationStrategy': 'BEST_FIT'|'BEST_FIT_PROGRESSIVE'|'SPOT_CAPACITY_OPTIMIZED', 'minvCpus': 123, 'maxvCpus': 123, 'desiredvCpus': 123, 'instanceTypes': [ 'string', ], 'imageId': 'string', 'subnets': [ 'string', ], 'securityGroupIds': [ 'string', ], 'ec2KeyPair': 'string', 'instanceRole': 'string', 'tags': { 'string': 'string' }, 'placementGroup': 'string', 'bidPercentage': 123, 'spotIamFleetRole': 'string', 'launchTemplate': { 'launchTemplateId': 'string', 'launchTemplateName': 'string', 'version': 'string' }, 'ec2Configuration': [ { 'imageType': 'string', 'imageIdOverride': 'string' }, ] }, 'serviceRole': 'string' }, ], 'nextToken': 'string' }
Response Structure
(dict) --
computeEnvironments (list) --
The list of compute environments.
(dict) --
An object representing an AWS Batch compute environment.
computeEnvironmentName (string) --
The name of the compute environment.
computeEnvironmentArn (string) --
The Amazon Resource Name (ARN) of the compute environment.
ecsClusterArn (string) --
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
tags (dict) --
The tags applied to the compute environment.
(string) --
(string) --
type (string) --
The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute Environments in the AWS Batch User Guide.
state (string) --
The state of the compute environment. The valid values are ENABLED or DISABLED.
If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state do not scale out. However, they scale in to minvCpus value after instances become idle.
status (string) --
The current status of the compute environment (for example, CREATING or VALID).
statusReason (string) --
A short, human-readable string to provide additional details about the current status of the compute environment.
computeResources (dict) --
The compute resources defined for the compute environment.
type (string) --
The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute Environments in the AWS Batch User Guide.
allocationStrategy (string) --
The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation Strategies in the AWS Batch User Guide.
AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, AWS Batch will wait for the additional instances to be available. If there are not enough instances available, or if the user is hitting Amazon EC2 service limits then additional jobs aren't run until currently running jobs have completed. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet IAM Role must be specified.
BEST_FIT_PROGRESSIVE
AWS Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.
SPOT_CAPACITY_OPTIMIZED
AWS Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, AWS Batch might need to go above maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxvCpus by more than a single instance.
minvCpus (integer) --
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
maxvCpus (integer) --
The maximum number of Amazon EC2 vCPUs that an environment can reach.
desiredvCpus (integer) --
The desired number of Amazon EC2 vCPUS in the compute environment. AWS Batch modifies this value between the minimum and maximum values, based on job queue demand.
instanceTypes (list) --
The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C, M, and R instance families) on the fly that match the demand of your job queues.
(string) --
imageId (string) --
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure.
subnets (list) --
The VPC subnets into which the compute resources are launched. These subnets must be within the same VPC. This parameter is required for jobs running on Fargate resources, where it can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
(string) --
securityGroupIds (list) --
The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. This parameter is required for jobs running on Fargate resources and must contain at least one security group. (Fargate does not support launch templates.) If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds will be used.
(string) --
ec2KeyPair (string) --
The Amazon EC2 key pair that is used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.
instanceRole (string) --
The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or ``arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole ``. For more information, see Amazon ECS Instance Role in the AWS Batch User Guide.
tags (dict) --
Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For AWS Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value—for example, { "Name": "AWS Batch Instance - C4OnDemand" }. This is helpful for recognizing your AWS Batch instances in the Amazon EC2 console. These tags can not be updated or removed after the compute environment has been created; any changes require creating a new compute environment and removing the old compute environment. These tags are not seen when using the AWS Batch ListTagsForResource API operation.
(string) --
(string) --
placementGroup (string) --
The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
bidPercentage (integer) --
The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.
spotIamFleetRole (string) --
The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For more information, see Amazon EC2 Spot Fleet Role in the AWS Batch User Guide.
launchTemplate (dict) --
The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch Template Support in the AWS Batch User Guide.
launchTemplateId (string) --
The ID of the launch template.
launchTemplateName (string) --
The name of the launch template.
version (string) --
The version number of the launch template, $Latest, or $Default.
If the value is $Latest, the latest version of the launch template is used. If the value is $Default, the default version of the launch template is used.
Default: $Default.
ec2Configuration (list) --
Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL1.
(dict) --
Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If the Ec2Configuration isn't specified, the default is ECS_AL1.
imageType (string) --
The image type to match with the instance type to select an AMI. If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized AMI is used.
ECS_AL2
Amazon Linux 2 <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami>`__− Default for all AWS Graviton-based instance families (for example, ``C6g`, M6g, R6g, and T4g) and can be used for all non-GPU instance types.
ECS_AL2_NVIDIA
Amazon Linux 2 (GPU) <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami>`__−Default for all GPU instance families (for example ``P4` and G4) and can be used for all non-AWS Graviton-based instance types.
ECS_AL1
imageIdOverride (string) --
The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the imageId set in the computeResource object.
serviceRole (string) --
The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.
nextToken (string) --
The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
{'jobDefinitions': {'containerProperties': {'fargatePlatformConfiguration': {'platformVersion': 'string'}, 'networkConfiguration': {'assignPublicIp': 'ENABLED ' '| ' 'DISABLED'}, 'resourceRequirements': {'type': {'MEMORY', 'VCPU'}}}, 'nodeProperties': {'nodeRangeProperties': {'container': {'fargatePlatformConfiguration': {'platformVersion': 'string'}, 'networkConfiguration': {'assignPublicIp': 'ENABLED ' '| ' 'DISABLED'}, 'resourceRequirements': {'type': {'MEMORY', 'VCPU'}}}}}, 'platformCapabilities': ['EC2 | FARGATE'], 'propagateTags': 'boolean'}}
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.
See also: AWS API Documentation
Request Syntax
client.describe_job_definitions( jobDefinitions=[ 'string', ], maxResults=123, jobDefinitionName='string', status='string', nextToken='string' )
list
A list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.
(string) --
integer
The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.
string
The name of the job definition to describe.
string
The status used to filter job definitions.
string
The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
dict
Response Syntax
{ 'jobDefinitions': [ { 'jobDefinitionName': 'string', 'jobDefinitionArn': 'string', 'revision': 123, 'status': 'string', 'type': 'string', 'parameters': { 'string': 'string' }, 'retryStrategy': { 'attempts': 123, 'evaluateOnExit': [ { 'onStatusReason': 'string', 'onReason': 'string', 'onExitCode': 'string', 'action': 'RETRY'|'EXIT' }, ] }, 'containerProperties': { 'image': 'string', 'vcpus': 123, 'memory': 123, 'command': [ 'string', ], 'jobRoleArn': 'string', 'executionRoleArn': 'string', 'volumes': [ { 'host': { 'sourcePath': 'string' }, 'name': 'string' }, ], 'environment': [ { 'name': 'string', 'value': 'string' }, ], 'mountPoints': [ { 'containerPath': 'string', 'readOnly': True|False, 'sourceVolume': 'string' }, ], 'readonlyRootFilesystem': True|False, 'privileged': True|False, 'ulimits': [ { 'hardLimit': 123, 'name': 'string', 'softLimit': 123 }, ], 'user': 'string', 'instanceType': 'string', 'resourceRequirements': [ { 'value': 'string', 'type': 'GPU'|'VCPU'|'MEMORY' }, ], 'linuxParameters': { 'devices': [ { 'hostPath': 'string', 'containerPath': 'string', 'permissions': [ 'READ'|'WRITE'|'MKNOD', ] }, ], 'initProcessEnabled': True|False, 'sharedMemorySize': 123, 'tmpfs': [ { 'containerPath': 'string', 'size': 123, 'mountOptions': [ 'string', ] }, ], 'maxSwap': 123, 'swappiness': 123 }, 'logConfiguration': { 'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk', 'options': { 'string': 'string' }, 'secretOptions': [ { 'name': 'string', 'valueFrom': 'string' }, ] }, 'secrets': [ { 'name': 'string', 'valueFrom': 'string' }, ], 'networkConfiguration': { 'assignPublicIp': 'ENABLED'|'DISABLED' }, 'fargatePlatformConfiguration': { 'platformVersion': 'string' } }, 'timeout': { 'attemptDurationSeconds': 123 }, 'nodeProperties': { 'numNodes': 123, 'mainNode': 123, 'nodeRangeProperties': [ { 'targetNodes': 'string', 'container': { 'image': 'string', 'vcpus': 123, 'memory': 123, 'command': [ 'string', ], 'jobRoleArn': 'string', 'executionRoleArn': 'string', 'volumes': [ { 'host': { 'sourcePath': 'string' }, 'name': 'string' }, ], 'environment': [ { 'name': 'string', 'value': 'string' }, ], 'mountPoints': [ { 'containerPath': 'string', 'readOnly': True|False, 'sourceVolume': 'string' }, ], 'readonlyRootFilesystem': True|False, 'privileged': True|False, 'ulimits': [ { 'hardLimit': 123, 'name': 'string', 'softLimit': 123 }, ], 'user': 'string', 'instanceType': 'string', 'resourceRequirements': [ { 'value': 'string', 'type': 'GPU'|'VCPU'|'MEMORY' }, ], 'linuxParameters': { 'devices': [ { 'hostPath': 'string', 'containerPath': 'string', 'permissions': [ 'READ'|'WRITE'|'MKNOD', ] }, ], 'initProcessEnabled': True|False, 'sharedMemorySize': 123, 'tmpfs': [ { 'containerPath': 'string', 'size': 123, 'mountOptions': [ 'string', ] }, ], 'maxSwap': 123, 'swappiness': 123 }, 'logConfiguration': { 'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk', 'options': { 'string': 'string' }, 'secretOptions': [ { 'name': 'string', 'valueFrom': 'string' }, ] }, 'secrets': [ { 'name': 'string', 'valueFrom': 'string' }, ], 'networkConfiguration': { 'assignPublicIp': 'ENABLED'|'DISABLED' }, 'fargatePlatformConfiguration': { 'platformVersion': 'string' } } }, ] }, 'tags': { 'string': 'string' }, 'propagateTags': True|False, 'platformCapabilities': [ 'EC2'|'FARGATE', ] }, ], 'nextToken': 'string' }
Response Structure
(dict) --
jobDefinitions (list) --
The list of job definitions.
(dict) --
An object representing an AWS Batch job definition.
jobDefinitionName (string) --
The name of the job definition.
jobDefinitionArn (string) --
The Amazon Resource Name (ARN) for the job definition.
revision (integer) --
The revision of the job definition.
status (string) --
The status of the job definition.
type (string) --
The type of job definition. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.
parameters (dict) --
Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job Definition Parameters in the AWS Batch User Guide.
(string) --
(string) --
retryStrategy (dict) --
The retry strategy to use for failed jobs that are submitted with this job definition.
attempts (integer) --
The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.
evaluateOnExit (list) --
Array of up to 5 objects that specify conditions under which the job should be retried or failed. If this parameter is specified, then the attempts parameter must also be specified.
(dict) --
Specifies a set of conditions to be met, and an action to take ( RETRY or EXIT) if all conditions are met.
onStatusReason (string) --
Contains a glob pattern to match against the StatusReason returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and white space (spaces, tabs). and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
onReason (string) --
Contains a glob pattern to match against the Reason returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and white space (spaces, tabs), and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
onExitCode (string) --
Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The patten can be up to 512 characters long, can contain only numbers, and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
action (string) --
Specifies the action to take if all of the specified conditions ( onStatusReason, onReason, and onExitCode) are met. The values are not case sensitive.
containerProperties (dict) --
An object with various properties specific to container-based jobs.
image (string) --
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag ``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
vcpus (integer) --
This parameter is deprecated and not supported for jobs run on Fargate resources, see resourceRequirement. The number of vCPUs reserved for the container. Jobs running on EC2 resources can specify the vCPU requirement for the job using resourceRequirements but the vCPU requirements can't be specified both here and in the resourceRequirement structure. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.
memory (integer) --
This parameter is deprecated and not supported for jobs run on Fargate resources, use ResourceRequirement. For jobs run on EC2 resources can specify the memory requirement using the ResourceRequirement structure. The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places; it must be specified for each node at least once.
command (list) --
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
(string) --
jobRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. Jobs running on Fargate resources must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.
volumes (list) --
A list of data volumes used in a job.
(dict) --
A data volume used in a job's container properties.
host (dict) --
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. However, the data isn't guaranteed to persist after the containers associated with it stop running.
sourcePath (string) --
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 this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location 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.
name (string) --
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
environment (list) --
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
mountPoints (list) --
The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
(dict) --
Details on a Docker volume mount point that is used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
containerPath (string) --
The path on the container where the host volume is mounted.
readOnly (boolean) --
If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.
sourceVolume (string) --
The name of the volume to mount.
readonlyRootFilesystem (boolean) --
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
privileged (boolean) --
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run. The default value is false.
ulimits (list) --
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
(dict) --
The ulimit settings to pass to the container.
hardLimit (integer) --
The hard limit for the ulimit type.
name (string) --
The type of the ulimit.
softLimit (integer) --
The soft limit for the ulimit type.
user (string) --
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
instanceType (string) --
The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.
resourceRequirements (list) --
The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
(dict) --
The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
value (string) --
The quantity of the specified resource to reserve for the container. The values vary based on the type specified.
type="GPU"
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.
For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in decimal form, and must match one of the supported values (0.5 and whole numbers between 1 and 30, inclusive) and the VCPU values must be one of the values supported for that memory value.
value = 0.5
VCPU = 0.25
value = 1
VCPU = 0.25 or 0.5
value = 2
VCPU = 0.25, 0.5, or 1
value = 3
VCPU = 0.5, or 1
value = 4
VCPU = 0.5, 1, or 2
value = 5, 6, or 7
VCPU = 1 or 2
value = 8
VCPU = 1, 2, or 4
value = 9, 10, 11, 12, 13, 14, 15, or 16
VCPU = 2 or 4
value = 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
VCPU = 4
type="VCPU"
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4
value = 0.25
MEMORY = 0.5, 1, or 2
value = 0.5
MEMORY = 1, 2, 3, or 4
value = 1
MEMORY = 2, 3, 4, 5, 6, 7, or 8
value = 2
MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16
value = 4
MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
type (string) --
The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
linuxParameters (dict) --
Linux-specific modifications that are applied to the container, such as details for device mappings.
devices (list) --
Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
(dict) --
An object representing a container instance host device.
hostPath (string) --
The path for the device on the host container instance.
containerPath (string) --
The path inside the container used to expose the host device. By default the hostPath value is used.
permissions (list) --
The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.
(string) --
initProcessEnabled (boolean) --
If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
sharedMemorySize (integer) --
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.
tmpfs (list) --
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.
(dict) --
The container path, mount options, and size of the tmpfs mount.
containerPath (string) --
The absolute file path in the container where the tmpfs volume is mounted.
size (integer) --
The size (in MiB) of the tmpfs volume.
mountOptions (list) --
The list of tmpfs volume mount options.
Valid values: " defaults" | " ro" | " rw" | " suid" | " nosuid" | " dev" | " nodev" | " exec" | " noexec" | " sync" | " async" | " dirsync" | " remount" | " mand" | " nomand" | " atime" | " noatime" | " diratime" | " nodiratime" | " bind" | " rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | " norelatime" | " strictatime" | " nostrictatime" | " mode" | " uid" | " gid" | " nr_inodes" | " nr_blocks" | " mpol"
(string) --
maxSwap (integer) --
The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.
If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.
swappiness (integer) --
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping not to happen unless absolutely necessary. A swappiness value of 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.
logConfiguration (dict) --
The log configuration specification for the container.
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
logDriver (string) --
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
fluentd
Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.
gelf
Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
journald
Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.
json-file
Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.
splunk
Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.
syslog
Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
options (dict) --
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
(string) --
(string) --
secretOptions (list) --
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the AWS Batch User Guide.
(dict) --
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying sensitive data in the AWS Batch User Guide.
name (string) --
The name of the secret.
valueFrom (string) --
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
secrets (list) --
The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
(dict) --
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying sensitive data in the AWS Batch User Guide.
name (string) --
The name of the secret.
valueFrom (string) --
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
networkConfiguration (dict) --
The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
assignPublicIp (string) --
Indicates whether the job should have a public IP address. For a job running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, in order to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking. The default value is "DISABLED".
fargatePlatformConfiguration (dict) --
The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
platformVersion (string) --
The AWS Fargate platform version on which the jobs are running. A platform version is specified only for jobs running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This will use a recent, approved version of the AWS Fargate platform for compute resources. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
timeout (dict) --
The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished.
attemptDurationSeconds (integer) --
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. The minimum value for the timeout is 60 seconds.
nodeProperties (dict) --
An object with various properties specific to multi-node parallel jobs.
numNodes (integer) --
The number of nodes associated with a multi-node parallel job.
mainNode (integer) --
Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes.
nodeRangeProperties (list) --
A list of node ranges and their properties associated with a multi-node parallel job.
(dict) --
An object representing the properties of the node range for a multi-node parallel job.
targetNodes (string) --
The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted ( :n), then 0 is used to start the range. If the ending range value is omitted ( n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes ( 0:n). You may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties.
container (dict) --
The container details for the node range.
image (string) --
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag ``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
vcpus (integer) --
This parameter is deprecated and not supported for jobs run on Fargate resources, see resourceRequirement. The number of vCPUs reserved for the container. Jobs running on EC2 resources can specify the vCPU requirement for the job using resourceRequirements but the vCPU requirements can't be specified both here and in the resourceRequirement structure. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.
memory (integer) --
This parameter is deprecated and not supported for jobs run on Fargate resources, use ResourceRequirement. For jobs run on EC2 resources can specify the memory requirement using the ResourceRequirement structure. The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places; it must be specified for each node at least once.
command (list) --
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
(string) --
jobRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. Jobs running on Fargate resources must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.
volumes (list) --
A list of data volumes used in a job.
(dict) --
A data volume used in a job's container properties.
host (dict) --
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. However, the data isn't guaranteed to persist after the containers associated with it stop running.
sourcePath (string) --
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 this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location 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.
name (string) --
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
environment (list) --
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
mountPoints (list) --
The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
(dict) --
Details on a Docker volume mount point that is used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
containerPath (string) --
The path on the container where the host volume is mounted.
readOnly (boolean) --
If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.
sourceVolume (string) --
The name of the volume to mount.
readonlyRootFilesystem (boolean) --
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
privileged (boolean) --
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run. The default value is false.
ulimits (list) --
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
(dict) --
The ulimit settings to pass to the container.
hardLimit (integer) --
The hard limit for the ulimit type.
name (string) --
The type of the ulimit.
softLimit (integer) --
The soft limit for the ulimit type.
user (string) --
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
instanceType (string) --
The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.
resourceRequirements (list) --
The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
(dict) --
The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
value (string) --
The quantity of the specified resource to reserve for the container. The values vary based on the type specified.
type="GPU"
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.
For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in decimal form, and must match one of the supported values (0.5 and whole numbers between 1 and 30, inclusive) and the VCPU values must be one of the values supported for that memory value.
value = 0.5
VCPU = 0.25
value = 1
VCPU = 0.25 or 0.5
value = 2
VCPU = 0.25, 0.5, or 1
value = 3
VCPU = 0.5, or 1
value = 4
VCPU = 0.5, 1, or 2
value = 5, 6, or 7
VCPU = 1 or 2
value = 8
VCPU = 1, 2, or 4
value = 9, 10, 11, 12, 13, 14, 15, or 16
VCPU = 2 or 4
value = 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
VCPU = 4
type="VCPU"
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4
value = 0.25
MEMORY = 0.5, 1, or 2
value = 0.5
MEMORY = 1, 2, 3, or 4
value = 1
MEMORY = 2, 3, 4, 5, 6, 7, or 8
value = 2
MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16
value = 4
MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
type (string) --
The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
linuxParameters (dict) --
Linux-specific modifications that are applied to the container, such as details for device mappings.
devices (list) --
Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
(dict) --
An object representing a container instance host device.
hostPath (string) --
The path for the device on the host container instance.
containerPath (string) --
The path inside the container used to expose the host device. By default the hostPath value is used.
permissions (list) --
The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.
(string) --
initProcessEnabled (boolean) --
If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
sharedMemorySize (integer) --
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.
tmpfs (list) --
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.
(dict) --
The container path, mount options, and size of the tmpfs mount.
containerPath (string) --
The absolute file path in the container where the tmpfs volume is mounted.
size (integer) --
The size (in MiB) of the tmpfs volume.
mountOptions (list) --
The list of tmpfs volume mount options.
Valid values: " defaults" | " ro" | " rw" | " suid" | " nosuid" | " dev" | " nodev" | " exec" | " noexec" | " sync" | " async" | " dirsync" | " remount" | " mand" | " nomand" | " atime" | " noatime" | " diratime" | " nodiratime" | " bind" | " rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | " norelatime" | " strictatime" | " nostrictatime" | " mode" | " uid" | " gid" | " nr_inodes" | " nr_blocks" | " mpol"
(string) --
maxSwap (integer) --
The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.
If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.
swappiness (integer) --
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping not to happen unless absolutely necessary. A swappiness value of 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.
logConfiguration (dict) --
The log configuration specification for the container.
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
logDriver (string) --
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
fluentd
Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.
gelf
Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
journald
Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.
json-file
Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.
splunk
Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.
syslog
Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
options (dict) --
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
(string) --
(string) --
secretOptions (list) --
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the AWS Batch User Guide.
(dict) --
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying sensitive data in the AWS Batch User Guide.
name (string) --
The name of the secret.
valueFrom (string) --
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
secrets (list) --
The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
(dict) --
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying sensitive data in the AWS Batch User Guide.
name (string) --
The name of the secret.
valueFrom (string) --
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
networkConfiguration (dict) --
The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
assignPublicIp (string) --
Indicates whether the job should have a public IP address. For a job running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, in order to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking. The default value is "DISABLED".
fargatePlatformConfiguration (dict) --
The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
platformVersion (string) --
The AWS Fargate platform version on which the jobs are running. A platform version is specified only for jobs running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This will use a recent, approved version of the AWS Fargate platform for compute resources. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
tags (dict) --
The tags applied to the job definition.
(string) --
(string) --
propagateTags (boolean) --
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
platformCapabilities (list) --
The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
(string) --
nextToken (string) --
The nextToken value to include in a future DescribeJobDefinitions request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
{'jobs': {'container': {'fargatePlatformConfiguration': {'platformVersion': 'string'}, 'networkConfiguration': {'assignPublicIp': 'ENABLED | ' 'DISABLED'}, 'resourceRequirements': {'type': {'VCPU', 'MEMORY'}}}, 'nodeProperties': {'nodeRangeProperties': {'container': {'fargatePlatformConfiguration': {'platformVersion': 'string'}, 'networkConfiguration': {'assignPublicIp': 'ENABLED ' '| ' 'DISABLED'}, 'resourceRequirements': {'type': {'MEMORY', 'VCPU'}}}}}, 'platformCapabilities': ['EC2 | FARGATE'], 'propagateTags': 'boolean'}}
Describes a list of AWS Batch jobs.
See also: AWS API Documentation
Request Syntax
client.describe_jobs( jobs=[ 'string', ] )
list
[REQUIRED]
A list of up to 100 job IDs.
(string) --
dict
Response Syntax
{ 'jobs': [ { 'jobArn': 'string', 'jobName': 'string', 'jobId': 'string', 'jobQueue': 'string', 'status': 'SUBMITTED'|'PENDING'|'RUNNABLE'|'STARTING'|'RUNNING'|'SUCCEEDED'|'FAILED', 'attempts': [ { 'container': { 'containerInstanceArn': 'string', 'taskArn': 'string', 'exitCode': 123, 'reason': 'string', 'logStreamName': 'string', 'networkInterfaces': [ { 'attachmentId': 'string', 'ipv6Address': 'string', 'privateIpv4Address': 'string' }, ] }, 'startedAt': 123, 'stoppedAt': 123, 'statusReason': 'string' }, ], 'statusReason': 'string', 'createdAt': 123, 'retryStrategy': { 'attempts': 123, 'evaluateOnExit': [ { 'onStatusReason': 'string', 'onReason': 'string', 'onExitCode': 'string', 'action': 'RETRY'|'EXIT' }, ] }, 'startedAt': 123, 'stoppedAt': 123, 'dependsOn': [ { 'jobId': 'string', 'type': 'N_TO_N'|'SEQUENTIAL' }, ], 'jobDefinition': 'string', 'parameters': { 'string': 'string' }, 'container': { 'image': 'string', 'vcpus': 123, 'memory': 123, 'command': [ 'string', ], 'jobRoleArn': 'string', 'executionRoleArn': 'string', 'volumes': [ { 'host': { 'sourcePath': 'string' }, 'name': 'string' }, ], 'environment': [ { 'name': 'string', 'value': 'string' }, ], 'mountPoints': [ { 'containerPath': 'string', 'readOnly': True|False, 'sourceVolume': 'string' }, ], 'readonlyRootFilesystem': True|False, 'ulimits': [ { 'hardLimit': 123, 'name': 'string', 'softLimit': 123 }, ], 'privileged': True|False, 'user': 'string', 'exitCode': 123, 'reason': 'string', 'containerInstanceArn': 'string', 'taskArn': 'string', 'logStreamName': 'string', 'instanceType': 'string', 'networkInterfaces': [ { 'attachmentId': 'string', 'ipv6Address': 'string', 'privateIpv4Address': 'string' }, ], 'resourceRequirements': [ { 'value': 'string', 'type': 'GPU'|'VCPU'|'MEMORY' }, ], 'linuxParameters': { 'devices': [ { 'hostPath': 'string', 'containerPath': 'string', 'permissions': [ 'READ'|'WRITE'|'MKNOD', ] }, ], 'initProcessEnabled': True|False, 'sharedMemorySize': 123, 'tmpfs': [ { 'containerPath': 'string', 'size': 123, 'mountOptions': [ 'string', ] }, ], 'maxSwap': 123, 'swappiness': 123 }, 'logConfiguration': { 'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk', 'options': { 'string': 'string' }, 'secretOptions': [ { 'name': 'string', 'valueFrom': 'string' }, ] }, 'secrets': [ { 'name': 'string', 'valueFrom': 'string' }, ], 'networkConfiguration': { 'assignPublicIp': 'ENABLED'|'DISABLED' }, 'fargatePlatformConfiguration': { 'platformVersion': 'string' } }, 'nodeDetails': { 'nodeIndex': 123, 'isMainNode': True|False }, 'nodeProperties': { 'numNodes': 123, 'mainNode': 123, 'nodeRangeProperties': [ { 'targetNodes': 'string', 'container': { 'image': 'string', 'vcpus': 123, 'memory': 123, 'command': [ 'string', ], 'jobRoleArn': 'string', 'executionRoleArn': 'string', 'volumes': [ { 'host': { 'sourcePath': 'string' }, 'name': 'string' }, ], 'environment': [ { 'name': 'string', 'value': 'string' }, ], 'mountPoints': [ { 'containerPath': 'string', 'readOnly': True|False, 'sourceVolume': 'string' }, ], 'readonlyRootFilesystem': True|False, 'privileged': True|False, 'ulimits': [ { 'hardLimit': 123, 'name': 'string', 'softLimit': 123 }, ], 'user': 'string', 'instanceType': 'string', 'resourceRequirements': [ { 'value': 'string', 'type': 'GPU'|'VCPU'|'MEMORY' }, ], 'linuxParameters': { 'devices': [ { 'hostPath': 'string', 'containerPath': 'string', 'permissions': [ 'READ'|'WRITE'|'MKNOD', ] }, ], 'initProcessEnabled': True|False, 'sharedMemorySize': 123, 'tmpfs': [ { 'containerPath': 'string', 'size': 123, 'mountOptions': [ 'string', ] }, ], 'maxSwap': 123, 'swappiness': 123 }, 'logConfiguration': { 'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk', 'options': { 'string': 'string' }, 'secretOptions': [ { 'name': 'string', 'valueFrom': 'string' }, ] }, 'secrets': [ { 'name': 'string', 'valueFrom': 'string' }, ], 'networkConfiguration': { 'assignPublicIp': 'ENABLED'|'DISABLED' }, 'fargatePlatformConfiguration': { 'platformVersion': 'string' } } }, ] }, 'arrayProperties': { 'statusSummary': { 'string': 123 }, 'size': 123, 'index': 123 }, 'timeout': { 'attemptDurationSeconds': 123 }, 'tags': { 'string': 'string' }, 'propagateTags': True|False, 'platformCapabilities': [ 'EC2'|'FARGATE', ] }, ] }
Response Structure
(dict) --
jobs (list) --
The list of jobs.
(dict) --
An object representing an AWS Batch job.
jobArn (string) --
The Amazon Resource Name (ARN) of the job.
jobName (string) --
The name of the job.
jobId (string) --
The ID for the job.
jobQueue (string) --
The Amazon Resource Name (ARN) of the job queue that the job is associated with.
status (string) --
The current status for the job.
attempts (list) --
A list of job attempts associated with this job.
(dict) --
An object representing a job attempt.
container (dict) --
Details about the container in this job attempt.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
taskArn (string) --
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.
exitCode (integer) --
The exit code for the job attempt. A non-zero exit code is considered a failure.
reason (string) --
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
logStreamName (string) --
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.
networkInterfaces (list) --
The network interfaces associated with the job attempt.
(dict) --
An object representing the elastic network interface for a multi-node parallel job node.
attachmentId (string) --
The attachment ID for the network interface.
ipv6Address (string) --
The private IPv6 address for the network interface.
privateIpv4Address (string) --
The private IPv4 address for the network interface.
startedAt (integer) --
The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the STARTING state to the RUNNING state).
stoppedAt (integer) --
The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
statusReason (string) --
A short, human-readable string to provide additional details about the current status of the job attempt.
statusReason (string) --
A short, human-readable string to provide additional details about the current status of the job.
createdAt (integer) --
The Unix timestamp (in 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.
retryStrategy (dict) --
The retry strategy to use for this job if an attempt fails.
attempts (integer) --
The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.
evaluateOnExit (list) --
Array of up to 5 objects that specify conditions under which the job should be retried or failed. If this parameter is specified, then the attempts parameter must also be specified.
(dict) --
Specifies a set of conditions to be met, and an action to take ( RETRY or EXIT) if all conditions are met.
onStatusReason (string) --
Contains a glob pattern to match against the StatusReason returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and white space (spaces, tabs). and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
onReason (string) --
Contains a glob pattern to match against the Reason returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and white space (spaces, tabs), and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
onExitCode (string) --
Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The patten can be up to 512 characters long, can contain only numbers, and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
action (string) --
Specifies the action to take if all of the specified conditions ( onStatusReason, onReason, and onExitCode) are met. The values are not case sensitive.
startedAt (integer) --
The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.
stoppedAt (integer) --
The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
dependsOn (list) --
A list of job IDs that this job depends on.
(dict) --
An object representing an AWS Batch job dependency.
jobId (string) --
The job ID of the AWS Batch job associated with this dependency.
type (string) --
The type of the job dependency.
jobDefinition (string) --
The job definition that is used by this job.
parameters (dict) --
Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
(string) --
(string) --
container (dict) --
An object representing the details of the container that's associated with the job.
image (string) --
The image used to start the container.
vcpus (integer) --
The number of vCPUs reserved for the container. Jobs running on EC2 resources can specify the vCPU requirement for the job using resourceRequirements but the vCPU requirements can't be specified both here and in the resourceRequirement object. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.
memory (integer) --
For jobs run on EC2 resources that didn't specify memory requirements using ResourceRequirement, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.
command (list) --
The command that is passed to the container.
(string) --
jobRoleArn (string) --
The Amazon Resource Name (ARN) associated with the job upon execution.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.
volumes (list) --
A list of volumes associated with the job.
(dict) --
A data volume used in a job's container properties.
host (dict) --
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. However, the data isn't guaranteed to persist after the containers associated with it stop running.
sourcePath (string) --
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 this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location 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.
name (string) --
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
environment (list) --
The environment variables to pass to a container.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
mountPoints (list) --
The mount points for data volumes in your container.
(dict) --
Details on a Docker volume mount point that is used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
containerPath (string) --
The path on the container where the host volume is mounted.
readOnly (boolean) --
If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.
sourceVolume (string) --
The name of the volume to mount.
readonlyRootFilesystem (boolean) --
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
ulimits (list) --
A list of ulimit values to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
(dict) --
The ulimit settings to pass to the container.
hardLimit (integer) --
The hard limit for the ulimit type.
name (string) --
The type of the ulimit.
softLimit (integer) --
The soft limit for the ulimit type.
privileged (boolean) --
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). The default value is false.
user (string) --
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
exitCode (integer) --
The exit code to return upon completion.
reason (string) --
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
containerInstanceArn (string) --
The Amazon Resource Name (ARN) of the container instance that the container is running on.
taskArn (string) --
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.
logStreamName (string) --
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.
instanceType (string) --
The instance type of the underlying host infrastructure of a multi-node parallel job.
networkInterfaces (list) --
The network interfaces associated with the job.
(dict) --
An object representing the elastic network interface for a multi-node parallel job node.
attachmentId (string) --
The attachment ID for the network interface.
ipv6Address (string) --
The private IPv6 address for the network interface.
privateIpv4Address (string) --
The private IPv4 address for the network interface.
resourceRequirements (list) --
The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
(dict) --
The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
value (string) --
The quantity of the specified resource to reserve for the container. The values vary based on the type specified.
type="GPU"
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.
For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in decimal form, and must match one of the supported values (0.5 and whole numbers between 1 and 30, inclusive) and the VCPU values must be one of the values supported for that memory value.
value = 0.5
VCPU = 0.25
value = 1
VCPU = 0.25 or 0.5
value = 2
VCPU = 0.25, 0.5, or 1
value = 3
VCPU = 0.5, or 1
value = 4
VCPU = 0.5, 1, or 2
value = 5, 6, or 7
VCPU = 1 or 2
value = 8
VCPU = 1, 2, or 4
value = 9, 10, 11, 12, 13, 14, 15, or 16
VCPU = 2 or 4
value = 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
VCPU = 4
type="VCPU"
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4
value = 0.25
MEMORY = 0.5, 1, or 2
value = 0.5
MEMORY = 1, 2, 3, or 4
value = 1
MEMORY = 2, 3, 4, 5, 6, 7, or 8
value = 2
MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16
value = 4
MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
type (string) --
The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
linuxParameters (dict) --
Linux-specific modifications that are applied to the container, such as details for device mappings.
devices (list) --
Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
(dict) --
An object representing a container instance host device.
hostPath (string) --
The path for the device on the host container instance.
containerPath (string) --
The path inside the container used to expose the host device. By default the hostPath value is used.
permissions (list) --
The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.
(string) --
initProcessEnabled (boolean) --
If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
sharedMemorySize (integer) --
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.
tmpfs (list) --
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.
(dict) --
The container path, mount options, and size of the tmpfs mount.
containerPath (string) --
The absolute file path in the container where the tmpfs volume is mounted.
size (integer) --
The size (in MiB) of the tmpfs volume.
mountOptions (list) --
The list of tmpfs volume mount options.
Valid values: " defaults" | " ro" | " rw" | " suid" | " nosuid" | " dev" | " nodev" | " exec" | " noexec" | " sync" | " async" | " dirsync" | " remount" | " mand" | " nomand" | " atime" | " noatime" | " diratime" | " nodiratime" | " bind" | " rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | " norelatime" | " strictatime" | " nostrictatime" | " mode" | " uid" | " gid" | " nr_inodes" | " nr_blocks" | " mpol"
(string) --
maxSwap (integer) --
The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.
If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.
swappiness (integer) --
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping not to happen unless absolutely necessary. A swappiness value of 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.
logConfiguration (dict) --
The log configuration specification for the container.
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance. Or, alternatively, it must be configured on a different log server for remote logging options. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
logDriver (string) --
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
fluentd
Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.
gelf
Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
journald
Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.
json-file
Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.
splunk
Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.
syslog
Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
options (dict) --
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
(string) --
(string) --
secretOptions (list) --
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the AWS Batch User Guide.
(dict) --
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying sensitive data in the AWS Batch User Guide.
name (string) --
The name of the secret.
valueFrom (string) --
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
secrets (list) --
The secrets to pass to the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
(dict) --
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying sensitive data in the AWS Batch User Guide.
name (string) --
The name of the secret.
valueFrom (string) --
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
networkConfiguration (dict) --
The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
assignPublicIp (string) --
Indicates whether the job should have a public IP address. For a job running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, in order to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking. The default value is "DISABLED".
fargatePlatformConfiguration (dict) --
The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
platformVersion (string) --
The AWS Fargate platform version on which the jobs are running. A platform version is specified only for jobs running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This will use a recent, approved version of the AWS Fargate platform for compute resources. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
nodeDetails (dict) --
An object representing the details of a node that is associated with a multi-node parallel job.
nodeIndex (integer) --
The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.
isMainNode (boolean) --
Specifies whether the current node is the main node for a multi-node parallel job.
nodeProperties (dict) --
An object representing the node properties of a multi-node parallel job.
numNodes (integer) --
The number of nodes associated with a multi-node parallel job.
mainNode (integer) --
Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes.
nodeRangeProperties (list) --
A list of node ranges and their properties associated with a multi-node parallel job.
(dict) --
An object representing the properties of the node range for a multi-node parallel job.
targetNodes (string) --
The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted ( :n), then 0 is used to start the range. If the ending range value is omitted ( n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes ( 0:n). You may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties.
container (dict) --
The container details for the node range.
image (string) --
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag ``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
vcpus (integer) --
This parameter is deprecated and not supported for jobs run on Fargate resources, see resourceRequirement. The number of vCPUs reserved for the container. Jobs running on EC2 resources can specify the vCPU requirement for the job using resourceRequirements but the vCPU requirements can't be specified both here and in the resourceRequirement structure. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.
memory (integer) --
This parameter is deprecated and not supported for jobs run on Fargate resources, use ResourceRequirement. For jobs run on EC2 resources can specify the memory requirement using the ResourceRequirement structure. The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places; it must be specified for each node at least once.
command (list) --
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
(string) --
jobRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. Jobs running on Fargate resources must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.
volumes (list) --
A list of data volumes used in a job.
(dict) --
A data volume used in a job's container properties.
host (dict) --
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. However, the data isn't guaranteed to persist after the containers associated with it stop running.
sourcePath (string) --
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 this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location 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.
name (string) --
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
environment (list) --
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
mountPoints (list) --
The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
(dict) --
Details on a Docker volume mount point that is used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
containerPath (string) --
The path on the container where the host volume is mounted.
readOnly (boolean) --
If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.
sourceVolume (string) --
The name of the volume to mount.
readonlyRootFilesystem (boolean) --
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
privileged (boolean) --
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run. The default value is false.
ulimits (list) --
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
(dict) --
The ulimit settings to pass to the container.
hardLimit (integer) --
The hard limit for the ulimit type.
name (string) --
The type of the ulimit.
softLimit (integer) --
The soft limit for the ulimit type.
user (string) --
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
instanceType (string) --
The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.
resourceRequirements (list) --
The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
(dict) --
The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
value (string) --
The quantity of the specified resource to reserve for the container. The values vary based on the type specified.
type="GPU"
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.
For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in decimal form, and must match one of the supported values (0.5 and whole numbers between 1 and 30, inclusive) and the VCPU values must be one of the values supported for that memory value.
value = 0.5
VCPU = 0.25
value = 1
VCPU = 0.25 or 0.5
value = 2
VCPU = 0.25, 0.5, or 1
value = 3
VCPU = 0.5, or 1
value = 4
VCPU = 0.5, 1, or 2
value = 5, 6, or 7
VCPU = 1 or 2
value = 8
VCPU = 1, 2, or 4
value = 9, 10, 11, 12, 13, 14, 15, or 16
VCPU = 2 or 4
value = 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
VCPU = 4
type="VCPU"
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4
value = 0.25
MEMORY = 0.5, 1, or 2
value = 0.5
MEMORY = 1, 2, 3, or 4
value = 1
MEMORY = 2, 3, 4, 5, 6, 7, or 8
value = 2
MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16
value = 4
MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
type (string) --
The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
linuxParameters (dict) --
Linux-specific modifications that are applied to the container, such as details for device mappings.
devices (list) --
Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
(dict) --
An object representing a container instance host device.
hostPath (string) --
The path for the device on the host container instance.
containerPath (string) --
The path inside the container used to expose the host device. By default the hostPath value is used.
permissions (list) --
The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.
(string) --
initProcessEnabled (boolean) --
If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
sharedMemorySize (integer) --
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.
tmpfs (list) --
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.
(dict) --
The container path, mount options, and size of the tmpfs mount.
containerPath (string) --
The absolute file path in the container where the tmpfs volume is mounted.
size (integer) --
The size (in MiB) of the tmpfs volume.
mountOptions (list) --
The list of tmpfs volume mount options.
Valid values: " defaults" | " ro" | " rw" | " suid" | " nosuid" | " dev" | " nodev" | " exec" | " noexec" | " sync" | " async" | " dirsync" | " remount" | " mand" | " nomand" | " atime" | " noatime" | " diratime" | " nodiratime" | " bind" | " rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | " norelatime" | " strictatime" | " nostrictatime" | " mode" | " uid" | " gid" | " nr_inodes" | " nr_blocks" | " mpol"
(string) --
maxSwap (integer) --
The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.
If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.
swappiness (integer) --
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping not to happen unless absolutely necessary. A swappiness value of 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.
logConfiguration (dict) --
The log configuration specification for the container.
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
logDriver (string) --
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
fluentd
Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.
gelf
Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
journald
Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.
json-file
Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.
splunk
Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.
syslog
Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
options (dict) --
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
(string) --
(string) --
secretOptions (list) --
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the AWS Batch User Guide.
(dict) --
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying sensitive data in the AWS Batch User Guide.
name (string) --
The name of the secret.
valueFrom (string) --
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
secrets (list) --
The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
(dict) --
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying sensitive data in the AWS Batch User Guide.
name (string) --
The name of the secret.
valueFrom (string) --
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
networkConfiguration (dict) --
The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
assignPublicIp (string) --
Indicates whether the job should have a public IP address. For a job running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, in order to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking. The default value is "DISABLED".
fargatePlatformConfiguration (dict) --
The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
platformVersion (string) --
The AWS Fargate platform version on which the jobs are running. A platform version is specified only for jobs running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This will use a recent, approved version of the AWS Fargate platform for compute resources. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
arrayProperties (dict) --
The array properties of the job, if it is an array job.
statusSummary (dict) --
A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.
(string) --
(integer) --
size (integer) --
The size of the array job. This parameter is returned for parent array jobs.
index (integer) --
The job index within the array that is associated with this job. This parameter is returned for array job children.
timeout (dict) --
The timeout configuration for the job.
attemptDurationSeconds (integer) --
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. The minimum value for the timeout is 60 seconds.
tags (dict) --
The tags applied to the job.
(string) --
(string) --
propagateTags (boolean) --
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
platformCapabilities (list) --
The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
(string) --
{'containerProperties': {'fargatePlatformConfiguration': {'platformVersion': 'string'}, 'networkConfiguration': {'assignPublicIp': 'ENABLED | ' 'DISABLED'}, 'resourceRequirements': {'type': {'VCPU', 'MEMORY'}}}, 'nodeProperties': {'nodeRangeProperties': {'container': {'fargatePlatformConfiguration': {'platformVersion': 'string'}, 'networkConfiguration': {'assignPublicIp': 'ENABLED ' '| ' 'DISABLED'}, 'resourceRequirements': {'type': {'MEMORY', 'VCPU'}}}}}, 'platformCapabilities': ['EC2 | FARGATE'], 'propagateTags': 'boolean'}
Registers an AWS Batch job definition.
See also: AWS API Documentation
Request Syntax
client.register_job_definition( jobDefinitionName='string', type='container'|'multinode', parameters={ 'string': 'string' }, containerProperties={ 'image': 'string', 'vcpus': 123, 'memory': 123, 'command': [ 'string', ], 'jobRoleArn': 'string', 'executionRoleArn': 'string', 'volumes': [ { 'host': { 'sourcePath': 'string' }, 'name': 'string' }, ], 'environment': [ { 'name': 'string', 'value': 'string' }, ], 'mountPoints': [ { 'containerPath': 'string', 'readOnly': True|False, 'sourceVolume': 'string' }, ], 'readonlyRootFilesystem': True|False, 'privileged': True|False, 'ulimits': [ { 'hardLimit': 123, 'name': 'string', 'softLimit': 123 }, ], 'user': 'string', 'instanceType': 'string', 'resourceRequirements': [ { 'value': 'string', 'type': 'GPU'|'VCPU'|'MEMORY' }, ], 'linuxParameters': { 'devices': [ { 'hostPath': 'string', 'containerPath': 'string', 'permissions': [ 'READ'|'WRITE'|'MKNOD', ] }, ], 'initProcessEnabled': True|False, 'sharedMemorySize': 123, 'tmpfs': [ { 'containerPath': 'string', 'size': 123, 'mountOptions': [ 'string', ] }, ], 'maxSwap': 123, 'swappiness': 123 }, 'logConfiguration': { 'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk', 'options': { 'string': 'string' }, 'secretOptions': [ { 'name': 'string', 'valueFrom': 'string' }, ] }, 'secrets': [ { 'name': 'string', 'valueFrom': 'string' }, ], 'networkConfiguration': { 'assignPublicIp': 'ENABLED'|'DISABLED' }, 'fargatePlatformConfiguration': { 'platformVersion': 'string' } }, nodeProperties={ 'numNodes': 123, 'mainNode': 123, 'nodeRangeProperties': [ { 'targetNodes': 'string', 'container': { 'image': 'string', 'vcpus': 123, 'memory': 123, 'command': [ 'string', ], 'jobRoleArn': 'string', 'executionRoleArn': 'string', 'volumes': [ { 'host': { 'sourcePath': 'string' }, 'name': 'string' }, ], 'environment': [ { 'name': 'string', 'value': 'string' }, ], 'mountPoints': [ { 'containerPath': 'string', 'readOnly': True|False, 'sourceVolume': 'string' }, ], 'readonlyRootFilesystem': True|False, 'privileged': True|False, 'ulimits': [ { 'hardLimit': 123, 'name': 'string', 'softLimit': 123 }, ], 'user': 'string', 'instanceType': 'string', 'resourceRequirements': [ { 'value': 'string', 'type': 'GPU'|'VCPU'|'MEMORY' }, ], 'linuxParameters': { 'devices': [ { 'hostPath': 'string', 'containerPath': 'string', 'permissions': [ 'READ'|'WRITE'|'MKNOD', ] }, ], 'initProcessEnabled': True|False, 'sharedMemorySize': 123, 'tmpfs': [ { 'containerPath': 'string', 'size': 123, 'mountOptions': [ 'string', ] }, ], 'maxSwap': 123, 'swappiness': 123 }, 'logConfiguration': { 'logDriver': 'json-file'|'syslog'|'journald'|'gelf'|'fluentd'|'awslogs'|'splunk', 'options': { 'string': 'string' }, 'secretOptions': [ { 'name': 'string', 'valueFrom': 'string' }, ] }, 'secrets': [ { 'name': 'string', 'valueFrom': 'string' }, ], 'networkConfiguration': { 'assignPublicIp': 'ENABLED'|'DISABLED' }, 'fargatePlatformConfiguration': { 'platformVersion': 'string' } } }, ] }, retryStrategy={ 'attempts': 123, 'evaluateOnExit': [ { 'onStatusReason': 'string', 'onReason': 'string', 'onExitCode': 'string', 'action': 'RETRY'|'EXIT' }, ] }, propagateTags=True|False, timeout={ 'attemptDurationSeconds': 123 }, tags={ 'string': 'string' }, platformCapabilities=[ 'EC2'|'FARGATE', ] )
string
[REQUIRED]
The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
string
[REQUIRED]
The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide.
dict
Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.
(string) --
(string) --
dict
An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.
image (string) --
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag ``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
vcpus (integer) --
This parameter is deprecated and not supported for jobs run on Fargate resources, see resourceRequirement. The number of vCPUs reserved for the container. Jobs running on EC2 resources can specify the vCPU requirement for the job using resourceRequirements but the vCPU requirements can't be specified both here and in the resourceRequirement structure. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.
memory (integer) --
This parameter is deprecated and not supported for jobs run on Fargate resources, use ResourceRequirement. For jobs run on EC2 resources can specify the memory requirement using the ResourceRequirement structure. The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places; it must be specified for each node at least once.
command (list) --
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
(string) --
jobRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. Jobs running on Fargate resources must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.
volumes (list) --
A list of data volumes used in a job.
(dict) --
A data volume used in a job's container properties.
host (dict) --
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. However, the data isn't guaranteed to persist after the containers associated with it stop running.
sourcePath (string) --
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 this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location 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.
name (string) --
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
environment (list) --
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
mountPoints (list) --
The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
(dict) --
Details on a Docker volume mount point that is used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
containerPath (string) --
The path on the container where the host volume is mounted.
readOnly (boolean) --
If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.
sourceVolume (string) --
The name of the volume to mount.
readonlyRootFilesystem (boolean) --
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
privileged (boolean) --
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run. The default value is false.
ulimits (list) --
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
(dict) --
The ulimit settings to pass to the container.
hardLimit (integer) -- [REQUIRED]
The hard limit for the ulimit type.
name (string) -- [REQUIRED]
The type of the ulimit.
softLimit (integer) -- [REQUIRED]
The soft limit for the ulimit type.
user (string) --
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
instanceType (string) --
The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.
resourceRequirements (list) --
The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
(dict) --
The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
value (string) -- [REQUIRED]
The quantity of the specified resource to reserve for the container. The values vary based on the type specified.
type="GPU"
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.
For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in decimal form, and must match one of the supported values (0.5 and whole numbers between 1 and 30, inclusive) and the VCPU values must be one of the values supported for that memory value.
value = 0.5
VCPU = 0.25
value = 1
VCPU = 0.25 or 0.5
value = 2
VCPU = 0.25, 0.5, or 1
value = 3
VCPU = 0.5, or 1
value = 4
VCPU = 0.5, 1, or 2
value = 5, 6, or 7
VCPU = 1 or 2
value = 8
VCPU = 1, 2, or 4
value = 9, 10, 11, 12, 13, 14, 15, or 16
VCPU = 2 or 4
value = 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
VCPU = 4
type="VCPU"
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4
value = 0.25
MEMORY = 0.5, 1, or 2
value = 0.5
MEMORY = 1, 2, 3, or 4
value = 1
MEMORY = 2, 3, 4, 5, 6, 7, or 8
value = 2
MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16
value = 4
MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
type (string) -- [REQUIRED]
The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
linuxParameters (dict) --
Linux-specific modifications that are applied to the container, such as details for device mappings.
devices (list) --
Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
(dict) --
An object representing a container instance host device.
hostPath (string) -- [REQUIRED]
The path for the device on the host container instance.
containerPath (string) --
The path inside the container used to expose the host device. By default the hostPath value is used.
permissions (list) --
The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.
(string) --
initProcessEnabled (boolean) --
If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
sharedMemorySize (integer) --
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.
tmpfs (list) --
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.
(dict) --
The container path, mount options, and size of the tmpfs mount.
containerPath (string) -- [REQUIRED]
The absolute file path in the container where the tmpfs volume is mounted.
size (integer) -- [REQUIRED]
The size (in MiB) of the tmpfs volume.
mountOptions (list) --
The list of tmpfs volume mount options.
Valid values: " defaults" | " ro" | " rw" | " suid" | " nosuid" | " dev" | " nodev" | " exec" | " noexec" | " sync" | " async" | " dirsync" | " remount" | " mand" | " nomand" | " atime" | " noatime" | " diratime" | " nodiratime" | " bind" | " rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | " norelatime" | " strictatime" | " nostrictatime" | " mode" | " uid" | " gid" | " nr_inodes" | " nr_blocks" | " mpol"
(string) --
maxSwap (integer) --
The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.
If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.
swappiness (integer) --
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping not to happen unless absolutely necessary. A swappiness value of 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.
logConfiguration (dict) --
The log configuration specification for the container.
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
logDriver (string) -- [REQUIRED]
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
fluentd
Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.
gelf
Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
journald
Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.
json-file
Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.
splunk
Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.
syslog
Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
options (dict) --
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
(string) --
(string) --
secretOptions (list) --
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the AWS Batch User Guide.
(dict) --
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying sensitive data in the AWS Batch User Guide.
name (string) -- [REQUIRED]
The name of the secret.
valueFrom (string) -- [REQUIRED]
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
secrets (list) --
The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
(dict) --
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying sensitive data in the AWS Batch User Guide.
name (string) -- [REQUIRED]
The name of the secret.
valueFrom (string) -- [REQUIRED]
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
networkConfiguration (dict) --
The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
assignPublicIp (string) --
Indicates whether the job should have a public IP address. For a job running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, in order to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking. The default value is "DISABLED".
fargatePlatformConfiguration (dict) --
The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
platformVersion (string) --
The AWS Fargate platform version on which the jobs are running. A platform version is specified only for jobs running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This will use a recent, approved version of the AWS Fargate platform for compute resources. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
dict
An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.
numNodes (integer) -- [REQUIRED]
The number of nodes associated with a multi-node parallel job.
mainNode (integer) -- [REQUIRED]
Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes.
nodeRangeProperties (list) -- [REQUIRED]
A list of node ranges and their properties associated with a multi-node parallel job.
(dict) --
An object representing the properties of the node range for a multi-node parallel job.
targetNodes (string) -- [REQUIRED]
The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted ( :n), then 0 is used to start the range. If the ending range value is omitted ( n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes ( 0:n). You may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties.
container (dict) --
The container details for the node range.
image (string) --
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag ``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
vcpus (integer) --
This parameter is deprecated and not supported for jobs run on Fargate resources, see resourceRequirement. The number of vCPUs reserved for the container. Jobs running on EC2 resources can specify the vCPU requirement for the job using resourceRequirements but the vCPU requirements can't be specified both here and in the resourceRequirement structure. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.
memory (integer) --
This parameter is deprecated and not supported for jobs run on Fargate resources, use ResourceRequirement. For jobs run on EC2 resources can specify the memory requirement using the ResourceRequirement structure. The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places; it must be specified for each node at least once.
command (list) --
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
(string) --
jobRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. Jobs running on Fargate resources must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.
volumes (list) --
A list of data volumes used in a job.
(dict) --
A data volume used in a job's container properties.
host (dict) --
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. However, the data isn't guaranteed to persist after the containers associated with it stop running.
sourcePath (string) --
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 this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location 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.
name (string) --
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
environment (list) --
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
mountPoints (list) --
The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
(dict) --
Details on a Docker volume mount point that is used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
containerPath (string) --
The path on the container where the host volume is mounted.
readOnly (boolean) --
If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.
sourceVolume (string) --
The name of the volume to mount.
readonlyRootFilesystem (boolean) --
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
privileged (boolean) --
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run. The default value is false.
ulimits (list) --
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
(dict) --
The ulimit settings to pass to the container.
hardLimit (integer) -- [REQUIRED]
The hard limit for the ulimit type.
name (string) -- [REQUIRED]
The type of the ulimit.
softLimit (integer) -- [REQUIRED]
The soft limit for the ulimit type.
user (string) --
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
instanceType (string) --
The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.
resourceRequirements (list) --
The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
(dict) --
The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
value (string) -- [REQUIRED]
The quantity of the specified resource to reserve for the container. The values vary based on the type specified.
type="GPU"
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.
For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in decimal form, and must match one of the supported values (0.5 and whole numbers between 1 and 30, inclusive) and the VCPU values must be one of the values supported for that memory value.
value = 0.5
VCPU = 0.25
value = 1
VCPU = 0.25 or 0.5
value = 2
VCPU = 0.25, 0.5, or 1
value = 3
VCPU = 0.5, or 1
value = 4
VCPU = 0.5, 1, or 2
value = 5, 6, or 7
VCPU = 1 or 2
value = 8
VCPU = 1, 2, or 4
value = 9, 10, 11, 12, 13, 14, 15, or 16
VCPU = 2 or 4
value = 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
VCPU = 4
type="VCPU"
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4
value = 0.25
MEMORY = 0.5, 1, or 2
value = 0.5
MEMORY = 1, 2, 3, or 4
value = 1
MEMORY = 2, 3, 4, 5, 6, 7, or 8
value = 2
MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16
value = 4
MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
type (string) -- [REQUIRED]
The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
linuxParameters (dict) --
Linux-specific modifications that are applied to the container, such as details for device mappings.
devices (list) --
Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
(dict) --
An object representing a container instance host device.
hostPath (string) -- [REQUIRED]
The path for the device on the host container instance.
containerPath (string) --
The path inside the container used to expose the host device. By default the hostPath value is used.
permissions (list) --
The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.
(string) --
initProcessEnabled (boolean) --
If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
sharedMemorySize (integer) --
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.
tmpfs (list) --
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.
(dict) --
The container path, mount options, and size of the tmpfs mount.
containerPath (string) -- [REQUIRED]
The absolute file path in the container where the tmpfs volume is mounted.
size (integer) -- [REQUIRED]
The size (in MiB) of the tmpfs volume.
mountOptions (list) --
The list of tmpfs volume mount options.
Valid values: " defaults" | " ro" | " rw" | " suid" | " nosuid" | " dev" | " nodev" | " exec" | " noexec" | " sync" | " async" | " dirsync" | " remount" | " mand" | " nomand" | " atime" | " noatime" | " diratime" | " nodiratime" | " bind" | " rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | " norelatime" | " strictatime" | " nostrictatime" | " mode" | " uid" | " gid" | " nr_inodes" | " nr_blocks" | " mpol"
(string) --
maxSwap (integer) --
The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.
If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.
swappiness (integer) --
This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping not to happen unless absolutely necessary. A swappiness value of 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.
logConfiguration (dict) --
The log configuration specification for the container.
This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
logDriver (string) -- [REQUIRED]
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.
The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the AWS Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
fluentd
Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker documentation.
gelf
Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see Graylog Extended Format logging driver in the Docker documentation.
journald
Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker documentation.
json-file
Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker documentation.
splunk
Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker documentation.
syslog
Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker documentation.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
options (dict) --
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
(string) --
(string) --
secretOptions (list) --
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the AWS Batch User Guide.
(dict) --
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying sensitive data in the AWS Batch User Guide.
name (string) -- [REQUIRED]
The name of the secret.
valueFrom (string) -- [REQUIRED]
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
secrets (list) --
The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.
(dict) --
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.
For more information, see Specifying sensitive data in the AWS Batch User Guide.
name (string) -- [REQUIRED]
The name of the secret.
valueFrom (string) -- [REQUIRED]
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
networkConfiguration (dict) --
The network configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
assignPublicIp (string) --
Indicates whether the job should have a public IP address. For a job running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, in order to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking. The default value is "DISABLED".
fargatePlatformConfiguration (dict) --
The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.
platformVersion (string) --
The AWS Fargate platform version on which the jobs are running. A platform version is specified only for jobs running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This will use a recent, approved version of the AWS Fargate platform for compute resources. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
dict
The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.
attempts (integer) --
The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.
evaluateOnExit (list) --
Array of up to 5 objects that specify conditions under which the job should be retried or failed. If this parameter is specified, then the attempts parameter must also be specified.
(dict) --
Specifies a set of conditions to be met, and an action to take ( RETRY or EXIT) if all conditions are met.
onStatusReason (string) --
Contains a glob pattern to match against the StatusReason returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and white space (spaces, tabs). and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
onReason (string) --
Contains a glob pattern to match against the Reason returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and white space (spaces, tabs), and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
onExitCode (string) --
Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The patten can be up to 512 characters long, can contain only numbers, and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
action (string) -- [REQUIRED]
Specifies the action to take if all of the specified conditions ( onStatusReason, onReason, and onExitCode) are met. The values are not case sensitive.
boolean
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
dict
The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the AWS Batch User Guide.
attemptDurationSeconds (integer) --
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. The minimum value for the timeout is 60 seconds.
dict
The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS Batch User Guide.
(string) --
(string) --
list
The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.
(string) --
dict
Response Syntax
{ 'jobDefinitionName': 'string', 'jobDefinitionArn': 'string', 'revision': 123 }
Response Structure
(dict) --
jobDefinitionName (string) --
The name of the job definition.
jobDefinitionArn (string) --
The Amazon Resource Name (ARN) of the job definition.
revision (integer) --
The revision of the job definition.
{'containerOverrides': {'resourceRequirements': {'type': {'VCPU', 'MEMORY'}}}, 'nodeOverrides': {'nodePropertyOverrides': {'containerOverrides': {'resourceRequirements': {'type': {'MEMORY', 'VCPU'}}}}}, 'propagateTags': 'boolean'}
Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
See also: AWS API Documentation
Request Syntax
client.submit_job( jobName='string', jobQueue='string', arrayProperties={ 'size': 123 }, dependsOn=[ { 'jobId': 'string', 'type': 'N_TO_N'|'SEQUENTIAL' }, ], jobDefinition='string', parameters={ 'string': 'string' }, containerOverrides={ 'vcpus': 123, 'memory': 123, 'command': [ 'string', ], 'instanceType': 'string', 'environment': [ { 'name': 'string', 'value': 'string' }, ], 'resourceRequirements': [ { 'value': 'string', 'type': 'GPU'|'VCPU'|'MEMORY' }, ] }, nodeOverrides={ 'numNodes': 123, 'nodePropertyOverrides': [ { 'targetNodes': 'string', 'containerOverrides': { 'vcpus': 123, 'memory': 123, 'command': [ 'string', ], 'instanceType': 'string', 'environment': [ { 'name': 'string', 'value': 'string' }, ], 'resourceRequirements': [ { 'value': 'string', 'type': 'GPU'|'VCPU'|'MEMORY' }, ] } }, ] }, retryStrategy={ 'attempts': 123, 'evaluateOnExit': [ { 'onStatusReason': 'string', 'onReason': 'string', 'onExitCode': 'string', 'action': 'RETRY'|'EXIT' }, ] }, propagateTags=True|False, timeout={ 'attemptDurationSeconds': 123 }, tags={ 'string': 'string' } )
string
[REQUIRED]
The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
string
[REQUIRED]
The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
dict
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.
size (integer) --
The size of the array job.
list
A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
(dict) --
An object representing an AWS Batch job dependency.
jobId (string) --
The job ID of the AWS Batch job associated with this dependency.
type (string) --
The type of the job dependency.
string
[REQUIRED]
The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
dict
Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.
(string) --
(string) --
dict
A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.
vcpus (integer) --
This parameter is deprecated and not supported for jobs run on Fargate resources, see resourceRequirement. For jobs run on EC2 resources, the number of vCPUs to reserve for the container. This value overrides the value set in the job definition. Jobs run on EC2 resources can specify the vCPU requirement using resourceRequirement but the vCPU requirements can't be specified both here and in resourceRequirement. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.
memory (integer) --
This parameter is deprecated and not supported for jobs run on Fargate resources, use ResourceRequirement. For jobs run on EC2 resource, the number of MiB of memory reserved for the job. This value overrides the value set in the job definition.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the job definition.
(string) --
instanceType (string) --
The instance type to use for a multi-node parallel job.
environment (list) --
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
resourceRequirements (list) --
The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.
(dict) --
The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
value (string) -- [REQUIRED]
The quantity of the specified resource to reserve for the container. The values vary based on the type specified.
type="GPU"
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.
For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in decimal form, and must match one of the supported values (0.5 and whole numbers between 1 and 30, inclusive) and the VCPU values must be one of the values supported for that memory value.
value = 0.5
VCPU = 0.25
value = 1
VCPU = 0.25 or 0.5
value = 2
VCPU = 0.25, 0.5, or 1
value = 3
VCPU = 0.5, or 1
value = 4
VCPU = 0.5, 1, or 2
value = 5, 6, or 7
VCPU = 1 or 2
value = 8
VCPU = 1, 2, or 4
value = 9, 10, 11, 12, 13, 14, 15, or 16
VCPU = 2 or 4
value = 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
VCPU = 4
type="VCPU"
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4
value = 0.25
MEMORY = 0.5, 1, or 2
value = 0.5
MEMORY = 1, 2, 3, or 4
value = 1
MEMORY = 2, 3, 4, 5, 6, 7, or 8
value = 2
MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16
value = 4
MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
type (string) -- [REQUIRED]
The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
dict
A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.
numNodes (integer) --
The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override:
There must be at least one node range in your job definition that has an open upper boundary (such as : or n:).
The lower boundary of the node range specified in the job definition must be fewer than the number of nodes specified in the override.
The main node index specified in the job definition must be fewer than the number of nodes specified in the override.
nodePropertyOverrides (list) --
The node property overrides for the job.
(dict) --
Object representing any node overrides to a job definition that is used in a SubmitJob API operation.
targetNodes (string) -- [REQUIRED]
The range of nodes, using node index values, that's used to override. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted ( :n), then 0 is used to start the range. If the ending range value is omitted ( n:), then the highest possible node index is used to end the range.
containerOverrides (dict) --
The overrides that should be sent to a node range.
vcpus (integer) --
This parameter is deprecated and not supported for jobs run on Fargate resources, see resourceRequirement. For jobs run on EC2 resources, the number of vCPUs to reserve for the container. This value overrides the value set in the job definition. Jobs run on EC2 resources can specify the vCPU requirement using resourceRequirement but the vCPU requirements can't be specified both here and in resourceRequirement. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.
memory (integer) --
This parameter is deprecated and not supported for jobs run on Fargate resources, use ResourceRequirement. For jobs run on EC2 resource, the number of MiB of memory reserved for the job. This value overrides the value set in the job definition.
command (list) --
The command to send to the container that overrides the default command from the Docker image or the job definition.
(string) --
instanceType (string) --
The instance type to use for a multi-node parallel job.
environment (list) --
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.
(dict) --
A key-value pair object.
name (string) --
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value (string) --
The value of the key-value pair. For environment variables, this is the value of the environment variable.
resourceRequirements (list) --
The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.
(dict) --
The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
value (string) -- [REQUIRED]
The quantity of the specified resource to reserve for the container. The values vary based on the type specified.
type="GPU"
The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.
For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.
For jobs running on Fargate resources, then value is the hard limit (in GiB), represented in decimal form, and must match one of the supported values (0.5 and whole numbers between 1 and 30, inclusive) and the VCPU values must be one of the values supported for that memory value.
value = 0.5
VCPU = 0.25
value = 1
VCPU = 0.25 or 0.5
value = 2
VCPU = 0.25, 0.5, or 1
value = 3
VCPU = 0.5, or 1
value = 4
VCPU = 0.5, 1, or 2
value = 5, 6, or 7
VCPU = 1 or 2
value = 8
VCPU = 1, 2, or 4
value = 9, 10, 11, 12, 13, 14, 15, or 16
VCPU = 2 or 4
value = 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
VCPU = 4
type="VCPU"
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.
For jobs running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4
value = 0.25
MEMORY = 0.5, 1, or 2
value = 0.5
MEMORY = 1, 2, 3, or 4
value = 1
MEMORY = 2, 3, 4, 5, 6, 7, or 8
value = 2
MEMORY = 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, or 16
value = 4
MEMORY = 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, or 30
type (string) -- [REQUIRED]
The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.
dict
The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
attempts (integer) --
The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.
evaluateOnExit (list) --
Array of up to 5 objects that specify conditions under which the job should be retried or failed. If this parameter is specified, then the attempts parameter must also be specified.
(dict) --
Specifies a set of conditions to be met, and an action to take ( RETRY or EXIT) if all conditions are met.
onStatusReason (string) --
Contains a glob pattern to match against the StatusReason returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and white space (spaces, tabs). and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
onReason (string) --
Contains a glob pattern to match against the Reason returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and white space (spaces, tabs), and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
onExitCode (string) --
Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The patten can be up to 512 characters long, can contain only numbers, and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.
action (string) -- [REQUIRED]
Specifies the action to take if all of the specified conditions ( onStatusReason, onReason, and onExitCode) are met. The values are not case sensitive.
boolean
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state. When specified, this overrides the tag propagation setting in the job definition.
dict
The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
attemptDurationSeconds (integer) --
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. The minimum value for the timeout is 60 seconds.
dict
The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.
(string) --
(string) --
dict
Response Syntax
{ 'jobArn': 'string', 'jobName': 'string', 'jobId': 'string' }
Response Structure
(dict) --
jobArn (string) --
The Amazon Resource Name (ARN) for the job.
jobName (string) --
The name of the job.
jobId (string) --
The unique identifier for the job.
{'computeResources': {'securityGroupIds': ['string'], 'subnets': ['string']}}
Updates an AWS Batch compute environment.
See also: AWS API Documentation
Request Syntax
client.update_compute_environment( computeEnvironment='string', state='ENABLED'|'DISABLED', computeResources={ 'minvCpus': 123, 'maxvCpus': 123, 'desiredvCpus': 123, 'subnets': [ 'string', ], 'securityGroupIds': [ 'string', ] }, serviceRole='string' )
string
[REQUIRED]
The name or full Amazon Resource Name (ARN) of the compute environment to update.
string
The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.
dict
Details of the compute resources managed by the compute environment. Required for a managed compute environment.
minvCpus (integer) --
The minimum number of Amazon EC2 vCPUs that an environment should maintain.
maxvCpus (integer) --
The maximum number of Amazon EC2 vCPUs that an environment can reach.
desiredvCpus (integer) --
The desired number of Amazon EC2 vCPUS in the compute environment.
subnets (list) --
The VPC subnets that the compute resources are launched into. This parameter is required for jobs running on Fargate compute resources, where it can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User Guide. This can't be specified for EC2 compute resources. Providing an empty list will be handled as if this parameter wasn't specified and no change is made.
(string) --
securityGroupIds (list) --
The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. This can't be specified for EC2 compute resources. Providing an empty list is handled as if this parameter wasn't specified and no changeis made.
(string) --
string
The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.
dict
Response Syntax
{ 'computeEnvironmentName': 'string', 'computeEnvironmentArn': 'string' }
Response Structure
(dict) --
computeEnvironmentName (string) --
The name of the compute environment.
computeEnvironmentArn (string) --
The Amazon Resource Name (ARN) of the compute environment.