You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* <p>Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing is a common means for
85
-
* developers, scientists, and engineers to access large amounts of compute resources. AWS Batch uses the advantages of
84
+
* <fullname>Batch</fullname>
85
+
* <p>Using Batch, you can run batch computing workloads on the Cloud. Batch computing is a common means for
86
+
* developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of
86
87
* this computing workload to remove the undifferentiated heavy lifting of configuring and managing required
87
88
* infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these
88
-
* advantages, AWS Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively
89
+
* advantages, Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively
89
90
* helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.</p>
90
-
* <p>As a fully managed service, AWS Batch can run batch computing workloads of any scale. AWS Batch automatically
91
+
* <p>As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically
91
92
* provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific
92
-
* workloads. With AWS Batch, there's no need to install or manage batch computing software. This means that you can focus
93
-
* your time and energy on analyzing results and solving your specific problems.</p>
93
+
* workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus
94
+
* your time and energy on analyzing results and solving your specific problems.</p>
94
95
*/
95
96
exportclassBatchextendsBatchClient{
96
97
/**
97
-
* <p>Cancels a job in an AWS Batch job queue. Jobs that are in the <code>SUBMITTED</code>, <code>PENDING</code>, or
98
+
* <p>Cancels a job in an Batch job queue. Jobs that are in the <code>SUBMITTED</code>, <code>PENDING</code>, or
98
99
* <code>RUNNABLE</code> state are canceled. Jobs that have progressed to <code>STARTING</code> or <code>RUNNING</code>
99
100
* aren't canceled, but the API operation still succeeds, even if no job is canceled. These jobs must be terminated with
100
101
* the <a>TerminateJob</a> operation.</p>
@@ -123,31 +124,30 @@ export class Batch extends BatchClient {
123
124
}
124
125
125
126
/**
126
-
* <p>Creates an AWS Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code> compute
127
-
* environments. <code>MANAGED</code> compute environments can use Amazon EC2 or AWS Fargate resources.
127
+
* <p>Creates an Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code> compute
128
+
* environments. <code>MANAGED</code> compute environments can use Amazon EC2 or Fargate resources.
128
129
* <code>UNMANAGED</code> compute environments can only use EC2 resources.</p>
129
-
* <p>In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources
130
+
* <p>In a managed compute environment, Batch manages the capacity and instance types of the compute resources
130
131
* within the environment. This is based on the compute resource specification that you define or the <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html">launch template</a> that you
131
132
* specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot
132
133
* Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can
133
-
* optionally set a maximum price so that Spot Instances only launch
134
-
* when
135
-
* the Spot Instance price is less than a specified percentage of the On-Demand price.</p>
136
-
*
134
+
* optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a
135
+
* specified percentage of the On-Demand price.</p>
137
136
* <note>
138
137
* <p>Multi-node parallel jobs aren't supported on Spot Instances.</p>
139
138
* </note>
140
139
* <p>In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility
141
140
* with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that
142
-
* each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html">container instance AMIs</a> in the
143
-
* <i>Amazon Elastic Container Service Developer Guide</i>. After you created your unmanaged compute environment, you can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster that's associated with it. Then, launch
144
-
* your container instances into that Amazon ECS cluster. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html">Launching an Amazon ECS container instance</a> in the
145
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
141
+
* each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html">container instance
142
+
* AMIs</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. After you created your unmanaged compute environment, you
143
+
* can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster that's associated with
144
+
* it. Then, launch your container instances into that Amazon ECS cluster. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html">Launching an Amazon ECS
145
+
* container instance</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
146
146
* <note>
147
-
* <p>AWS Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it
147
+
* <p>Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it
148
148
* doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible
149
149
* for managing the guest operating system (including its updates and security patches) and any additional application
150
-
* software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete
150
+
* software or utilities that you install on the compute resources. To use a new AMI for your Batch jobs, complete
151
151
* these steps:</p>
152
152
* <ol>
153
153
* <li>
@@ -195,9 +195,9 @@ export class Batch extends BatchClient {
195
195
}
196
196
197
197
/**
198
-
* <p>Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the
198
+
* <p>Creates an Batch job queue. When you create a job queue, you associate one or more compute environments to the
199
199
* queue and assign an order of preference for the compute environments.</p>
200
-
* <p>You also set a priority to the job queue that determines the order that the AWS Batch scheduler places jobs onto
200
+
* <p>You also set a priority to the job queue that determines the order that the Batch scheduler places jobs onto
201
201
* its associated compute environments. For example, if a compute environment is associated with more than one job
202
202
* queue, the job queue with a higher priority is given preference for scheduling jobs to that compute
203
203
* environment.</p>
@@ -232,8 +232,8 @@ export class Batch extends BatchClient {
232
232
}
233
233
234
234
/**
235
-
* <p>Deletes an AWS Batch compute environment.</p>
236
-
* <p>Before you can delete a compute environment, you must set its state to <code>DISABLED</code> with the <a>UpdateComputeEnvironment</a> API operation and disassociate it from any job queues with the <a>UpdateJobQueue</a> API operation. Compute environments that use AWS Fargate resources must terminate all
235
+
* <p>Deletes an Batch compute environment.</p>
236
+
* <p>Before you can delete a compute environment, you must set its state to <code>DISABLED</code> with the <a>UpdateComputeEnvironment</a> API operation and disassociate it from any job queues with the <a>UpdateJobQueue</a> API operation. Compute environments that use Fargate resources must terminate all
237
237
* active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute
238
238
* environment enters an invalid state.</p>
239
239
*/
@@ -302,7 +302,7 @@ export class Batch extends BatchClient {
302
302
}
303
303
304
304
/**
305
-
* <p>Deregisters an AWS Batch job definition. Job definitions are permanently deleted after 180 days.</p>
305
+
* <p>Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.</p>
306
306
*/
307
307
publicderegisterJobDefinition(
308
308
args: DeregisterJobDefinitionCommandInput,
@@ -434,7 +434,7 @@ export class Batch extends BatchClient {
434
434
}
435
435
436
436
/**
437
-
* <p>Describes a list of AWS Batch jobs.</p>
437
+
* <p>Describes a list of Batch jobs.</p>
438
438
*/
439
439
publicdescribeJobs(
440
440
args: DescribeJobsCommandInput,
@@ -463,7 +463,7 @@ export class Batch extends BatchClient {
463
463
}
464
464
465
465
/**
466
-
* <p>Returns a list of AWS Batch jobs.</p>
466
+
* <p>Returns a list of Batch jobs.</p>
467
467
* <p>You must specify only one of the following items:</p>
468
468
* <ul>
469
469
* <li>
@@ -503,7 +503,7 @@ export class Batch extends BatchClient {
503
503
}
504
504
505
505
/**
506
-
* <p>Lists the tags for an AWS Batch resource. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job
506
+
* <p>Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, and job
507
507
* queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.</p>
508
508
*/
509
509
publiclistTagsForResource(
@@ -536,7 +536,7 @@ export class Batch extends BatchClient {
536
536
}
537
537
538
538
/**
539
-
* <p>Registers an AWS Batch job definition.</p>
539
+
* <p>Registers an Batch job definition.</p>
540
540
*/
541
541
publicregisterJobDefinition(
542
542
args: RegisterJobDefinitionCommandInput,
@@ -568,7 +568,7 @@ export class Batch extends BatchClient {
568
568
}
569
569
570
570
/**
571
-
* <p>Submits an AWS Batch job from a job definition. Parameters that are specified during <a>SubmitJob</a>
571
+
* <p>Submits an Batch job from a job definition. Parameters that are specified during <a>SubmitJob</a>
572
572
* override parameters defined in the job definition. vCPU and memory requirements that are specified in the
573
573
* <code>ResourceRequirements</code> objects in the job definition are the exception. They can't be overridden this way
574
574
* using the <code>memory</code> and <code>vcpus</code> parameters. Rather, you must specify updates to job definition
@@ -604,8 +604,8 @@ export class Batch extends BatchClient {
604
604
605
605
/**
606
606
* <p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a
607
-
* resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags
608
-
* associated with that resource are deleted as well. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job
607
+
* resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that
608
+
* are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, and job
609
609
* queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.</p>
0 commit comments