@aws-sdk/client-batch 3.287.0 → 3.289.0

package/dist-types/commands/CancelJobCommand.d.ts

@@ -32,6 +32,18 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea
  * @see {@link CancelJobCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To cancel a job
+ * ```javascript
+ * // This example cancels a job with the specified job ID.
+ * const input = {
+ *   "jobId": "1d828f65-7a4d-42e8-996d-3b900ed59dc4",
+ *   "reason": "Cancelling job."
+ * };
+ * const command = new CancelJobCommand(input);
+ * await client.send(command);
+ * // example id: to-cancel-a-job-1481152314733
+ * ```
+ *
  */
 export declare class CancelJobCommand extends $Command<CancelJobCommandInput, CancelJobCommandOutput, BatchClientResolvedConfig> {
     readonly input: CancelJobCommandInput;

package/dist-types/commands/CreateComputeEnvironmentCommand.d.ts

@@ -107,6 +107,96 @@ export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvi
  * @see {@link CreateComputeEnvironmentCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To create a managed EC2 compute environment
+ * ```javascript
+ * // This example creates a managed compute environment with specific C4 instance types that are launched on demand. The compute environment is called C4OnDemand.
+ * const input = {
+ *   "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"
+ * };
+ * const command = new CreateComputeEnvironmentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand",
+ *   "computeEnvironmentName": "C4OnDemand"
+ * }
+ * *\/
+ * // example id: to-create-a-managed-ec2-compute-environment-1481152600017
+ * ```
+ *
+ * @example To create a managed EC2 Spot compute environment
+ * ```javascript
+ * // 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.
+ * const input = {
+ *   "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"
+ * };
+ * const command = new CreateComputeEnvironmentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot",
+ *   "computeEnvironmentName": "M4Spot"
+ * }
+ * *\/
+ * // example id: to-create-a-managed-ec2-spot-compute-environment-1481152844190
+ * ```
+ *
  */
 export declare class CreateComputeEnvironmentCommand extends $Command<CreateComputeEnvironmentCommandInput, CreateComputeEnvironmentCommandOutput, BatchClientResolvedConfig> {
     readonly input: CreateComputeEnvironmentCommandInput;

package/dist-types/commands/CreateJobQueueCommand.d.ts

@@ -34,6 +34,60 @@ export interface CreateJobQueueCommandOutput extends CreateJobQueueResponse, __M
  * @see {@link CreateJobQueueCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To create a job queue with a single compute environment
+ * ```javascript
+ * // This example creates a job queue called LowPriority that uses the M4Spot compute environment.
+ * const input = {
+ *   "computeEnvironmentOrder": [
+ *     {
+ *       "computeEnvironment": "M4Spot",
+ *       "order": 1
+ *     }
+ *   ],
+ *   "jobQueueName": "LowPriority",
+ *   "priority": 1,
+ *   "state": "ENABLED"
+ * };
+ * const command = new CreateJobQueueCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority",
+ *   "jobQueueName": "LowPriority"
+ * }
+ * *\/
+ * // example id: to-create-a-job-queue-with-a-single-compute-environment-1481152967946
+ * ```
+ *
+ * @example To create a job queue with multiple compute environments
+ * ```javascript
+ * // 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.
+ * const input = {
+ *   "computeEnvironmentOrder": [
+ *     {
+ *       "computeEnvironment": "C4OnDemand",
+ *       "order": 1
+ *     },
+ *     {
+ *       "computeEnvironment": "M4Spot",
+ *       "order": 2
+ *     }
+ *   ],
+ *   "jobQueueName": "HighPriority",
+ *   "priority": 10,
+ *   "state": "ENABLED"
+ * };
+ * const command = new CreateJobQueueCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
+ *   "jobQueueName": "HighPriority"
+ * }
+ * *\/
+ * // example id: to-create-a-job-queue-with-multiple-compute-environments-1481153027051
+ * ```
+ *
  */
 export declare class CreateJobQueueCommand extends $Command<CreateJobQueueCommandInput, CreateJobQueueCommandOutput, BatchClientResolvedConfig> {
     readonly input: CreateJobQueueCommandInput;

package/dist-types/commands/DeleteComputeEnvironmentCommand.d.ts

@@ -32,6 +32,17 @@ export interface DeleteComputeEnvironmentCommandOutput extends DeleteComputeEnvi
  * @see {@link DeleteComputeEnvironmentCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To delete a compute environment
+ * ```javascript
+ * // This example deletes the P2OnDemand compute environment.
+ * const input = {
+ *   "computeEnvironment": "P2OnDemand"
+ * };
+ * const command = new DeleteComputeEnvironmentCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-a-compute-environment-1481153105644
+ * ```
+ *
  */
 export declare class DeleteComputeEnvironmentCommand extends $Command<DeleteComputeEnvironmentCommandInput, DeleteComputeEnvironmentCommandOutput, BatchClientResolvedConfig> {
     readonly input: DeleteComputeEnvironmentCommandInput;

package/dist-types/commands/DeleteJobQueueCommand.d.ts

@@ -32,6 +32,17 @@ export interface DeleteJobQueueCommandOutput extends DeleteJobQueueResponse, __M
  * @see {@link DeleteJobQueueCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To delete a job queue
+ * ```javascript
+ * // This example deletes the GPGPU job queue.
+ * const input = {
+ *   "jobQueue": "GPGPU"
+ * };
+ * const command = new DeleteJobQueueCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-a-job-queue-1481153508134
+ * ```
+ *
  */
 export declare class DeleteJobQueueCommand extends $Command<DeleteJobQueueCommandInput, DeleteJobQueueCommandOutput, BatchClientResolvedConfig> {
     readonly input: DeleteJobQueueCommandInput;

package/dist-types/commands/DeregisterJobDefinitionCommand.d.ts

@@ -29,6 +29,17 @@ export interface DeregisterJobDefinitionCommandOutput extends DeregisterJobDefin
  * @see {@link DeregisterJobDefinitionCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To deregister a job definition
+ * ```javascript
+ * // This example deregisters a job definition called sleep10.
+ * const input = {
+ *   "jobDefinition": "sleep10"
+ * };
+ * const command = new DeregisterJobDefinitionCommand(input);
+ * await client.send(command);
+ * // example id: to-deregister-a-job-definition-1481153579565
+ * ```
+ *
  */
 export declare class DeregisterJobDefinitionCommand extends $Command<DeregisterJobDefinitionCommandInput, DeregisterJobDefinitionCommandOutput, BatchClientResolvedConfig> {
     readonly input: DeregisterJobDefinitionCommandInput;

package/dist-types/commands/DescribeComputeEnvironmentsCommand.d.ts

@@ -32,6 +32,57 @@ export interface DescribeComputeEnvironmentsCommandOutput extends DescribeComput
  * @see {@link DescribeComputeEnvironmentsCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To describe a compute environment
+ * ```javascript
+ * // This example describes the P2OnDemand compute environment.
+ * const input = {
+ *   "computeEnvironments": [
+ *     "P2OnDemand"
+ *   ]
+ * };
+ * const command = new DescribeComputeEnvironmentsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-a-compute-environment-1481153713334
+ * ```
+ *
  */
 export declare class DescribeComputeEnvironmentsCommand extends $Command<DescribeComputeEnvironmentsCommandInput, DescribeComputeEnvironmentsCommandOutput, BatchClientResolvedConfig> {
     readonly input: DescribeComputeEnvironmentsCommandInput;

package/dist-types/commands/DescribeJobDefinitionsCommand.d.ts

@@ -30,6 +30,51 @@ export interface DescribeJobDefinitionsCommandOutput extends DescribeJobDefiniti
  * @see {@link DescribeJobDefinitionsCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To describe active job definitions
+ * ```javascript
+ * // This example describes all of your active job definitions.
+ * const input = {
+ *   "status": "ACTIVE"
+ * };
+ * const command = new DescribeJobDefinitionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "jobDefinitions": [
+ *     {
+ *       "type": "container",
+ *       "containerProperties": {
+ *         "command": [
+ *           "sleep",
+ *           "60"
+ *         ],
+ *         "environment": [],
+ *         "image": "busybox",
+ *         "mountPoints": [],
+ *         "resourceRequirements": [
+ *           {
+ *             "type": "MEMORY",
+ *             "value": "128"
+ *           },
+ *           {
+ *             "type": "VCPU",
+ *             "value": "1"
+ *           }
+ *         ],
+ *         "ulimits": [],
+ *         "volumes": []
+ *       },
+ *       "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1",
+ *       "jobDefinitionName": "sleep60",
+ *       "revision": 1,
+ *       "status": "ACTIVE"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-active-job-definitions-1481153895831
+ * ```
+ *
  */
 export declare class DescribeJobDefinitionsCommand extends $Command<DescribeJobDefinitionsCommandInput, DescribeJobDefinitionsCommandOutput, BatchClientResolvedConfig> {
     readonly input: DescribeJobDefinitionsCommandInput;

package/dist-types/commands/DescribeJobQueuesCommand.d.ts

@@ -29,6 +29,39 @@ export interface DescribeJobQueuesCommandOutput extends DescribeJobQueuesRespons
  * @see {@link DescribeJobQueuesCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To describe a job queue
+ * ```javascript
+ * // This example describes the HighPriority job queue.
+ * const input = {
+ *   "jobQueues": [
+ *     "HighPriority"
+ *   ]
+ * };
+ * const command = new DescribeJobQueuesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-a-job-queue-1481153995804
+ * ```
+ *
  */
 export declare class DescribeJobQueuesCommand extends $Command<DescribeJobQueuesCommandInput, DescribeJobQueuesCommandOutput, BatchClientResolvedConfig> {
     readonly input: DescribeJobQueuesCommandInput;

package/dist-types/commands/DescribeJobsCommand.d.ts

@@ -29,6 +29,52 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad
  * @see {@link DescribeJobsCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To describe a specific job
+ * ```javascript
+ * // This example describes a job with the specified job ID.
+ * const input = {
+ *   "jobs": [
+ *     "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9"
+ *   ]
+ * };
+ * const command = new DescribeJobsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-a-specific-job-1481154090490
+ * ```
+ *
  */
 export declare class DescribeJobsCommand extends $Command<DescribeJobsCommandInput, DescribeJobsCommandOutput, BatchClientResolvedConfig> {
     readonly input: DescribeJobsCommandInput;

package/dist-types/commands/ListJobsCommand.d.ts

@@ -43,6 +43,49 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare
  * @see {@link ListJobsCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To list running jobs
+ * ```javascript
+ * // This example lists the running jobs in the HighPriority job queue.
+ * const input = {
+ *   "jobQueue": "HighPriority"
+ * };
+ * const command = new ListJobsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "jobSummaryList": [
+ *     {
+ *       "jobId": "e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb",
+ *       "jobName": "example"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-running-jobs-1481154202164
+ * ```
+ *
+ * @example To list submitted jobs
+ * ```javascript
+ * // This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.
+ * const input = {
+ *   "jobQueue": "HighPriority",
+ *   "jobStatus": "SUBMITTED"
+ * };
+ * const command = new ListJobsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "jobSummaryList": [
+ *     {
+ *       "jobId": "68f0c163-fbd4-44e6-9fd1-25b14a434786",
+ *       "jobName": "example"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-submitted-jobs-1481154251623
+ * ```
+ *
  */
 export declare class ListJobsCommand extends $Command<ListJobsCommandInput, ListJobsCommandOutput, BatchClientResolvedConfig> {
     readonly input: ListJobsCommandInput;

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -30,6 +30,26 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example ListTagsForResource Example
+ * ```javascript
+ * // This demonstrates calling the ListTagsForResource action.
+ * const input = {
+ *   "resourceArn": "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1"
+ * };
+ * const command = new ListTagsForResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "tags": {
+ *     "Department": "Engineering",
+ *     "Stage": "Alpha",
+ *     "User": "JaneDoe"
+ *   }
+ * }
+ * *\/
+ * // example id: listtagsforresource-example-1591293003710
+ * ```
+ *
  */
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, BatchClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;

package/dist-types/commands/RegisterJobDefinitionCommand.d.ts

@@ -29,6 +29,82 @@ export interface RegisterJobDefinitionCommandOutput extends RegisterJobDefinitio
  * @see {@link RegisterJobDefinitionCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To register a job definition
+ * ```javascript
+ * // This example registers a job definition for a simple container job.
+ * const input = {
+ *   "type": "container",
+ *   "containerProperties": {
+ *     "command": [
+ *       "sleep",
+ *       "10"
+ *     ],
+ *     "image": "busybox",
+ *     "resourceRequirements": [
+ *       {
+ *         "type": "MEMORY",
+ *         "value": "128"
+ *       },
+ *       {
+ *         "type": "VCPU",
+ *         "value": "1"
+ *       }
+ *     ]
+ *   },
+ *   "jobDefinitionName": "sleep10"
+ * };
+ * const command = new RegisterJobDefinitionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep10:1",
+ *   "jobDefinitionName": "sleep10",
+ *   "revision": 1
+ * }
+ * *\/
+ * // example id: to-register-a-job-definition-1481154325325
+ * ```
+ *
+ * @example RegisterJobDefinition with tags
+ * ```javascript
+ * // This demonstrates calling the RegisterJobDefinition action, including tags.
+ * const input = {
+ *   "type": "container",
+ *   "containerProperties": {
+ *     "command": [
+ *       "sleep",
+ *       "30"
+ *     ],
+ *     "image": "busybox",
+ *     "resourceRequirements": [
+ *       {
+ *         "type": "MEMORY",
+ *         "value": "128"
+ *       },
+ *       {
+ *         "type": "VCPU",
+ *         "value": "1"
+ *       }
+ *     ]
+ *   },
+ *   "jobDefinitionName": "sleep30",
+ *   "tags": {
+ *     "Department": "Engineering",
+ *     "User": "JaneDoe"
+ *   }
+ * };
+ * const command = new RegisterJobDefinitionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1",
+ *   "jobDefinitionName": "sleep30",
+ *   "revision": 1
+ * }
+ * *\/
+ * // example id: registerjobdefinition-with-tags-1591290509028
+ * ```
+ *
  */
 export declare class RegisterJobDefinitionCommand extends $Command<RegisterJobDefinitionCommandInput, RegisterJobDefinitionCommandOutput, BatchClientResolvedConfig> {
     readonly input: RegisterJobDefinitionCommandInput;

package/dist-types/commands/SubmitJobCommand.d.ts

@@ -41,6 +41,25 @@ export interface SubmitJobCommandOutput extends SubmitJobResponse, __MetadataBea
  * @see {@link SubmitJobCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To submit a job to a queue
+ * ```javascript
+ * // This example submits a simple container job called example to the HighPriority job queue.
+ * const input = {
+ *   "jobDefinition": "sleep60",
+ *   "jobName": "example",
+ *   "jobQueue": "HighPriority"
+ * };
+ * const command = new SubmitJobCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "jobId": "876da822-4198-45f2-a252-6cea32512ea8",
+ *   "jobName": "example"
+ * }
+ * *\/
+ * // example id: to-submit-a-job-to-a-queue-1481154481673
+ * ```
+ *
  */
 export declare class SubmitJobCommand extends $Command<SubmitJobCommandInput, SubmitJobCommandOutput, BatchClientResolvedConfig> {
     readonly input: SubmitJobCommandInput;

package/dist-types/commands/TagResourceCommand.d.ts

@@ -32,6 +32,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example TagResource Example
+ * ```javascript
+ * // This demonstrates calling the TagResource action.
+ * const input = {
+ *   "resourceArn": "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1",
+ *   "tags": {
+ *     "Stage": "Alpha"
+ *   }
+ * };
+ * const command = new TagResourceCommand(input);
+ * await client.send(command);
+ * // example id: tagresource-example-1591291959952
+ * ```
+ *
  */
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, BatchClientResolvedConfig> {
     readonly input: TagResourceCommandInput;

package/dist-types/commands/TerminateJobCommand.d.ts

@@ -31,6 +31,18 @@ export interface TerminateJobCommandOutput extends TerminateJobResponse, __Metad
  * @see {@link TerminateJobCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To terminate a job
+ * ```javascript
+ * // This example terminates a job with the specified job ID.
+ * const input = {
+ *   "jobId": "61e743ed-35e4-48da-b2de-5c8333821c84",
+ *   "reason": "Terminating job."
+ * };
+ * const command = new TerminateJobCommand(input);
+ * await client.send(command);
+ * // example id: to-terminate-a-job-1481154558276
+ * ```
+ *
  */
 export declare class TerminateJobCommand extends $Command<TerminateJobCommandInput, TerminateJobCommandOutput, BatchClientResolvedConfig> {
     readonly input: TerminateJobCommandInput;

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -29,6 +29,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example UntagResource Example
+ * ```javascript
+ * // This demonstrates calling the UntagResource action.
+ * const input = {
+ *   "resourceArn": "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1",
+ *   "tagKeys": [
+ *     "Stage"
+ *   ]
+ * };
+ * const command = new UntagResourceCommand(input);
+ * await client.send(command);
+ * // example id: untagresource-example-1591292811042
+ * ```
+ *
  */
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, BatchClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;

package/dist-types/commands/UpdateComputeEnvironmentCommand.d.ts

@@ -29,6 +29,24 @@ export interface UpdateComputeEnvironmentCommandOutput extends UpdateComputeEnvi
  * @see {@link UpdateComputeEnvironmentCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To update a compute environment
+ * ```javascript
+ * // This example disables the P2OnDemand compute environment so it can be deleted.
+ * const input = {
+ *   "computeEnvironment": "P2OnDemand",
+ *   "state": "DISABLED"
+ * };
+ * const command = new UpdateComputeEnvironmentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand",
+ *   "computeEnvironmentName": "P2OnDemand"
+ * }
+ * *\/
+ * // example id: to-update-a-compute-environment-1481154702731
+ * ```
+ *
  */
 export declare class UpdateComputeEnvironmentCommand extends $Command<UpdateComputeEnvironmentCommandInput, UpdateComputeEnvironmentCommandOutput, BatchClientResolvedConfig> {
     readonly input: UpdateComputeEnvironmentCommandInput;

package/dist-types/commands/UpdateJobQueueCommand.d.ts

@@ -29,6 +29,24 @@ export interface UpdateJobQueueCommandOutput extends UpdateJobQueueResponse, __M
  * @see {@link UpdateJobQueueCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
  *
+ * @example To update a job queue
+ * ```javascript
+ * // This example disables a job queue so that it can be deleted.
+ * const input = {
+ *   "jobQueue": "GPGPU",
+ *   "state": "DISABLED"
+ * };
+ * const command = new UpdateJobQueueCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU",
+ *   "jobQueueName": "GPGPU"
+ * }
+ * *\/
+ * // example id: to-update-a-job-queue-1481154806981
+ * ```
+ *
  */
 export declare class UpdateJobQueueCommand extends $Command<UpdateJobQueueCommandInput, UpdateJobQueueCommandOutput, BatchClientResolvedConfig> {
     readonly input: UpdateJobQueueCommandInput;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-batch",
   "description": "AWS SDK for JavaScript Batch Client for Node.js, Browser and React Native",
-  "version": "3.287.0",
+  "version": "3.289.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.287.0",
-    "@aws-sdk/config-resolver": "3.287.0",
-    "@aws-sdk/credential-provider-node": "3.287.0",
-    "@aws-sdk/fetch-http-handler": "3.282.0",
-    "@aws-sdk/hash-node": "3.272.0",
-    "@aws-sdk/invalid-dependency": "3.272.0",
-    "@aws-sdk/middleware-content-length": "3.282.0",
-    "@aws-sdk/middleware-endpoint": "3.282.0",
-    "@aws-sdk/middleware-host-header": "3.282.0",
-    "@aws-sdk/middleware-logger": "3.287.0",
-    "@aws-sdk/middleware-recursion-detection": "3.282.0",
-    "@aws-sdk/middleware-retry": "3.287.0",
-    "@aws-sdk/middleware-serde": "3.272.0",
-    "@aws-sdk/middleware-signing": "3.282.0",
-    "@aws-sdk/middleware-stack": "3.272.0",
-    "@aws-sdk/middleware-user-agent": "3.282.0",
-    "@aws-sdk/node-config-provider": "3.287.0",
-    "@aws-sdk/node-http-handler": "3.282.0",
-    "@aws-sdk/protocol-http": "3.282.0",
-    "@aws-sdk/smithy-client": "3.279.0",
-    "@aws-sdk/types": "3.272.0",
-    "@aws-sdk/url-parser": "3.272.0",
+    "@aws-sdk/client-sts": "3.289.0",
+    "@aws-sdk/config-resolver": "3.289.0",
+    "@aws-sdk/credential-provider-node": "3.289.0",
+    "@aws-sdk/fetch-http-handler": "3.289.0",
+    "@aws-sdk/hash-node": "3.289.0",
+    "@aws-sdk/invalid-dependency": "3.289.0",
+    "@aws-sdk/middleware-content-length": "3.289.0",
+    "@aws-sdk/middleware-endpoint": "3.289.0",
+    "@aws-sdk/middleware-host-header": "3.289.0",
+    "@aws-sdk/middleware-logger": "3.289.0",
+    "@aws-sdk/middleware-recursion-detection": "3.289.0",
+    "@aws-sdk/middleware-retry": "3.289.0",
+    "@aws-sdk/middleware-serde": "3.289.0",
+    "@aws-sdk/middleware-signing": "3.289.0",
+    "@aws-sdk/middleware-stack": "3.289.0",
+    "@aws-sdk/middleware-user-agent": "3.289.0",
+    "@aws-sdk/node-config-provider": "3.289.0",
+    "@aws-sdk/node-http-handler": "3.289.0",
+    "@aws-sdk/protocol-http": "3.289.0",
+    "@aws-sdk/smithy-client": "3.289.0",
+    "@aws-sdk/types": "3.289.0",
+    "@aws-sdk/url-parser": "3.289.0",
     "@aws-sdk/util-base64": "3.208.0",
     "@aws-sdk/util-body-length-browser": "3.188.0",
     "@aws-sdk/util-body-length-node": "3.208.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.279.0",
-    "@aws-sdk/util-defaults-mode-node": "3.287.0",
-    "@aws-sdk/util-endpoints": "3.272.0",
-    "@aws-sdk/util-retry": "3.272.0",
-    "@aws-sdk/util-user-agent-browser": "3.282.0",
-    "@aws-sdk/util-user-agent-node": "3.287.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.289.0",
+    "@aws-sdk/util-defaults-mode-node": "3.289.0",
+    "@aws-sdk/util-endpoints": "3.289.0",
+    "@aws-sdk/util-retry": "3.289.0",
+    "@aws-sdk/util-user-agent-browser": "3.289.0",
+    "@aws-sdk/util-user-agent-node": "3.289.0",
     "@aws-sdk/util-utf8": "3.254.0",
     "tslib": "^2.3.1"
   },