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.

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)

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

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

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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.

Property Details

endpointAWS.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 AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are cancelled. Jobs that have progressed to STARTING or RUNNING are not cancelled (but the API operation still succeeds, even if no job is cancelled); 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 AWS Batch job ID of the job to cancel.

    • reason — (String)

      A message to attach to the job that explains the reason for cancelling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS 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 AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments.

In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use a recent, approved version of the Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.

In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see Container Instance AMIs in the Amazon EC2 Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it and then manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS Container Instance in the Amazon EC2 Container Service Developer Guide.

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 */
  serviceRole: 'STRING_VALUE', /* required */
  type: MANAGED | UNMANAGED, /* required */
  computeResources: {
    instanceRole: 'STRING_VALUE', /* required */
    instanceTypes: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    maxvCpus: 0, /* required */
    minvCpus: 0, /* required */
    securityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    subnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    type: EC2 | SPOT, /* required */
    bidPercentage: 0,
    desiredvCpus: 0,
    ec2KeyPair: 'STRING_VALUE',
    imageId: 'STRING_VALUE',
    spotIamFleetRole: 'STRING_VALUE',
    tags: {
      '<String>': 'STRING_VALUE',
      /* '<String>': ... */
    }
  },
  state: ENABLED | DISABLED
};
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.

      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.

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

      Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments.

      • typerequired — (String)

        The type of compute environment.

        Possible values include:
        • "EC2"
        • "SPOT"
      • minvCpusrequired — (Integer)

        The minimum number of EC2 vCPUs that an environment should maintain.

      • maxvCpusrequired — (Integer)

        The maximum number of EC2 vCPUs that an environment can reach.

      • desiredvCpus — (Integer)

        The desired number of EC2 vCPUS in the compute environment.

      • instanceTypesrequired — (Array<String>)

        The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, c4 or p3), or you can specify specific sizes within a family (such as c4.8xlarge). You can also choose optimal to pick instance types (from the latest C, M, and R instance families) on the fly that match the demand of your job queues.

      • imageId — (String)

        The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.

      • subnetsrequired — (Array<String>)

        The VPC subnets into which the compute resources are launched.

      • securityGroupIdsrequired — (Array<String>)

        The EC2 security group that is associated with instances launched in the compute environment.

      • ec2KeyPair — (String)

        The EC2 key pair that is used for instances launched in the compute environment.

      • instanceRolerequired — (String)

        The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole. For more information, see Amazon ECS Instance Role in the AWS Batch User Guide.

      • tags — (map<String>)

        Key-value pair tags to be applied to resources that are launched in the compute environment.

      • bidPercentage — (Integer)

        The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.

      • spotIamFleetRole — (String)

        The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.

    • serviceRole — (String)

      The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

      If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

      Note: Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not 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.

      • 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 AWS 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 in which the AWS 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: 0 /* required */
    },
    /* more items */
  ],
  jobQueueName: 'STRING_VALUE', /* required */
  priority: 0, /* required */
  state: ENABLED | DISABLED
};
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.

    • state — (String)

      The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • 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 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.

    • 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 execute a given job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to 3 compute environments with a job queue.

      • orderrequired — (Integer)

        The order of the compute environment.

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

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

Deletes an AWS 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.

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 terminated when you delete a job queue.

It is 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.

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

Deregisters an AWS Batch job definition.

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 are 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: 0,
  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 is not 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 is 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.

        • computeEnvironmentNamerequired — (String)

          The name of the compute environment.

        • computeEnvironmentArnrequired — (String)

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

        • ecsClusterArnrequired — (String)

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

        • type — (String)

          The type of the compute environment.

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

          The state of the compute environment. The valid values are ENABLED or DISABLED. An ENABLED state indicates that you can register instances with the compute environment and that the associated instances can accept jobs.

          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.

          • typerequired — (String)

            The type of compute environment.

            Possible values include:
            • "EC2"
            • "SPOT"
          • minvCpusrequired — (Integer)

            The minimum number of EC2 vCPUs that an environment should maintain.

          • maxvCpusrequired — (Integer)

            The maximum number of EC2 vCPUs that an environment can reach.

          • desiredvCpus — (Integer)

            The desired number of EC2 vCPUS in the compute environment.

          • instanceTypesrequired — (Array<String>)

            The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, c4 or p3), or you can specify specific sizes within a family (such as c4.8xlarge). You can also choose optimal to pick instance types (from the latest C, M, and R instance families) on the fly that match the demand of your job queues.

          • imageId — (String)

            The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.

          • subnetsrequired — (Array<String>)

            The VPC subnets into which the compute resources are launched.

          • securityGroupIdsrequired — (Array<String>)

            The EC2 security group that is associated with instances launched in the compute environment.

          • ec2KeyPair — (String)

            The EC2 key pair that is used for instances launched in the compute environment.

          • instanceRolerequired — (String)

            The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole. For more information, see Amazon ECS Instance Role in the AWS Batch User Guide.

          • tags — (map<String>)

            Key-value pair tags to be applied to resources that are launched in the compute environment.

          • bidPercentage — (Integer)

            The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.

          • spotIamFleetRole — (String)

            The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.

        • serviceRole — (String)

          The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.

      • nextToken — (String)

        The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

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", 
       memory: 128, 
       mountPoints: [
       ], 
       ulimits: [
       ], 
       vcpus: 1, 
       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: 0,
  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 space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.

    • 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 along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not 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 with which 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 is 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.

        • jobDefinitionNamerequired — (String)

          The name of the job definition.

        • jobDefinitionArnrequired — (String)

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

        • revisionrequired — (Integer)

          The revision of the job definition.

        • status — (String)

          The status of the job definition.

        • typerequired — (String)

          The type of job definition.

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

        • 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 may specify between 1 and 10 attempts. If attempts is greater than one, the job is retried if it fails until it has moved to RUNNABLE that many times.

        • containerProperties — (map)

          An object with various properties specific to container-based jobs.

          • imagerequired — (String)

            The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

            • Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).

            • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

            • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

            • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

          • vcpusrequired — (Integer)

            The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least 1 vCPU.

          • memoryrequired — (Integer)

            The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.

          • command — (Array<String>)

            The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

          • jobRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.

          • 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, but the data is not guaranteed to persist after the containers associated with it stop running.

              • sourcePath — (String)

                The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

            • name — (String)

              The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

          • environment — (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 do not recommend using plain text 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 AWS 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 at which to mount the host volume.

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

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

            • hardLimitrequired — (Integer)

              The hard limit for the ulimit type.

            • namerequired — (String)

              The type of the ulimit.

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

      • 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: 0,
  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 along with 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 is not 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 is 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.

        • jobQueueNamerequired — (String)

          The name of the job queue.

        • jobQueueArnrequired — (String)

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

        • staterequired — (String)

          Describes the ability of the queue to accept new jobs.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • 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.

        • priorityrequired — (Integer)

          The priority of the job queue.

        • computeEnvironmentOrderrequired — (Array<map>)

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

          • orderrequired — (Integer)

            The order of the compute environment.

          • computeEnvironmentrequired — (String)

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

      • 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 AWS 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 space-separated 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.

        • jobNamerequired — (String)

          The name of the job.

        • jobIdrequired — (String)

          The ID for the job.

        • jobQueuerequired — (String)

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

        • statusrequired — (String)

          The current status for the job.

          Possible values include:
          • "SUBMITTED"
          • "PENDING"
          • "RUNNABLE"
          • "STARTING"
          • "RUNNING"
          • "SUCCEEDED"
          • "FAILED"
        • 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 is associated with the job attempt. Each container attempt receives a task ARN when they reach the STARTING status.

            • exitCode — (Integer)

              The exit code for the job attempt. A non-zero exit code is considered a failure.

            • reason — (String)

              A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

            • logStreamName — (String)

              The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

          • startedAt — (Integer)

            The Unix timestamp for when the attempt was started (when the task transitioned from the PENDING state to the RUNNING state).

          • stoppedAt — (Integer)

            The Unix timestamp for when the attempt was stopped (when the task transitioned from the RUNNING state to the STOPPED state).

          • 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 for when the job was created (when the task 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 may specify between 1 and 10 attempts. If attempts is greater than one, the job is retried if it fails until it has moved to RUNNABLE that many times.

        • startedAtrequired — (Integer)

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

        • stoppedAt — (Integer)

          The Unix timestamp for when the job was stopped (when the task transitioned from the RUNNING state to the STOPPED state).

        • dependsOn — (Array<map>)

          A list of job names or IDs on which this job depends.

          • jobId — (String)

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

        • jobDefinitionrequired — (String)

          The job definition that is 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 is associated with the job.

          • image — (String)

            The image used to start the container.

          • vcpus — (Integer)

            The number of VCPUs allocated for the job.

          • memory — (Integer)

            The number of MiB of memory reserved for the job.

          • command — (Array<String>)

            The command that is passed to the container.

          • jobRoleArn — (String)

            The Amazon Resource Name (ARN) associated with the job upon execution.

          • 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, but the data is not guaranteed to persist after the containers associated with it stop running.

              • sourcePath — (String)

                The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

            • name — (String)

              The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

          • environment — (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 AWS 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 at which to mount the host volume.

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

          • ulimits — (Array<map>)

            A list of ulimit values to set in the container.

            • hardLimitrequired — (Integer)

              The hard limit for the ulimit type.

            • namerequired — (String)

              The type of the ulimit.

            • softLimitrequired — (Integer)

              The soft limit for the ulimit type.

          • privileged — (Boolean)

            When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

          • user — (String)

            The user name to use inside the container.

          • 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 on which the container is running.

          • taskArn — (String)

            The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.

          • logStreamName — (String)

            The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

Returns:

  • (AWS.Request)

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

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

Returns a list of task jobs for a specified job queue. You can filter the results by job status with the jobStatus parameter. If you do not 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 = {
  jobQueue: 'STRING_VALUE', /* required */
  jobStatus: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED,
  maxResults: 0,
  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 with which to list jobs.

    • jobStatus — (String)

      The job status with which to filter jobs in the specified queue. If you do not 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 along with 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 is not 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 is 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:

      • jobSummaryList — (Array<map>)

        A list of job summaries that match the request.

        • jobIdrequired — (String)

          The ID of the job.

        • jobNamerequired — (String)

          The name of the job.

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

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

Registers an AWS 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", 
   memory: 128, 
   vcpus: 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
   }
   */
 });

Calling the registerJobDefinition operation

var params = {
  jobDefinitionName: 'STRING_VALUE', /* required */
  type: container, /* required */
  containerProperties: {
    image: 'STRING_VALUE', /* required */
    memory: 0, /* required */
    vcpus: 0, /* required */
    command: [
      'STRING_VALUE',
      /* more items */
    ],
    environment: [
      {
        name: 'STRING_VALUE',
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    jobRoleArn: 'STRING_VALUE',
    mountPoints: [
      {
        containerPath: 'STRING_VALUE',
        readOnly: true || false,
        sourceVolume: 'STRING_VALUE'
      },
      /* more items */
    ],
    privileged: true || false,
    readonlyRootFilesystem: true || false,
    ulimits: [
      {
        hardLimit: 0, /* required */
        name: 'STRING_VALUE', /* required */
        softLimit: 0 /* required */
      },
      /* more items */
    ],
    user: 'STRING_VALUE',
    volumes: [
      {
        host: {
          sourcePath: 'STRING_VALUE'
        },
        name: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  parameters: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  retryStrategy: {
    attempts: 0
  }
};
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.

      Possible values include:
      • "container"
    • 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.

    • containerProperties — (map)

      An object with various properties specific for container-based jobs. This parameter is required if the type parameter is container.

      • imagerequired — (String)

        The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

        • Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).

        • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

        • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

        • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

      • vcpusrequired — (Integer)

        The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least 1 vCPU.

      • memoryrequired — (Integer)

        The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.

      • command — (Array<String>)

        The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

      • jobRoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.

      • 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, but the data is not guaranteed to persist after the containers associated with it stop running.

          • sourcePath — (String)

            The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

        • name — (String)

          The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

      • environment — (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 do not recommend using plain text 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 AWS 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 at which to mount the host volume.

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

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

        • hardLimitrequired — (Integer)

          The hard limit for the ulimit type.

        • namerequired — (String)

          The type of the ulimit.

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

    • retryStrategy — (map)

      The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here.

      • attempts — (Integer)

        The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If attempts is greater than one, the job is retried if it fails until it has moved to RUNNABLE that many times.

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 AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.

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 */
  containerOverrides: {
    command: [
      'STRING_VALUE',
      /* more items */
    ],
    environment: [
      {
        name: 'STRING_VALUE',
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    memory: 0,
    vcpus: 0
  },
  dependsOn: [
    {
      jobId: 'STRING_VALUE'
    },
    /* more items */
  ],
  parameters: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  retryStrategy: {
    attempts: 0
  }
};
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 into which the job will be submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

    • dependsOn — (Array<map>)

      A list of job IDs on which this job depends. A job can depend upon a maximum of 20 jobs.

      • jobId — (String)

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

    • jobDefinition — (String)

      The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition.

    • 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 JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.

      • vcpus — (Integer)

        The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.

      • memory — (Integer)

        The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.

      • command — (Array<String>)

        The command to send to the container that overrides the default command from the Docker image or the job definition.

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

    • 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 may specify between 1 and 10 attempts. If attempts is greater than one, the job is retried if it fails until it has moved to RUNNABLE that many times.

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:

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

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 AWS Batch job ID of the job to terminate.

    • reason — (String)

      A message to attach to the job that explains the reason for cancelling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS 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.

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

Updates an AWS 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: 0,
    maxvCpus: 0,
    minvCpus: 0
  },
  serviceRole: 'STRING_VALUE',
  state: ENABLED | DISABLED
};
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.

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

      Details of the compute resources managed by the compute environment. Required for a managed compute environment.

      • minvCpus — (Integer)

        The minimum number of EC2 vCPUs that an environment should maintain.

      • maxvCpus — (Integer)

        The maximum number of EC2 vCPUs that an environment can reach.

      • desiredvCpus — (Integer)

        The desired number of EC2 vCPUS in the compute environment.

    • serviceRole — (String)

      The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

      If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

      Note: Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not 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 compute environment.

      • 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: 0 /* required */
    },
    /* more items */
  ],
  priority: 0,
  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.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • 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 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.

    • 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 execute a given job.

      • orderrequired — (Integer)

        The order of the compute environment.

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