You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Batch

Inherits:
AWS.Service show all
Identifier:
batch
API Version:
2016-08-10
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of this computing workload to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these advantages, Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.

As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus your time and energy on analyzing results and solving your specific problems.

Sending a Request Using Batch

var batch = new AWS.Batch();
batch.cancelJob(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Batch object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var batch = new AWS.Batch({apiVersion: '2016-08-10'});

You can also set the API version globally in AWS.config.apiVersions using the batch service identifier:

AWS.config.apiVersions = {
  batch: '2016-08-10',
  // other service API versions
};

var batch = new AWS.Batch();

Version:

  • 2016-08-10

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Batch(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Batch object

var batch = new AWS.Batch({apiVersion: '2016-08-10'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Batch.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Batch.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Batch.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelJob(params = {}, callback) ⇒ AWS.Request

Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are canceled. Jobs that have progressed to STARTING or RUNNING aren't canceled, but the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.

Service Reference:

Examples:

To cancel a job


/* This example cancels a job with the specified job ID. */

 var params = {
  jobId: "1d828f65-7a4d-42e8-996d-3b900ed59dc4", 
  reason: "Cancelling job."
 };
 batch.cancelJob(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the cancelJob operation

var params = {
  jobId: 'STRING_VALUE', /* required */
  reason: 'STRING_VALUE' /* required */
};
batch.cancelJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • jobId — (String)

      The Batch job ID of the job to cancel.

    • reason — (String)

      A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createComputeEnvironment(params = {}, callback) ⇒ AWS.Request

Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use EC2 resources.

In a managed compute environment, 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. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can 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 less than a specified percentage of the On-Demand price.

Note: Multi-node parallel jobs aren't supported on Spot Instances.

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 AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, 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.

Note: Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible for managing the guest operating system (including its updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your Batch jobs, complete these steps:
  1. Create a new compute environment with the new AMI.
  2. Add the compute environment to an existing job queue.
  3. Remove the earlier compute environment from your job queue.
  4. Delete the earlier compute environment.

Service Reference:

Examples:

To create a managed EC2 compute environment


/* This example creates a managed compute environment with specific C4 instance types that are launched on demand. The compute environment is called C4OnDemand. */

 var params = {
  type: "MANAGED", 
  computeEnvironmentName: "C4OnDemand", 
  computeResources: {
   type: "EC2", 
   desiredvCpus: 48, 
   ec2KeyPair: "id_rsa", 
   instanceRole: "ecsInstanceRole", 
   instanceTypes: [
      "c4.large", 
      "c4.xlarge", 
      "c4.2xlarge", 
      "c4.4xlarge", 
      "c4.8xlarge"
   ], 
   maxvCpus: 128, 
   minvCpus: 0, 
   securityGroupIds: [
      "sg-cf5093b2"
   ], 
   subnets: [
      "subnet-220c0e0a", 
      "subnet-1a95556d", 
      "subnet-978f6dce"
   ], 
   tags: {
    "Name": "Batch Instance - C4OnDemand"
   }
  }, 
  serviceRole: "arn:aws:iam::012345678910:role/AWSBatchServiceRole", 
  state: "ENABLED"
 };
 batch.createComputeEnvironment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    computeEnvironmentArn: "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand", 
    computeEnvironmentName: "C4OnDemand"
   }
   */
 });

To create a managed EC2 Spot compute environment


/* This example creates a managed compute environment with the M4 instance type that is launched when the Spot bid price is at or below 20% of the On-Demand price for the instance type. The compute environment is called M4Spot. */

 var params = {
  type: "MANAGED", 
  computeEnvironmentName: "M4Spot", 
  computeResources: {
   type: "SPOT", 
   bidPercentage: 20, 
   desiredvCpus: 4, 
   ec2KeyPair: "id_rsa", 
   instanceRole: "ecsInstanceRole", 
   instanceTypes: [
      "m4"
   ], 
   maxvCpus: 128, 
   minvCpus: 0, 
   securityGroupIds: [
      "sg-cf5093b2"
   ], 
   spotIamFleetRole: "arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role", 
   subnets: [
      "subnet-220c0e0a", 
      "subnet-1a95556d", 
      "subnet-978f6dce"
   ], 
   tags: {
    "Name": "Batch Instance - M4Spot"
   }
  }, 
  serviceRole: "arn:aws:iam::012345678910:role/AWSBatchServiceRole", 
  state: "ENABLED"
 };
 batch.createComputeEnvironment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    computeEnvironmentArn: "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot", 
    computeEnvironmentName: "M4Spot"
   }
   */
 });

Calling the createComputeEnvironment operation

var params = {
  computeEnvironmentName: 'STRING_VALUE', /* required */
  type: MANAGED | UNMANAGED, /* required */
  computeResources: {
    maxvCpus: 'NUMBER_VALUE', /* required */
    subnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    type: EC2 | SPOT | FARGATE | FARGATE_SPOT, /* required */
    allocationStrategy: BEST_FIT | BEST_FIT_PROGRESSIVE | SPOT_CAPACITY_OPTIMIZED,
    bidPercentage: 'NUMBER_VALUE',
    desiredvCpus: 'NUMBER_VALUE',
    ec2Configuration: [
      {
        imageType: 'STRING_VALUE', /* required */
        imageIdOverride: 'STRING_VALUE'
      },
      /* more items */
    ],
    ec2KeyPair: 'STRING_VALUE',
    imageId: 'STRING_VALUE',
    instanceRole: 'STRING_VALUE',
    instanceTypes: [
      'STRING_VALUE',
      /* more items */
    ],
    launchTemplate: {
      launchTemplateId: 'STRING_VALUE',
      launchTemplateName: 'STRING_VALUE',
      version: 'STRING_VALUE'
    },
    minvCpus: 'NUMBER_VALUE',
    placementGroup: 'STRING_VALUE',
    securityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    spotIamFleetRole: 'STRING_VALUE',
    tags: {
      '<String>': 'STRING_VALUE',
      /* '<String>': ... */
    }
  },
  serviceRole: 'STRING_VALUE',
  state: ENABLED | DISABLED,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  unmanagedvCpus: 'NUMBER_VALUE'
};
batch.createComputeEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • computeEnvironmentName — (String)

      The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

    • type — (String)

      The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the Batch User Guide.

      Possible values include:
      • "MANAGED"
      • "UNMANAGED"
    • state — (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.

      If the state is ENABLED, then the 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 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 don't scale out. However, they scale in to minvCpus value after instances become idle.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • unmanagedvCpus — (Integer)

      The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter is not provided for a fair share job queue, no vCPU capacity will be reserved.

      Note: This parameter is only supported when the type parameter is set to UNMANAGED/
    • computeResources — (map)

      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 Batch User Guide.

      • type — required — (String)

        The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute Environments in the Batch User Guide.

        If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet role in the Batch User Guide.

        Possible values include:
        • "EC2"
        • "SPOT"
        • "FARGATE"
        • "FARGATE_SPOT"
      • 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 Batch User Guide.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
        BEST_FIT (default)

        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, Batch waits for the additional instances to be available. If there aren't enough instances available, or if the user is reaching Amazon EC2 service limits then additional jobs aren't run until the 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

        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, Batch will select new instance types.

        SPOT_CAPACITY_OPTIMIZED

        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, Batch might need to go above maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

        Possible values include:
        • "BEST_FIT"
        • "BEST_FIT_PROGRESSIVE"
        • "SPOT_CAPACITY_OPTIMIZED"
      • minvCpus — (Integer)

        The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).

        Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
      • maxvCpus — required — (Integer)

        The maximum number of Amazon EC2 vCPUs that a compute environment can reach.

        Note: With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. For example, no more than a single instance from among those specified in your compute environment is allocated.
      • desiredvCpus — (Integer)

        The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values, based on job queue demand.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
      • instanceTypes — (Array<String>)

        The instances types that can 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 C4, M4, and R4 instance families) that match the demand of your job queues.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
        Note: When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
        Note: Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are used.
      • 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.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
        Note: The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
      • subnets — required — (Array<String>)

        The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User Guide.

      • securityGroupIds — (Array<String>)

        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 that are running on Fargate resources and must contain at least one security group. Fargate doesn't support launch templates. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds are used.

      • ec2KeyPair — (String)

        The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
      • 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 Batch User Guide.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
      • tags — (map<String>)

        Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value−for example, { "Name": "Batch Instance - C4OnDemand" }. This is helpful for recognizing your Batch instances in the Amazon EC2 console. These tags can't be updated or removed after the compute environment is created. Any changes to these tags require that you create a new compute environment and remove the old compute environment. These tags aren't seen when using the Batch ListTagsForResource API operation.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
      • 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.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
      • 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 less than 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.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
      • 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 Batch User Guide.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

        To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot Instances not tagged on creation in the Batch User Guide.

      • launchTemplate — (map)

        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 Batch User Guide.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
        • 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.

          After the compute environment is created, the launch template version that's used isn't changed, even if the $Default or $Latest version for the launch template is updated. To use a new launch template version, create a new compute environment, add the new compute environment to the existing job queue, remove the old compute environment from the job queue, and delete the old compute environment.

          Default: $Default.

      • ec2Configuration — (Array<map>)

        Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2.

        One or two values can be provided.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
        • imageType — required — (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 Amazon Linux 2 AMI (ECS_AL2) is used.

          ECS_AL2

          Amazon Linux 2− Default for all non-GPU instance families.

          ECS_AL2_NVIDIA

          Amazon Linux 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

          ECS_AL1

          Amazon Linux. Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.

        • 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 full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

      If your account already created the Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the Batch service-linked role in your account.

      If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

      Note: Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
    • tags — (map<String>)

      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 Amazon Web Services Resources in Amazon Web Services 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • computeEnvironmentName — (String)

        The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

      • computeEnvironmentArn — (String)

        The Amazon Resource Name (ARN) of the compute environment.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createJobQueue(params = {}, callback) ⇒ AWS.Request

Creates an Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.

You also set a priority to the job queue that determines the order that the Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.

Service Reference:

Examples:

To create a job queue with a single compute environment


/* This example creates a job queue called LowPriority that uses the M4Spot compute environment. */

 var params = {
  computeEnvironmentOrder: [
     {
    computeEnvironment: "M4Spot", 
    order: 1
   }
  ], 
  jobQueueName: "LowPriority", 
  priority: 1, 
  state: "ENABLED"
 };
 batch.createJobQueue(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    jobQueueArn: "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority", 
    jobQueueName: "LowPriority"
   }
   */
 });

To create a job queue with multiple compute environments


/* This example creates a job queue called HighPriority that uses the C4OnDemand compute environment with an order of 1 and the M4Spot compute environment with an order of 2. */

 var params = {
  computeEnvironmentOrder: [
     {
    computeEnvironment: "C4OnDemand", 
    order: 1
   }, 
     {
    computeEnvironment: "M4Spot", 
    order: 2
   }
  ], 
  jobQueueName: "HighPriority", 
  priority: 10, 
  state: "ENABLED"
 };
 batch.createJobQueue(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    jobQueueArn: "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", 
    jobQueueName: "HighPriority"
   }
   */
 });

Calling the createJobQueue operation

var params = {
  computeEnvironmentOrder: [ /* required */
    {
      computeEnvironment: 'STRING_VALUE', /* required */
      order: 'NUMBER_VALUE' /* required */
    },
    /* more items */
  ],
  jobQueueName: 'STRING_VALUE', /* required */
  priority: 'NUMBER_VALUE', /* required */
  schedulingPolicyArn: 'STRING_VALUE',
  state: ENABLED | DISABLED,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
batch.createJobQueue(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • jobQueueName — (String)

      The name of the job queue. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.

    • state — (String)

      The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • schedulingPolicyArn — (String)

      Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue will use a fair share scheduling policy. If this parameter is not specified, the job queue will use a first in, first out (FIFO) scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

    • priority — (Integer)

      The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

    • computeEnvironmentOrder — (Array<map>)

      The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should run a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

      Note: All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.
      • order — required — (Integer)

        The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

      • computeEnvironment — required — (String)

        The Amazon Resource Name (ARN) of the compute environment.

    • tags — (map<String>)

      The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources in Batch User Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobQueueName — (String)

        The name of the job queue.

      • jobQueueArn — (String)

        The Amazon Resource Name (ARN) of the job queue.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createSchedulingPolicy(params = {}, callback) ⇒ AWS.Request

Creates an Batch scheduling policy.

Service Reference:

Examples:

Calling the createSchedulingPolicy operation

var params = {
  name: 'STRING_VALUE', /* required */
  fairsharePolicy: {
    computeReservation: 'NUMBER_VALUE',
    shareDecaySeconds: 'NUMBER_VALUE',
    shareDistribution: [
      {
        shareIdentifier: 'STRING_VALUE', /* required */
        weightFactor: 'NUMBER_VALUE'
      },
      /* more items */
    ]
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
batch.createSchedulingPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • name — (String)

      The name of the scheduling policy. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

    • fairsharePolicy — (map)

      The fair share policy of the scheduling policy.

      • shareDecaySeconds — (Integer)

        The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds. A value of zero (0) indicates that only current usage should be measured; if there are four evenly weighted fair share identifiers then each can only use up to 25% of the available CPU resources, even if some of the fair share identifiers have no currently running jobs. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).

      • computeReservation — (Integer)

        A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.

        The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.

        For example, a computeReservation value of 50 indicates that Batch should reserve 50% of the maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there is only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.

        The minimum value is 0 and the maximum value is 99.

      • shareDistribution — (Array<map>)

        Array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that are not included have a default weight of 1.0.

        • shareIdentifier — required — (String)

          A fair share identifier or fair share identifier prefix. If the string ends with '' then this entry specifies the weight factor to use for fair share identifiers that begin with that prefix. The list of fair share identifiers in a fair share policy cannot overlap. For example you cannot have one that specifies a shareIdentifier of UserA* and another that specifies a shareIdentifier of UserA-1.

          There can be no more than 500 fair share identifiers active in a job queue.

          The string is limited to 255 alphanumeric characters, optionally followed by ''.

        • weightFactor — (Float)

          The weight factor for the fair share identifier. The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs using a share identifier with a weight factor of 0.125 (1/8) will get 8 times the compute resources of jobs using a share identifier with a weight factor of 1.

          The smallest supported value is 0.0001 and the largest supported value is 999.9999.

    • tags — (map<String>)

      The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

      These tags can be updated or removed using the TagResource and UntagResource API operations.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • name — (String)

        The name of the scheduling policy.

      • arn — (String)

        The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteComputeEnvironment(params = {}, callback) ⇒ AWS.Request

Deletes an Batch compute environment.

Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. Compute environments that use Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment enters an invalid state.

Service Reference:

Examples:

To delete a compute environment


/* This example deletes the P2OnDemand compute environment. */

 var params = {
  computeEnvironment: "P2OnDemand"
 };
 batch.deleteComputeEnvironment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteComputeEnvironment operation

var params = {
  computeEnvironment: 'STRING_VALUE' /* required */
};
batch.deleteComputeEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • computeEnvironment — (String)

      The name or Amazon Resource Name (ARN) of the compute environment to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteJobQueue(params = {}, callback) ⇒ AWS.Request

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each second.

It's not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.

Service Reference:

Examples:

To delete a job queue


/* This example deletes the GPGPU job queue. */

 var params = {
  jobQueue: "GPGPU"
 };
 batch.deleteJobQueue(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteJobQueue operation

var params = {
  jobQueue: 'STRING_VALUE' /* required */
};
batch.deleteJobQueue(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • jobQueue — (String)

      The short name or full Amazon Resource Name (ARN) of the queue to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSchedulingPolicy(params = {}, callback) ⇒ AWS.Request

Deletes the specified scheduling policy.

You can't delete a scheduling policy that is used in any job queues.

Service Reference:

Examples:

Calling the deleteSchedulingPolicy operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
batch.deleteSchedulingPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • arn — (String)

      The Amazon Resource Name (ARN) of the scheduling policy to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deregisterJobDefinition(params = {}, callback) ⇒ AWS.Request

Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.

Service Reference:

Examples:

To deregister a job definition


/* This example deregisters a job definition called sleep10. */

 var params = {
  jobDefinition: "sleep10"
 };
 batch.deregisterJobDefinition(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deregisterJobDefinition operation

var params = {
  jobDefinition: 'STRING_VALUE' /* required */
};
batch.deregisterJobDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • jobDefinition — (String)

      The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeComputeEnvironments(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To describe a compute environment


/* This example describes the P2OnDemand compute environment. */

 var params = {
  computeEnvironments: [
     "P2OnDemand"
  ]
 };
 batch.describeComputeEnvironments(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    computeEnvironments: [
       {
      type: "MANAGED", 
      computeEnvironmentArn: "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand", 
      computeEnvironmentName: "P2OnDemand", 
      computeResources: {
       type: "EC2", 
       desiredvCpus: 48, 
       ec2KeyPair: "id_rsa", 
       instanceRole: "ecsInstanceRole", 
       instanceTypes: [
          "p2"
       ], 
       maxvCpus: 128, 
       minvCpus: 0, 
       securityGroupIds: [
          "sg-cf5093b2"
       ], 
       subnets: [
          "subnet-220c0e0a", 
          "subnet-1a95556d", 
          "subnet-978f6dce"
       ], 
       tags: {
        "Name": "Batch Instance - P2OnDemand"
       }
      }, 
      ecsClusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/P2OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc", 
      serviceRole: "arn:aws:iam::012345678910:role/AWSBatchServiceRole", 
      state: "ENABLED", 
      status: "VALID", 
      statusReason: "ComputeEnvironment Healthy"
     }
    ]
   }
   */
 });

Calling the describeComputeEnvironments operation

var params = {
  computeEnvironments: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
batch.describeComputeEnvironments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • computeEnvironments — (Array<String>)

      A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

    • maxResults — (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.

    • nextToken — (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.

      Note: This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • computeEnvironments — (Array<map>)

        The list of compute environments.

        • computeEnvironmentName — required — (String)

          The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

        • computeEnvironmentArn — required — (String)

          The Amazon Resource Name (ARN) of the compute environment.

        • unmanagedvCpus — (Integer)

          The maximum number of VCPUs expected to be used for an unmanaged compute environment.

        • ecsClusterArn — required — (String)

          The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

        • tags — (map<String>)

          The tags applied to the compute environment.

        • type — (String)

          The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the Batch User Guide.

          Possible values include:
          • "MANAGED"
          • "UNMANAGED"
        • state — (String)

          The state of the compute environment. The valid values are ENABLED or DISABLED.

          If the state is ENABLED, then the 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 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 don't scale out. However, they scale in to minvCpus value after instances become idle.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • status — (String)

          The current status of the compute environment (for example, CREATING or VALID).

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "DELETED"
          • "VALID"
          • "INVALID"
        • statusReason — (String)

          A short, human-readable string to provide additional details about the current status of the compute environment.

        • computeResources — (map)

          The compute resources defined for the compute environment. For more information, see Compute Environments in the Batch User Guide.

          • type — required — (String)

            The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute Environments in the Batch User Guide.

            If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet role in the Batch User Guide.

            Possible values include:
            • "EC2"
            • "SPOT"
            • "FARGATE"
            • "FARGATE_SPOT"
          • 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 Batch User Guide.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
            BEST_FIT (default)

            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, Batch waits for the additional instances to be available. If there aren't enough instances available, or if the user is reaching Amazon EC2 service limits then additional jobs aren't run until the 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

            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, Batch will select new instance types.

            SPOT_CAPACITY_OPTIMIZED

            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, Batch might need to go above maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

            Possible values include:
            • "BEST_FIT"
            • "BEST_FIT_PROGRESSIVE"
            • "SPOT_CAPACITY_OPTIMIZED"
          • minvCpus — (Integer)

            The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).

            Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
          • maxvCpus — required — (Integer)

            The maximum number of Amazon EC2 vCPUs that a compute environment can reach.

            Note: With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. For example, no more than a single instance from among those specified in your compute environment is allocated.
          • desiredvCpus — (Integer)

            The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values, based on job queue demand.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
          • instanceTypes — (Array<String>)

            The instances types that can 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 C4, M4, and R4 instance families) that match the demand of your job queues.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
            Note: When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.
            Note: Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are used.
          • 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.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
            Note: The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
          • subnets — required — (Array<String>)

            The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User Guide.

          • securityGroupIds — (Array<String>)

            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 that are running on Fargate resources and must contain at least one security group. Fargate doesn't support launch templates. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds are used.

          • ec2KeyPair — (String)

            The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
          • 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 Batch User Guide.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
          • tags — (map<String>)

            Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value−for example, { "Name": "Batch Instance - C4OnDemand" }. This is helpful for recognizing your Batch instances in the Amazon EC2 console. These tags can't be updated or removed after the compute environment is created. Any changes to these tags require that you create a new compute environment and remove the old compute environment. These tags aren't seen when using the Batch ListTagsForResource API operation.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
          • 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.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
          • 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 less than 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.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
          • 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 Batch User Guide.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.

            To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot Instances not tagged on creation in the Batch User Guide.

          • launchTemplate — (map)

            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 Batch User Guide.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
            • 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.

              After the compute environment is created, the launch template version that's used isn't changed, even if the $Default or $Latest version for the launch template is updated. To use a new launch template version, create a new compute environment, add the new compute environment to the existing job queue, remove the old compute environment from the job queue, and delete the old compute environment.

              Default: $Default.

          • ec2Configuration — (Array<map>)

            Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2.

            One or two values can be provided.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
            • imageType — required — (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 Amazon Linux 2 AMI (ECS_AL2) is used.

              ECS_AL2

              Amazon Linux 2− Default for all non-GPU instance families.

              ECS_AL2_NVIDIA

              Amazon Linux 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

              ECS_AL1

              Amazon Linux. Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.

            • 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 Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

      • nextToken — (String)

        The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeComputeEnvironments 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeJobDefinitions(params = {}, callback) ⇒ AWS.Request

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

Service Reference:

Examples:

To describe active job definitions


/* This example describes all of your active job definitions. */

 var params = {
  status: "ACTIVE"
 };
 batch.describeJobDefinitions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    jobDefinitions: [
       {
      type: "container", 
      containerProperties: {
       command: [
          "sleep", 
          "60"
       ], 
       environment: [
       ], 
       image: "busybox", 
       mountPoints: [
       ], 
       resourceRequirements: [
          {
         type: "MEMORY", 
         value: "128"
        }, 
          {
         type: "VCPU", 
         value: "1"
        }
       ], 
       ulimits: [
       ], 
       volumes: [
       ]
      }, 
      jobDefinitionArn: "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1", 
      jobDefinitionName: "sleep60", 
      revision: 1, 
      status: "ACTIVE"
     }
    ]
   }
   */
 });

Calling the describeJobDefinitions operation

var params = {
  jobDefinitionName: 'STRING_VALUE',
  jobDefinitions: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  status: 'STRING_VALUE'
};
batch.describeJobDefinitions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • jobDefinitions — (Array<String>)

      A list of up to 100 job definitions. Each entry in the list can either be an ARN of the form arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}.

    • maxResults — (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 and 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.

    • jobDefinitionName — (String)

      The name of the job definition to describe.

    • status — (String)

      The status used to filter job definitions.

    • nextToken — (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.

      Note: This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobDefinitions — (Array<map>)

        The list of job definitions.

        • jobDefinitionName — required — (String)

          The name of the job definition.

        • jobDefinitionArn — required — (String)

          The Amazon Resource Name (ARN) for the job definition.

        • revision — required — (Integer)

          The revision of the job definition.

        • status — (String)

          The status of the job definition.

        • type — required — (String)

          The type of job definition, either container or multinode. 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 Batch User Guide.

        • schedulingPriority — (Integer)

          The scheduling priority of the job definition. This will only affect jobs in job queues with a fair share policy. Jobs with a higher scheduling priority will be scheduled before jobs with a lower scheduling priority.

        • parameters — (map<String>)

          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 Batch User Guide.

        • retryStrategy — (map)

          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 can 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 — (Array<map>)

            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.

            • onStatusReason — (String)

              Contains a glob pattern to match against the StatusReason returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

              The string can be between 1 and 512 characters in length.

            • onReason — (String)

              Contains a glob pattern to match against the Reason returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

              The string can be between 1 and 512 characters in length.

            • onExitCode — (String)

              Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The pattern can be up to 512 characters in length. It 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.

              The string can be between 1 and 512 characters in length.

            • action — required — (String)

              Specifies the action to take if all of the specified conditions (onStatusReason, onReason, and onExitCode) are met. The values aren't case sensitive.

              Possible values include:
              • "RETRY"
              • "EXIT"
        • containerProperties — (map)

          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.

            Note: Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

            • 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, use resourceRequirements to specify the vCPU requirements for the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the number of vCPUs reserved for the job.

            Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.

          • memory — (Integer)

            This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.

          • command — (Array<String>)

            The command that's 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.

          • jobRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services 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 Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.

          • volumes — (Array<map>)

            A list of data volumes used in a job.

            • host — (map)

              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.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
              • sourcePath — (String)

                The path on the host container instance that's 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 doesn't 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.

                Note: This parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided.
            • 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.

            • efsVolumeConfiguration — (map)

              This parameter is specified when you are using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

              • fileSystemId — required — (String)

                The Amazon EFS file system ID to use.

              • rootDirectory — (String)

                The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

                If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

              • transitEncryption — (String)

                Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

                Possible values include:
                • "ENABLED"
                • "DISABLED"
              • transitEncryptionPort — (Integer)

                The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.

              • authorizationConfig — (map)

                The authorization configuration details for the Amazon EFS file system.

                • accessPointId — (String)

                  The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS Access Points in the Amazon Elastic File System User Guide.

                • iam — (String)

                  Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

                  Possible values include:
                  • "ENABLED"
                  • "DISABLED"
          • environment — (Array<map>)

            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.

            We don't recommend using plaintext environment variables for sensitive information, such as credential data.
            Note: Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.
            • 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 — (Array<map>)

            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.

            • 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.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.
          • ulimits — (Array<map>)

            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.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
            • hardLimit — required — (Integer)

              The hard limit for the ulimit type.

            • name — required — (String)

              The type of the ulimit.

            • softLimit — required — (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.

            Note: This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
          • resourceRequirements — (Array<map>)

            The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

            • value — required — (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.

              Note: GPUs are not available for jobs that are running on Fargate resources.
              type="MEMORY"

              The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. 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.

              Note: If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the Batch User Guide.

              For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

              value = 512

              VCPU = 0.25

              value = 1024

              VCPU = 0.25 or 0.5

              value = 2048

              VCPU = 0.25, 0.5, or 1

              value = 3072

              VCPU = 0.5, or 1

              value = 4096

              VCPU = 0.5, 1, or 2

              value = 5120, 6144, or 7168

              VCPU = 1 or 2

              value = 8192

              VCPU = 1, 2, or 4

              value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

              VCPU = 2 or 4

              value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

              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. For EC2 resources, 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 that are 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 = 512, 1024, or 2048

              value = 0.5

              MEMORY = 1024, 2048, 3072, or 4096

              value = 1

              MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

              value = 2

              MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

              value = 4

              MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

            • type — required — (String)

              The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

              Possible values include:
              • "GPU"
              • "VCPU"
              • "MEMORY"
          • linuxParameters — (map)

            Linux-specific modifications that are applied to the container, such as details for device mappings.

            • devices — (Array<map>)

              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.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
              • hostPath — required — (String)

                The path for the device on the host container instance.

              • containerPath — (String)

                The path inside the container that's used to expose the host device. By default, the hostPath value is used.

              • permissions — (Array<String>)

                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.

            • 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.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
            • tmpfs — (Array<map>)

              The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
              • containerPath — required — (String)

                The absolute file path in the container where the tmpfs volume is mounted.

              • size — required — (Integer)

                The size (in MiB) of the tmpfs volume.

              • mountOptions — (Array<String>)

                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"

            • 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.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
            • 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. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

              Consider the following when you use a per-container swap configuration.

              • Swap space must be enabled and allocated on the container instance for the containers to use.

                Note: The Amazon ECS optimized AMIs don't have swap enabled by default. You must enable swap on the instance to use this feature. For more information, see Instance Store Swap Volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?

              • The swap space parameters are only supported for job definitions using EC2 resources.

              • If the maxSwap and swappiness parameters are omitted from a job definition, each container will have a default swappiness value of 60, and the total swap usage will be limited to two times the memory reservation of the container.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
          • logConfiguration — (map)

            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.

            Note: Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

            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"

            Note: The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
            • logDriver — required — (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.

              Note: Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.
              awslogs

              Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the 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.

              Note: If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

              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"

              Possible values include:
              • "json-file"
              • "syslog"
              • "journald"
              • "gelf"
              • "fluentd"
              • "awslogs"
              • "splunk"
            • options — (map<String>)

              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"

            • secretOptions — (Array<map>)

              The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Batch User Guide.

              • name — required — (String)

                The name of the secret.

              • valueFrom — required — (String)

                The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

                Note: If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
          • secrets — (Array<map>)

            The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.

            • name — required — (String)

              The name of the secret.

            • valueFrom — required — (String)

              The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

              Note: If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
          • networkConfiguration — (map)

            The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

            • assignPublicIp — (String)

              Indicates whether the job should have a public IP address. For a job that is running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, 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".

              Possible values include:
              • "ENABLED"
              • "DISABLED"
          • fargatePlatformConfiguration — (map)

            The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

            • platformVersion — (String)

              The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

        • timeout — (map)

          The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which 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 Batch terminates your jobs if they have not finished. The minimum value for the timeout is 60 seconds.

        • nodeProperties — (map)

          An object with various properties specific to multi-node parallel jobs.

          Note: If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
          • numNodes — required — (Integer)

            The number of nodes associated with a multi-node parallel job.

          • mainNode — required — (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 — required — (Array<map>)

            A list of node ranges and their properties associated with a multi-node parallel job.

            • targetNodes — required — (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 can nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties.

            • container — (map)

              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.

                Note: Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

                • 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, use resourceRequirements to specify the vCPU requirements for the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the number of vCPUs reserved for the job.

                Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.

              • memory — (Integer)

                This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.

              • command — (Array<String>)

                The command that's 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.

              • jobRoleArn — (String)

                The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services 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 Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.

              • volumes — (Array<map>)

                A list of data volumes used in a job.

                • host — (map)

                  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.

                  Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
                  • sourcePath — (String)

                    The path on the host container instance that's 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 doesn't 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.

                    Note: This parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided.
                • 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.

                • efsVolumeConfiguration — (map)

                  This parameter is specified when you are using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

                  • fileSystemId — required — (String)

                    The Amazon EFS file system ID to use.

                  • rootDirectory — (String)

                    The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

                    If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

                  • transitEncryption — (String)

                    Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

                    Possible values include:
                    • "ENABLED"
                    • "DISABLED"
                  • transitEncryptionPort — (Integer)

                    The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.

                  • authorizationConfig — (map)

                    The authorization configuration details for the Amazon EFS file system.

                    • accessPointId — (String)

                      The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS Access Points in the Amazon Elastic File System User Guide.

                    • iam — (String)

                      Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

                      Possible values include:
                      • "ENABLED"
                      • "DISABLED"
              • environment — (Array<map>)

                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.

                We don't recommend using plaintext environment variables for sensitive information, such as credential data.
                Note: Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.
                • 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 — (Array<map>)

                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.

                • 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.

                Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.
              • ulimits — (Array<map>)

                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.

                Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
                • hardLimit — required — (Integer)

                  The hard limit for the ulimit type.

                • name — required — (String)

                  The type of the ulimit.

                • softLimit — required — (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.

                Note: This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
              • resourceRequirements — (Array<map>)

                The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

                • value — required — (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.

                  Note: GPUs are not available for jobs that are running on Fargate resources.
                  type="MEMORY"

                  The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. 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.

                  Note: If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the Batch User Guide.

                  For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

                  value = 512

                  VCPU = 0.25

                  value = 1024

                  VCPU = 0.25 or 0.5

                  value = 2048

                  VCPU = 0.25, 0.5, or 1

                  value = 3072

                  VCPU = 0.5, or 1

                  value = 4096

                  VCPU = 0.5, 1, or 2

                  value = 5120, 6144, or 7168

                  VCPU = 1 or 2

                  value = 8192

                  VCPU = 1, 2, or 4

                  value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

                  VCPU = 2 or 4

                  value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

                  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. For EC2 resources, 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 that are 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 = 512, 1024, or 2048

                  value = 0.5

                  MEMORY = 1024, 2048, 3072, or 4096

                  value = 1

                  MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

                  value = 2

                  MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

                  value = 4

                  MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

                • type — required — (String)

                  The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

                  Possible values include:
                  • "GPU"
                  • "VCPU"
                  • "MEMORY"
              • linuxParameters — (map)

                Linux-specific modifications that are applied to the container, such as details for device mappings.

                • devices — (Array<map>)

                  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.

                  Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
                  • hostPath — required — (String)

                    The path for the device on the host container instance.

                  • containerPath — (String)

                    The path inside the container that's used to expose the host device. By default, the hostPath value is used.

                  • permissions — (Array<String>)

                    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.

                • 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.

                  Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
                • tmpfs — (Array<map>)

                  The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

                  Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
                  • containerPath — required — (String)

                    The absolute file path in the container where the tmpfs volume is mounted.

                  • size — required — (Integer)

                    The size (in MiB) of the tmpfs volume.

                  • mountOptions — (Array<String>)

                    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"

                • 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.

                  Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
                • 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. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

                  Consider the following when you use a per-container swap configuration.

                  • Swap space must be enabled and allocated on the container instance for the containers to use.

                    Note: The Amazon ECS optimized AMIs don't have swap enabled by default. You must enable swap on the instance to use this feature. For more information, see Instance Store Swap Volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?

                  • The swap space parameters are only supported for job definitions using EC2 resources.

                  • If the maxSwap and swappiness parameters are omitted from a job definition, each container will have a default swappiness value of 60, and the total swap usage will be limited to two times the memory reservation of the container.

                  Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
              • logConfiguration — (map)

                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.

                Note: Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

                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"

                Note: The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
                • logDriver — required — (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.

                  Note: Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.
                  awslogs

                  Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the 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.

                  Note: If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

                  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"

                  Possible values include:
                  • "json-file"
                  • "syslog"
                  • "journald"
                  • "gelf"
                  • "fluentd"
                  • "awslogs"
                  • "splunk"
                • options — (map<String>)

                  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"

                • secretOptions — (Array<map>)

                  The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Batch User Guide.

                  • name — required — (String)

                    The name of the secret.

                  • valueFrom — required — (String)

                    The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

                    Note: If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
              • secrets — (Array<map>)

                The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.

                • name — required — (String)

                  The name of the secret.

                • valueFrom — required — (String)

                  The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

                  Note: If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
              • networkConfiguration — (map)

                The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

                • assignPublicIp — (String)

                  Indicates whether the job should have a public IP address. For a job that is running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, 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".

                  Possible values include:
                  • "ENABLED"
                  • "DISABLED"
              • fargatePlatformConfiguration — (map)

                The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

                • platformVersion — (String)

                  The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

        • tags — (map<String>)

          The tags applied to the job definition.

        • 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 — (Array<String>)

          The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeJobQueues(params = {}, callback) ⇒ AWS.Request

Describes one or more of your job queues.

Service Reference:

Examples:

To describe a job queue


/* This example describes the HighPriority job queue. */

 var params = {
  jobQueues: [
     "HighPriority"
  ]
 };
 batch.describeJobQueues(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    jobQueues: [
       {
      computeEnvironmentOrder: [
         {
        computeEnvironment: "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand", 
        order: 1
       }
      ], 
      jobQueueArn: "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", 
      jobQueueName: "HighPriority", 
      priority: 1, 
      state: "ENABLED", 
      status: "VALID", 
      statusReason: "JobQueue Healthy"
     }
    ]
   }
   */
 });

Calling the describeJobQueues operation

var params = {
  jobQueues: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
batch.describeJobQueues(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • jobQueues — (Array<String>)

      A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

    • maxResults — (Integer)

      The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

    • nextToken — (String)

      The nextToken value returned from a previous paginated DescribeJobQueues 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.

      Note: This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobQueues — (Array<map>)

        The list of job queues.

        • jobQueueName — required — (String)

          The name of the job queue.

        • jobQueueArn — required — (String)

          The Amazon Resource Name (ARN) of the job queue.

        • state — required — (String)

          Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it's able to accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • schedulingPolicyArn — (String)

          Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

        • status — (String)

          The status of the job queue (for example, CREATING or VALID).

          Possible values include:
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "DELETED"
          • "VALID"
          • "INVALID"
        • statusReason — (String)

          A short, human-readable string to provide additional details about the current status of the job queue.

        • priority — required — (Integer)

          The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

        • computeEnvironmentOrder — required — (Array<map>)

          The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.

          • order — required — (Integer)

            The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

          • computeEnvironment — required — (String)

            The Amazon Resource Name (ARN) of the compute environment.

        • tags — (map<String>)

          The tags applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

      • nextToken — (String)

        The nextToken value to include in a future DescribeJobQueues request. When the results of a DescribeJobQueues 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeJobs(params = {}, callback) ⇒ AWS.Request

Describes a list of Batch jobs.

Service Reference:

Examples:

To describe a specific job


/* This example describes a job with the specified job ID. */

 var params = {
  jobs: [
     "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9"
  ]
 };
 batch.describeJobs(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    jobs: [
       {
      container: {
       command: [
          "sleep", 
          "60"
       ], 
       containerInstanceArn: "arn:aws:ecs:us-east-1:012345678910:container-instance/5406d7cd-58bd-4b8f-9936-48d7c6b1526c", 
       environment: [
       ], 
       exitCode: 0, 
       image: "busybox", 
       memory: 128, 
       mountPoints: [
       ], 
       ulimits: [
       ], 
       vcpus: 1, 
       volumes: [
       ]
      }, 
      createdAt: 1480460782010, 
      dependsOn: [
      ], 
      jobDefinition: "sleep60", 
      jobId: "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9", 
      jobName: "example", 
      jobQueue: "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", 
      parameters: {
      }, 
      startedAt: 1480460816500, 
      status: "SUCCEEDED", 
      stoppedAt: 1480460880699
     }
    ]
   }
   */
 });

Calling the describeJobs operation

var params = {
  jobs: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
batch.describeJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • jobs — (Array<String>)

      A list of up to 100 job IDs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobs — (Array<map>)

        The list of jobs.

        • jobArn — (String)

          The Amazon Resource Name (ARN) of the job.

        • jobName — required — (String)

          The name of the job.

        • jobId — required — (String)

          The ID for the job.

        • jobQueue — required — (String)

          The Amazon Resource Name (ARN) of the job queue that the job is associated with.

        • status — required — (String)

          The current status for the job.

          Note: If your jobs don't progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the Batch User Guide.
          Possible values include:
          • "SUBMITTED"
          • "PENDING"
          • "RUNNABLE"
          • "STARTING"
          • "RUNNING"
          • "SUCCEEDED"
          • "FAILED"
        • shareIdentifier — (String)

          The share identifier for the job.

        • schedulingPriority — (Integer)

          The scheduling policy of the job definition. This will only affect jobs in job queues with a fair share policy. Jobs with a higher scheduling priority will be scheduled before jobs with a lower scheduling priority.

        • attempts — (Array<map>)

          A list of job attempts associated with this job.

          • container — (map)

            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's 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 Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

            • networkInterfaces — (Array<map>)

              The network interfaces associated with the job attempt.

              • 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 — (map)

          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 can 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 — (Array<map>)

            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.

            • onStatusReason — (String)

              Contains a glob pattern to match against the StatusReason returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

              The string can be between 1 and 512 characters in length.

            • onReason — (String)

              Contains a glob pattern to match against the Reason returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

              The string can be between 1 and 512 characters in length.

            • onExitCode — (String)

              Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The pattern can be up to 512 characters in length. It 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.

              The string can be between 1 and 512 characters in length.

            • action — required — (String)

              Specifies the action to take if all of the specified conditions (onStatusReason, onReason, and onExitCode) are met. The values aren't case sensitive.

              Possible values include:
              • "RETRY"
              • "EXIT"
        • startedAt — required — (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 — (Array<map>)

          A list of job IDs that this job depends on.

          • jobId — (String)

            The job ID of the Batch job associated with this dependency.

          • type — (String)

            The type of the job dependency.

            Possible values include:
            • "N_TO_N"
            • "SEQUENTIAL"
        • jobDefinition — required — (String)

          The job definition that's used by this job.

        • parameters — (map<String>)

          Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

        • container — (map)

          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. For jobs that run on EC2 resources, you can specify the vCPU requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in both the vcpus and resourceRequirements 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.

            Note: This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.
          • memory — (Integer)

            For jobs run on EC2 resources that didn't specify memory requirements using resourceRequirements, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.

          • command — (Array<String>)

            The command that's passed to the container.

          • 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 Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.

          • volumes — (Array<map>)

            A list of volumes associated with the job.

            • host — (map)

              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.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
              • sourcePath — (String)

                The path on the host container instance that's 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 doesn't 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.

                Note: This parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided.
            • 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.

            • efsVolumeConfiguration — (map)

              This parameter is specified when you are using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

              • fileSystemId — required — (String)

                The Amazon EFS file system ID to use.

              • rootDirectory — (String)

                The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

                If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

              • transitEncryption — (String)

                Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

                Possible values include:
                • "ENABLED"
                • "DISABLED"
              • transitEncryptionPort — (Integer)

                The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.

              • authorizationConfig — (map)

                The authorization configuration details for the Amazon EFS file system.

                • accessPointId — (String)

                  The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS Access Points in the Amazon Elastic File System User Guide.

                • iam — (String)

                  Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

                  Possible values include:
                  • "ENABLED"
                  • "DISABLED"
          • environment — (Array<map>)

            The environment variables to pass to a container.

            Note: Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.
            • 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 — (Array<map>)

            The mount points for data volumes in your container.

            • 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 — (Array<map>)

            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.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources.
            • hardLimit — required — (Integer)

              The hard limit for the ulimit type.

            • name — required — (String)

              The type of the ulimit.

            • softLimit — required — (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.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as 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's 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 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.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources.
          • networkInterfaces — (Array<map>)

            The network interfaces associated with the job.

            • 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 — (Array<map>)

            The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

            • value — required — (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.

              Note: GPUs are not available for jobs that are running on Fargate resources.
              type="MEMORY"

              The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. 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.

              Note: If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the Batch User Guide.

              For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

              value = 512

              VCPU = 0.25

              value = 1024

              VCPU = 0.25 or 0.5

              value = 2048

              VCPU = 0.25, 0.5, or 1

              value = 3072

              VCPU = 0.5, or 1

              value = 4096

              VCPU = 0.5, 1, or 2

              value = 5120, 6144, or 7168

              VCPU = 1 or 2

              value = 8192

              VCPU = 1, 2, or 4

              value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

              VCPU = 2 or 4

              value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

              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. For EC2 resources, 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 that are 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 = 512, 1024, or 2048

              value = 0.5

              MEMORY = 1024, 2048, 3072, or 4096

              value = 1

              MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

              value = 2

              MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

              value = 4

              MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

            • type — required — (String)

              The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

              Possible values include:
              • "GPU"
              • "VCPU"
              • "MEMORY"
          • linuxParameters — (map)

            Linux-specific modifications that are applied to the container, such as details for device mappings.

            • devices — (Array<map>)

              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.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
              • hostPath — required — (String)

                The path for the device on the host container instance.

              • containerPath — (String)

                The path inside the container that's used to expose the host device. By default, the hostPath value is used.

              • permissions — (Array<String>)

                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.

            • 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.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
            • tmpfs — (Array<map>)

              The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
              • containerPath — required — (String)

                The absolute file path in the container where the tmpfs volume is mounted.

              • size — required — (Integer)

                The size (in MiB) of the tmpfs volume.

              • mountOptions — (Array<String>)

                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"

            • 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.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
            • 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. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

              Consider the following when you use a per-container swap configuration.

              • Swap space must be enabled and allocated on the container instance for the containers to use.

                Note: The Amazon ECS optimized AMIs don't have swap enabled by default. You must enable swap on the instance to use this feature. For more information, see Instance Store Swap Volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?

              • The swap space parameters are only supported for job definitions using EC2 resources.

              • If the maxSwap and swappiness parameters are omitted from a job definition, each container will have a default swappiness value of 60, and the total swap usage will be limited to two times the memory reservation of the container.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
          • logConfiguration — (map)

            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.

            Note: Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS container agent.

            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"

            Note: The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
            • logDriver — required — (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.

              Note: Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.
              awslogs

              Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the 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.

              Note: If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

              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"

              Possible values include:
              • "json-file"
              • "syslog"
              • "journald"
              • "gelf"
              • "fluentd"
              • "awslogs"
              • "splunk"
            • options — (map<String>)

              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"

            • secretOptions — (Array<map>)

              The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Batch User Guide.

              • name — required — (String)

                The name of the secret.

              • valueFrom — required — (String)

                The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

                Note: If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
          • secrets — (Array<map>)

            The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.

            • name — required — (String)

              The name of the secret.

            • valueFrom — required — (String)

              The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

              Note: If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
          • networkConfiguration — (map)

            The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

            • assignPublicIp — (String)

              Indicates whether the job should have a public IP address. For a job that is running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, 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".

              Possible values include:
              • "ENABLED"
              • "DISABLED"
          • fargatePlatformConfiguration — (map)

            The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

            • platformVersion — (String)

              The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

        • nodeDetails — (map)

          An object representing the details of a node that's 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 — (map)

          An object representing the node properties of a multi-node parallel job.

          Note: This isn't applicable to jobs that are running on Fargate resources.
          • numNodes — required — (Integer)

            The number of nodes associated with a multi-node parallel job.

          • mainNode — required — (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 — required — (Array<map>)

            A list of node ranges and their properties associated with a multi-node parallel job.

            • targetNodes — required — (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 can nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties.

            • container — (map)

              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.

                Note: Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

                • 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, use resourceRequirements to specify the vCPU requirements for the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the number of vCPUs reserved for the job.

                Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.

              • memory — (Integer)

                This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.

              • command — (Array<String>)

                The command that's 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.

              • jobRoleArn — (String)

                The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services 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 Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.

              • volumes — (Array<map>)

                A list of data volumes used in a job.

                • host — (map)

                  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.

                  Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
                  • sourcePath — (String)

                    The path on the host container instance that's 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 doesn't 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.

                    Note: This parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided.
                • 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.

                • efsVolumeConfiguration — (map)

                  This parameter is specified when you are using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

                  • fileSystemId — required — (String)

                    The Amazon EFS file system ID to use.

                  • rootDirectory — (String)

                    The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

                    If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

                  • transitEncryption — (String)

                    Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

                    Possible values include:
                    • "ENABLED"
                    • "DISABLED"
                  • transitEncryptionPort — (Integer)

                    The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.

                  • authorizationConfig — (map)

                    The authorization configuration details for the Amazon EFS file system.

                    • accessPointId — (String)

                      The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS Access Points in the Amazon Elastic File System User Guide.

                    • iam — (String)

                      Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

                      Possible values include:
                      • "ENABLED"
                      • "DISABLED"
              • environment — (Array<map>)

                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.

                We don't recommend using plaintext environment variables for sensitive information, such as credential data.
                Note: Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.
                • 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 — (Array<map>)

                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.

                • 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.

                Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.
              • ulimits — (Array<map>)

                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.

                Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
                • hardLimit — required — (Integer)

                  The hard limit for the ulimit type.

                • name — required — (String)

                  The type of the ulimit.

                • softLimit — required — (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.

                Note: This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
              • resourceRequirements — (Array<map>)

                The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

                • value — required — (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.

                  Note: GPUs are not available for jobs that are running on Fargate resources.
                  type="MEMORY"

                  The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. 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.

                  Note: If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the Batch User Guide.

                  For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

                  value = 512

                  VCPU = 0.25

                  value = 1024

                  VCPU = 0.25 or 0.5

                  value = 2048

                  VCPU = 0.25, 0.5, or 1

                  value = 3072

                  VCPU = 0.5, or 1

                  value = 4096

                  VCPU = 0.5, 1, or 2

                  value = 5120, 6144, or 7168

                  VCPU = 1 or 2

                  value = 8192

                  VCPU = 1, 2, or 4

                  value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

                  VCPU = 2 or 4

                  value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

                  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. For EC2 resources, 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 that are 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 = 512, 1024, or 2048

                  value = 0.5

                  MEMORY = 1024, 2048, 3072, or 4096

                  value = 1

                  MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

                  value = 2

                  MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

                  value = 4

                  MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

                • type — required — (String)

                  The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

                  Possible values include:
                  • "GPU"
                  • "VCPU"
                  • "MEMORY"
              • linuxParameters — (map)

                Linux-specific modifications that are applied to the container, such as details for device mappings.

                • devices — (Array<map>)

                  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.

                  Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
                  • hostPath — required — (String)

                    The path for the device on the host container instance.

                  • containerPath — (String)

                    The path inside the container that's used to expose the host device. By default, the hostPath value is used.

                  • permissions — (Array<String>)

                    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.

                • 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.

                  Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
                • tmpfs — (Array<map>)

                  The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

                  Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
                  • containerPath — required — (String)

                    The absolute file path in the container where the tmpfs volume is mounted.

                  • size — required — (Integer)

                    The size (in MiB) of the tmpfs volume.

                  • mountOptions — (Array<String>)

                    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"

                • 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.

                  Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
                • 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. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

                  Consider the following when you use a per-container swap configuration.

                  • Swap space must be enabled and allocated on the container instance for the containers to use.

                    Note: The Amazon ECS optimized AMIs don't have swap enabled by default. You must enable swap on the instance to use this feature. For more information, see Instance Store Swap Volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?

                  • The swap space parameters are only supported for job definitions using EC2 resources.

                  • If the maxSwap and swappiness parameters are omitted from a job definition, each container will have a default swappiness value of 60, and the total swap usage will be limited to two times the memory reservation of the container.

                  Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
              • logConfiguration — (map)

                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.

                Note: Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

                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"

                Note: The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
                • logDriver — required — (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.

                  Note: Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.
                  awslogs

                  Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the 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.

                  Note: If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

                  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"

                  Possible values include:
                  • "json-file"
                  • "syslog"
                  • "journald"
                  • "gelf"
                  • "fluentd"
                  • "awslogs"
                  • "splunk"
                • options — (map<String>)

                  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"

                • secretOptions — (Array<map>)

                  The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Batch User Guide.

                  • name — required — (String)

                    The name of the secret.

                  • valueFrom — required — (String)

                    The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

                    Note: If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
              • secrets — (Array<map>)

                The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.

                • name — required — (String)

                  The name of the secret.

                • valueFrom — required — (String)

                  The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

                  Note: If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
              • networkConfiguration — (map)

                The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

                • assignPublicIp — (String)

                  Indicates whether the job should have a public IP address. For a job that is running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, 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".

                  Possible values include:
                  • "ENABLED"
                  • "DISABLED"
              • fargatePlatformConfiguration — (map)

                The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

                • platformVersion — (String)

                  The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

        • arrayProperties — (map)

          The array properties of the job, if it is an array job.

          • statusSummary — (map<Integer>)

            A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.

          • 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's associated with this job. This parameter is returned for array job children.

        • timeout — (map)

          The timeout configuration for the job.

          • attemptDurationSeconds — (Integer)

            The time duration in seconds (measured from the job attempt's startedAt timestamp) after which Batch terminates your jobs if they have not finished. The minimum value for the timeout is 60 seconds.

        • tags — (map<String>)

          The tags applied to the job.

        • 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 — (Array<String>)

          The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSchedulingPolicies(params = {}, callback) ⇒ AWS.Request

Describes one or more of your scheduling policies.

Service Reference:

Examples:

Calling the describeSchedulingPolicies operation

var params = {
  arns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
batch.describeSchedulingPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • arns — (Array<String>)

      A list of up to 100 scheduling policy Amazon Resource Name (ARN) entries.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • schedulingPolicies — (Array<map>)

        The list of scheduling policies.

        • name — required — (String)

          The name of the scheduling policy.

        • arn — required — (String)

          Amazon Resource Name (ARN) of the scheduling policy. An example would be arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority

        • fairsharePolicy — (map)

          The fair share policy for the scheduling policy.

          • shareDecaySeconds — (Integer)

            The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds. A value of zero (0) indicates that only current usage should be measured; if there are four evenly weighted fair share identifiers then each can only use up to 25% of the available CPU resources, even if some of the fair share identifiers have no currently running jobs. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).

          • computeReservation — (Integer)

            A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.

            The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.

            For example, a computeReservation value of 50 indicates that Batch should reserve 50% of the maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there is only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.

            The minimum value is 0 and the maximum value is 99.

          • shareDistribution — (Array<map>)

            Array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that are not included have a default weight of 1.0.

            • shareIdentifier — required — (String)

              A fair share identifier or fair share identifier prefix. If the string ends with '' then this entry specifies the weight factor to use for fair share identifiers that begin with that prefix. The list of fair share identifiers in a fair share policy cannot overlap. For example you cannot have one that specifies a shareIdentifier of UserA* and another that specifies a shareIdentifier of UserA-1.

              There can be no more than 500 fair share identifiers active in a job queue.

              The string is limited to 255 alphanumeric characters, optionally followed by ''.

            • weightFactor — (Float)

              The weight factor for the fair share identifier. The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs using a share identifier with a weight factor of 0.125 (1/8) will get 8 times the compute resources of jobs using a share identifier with a weight factor of 1.

              The smallest supported value is 0.0001 and the largest supported value is 999.9999.

        • tags — (map<String>)

          The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listJobs(params = {}, callback) ⇒ AWS.Request

Returns a list of Batch jobs.

You must specify only one of the following items:

  • A job queue ID to return a list of jobs in that job queue

  • A multi-node parallel job ID to return a list of nodes for that job

  • An array job ID to return a list of the children for that job

You can filter the results by job status with the jobStatus parameter. If you don't specify a status, only RUNNING jobs are returned.

Service Reference:

Examples:

To list running jobs


/* This example lists the running jobs in the HighPriority job queue. */

 var params = {
  jobQueue: "HighPriority"
 };
 batch.listJobs(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    jobSummaryList: [
       {
      jobId: "e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb", 
      jobName: "example"
     }
    ]
   }
   */
 });

To list submitted jobs


/* This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status. */

 var params = {
  jobQueue: "HighPriority", 
  jobStatus: "SUBMITTED"
 };
 batch.listJobs(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    jobSummaryList: [
       {
      jobId: "68f0c163-fbd4-44e6-9fd1-25b14a434786", 
      jobName: "example"
     }
    ]
   }
   */
 });

Calling the listJobs operation

var params = {
  arrayJobId: 'STRING_VALUE',
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  jobQueue: 'STRING_VALUE',
  jobStatus: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED,
  maxResults: 'NUMBER_VALUE',
  multiNodeJobId: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
batch.listJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • jobQueue — (String)

      The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

    • arrayJobId — (String)

      The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

    • multiNodeJobId — (String)

      The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

    • jobStatus — (String)

      The job status used to filter jobs in the specified queue. If the filters parameter is specified, the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a status, only RUNNING jobs are returned.

      Possible values include:
      • "SUBMITTED"
      • "PENDING"
      • "RUNNABLE"
      • "STARTING"
      • "RUNNING"
      • "SUCCEEDED"
      • "FAILED"
    • maxResults — (Integer)

      The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListJobs returns up to 100 results and a nextToken value if applicable.

    • nextToken — (String)

      The nextToken value returned from a previous paginated ListJobs 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.

      Note: This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.
    • filters — (Array<map>)

      The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field, with the most recent jobs being first.

      JOB_NAME

      The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (), the filter will match any job name that begins with the string before the ''. This corresponds to the jobName value. For example, test1 matches both Test1 and test1, and test1* matches both test1 and Test10. When the JOB_NAME filter is used, the results are grouped by the job name and version.

      JOB_DEFINITION

      The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the jobDefinition value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (), the filter will match any job definition name that begins with the string before the ''. For example, jd1 matches only jd1, and jd1* matches both jd1 and jd1A. The version of the job definition that's used doesn't affect the sort order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), the results include jobs that used the specified revision of the job definition. Asterisk (*) is not supported when the ARN is used.

      BEFORE_CREATED_AT

      The value for the filter is the time that's before the job was created. This corresponds to the createdAt value. The value is a string representation of the number of seconds since 00:00:00 UTC (midnight) on January 1, 1970.

      AFTER_CREATED_AT

      The value for the filter is the time that's after the job was created. This corresponds to the createdAt value. The value is a string representation of the number of seconds since 00:00:00 UTC (midnight) on January 1, 1970.

      • name — (String)

        The name of the filter. Filter names are case sensitive.

      • values — (Array<String>)

        The filter values.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobSummaryList — (Array<map>)

        A list of job summaries that match the request.

        • jobArn — (String)

          The Amazon Resource Name (ARN) of the job.

        • jobId — required — (String)

          The ID of the job.

        • jobName — required — (String)

          The name of the job.

        • createdAt — (Integer)

          The Unix timestamp 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.

        • status — (String)

          The current status for the job.

          Possible values include:
          • "SUBMITTED"
          • "PENDING"
          • "RUNNABLE"
          • "STARTING"
          • "RUNNING"
          • "SUCCEEDED"
          • "FAILED"
        • statusReason — (String)

          A short, human-readable string to provide additional details about the current status of the job.

        • startedAt — (Integer)

          The Unix timestamp for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).

        • stoppedAt — (Integer)

          The Unix timestamp for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

        • container — (map)

          An object representing the details of the container that's associated with the job.

          • 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.

        • arrayProperties — (map)

          The array properties of the job, if it is an array job.

          • 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's associated with this job. This parameter is returned for children of array jobs.

        • nodeProperties — (map)

          The node properties for a single node in a job summary list.

          Note: This isn't applicable to jobs that are running on Fargate resources.
          • isMainNode — (Boolean)

            Specifies whether the current node is the main node for a multi-node parallel job.

          • numNodes — (Integer)

            The number of nodes 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.

        • jobDefinition — (String)

          The Amazon Resource Name (ARN) of the job definition.

      • nextToken — (String)

        The nextToken value to include in a future ListJobs request. When the results of a ListJobs 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listSchedulingPolicies(params = {}, callback) ⇒ AWS.Request

Returns a list of Batch scheduling policies.

Service Reference:

Examples:

Calling the listSchedulingPolicies operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
batch.listSchedulingPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • maxResults — (Integer)

      The maximum number of results returned by ListSchedulingPolicies in paginated output. When this parameter is used, ListSchedulingPolicies only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListSchedulingPolicies request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListSchedulingPolicies returns up to 100 results and a nextToken value if applicable.

    • nextToken — (String)

      The nextToken value returned from a previous paginated ListSchedulingPolicies 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.

      Note: This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • schedulingPolicies — (Array<map>)

        A list of scheduling policies that match the request.

        • arn — required — (String)

          Amazon Resource Name (ARN) of the scheduling policy.

      • nextToken — (String)

        The nextToken value to include in a future ListSchedulingPolicies request. When the results of a ListSchedulingPolicies 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

Service Reference:

Examples:

ListTagsForResource Example


/* This demonstrates calling the ListTagsForResource action. */

 var params = {
  resourceArn: "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1"
 };
 batch.listTagsForResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    tags: {
     "Department": "Engineering", 
     "Stage": "Alpha", 
     "User": "JaneDoe"
    }
   }
   */
 });

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
batch.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        The tags for the resource.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

registerJobDefinition(params = {}, callback) ⇒ AWS.Request

Registers an Batch job definition.

Service Reference:

Examples:

To register a job definition


/* This example registers a job definition for a simple container job. */

 var params = {
  type: "container", 
  containerProperties: {
   command: [
      "sleep", 
      "10"
   ], 
   image: "busybox", 
   resourceRequirements: [
      {
     type: "MEMORY", 
     value: "128"
    }, 
      {
     type: "VCPU", 
     value: "1"
    }
   ]
  }, 
  jobDefinitionName: "sleep10"
 };
 batch.registerJobDefinition(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    jobDefinitionArn: "arn:aws:batch:us-east-1:012345678910:job-definition/sleep10:1", 
    jobDefinitionName: "sleep10", 
    revision: 1
   }
   */
 });

RegisterJobDefinition with tags


/* This demonstrates calling the RegisterJobDefinition action, including tags. */

 var params = {
  type: "container", 
  containerProperties: {
   command: [
      "sleep", 
      "30"
   ], 
   image: "busybox", 
   resourceRequirements: [
      {
     type: "MEMORY", 
     value: "128"
    }, 
      {
     type: "VCPU", 
     value: "1"
    }
   ]
  }, 
  jobDefinitionName: "sleep30", 
  tags: {
   "Department": "Engineering", 
   "User": "JaneDoe"
  }
 };
 batch.registerJobDefinition(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    jobDefinitionArn: "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1", 
    jobDefinitionName: "sleep30", 
    revision: 1
   }
   */
 });

Calling the registerJobDefinition operation

var params = {
  jobDefinitionName: 'STRING_VALUE', /* required */
  type: container | multinode, /* required */
  containerProperties: {
    command: [
      'STRING_VALUE',
      /* more items */
    ],
    environment: [
      {
        name: 'STRING_VALUE',
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    executionRoleArn: 'STRING_VALUE',
    fargatePlatformConfiguration: {
      platformVersion: 'STRING_VALUE'
    },
    image: 'STRING_VALUE',
    instanceType: 'STRING_VALUE',
    jobRoleArn: 'STRING_VALUE',
    linuxParameters: {
      devices: [
        {
          hostPath: 'STRING_VALUE', /* required */
          containerPath: 'STRING_VALUE',
          permissions: [
            READ | WRITE | MKNOD,
            /* more items */
          ]
        },
        /* more items */
      ],
      initProcessEnabled: true || false,
      maxSwap: 'NUMBER_VALUE',
      sharedMemorySize: 'NUMBER_VALUE',
      swappiness: 'NUMBER_VALUE',
      tmpfs: [
        {
          containerPath: 'STRING_VALUE', /* required */
          size: 'NUMBER_VALUE', /* required */
          mountOptions: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    logConfiguration: {
      logDriver: json-file | syslog | journald | gelf | fluentd | awslogs | splunk, /* required */
      options: {
        '<String>': 'STRING_VALUE',
        /* '<String>': ... */
      },
      secretOptions: [
        {
          name: 'STRING_VALUE', /* required */
          valueFrom: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    memory: 'NUMBER_VALUE',
    mountPoints: [
      {
        containerPath: 'STRING_VALUE',
        readOnly: true || false,
        sourceVolume: 'STRING_VALUE'
      },
      /* more items */
    ],
    networkConfiguration: {
      assignPublicIp: ENABLED | DISABLED
    },
    privileged: true || false,
    readonlyRootFilesystem: true || false,
    resourceRequirements: [
      {
        type: GPU | VCPU | MEMORY, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    secrets: [
      {
        name: 'STRING_VALUE', /* required */
        valueFrom: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ulimits: [
      {
        hardLimit: 'NUMBER_VALUE', /* required */
        name: 'STRING_VALUE', /* required */
        softLimit: 'NUMBER_VALUE' /* required */
      },
      /* more items */
    ],
    user: 'STRING_VALUE',
    vcpus: 'NUMBER_VALUE',
    volumes: [
      {
        efsVolumeConfiguration: {
          fileSystemId: 'STRING_VALUE', /* required */
          authorizationConfig: {
            accessPointId: 'STRING_VALUE',
            iam: ENABLED | DISABLED
          },
          rootDirectory: 'STRING_VALUE',
          transitEncryption: ENABLED | DISABLED,
          transitEncryptionPort: 'NUMBER_VALUE'
        },
        host: {
          sourcePath: 'STRING_VALUE'
        },
        name: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  nodeProperties: {
    mainNode: 'NUMBER_VALUE', /* required */
    nodeRangeProperties: [ /* required */
      {
        targetNodes: 'STRING_VALUE', /* required */
        container: {
          command: [
            'STRING_VALUE',
            /* more items */
          ],
          environment: [
            {
              name: 'STRING_VALUE',
              value: 'STRING_VALUE'
            },
            /* more items */
          ],
          executionRoleArn: 'STRING_VALUE',
          fargatePlatformConfiguration: {
            platformVersion: 'STRING_VALUE'
          },
          image: 'STRING_VALUE',
          instanceType: 'STRING_VALUE',
          jobRoleArn: 'STRING_VALUE',
          linuxParameters: {
            devices: [
              {
                hostPath: 'STRING_VALUE', /* required */
                containerPath: 'STRING_VALUE',
                permissions: [
                  READ | WRITE | MKNOD,
                  /* more items */
                ]
              },
              /* more items */
            ],
            initProcessEnabled: true || false,
            maxSwap: 'NUMBER_VALUE',
            sharedMemorySize: 'NUMBER_VALUE',
            swappiness: 'NUMBER_VALUE',
            tmpfs: [
              {
                containerPath: 'STRING_VALUE', /* required */
                size: 'NUMBER_VALUE', /* required */
                mountOptions: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              /* more items */
            ]
          },
          logConfiguration: {
            logDriver: json-file | syslog | journald | gelf | fluentd | awslogs | splunk, /* required */
            options: {
              '<String>': 'STRING_VALUE',
              /* '<String>': ... */
            },
            secretOptions: [
              {
                name: 'STRING_VALUE', /* required */
                valueFrom: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          },
          memory: 'NUMBER_VALUE',
          mountPoints: [
            {
              containerPath: 'STRING_VALUE',
              readOnly: true || false,
              sourceVolume: 'STRING_VALUE'
            },
            /* more items */
          ],
          networkConfiguration: {
            assignPublicIp: ENABLED | DISABLED
          },
          privileged: true || false,
          readonlyRootFilesystem: true || false,
          resourceRequirements: [
            {
              type: GPU | VCPU | MEMORY, /* required */
              value: 'STRING_VALUE' /* required */
            },
            /* more items */
          ],
          secrets: [
            {
              name: 'STRING_VALUE', /* required */
              valueFrom: 'STRING_VALUE' /* required */
            },
            /* more items */
          ],
          ulimits: [
            {
              hardLimit: 'NUMBER_VALUE', /* required */
              name: 'STRING_VALUE', /* required */
              softLimit: 'NUMBER_VALUE' /* required */
            },
            /* more items */
          ],
          user: 'STRING_VALUE',
          vcpus: 'NUMBER_VALUE',
          volumes: [
            {
              efsVolumeConfiguration: {
                fileSystemId: 'STRING_VALUE', /* required */
                authorizationConfig: {
                  accessPointId: 'STRING_VALUE',
                  iam: ENABLED | DISABLED
                },
                rootDirectory: 'STRING_VALUE',
                transitEncryption: ENABLED | DISABLED,
                transitEncryptionPort: 'NUMBER_VALUE'
              },
              host: {
                sourcePath: 'STRING_VALUE'
              },
              name: 'STRING_VALUE'
            },
            /* more items */
          ]
        }
      },
      /* more items */
    ],
    numNodes: 'NUMBER_VALUE' /* required */
  },
  parameters: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  platformCapabilities: [
    EC2 | FARGATE,
    /* more items */
  ],
  propagateTags: true || false,
  retryStrategy: {
    attempts: 'NUMBER_VALUE',
    evaluateOnExit: [
      {
        action: RETRY | EXIT, /* required */
        onExitCode: 'STRING_VALUE',
        onReason: 'STRING_VALUE',
        onStatusReason: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  schedulingPriority: 'NUMBER_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  timeout: {
    attemptDurationSeconds: 'NUMBER_VALUE'
  }
};
batch.registerJobDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • jobDefinitionName — (String)

      The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

    • type — (String)

      The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.

      Note: If the job is run on Fargate resources, then multinode isn't supported.
      Possible values include:
      • "container"
      • "multinode"
    • parameters — (map<String>)

      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.

    • schedulingPriority — (Integer)

      The scheduling priority for jobs that are submitted with this job definition. This will only affect jobs in job queues with a fair share policy. Jobs with a higher scheduling priority will be scheduled before jobs with a lower scheduling priority.

      The minimum supported value is 0 and the maximum supported value is 9999.

    • containerProperties — (map)

      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.

      Note: If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.
      • 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.

        Note: Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

        • 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, use resourceRequirements to specify the vCPU requirements for the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the number of vCPUs reserved for the job.

        Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.

      • memory — (Integer)

        This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.

      • command — (Array<String>)

        The command that's 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.

      • jobRoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services 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 Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.

      • volumes — (Array<map>)

        A list of data volumes used in a job.

        • host — (map)

          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.

          Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
          • sourcePath — (String)

            The path on the host container instance that's 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 doesn't 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.

            Note: This parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided.
        • 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.

        • efsVolumeConfiguration — (map)

          This parameter is specified when you are using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

          • fileSystemId — required — (String)

            The Amazon EFS file system ID to use.

          • rootDirectory — (String)

            The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

            If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

          • transitEncryption — (String)

            Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
          • transitEncryptionPort — (Integer)

            The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.

          • authorizationConfig — (map)

            The authorization configuration details for the Amazon EFS file system.

            • accessPointId — (String)

              The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS Access Points in the Amazon Elastic File System User Guide.

            • iam — (String)

              Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
      • environment — (Array<map>)

        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.

        We don't recommend using plaintext environment variables for sensitive information, such as credential data.
        Note: Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.
        • 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 — (Array<map>)

        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.

        • 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.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.
      • ulimits — (Array<map>)

        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.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
        • hardLimit — required — (Integer)

          The hard limit for the ulimit type.

        • name — required — (String)

          The type of the ulimit.

        • softLimit — required — (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.

        Note: This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
      • resourceRequirements — (Array<map>)

        The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

        • value — required — (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.

          Note: GPUs are not available for jobs that are running on Fargate resources.
          type="MEMORY"

          The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. 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.

          Note: If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the Batch User Guide.

          For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

          value = 512

          VCPU = 0.25

          value = 1024

          VCPU = 0.25 or 0.5

          value = 2048

          VCPU = 0.25, 0.5, or 1

          value = 3072

          VCPU = 0.5, or 1

          value = 4096

          VCPU = 0.5, 1, or 2

          value = 5120, 6144, or 7168

          VCPU = 1 or 2

          value = 8192

          VCPU = 1, 2, or 4

          value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

          VCPU = 2 or 4

          value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

          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. For EC2 resources, 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 that are 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 = 512, 1024, or 2048

          value = 0.5

          MEMORY = 1024, 2048, 3072, or 4096

          value = 1

          MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

          value = 2

          MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

          value = 4

          MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

        • type — required — (String)

          The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

          Possible values include:
          • "GPU"
          • "VCPU"
          • "MEMORY"
      • linuxParameters — (map)

        Linux-specific modifications that are applied to the container, such as details for device mappings.

        • devices — (Array<map>)

          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.

          Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
          • hostPath — required — (String)

            The path for the device on the host container instance.

          • containerPath — (String)

            The path inside the container that's used to expose the host device. By default, the hostPath value is used.

          • permissions — (Array<String>)

            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.

        • 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.

          Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
        • tmpfs — (Array<map>)

          The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

          Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
          • containerPath — required — (String)

            The absolute file path in the container where the tmpfs volume is mounted.

          • size — required — (Integer)

            The size (in MiB) of the tmpfs volume.

          • mountOptions — (Array<String>)

            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"

        • 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.

          Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
        • 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. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

          Consider the following when you use a per-container swap configuration.

          • Swap space must be enabled and allocated on the container instance for the containers to use.

            Note: The Amazon ECS optimized AMIs don't have swap enabled by default. You must enable swap on the instance to use this feature. For more information, see Instance Store Swap Volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?

          • The swap space parameters are only supported for job definitions using EC2 resources.

          • If the maxSwap and swappiness parameters are omitted from a job definition, each container will have a default swappiness value of 60, and the total swap usage will be limited to two times the memory reservation of the container.

          Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
      • logConfiguration — (map)

        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.

        Note: Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

        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"

        Note: The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
        • logDriver — required — (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.

          Note: Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.
          awslogs

          Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the 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.

          Note: If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

          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"

          Possible values include:
          • "json-file"
          • "syslog"
          • "journald"
          • "gelf"
          • "fluentd"
          • "awslogs"
          • "splunk"
        • options — (map<String>)

          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"

        • secretOptions — (Array<map>)

          The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Batch User Guide.

          • name — required — (String)

            The name of the secret.

          • valueFrom — required — (String)

            The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

            Note: If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
      • secrets — (Array<map>)

        The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.

        • name — required — (String)

          The name of the secret.

        • valueFrom — required — (String)

          The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

          Note: If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
      • networkConfiguration — (map)

        The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

        • assignPublicIp — (String)

          Indicates whether the job should have a public IP address. For a job that is running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, 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".

          Possible values include:
          • "ENABLED"
          • "DISABLED"
      • fargatePlatformConfiguration — (map)

        The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

        • platformVersion — (String)

          The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

    • nodeProperties — (map)

      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 Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

      Note: If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
      • numNodes — required — (Integer)

        The number of nodes associated with a multi-node parallel job.

      • mainNode — required — (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 — required — (Array<map>)

        A list of node ranges and their properties associated with a multi-node parallel job.

        • targetNodes — required — (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 can nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties.

        • container — (map)

          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.

            Note: Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

            • 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, use resourceRequirements to specify the vCPU requirements for the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the number of vCPUs reserved for the job.

            Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.

          • memory — (Integer)

            This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.

          • command — (Array<String>)

            The command that's 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.

          • jobRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services 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 Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.

          • volumes — (Array<map>)

            A list of data volumes used in a job.

            • host — (map)

              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.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
              • sourcePath — (String)

                The path on the host container instance that's 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 doesn't 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.

                Note: This parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided.
            • 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.

            • efsVolumeConfiguration — (map)

              This parameter is specified when you are using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

              • fileSystemId — required — (String)

                The Amazon EFS file system ID to use.

              • rootDirectory — (String)

                The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

                If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

              • transitEncryption — (String)

                Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

                Possible values include:
                • "ENABLED"
                • "DISABLED"
              • transitEncryptionPort — (Integer)

                The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.

              • authorizationConfig — (map)

                The authorization configuration details for the Amazon EFS file system.

                • accessPointId — (String)

                  The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS Access Points in the Amazon Elastic File System User Guide.

                • iam — (String)

                  Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

                  Possible values include:
                  • "ENABLED"
                  • "DISABLED"
          • environment — (Array<map>)

            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.

            We don't recommend using plaintext environment variables for sensitive information, such as credential data.
            Note: Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.
            • 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 — (Array<map>)

            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.

            • 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.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.
          • ulimits — (Array<map>)

            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.

            Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
            • hardLimit — required — (Integer)

              The hard limit for the ulimit type.

            • name — required — (String)

              The type of the ulimit.

            • softLimit — required — (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.

            Note: This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
          • resourceRequirements — (Array<map>)

            The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

            • value — required — (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.

              Note: GPUs are not available for jobs that are running on Fargate resources.
              type="MEMORY"

              The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. 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.

              Note: If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the Batch User Guide.

              For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

              value = 512

              VCPU = 0.25

              value = 1024

              VCPU = 0.25 or 0.5

              value = 2048

              VCPU = 0.25, 0.5, or 1

              value = 3072

              VCPU = 0.5, or 1

              value = 4096

              VCPU = 0.5, 1, or 2

              value = 5120, 6144, or 7168

              VCPU = 1 or 2

              value = 8192

              VCPU = 1, 2, or 4

              value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

              VCPU = 2 or 4

              value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

              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. For EC2 resources, 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 that are 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 = 512, 1024, or 2048

              value = 0.5

              MEMORY = 1024, 2048, 3072, or 4096

              value = 1

              MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

              value = 2

              MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

              value = 4

              MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

            • type — required — (String)

              The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

              Possible values include:
              • "GPU"
              • "VCPU"
              • "MEMORY"
          • linuxParameters — (map)

            Linux-specific modifications that are applied to the container, such as details for device mappings.

            • devices — (Array<map>)

              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.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
              • hostPath — required — (String)

                The path for the device on the host container instance.

              • containerPath — (String)

                The path inside the container that's used to expose the host device. By default, the hostPath value is used.

              • permissions — (Array<String>)

                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.

            • 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.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
            • tmpfs — (Array<map>)

              The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
              • containerPath — required — (String)

                The absolute file path in the container where the tmpfs volume is mounted.

              • size — required — (Integer)

                The size (in MiB) of the tmpfs volume.

              • mountOptions — (Array<String>)

                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"

            • 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.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
            • 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. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

              Consider the following when you use a per-container swap configuration.

              • Swap space must be enabled and allocated on the container instance for the containers to use.

                Note: The Amazon ECS optimized AMIs don't have swap enabled by default. You must enable swap on the instance to use this feature. For more information, see Instance Store Swap Volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?

              • The swap space parameters are only supported for job definitions using EC2 resources.

              • If the maxSwap and swappiness parameters are omitted from a job definition, each container will have a default swappiness value of 60, and the total swap usage will be limited to two times the memory reservation of the container.

              Note: This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
          • logConfiguration — (map)

            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.

            Note: Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

            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"

            Note: The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
            • logDriver — required — (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.

              Note: Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.
              awslogs

              Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the 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.

              Note: If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

              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"

              Possible values include:
              • "json-file"
              • "syslog"
              • "journald"
              • "gelf"
              • "fluentd"
              • "awslogs"
              • "splunk"
            • options — (map<String>)

              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"

            • secretOptions — (Array<map>)

              The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Batch User Guide.

              • name — required — (String)

                The name of the secret.

              • valueFrom — required — (String)

                The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

                Note: If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
          • secrets — (Array<map>)

            The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.

            • name — required — (String)

              The name of the secret.

            • valueFrom — required — (String)

              The secret to expose to the container. The supported values are either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

              Note: If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
          • networkConfiguration — (map)

            The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

            • assignPublicIp — (String)

              Indicates whether the job should have a public IP address. For a job that is running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, 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".

              Possible values include:
              • "ENABLED"
              • "DISABLED"
          • fargatePlatformConfiguration — (map)

            The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 resources must not specify this parameter.

            • platformVersion — (String)

              The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

    • retryStrategy — (map)

      The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's 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 can 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 — (Array<map>)

        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.

        • onStatusReason — (String)

          Contains a glob pattern to match against the StatusReason returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

          The string can be between 1 and 512 characters in length.

        • onReason — (String)

          Contains a glob pattern to match against the Reason returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

          The string can be between 1 and 512 characters in length.

        • onExitCode — (String)

          Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The pattern can be up to 512 characters in length. It 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.

          The string can be between 1 and 512 characters in length.

        • action — required — (String)

          Specifies the action to take if all of the specified conditions (onStatusReason, onReason, and onExitCode) are met. The values aren't case sensitive.

          Possible values include:
          • "RETRY"
          • "EXIT"
    • 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.

    • timeout — (map)

      The timeout configuration for jobs that are submitted with this job definition, after which 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's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.

      • attemptDurationSeconds — (Integer)

        The time duration in seconds (measured from the job attempt's startedAt timestamp) after which Batch terminates your jobs if they have not finished. The minimum value for the timeout is 60 seconds.

    • tags — (map<String>)

      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 Amazon Web Services Resources in Batch User Guide.

    • platformCapabilities — (Array<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

submitJob(params = {}, callback) ⇒ AWS.Request

Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the resourceRequirements objects in the job definition are the exception. They can't be overridden this way using the memory and vcpus parameters. Rather, you must specify updates to job definition parameters in a ResourceRequirements object that's included in the containerOverrides parameter.

Note: Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.

Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.

Service Reference:

Examples:

To submit a job to a queue


/* This example submits a simple container job called example to the HighPriority job queue. */

 var params = {
  jobDefinition: "sleep60", 
  jobName: "example", 
  jobQueue: "HighPriority"
 };
 batch.submitJob(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    jobId: "876da822-4198-45f2-a252-6cea32512ea8", 
    jobName: "example"
   }
   */
 });

Calling the submitJob operation

var params = {
  jobDefinition: 'STRING_VALUE', /* required */
  jobName: 'STRING_VALUE', /* required */
  jobQueue: 'STRING_VALUE', /* required */
  arrayProperties: {
    size: 'NUMBER_VALUE'
  },
  containerOverrides: {
    command: [
      'STRING_VALUE',
      /* more items */
    ],
    environment: [
      {
        name: 'STRING_VALUE',
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    instanceType: 'STRING_VALUE',
    memory: 'NUMBER_VALUE',
    resourceRequirements: [
      {
        type: GPU | VCPU | MEMORY, /* required */
        value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    vcpus: 'NUMBER_VALUE'
  },
  dependsOn: [
    {
      jobId: 'STRING_VALUE',
      type: N_TO_N | SEQUENTIAL
    },
    /* more items */
  ],
  nodeOverrides: {
    nodePropertyOverrides: [
      {
        targetNodes: 'STRING_VALUE', /* required */
        containerOverrides: {
          command: [
            'STRING_VALUE',
            /* more items */
          ],
          environment: [
            {
              name: 'STRING_VALUE',
              value: 'STRING_VALUE'
            },
            /* more items */
          ],
          instanceType: 'STRING_VALUE',
          memory: 'NUMBER_VALUE',
          resourceRequirements: [
            {
              type: GPU | VCPU | MEMORY, /* required */
              value: 'STRING_VALUE' /* required */
            },
            /* more items */
          ],
          vcpus: 'NUMBER_VALUE'
        }
      },
      /* more items */
    ],
    numNodes: 'NUMBER_VALUE'
  },
  parameters: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  propagateTags: true || false,
  retryStrategy: {
    attempts: 'NUMBER_VALUE',
    evaluateOnExit: [
      {
        action: RETRY | EXIT, /* required */
        onExitCode: 'STRING_VALUE',
        onReason: 'STRING_VALUE',
        onStatusReason: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  schedulingPriorityOverride: 'NUMBER_VALUE',
  shareIdentifier: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  timeout: {
    attemptDurationSeconds: 'NUMBER_VALUE'
  }
};
batch.submitJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • jobName — (String)

      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.

    • jobQueue — (String)

      The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

    • shareIdentifier — (String)

      The share identifier for the job.

    • schedulingPriorityOverride — (Integer)

      The scheduling priority for the job. This will only affect jobs in job queues with a fair share policy. Jobs with a higher scheduling priority will be scheduled before jobs with a lower scheduling priority. This will override any scheduling priority in the job definition.

      The minimum supported value is 0 and the maximum supported value is 9999.

    • arrayProperties — (map)

      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 Batch User Guide.

      • size — (Integer)

        The size of the array job.

    • dependsOn — (Array<map>)

      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.

      • jobId — (String)

        The job ID of the Batch job associated with this dependency.

      • type — (String)

        The type of the job dependency.

        Possible values include:
        • "N_TO_N"
        • "SEQUENTIAL"
    • jobDefinition — (String)

      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.

    • parameters — (map<String>)

      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.

    • containerOverrides — (map)

      A list of container overrides in the 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, which is specified in the job definition or the Docker image, with a command override. You can also override existing environment variables on a container or add new environment variables to it with an environment override.

      • vcpus — (Integer)

        This parameter is deprecated, use resourceRequirements to override the vcpus parameter that's set in the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirements structure in the job definition. To override vCPU requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to VCPU and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

      • memory — (Integer)

        This parameter is deprecated, use resourceRequirements to override the memory requirements specified in the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the resourceRequirements structure in the job definition. To override memory requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

      • command — (Array<String>)

        The command to send to the container that overrides the default command from the Docker image or the job definition.

      • instanceType — (String)

        The instance type to use for a multi-node parallel job.

        Note: This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
      • environment — (Array<map>)

        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.

        Note: Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.
        • 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 — (Array<map>)

        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.

        • value — required — (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.

          Note: GPUs are not available for jobs that are running on Fargate resources.
          type="MEMORY"

          The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. 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.

          Note: If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the Batch User Guide.

          For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

          value = 512

          VCPU = 0.25

          value = 1024

          VCPU = 0.25 or 0.5

          value = 2048

          VCPU = 0.25, 0.5, or 1

          value = 3072

          VCPU = 0.5, or 1

          value = 4096

          VCPU = 0.5, 1, or 2

          value = 5120, 6144, or 7168

          VCPU = 1 or 2

          value = 8192

          VCPU = 1, 2, or 4

          value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

          VCPU = 2 or 4

          value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

          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. For EC2 resources, 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 that are 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 = 512, 1024, or 2048

          value = 0.5

          MEMORY = 1024, 2048, 3072, or 4096

          value = 1

          MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

          value = 2

          MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

          value = 4

          MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

        • type — required — (String)

          The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

          Possible values include:
          • "GPU"
          • "VCPU"
          • "MEMORY"
    • nodeOverrides — (map)

      A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

      Note: This parameter isn't applicable to jobs that are running on Fargate resources; use containerOverrides instead.
      • 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 — (Array<map>)

        The node property overrides for the job.

        • targetNodes — required — (String)

          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 — (map)

          The overrides that should be sent to a node range.

          • vcpus — (Integer)

            This parameter is deprecated, use resourceRequirements to override the vcpus parameter that's set in the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirements structure in the job definition. To override vCPU requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to VCPU and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

          • memory — (Integer)

            This parameter is deprecated, use resourceRequirements to override the memory requirements specified in the job definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the resourceRequirements structure in the job definition. To override memory requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

          • command — (Array<String>)

            The command to send to the container that overrides the default command from the Docker image or the job definition.

          • instanceType — (String)

            The instance type to use for a multi-node parallel job.

            Note: This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
          • environment — (Array<map>)

            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.

            Note: Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.
            • 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 — (Array<map>)

            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.

            • value — required — (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.

              Note: GPUs are not available for jobs that are running on Fargate resources.
              type="MEMORY"

              The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. 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.

              Note: If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the Batch User Guide.

              For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

              value = 512

              VCPU = 0.25

              value = 1024

              VCPU = 0.25 or 0.5

              value = 2048

              VCPU = 0.25, 0.5, or 1

              value = 3072

              VCPU = 0.5, or 1

              value = 4096

              VCPU = 0.5, 1, or 2

              value = 5120, 6144, or 7168

              VCPU = 1 or 2

              value = 8192

              VCPU = 1, 2, or 4

              value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

              VCPU = 2 or 4

              value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

              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. For EC2 resources, 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 that are 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 = 512, 1024, or 2048

              value = 0.5

              MEMORY = 1024, 2048, 3072, or 4096

              value = 1

              MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

              value = 2

              MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

              value = 4

              MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

            • type — required — (String)

              The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

              Possible values include:
              • "GPU"
              • "VCPU"
              • "MEMORY"
    • retryStrategy — (map)

      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 can 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 — (Array<map>)

        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.

        • onStatusReason — (String)

          Contains a glob pattern to match against the StatusReason returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

          The string can be between 1 and 512 characters in length.

        • onReason — (String)

          Contains a glob pattern to match against the Reason returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

          The string can be between 1 and 512 characters in length.

        • onExitCode — (String)

          Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The pattern can be up to 512 characters in length. It 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.

          The string can be between 1 and 512 characters in length.

        • action — required — (String)

          Specifies the action to take if all of the specified conditions (onStatusReason, onReason, and onExitCode) are met. The values aren't case sensitive.

          Possible values include:
          • "RETRY"
          • "EXIT"
    • 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. When specified, this overrides the tag propagation setting in the job definition.

    • timeout — (map)

      The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which 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 Batch terminates your jobs if they have not finished. The minimum value for the timeout is 60 seconds.

    • tags — (map<String>)

      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 Amazon Web Services Resources in Amazon Web Services General Reference.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

Service Reference:

Examples:

TagResource Example


/* This demonstrates calling the TagResource action. */

 var params = {
  resourceArn: "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1", 
  tags: {
   "Stage": "Alpha"
  }
 };
 batch.tagResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
batch.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource that tags are added to. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

    • tags — (map<String>)

      The tags that you apply to the resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

terminateJob(params = {}, callback) ⇒ AWS.Request

Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled.

Service Reference:

Examples:

To terminate a job


/* This example terminates a job with the specified job ID. */

 var params = {
  jobId: "61e743ed-35e4-48da-b2de-5c8333821c84", 
  reason: "Terminating job."
 };
 batch.terminateJob(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the terminateJob operation

var params = {
  jobId: 'STRING_VALUE', /* required */
  reason: 'STRING_VALUE' /* required */
};
batch.terminateJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • jobId — (String)

      The Batch job ID of the job to terminate.

    • reason — (String)

      A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Deletes specified tags from an Batch resource.

Service Reference:

Examples:

UntagResource Example


/* This demonstrates calling the UntagResource action. */

 var params = {
  resourceArn: "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1", 
  tagKeys: [
     "Stage"
  ]
 };
 batch.untagResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
batch.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource from which to delete tags. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

    • tagKeys — (Array<String>)

      The keys of the tags to be removed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateComputeEnvironment(params = {}, callback) ⇒ AWS.Request

Updates an Batch compute environment.

Service Reference:

Examples:

To update a compute environment


/* This example disables the P2OnDemand compute environment so it can be deleted. */

 var params = {
  computeEnvironment: "P2OnDemand", 
  state: "DISABLED"
 };
 batch.updateComputeEnvironment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    computeEnvironmentArn: "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand", 
    computeEnvironmentName: "P2OnDemand"
   }
   */
 });

Calling the updateComputeEnvironment operation

var params = {
  computeEnvironment: 'STRING_VALUE', /* required */
  computeResources: {
    desiredvCpus: 'NUMBER_VALUE',
    maxvCpus: 'NUMBER_VALUE',
    minvCpus: 'NUMBER_VALUE',
    securityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    subnets: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  serviceRole: 'STRING_VALUE',
  state: ENABLED | DISABLED,
  unmanagedvCpus: 'NUMBER_VALUE'
};
batch.updateComputeEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • computeEnvironment — (String)

      The name or full Amazon Resource Name (ARN) of the compute environment to update.

    • state — (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.

      If the state is ENABLED, then the 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 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 don't scale out. However, they scale in to minvCpus value after instances become idle.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • unmanagedvCpus — (Integer)

      The maximum number of vCPUs expected to be used for an unmanaged compute environment. This parameter should not be specified for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter is not provided for a fair share job queue, no vCPU capacity will be reserved.

    • computeResources — (map)

      Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the Batch User Guide.

      • minvCpus — (Integer)

        The minimum number of Amazon EC2 vCPUs that an environment should maintain.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
      • maxvCpus — (Integer)

        The maximum number of Amazon EC2 vCPUs that an environment can reach.

        Note: With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. That is, no more than a single instance from among those specified in your compute environment.
      • desiredvCpus — (Integer)

        The desired number of Amazon EC2 vCPUS in the compute environment.

        Note: This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified.
      • subnets — (Array<String>)

        The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16 subnets. Providing an empty list will be handled as if this parameter wasn't specified and no change is made. This can't be specified for EC2 compute resources. For more information, see VPCs and Subnets in the Amazon VPC User Guide.

      • securityGroupIds — (Array<String>)

        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 change is made.

    • serviceRole — (String)

      The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

      If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role.

      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.

      Note: Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • computeEnvironmentName — (String)

        The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

      • computeEnvironmentArn — (String)

        The Amazon Resource Name (ARN) of the compute environment.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateJobQueue(params = {}, callback) ⇒ AWS.Request

Updates a job queue.

Service Reference:

Examples:

To update a job queue


/* This example disables a job queue so that it can be deleted. */

 var params = {
  jobQueue: "GPGPU", 
  state: "DISABLED"
 };
 batch.updateJobQueue(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    jobQueueArn: "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU", 
    jobQueueName: "GPGPU"
   }
   */
 });

Calling the updateJobQueue operation

var params = {
  jobQueue: 'STRING_VALUE', /* required */
  computeEnvironmentOrder: [
    {
      computeEnvironment: 'STRING_VALUE', /* required */
      order: 'NUMBER_VALUE' /* required */
    },
    /* more items */
  ],
  priority: 'NUMBER_VALUE',
  schedulingPolicyArn: 'STRING_VALUE',
  state: ENABLED | DISABLED
};
batch.updateJobQueue(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • jobQueue — (String)

      The name or the Amazon Resource Name (ARN) of the job queue.

    • state — (String)

      Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • schedulingPolicyArn — (String)

      Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

    • priority — (Integer)

      The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

    • computeEnvironmentOrder — (Array<map>)

      Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should run a given job. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

      Note: All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.
      • order — required — (Integer)

        The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

      • computeEnvironment — required — (String)

        The Amazon Resource Name (ARN) of the compute environment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobQueueName — (String)

        The name of the job queue.

      • jobQueueArn — (String)

        The Amazon Resource Name (ARN) of the job queue.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateSchedulingPolicy(params = {}, callback) ⇒ AWS.Request

Updates a scheduling policy.

Service Reference:

Examples:

Calling the updateSchedulingPolicy operation

var params = {
  arn: 'STRING_VALUE', /* required */
  fairsharePolicy: {
    computeReservation: 'NUMBER_VALUE',
    shareDecaySeconds: 'NUMBER_VALUE',
    shareDistribution: [
      {
        shareIdentifier: 'STRING_VALUE', /* required */
        weightFactor: 'NUMBER_VALUE'
      },
      /* more items */
    ]
  }
};
batch.updateSchedulingPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • arn — (String)

      The Amazon Resource Name (ARN) of the scheduling policy to update.

    • fairsharePolicy — (map)

      The fair share policy.

      • shareDecaySeconds — (Integer)

        The time period to use to calculate a fair share percentage for each fair share identifier in use, in seconds. A value of zero (0) indicates that only current usage should be measured; if there are four evenly weighted fair share identifiers then each can only use up to 25% of the available CPU resources, even if some of the fair share identifiers have no currently running jobs. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).

      • computeReservation — (Integer)

        A value used to reserve some of the available maximum vCPU for fair share identifiers that have not yet been used.

        The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.

        For example, a computeReservation value of 50 indicates that Batch should reserve 50% of the maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there is only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.

        The minimum value is 0 and the maximum value is 99.

      • shareDistribution — (Array<map>)

        Array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that are not included have a default weight of 1.0.

        • shareIdentifier — required — (String)

          A fair share identifier or fair share identifier prefix. If the string ends with '' then this entry specifies the weight factor to use for fair share identifiers that begin with that prefix. The list of fair share identifiers in a fair share policy cannot overlap. For example you cannot have one that specifies a shareIdentifier of UserA* and another that specifies a shareIdentifier of UserA-1.

          There can be no more than 500 fair share identifiers active in a job queue.

          The string is limited to 255 alphanumeric characters, optionally followed by ''.

        • weightFactor — (Float)

          The weight factor for the fair share identifier. The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs using a share identifier with a weight factor of 0.125 (1/8) will get 8 times the compute resources of jobs using a share identifier with a weight factor of 1.

          The smallest supported value is 0.0001 and the largest supported value is 999.9999.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.