Skip to content

Commit a34551e

Browse files
authored
feat(clients): update clients as of 07/29/2021 (#2631)
* chore(models): update models as of 07/29/2021 * feat(clients): update clients as of 07/29/2021
1 parent 9b9a3a6 commit a34551e

File tree

484 files changed

+51511
-9525
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

484 files changed

+51511
-9525
lines changed

clients/client-batch/Batch.ts

+34-34
Original file line numberDiff line numberDiff line change
@@ -81,20 +81,21 @@ import {
8181
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
8282

8383
/**
84-
* <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
8687
* this computing workload to remove the undifferentiated heavy lifting of configuring and managing required
8788
* 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
8990
* 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
9192
* 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>
9495
*/
9596
export class Batch extends BatchClient {
9697
/**
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
9899
* <code>RUNNABLE</code> state are canceled. Jobs that have progressed to <code>STARTING</code> or <code>RUNNING</code>
99100
* aren't canceled, but the API operation still succeeds, even if no job is canceled. These jobs must be terminated with
100101
* the <a>TerminateJob</a> operation.</p>
@@ -123,31 +124,30 @@ export class Batch extends BatchClient {
123124
}
124125

125126
/**
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.
128129
* <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
130131
* 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
131132
* specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot
132133
* 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>
137136
* <note>
138137
* <p>Multi-node parallel jobs aren't supported on Spot Instances.</p>
139138
* </note>
140139
* <p>In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility
141140
* 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>
146146
* <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
148148
* doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible
149149
* 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
151151
* these steps:</p>
152152
* <ol>
153153
* <li>
@@ -195,9 +195,9 @@ export class Batch extends BatchClient {
195195
}
196196

197197
/**
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
199199
* 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
201201
* its associated compute environments. For example, if a compute environment is associated with more than one job
202202
* queue, the job queue with a higher priority is given preference for scheduling jobs to that compute
203203
* environment.</p>
@@ -232,8 +232,8 @@ export class Batch extends BatchClient {
232232
}
233233

234234
/**
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
237237
* active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute
238238
* environment enters an invalid state.</p>
239239
*/
@@ -302,7 +302,7 @@ export class Batch extends BatchClient {
302302
}
303303

304304
/**
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>
306306
*/
307307
public deregisterJobDefinition(
308308
args: DeregisterJobDefinitionCommandInput,
@@ -434,7 +434,7 @@ export class Batch extends BatchClient {
434434
}
435435

436436
/**
437-
* <p>Describes a list of AWS Batch jobs.</p>
437+
* <p>Describes a list of Batch jobs.</p>
438438
*/
439439
public describeJobs(
440440
args: DescribeJobsCommandInput,
@@ -463,7 +463,7 @@ export class Batch extends BatchClient {
463463
}
464464

465465
/**
466-
* <p>Returns a list of AWS Batch jobs.</p>
466+
* <p>Returns a list of Batch jobs.</p>
467467
* <p>You must specify only one of the following items:</p>
468468
* <ul>
469469
* <li>
@@ -503,7 +503,7 @@ export class Batch extends BatchClient {
503503
}
504504

505505
/**
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
507507
* queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.</p>
508508
*/
509509
public listTagsForResource(
@@ -536,7 +536,7 @@ export class Batch extends BatchClient {
536536
}
537537

538538
/**
539-
* <p>Registers an AWS Batch job definition.</p>
539+
* <p>Registers an Batch job definition.</p>
540540
*/
541541
public registerJobDefinition(
542542
args: RegisterJobDefinitionCommandInput,
@@ -568,7 +568,7 @@ export class Batch extends BatchClient {
568568
}
569569

570570
/**
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>
572572
* override parameters defined in the job definition. vCPU and memory requirements that are specified in the
573573
* <code>ResourceRequirements</code> objects in the job definition are the exception. They can't be overridden this way
574574
* 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 {
604604

605605
/**
606606
* <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
609609
* queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.</p>
610610
*/
611611
public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
@@ -663,7 +663,7 @@ export class Batch extends BatchClient {
663663
}
664664

665665
/**
666-
* <p>Deletes specified tags from an AWS Batch resource.</p>
666+
* <p>Deletes specified tags from an Batch resource.</p>
667667
*/
668668
public untagResource(
669669
args: UntagResourceCommandInput,
@@ -695,7 +695,7 @@ export class Batch extends BatchClient {
695695
}
696696

697697
/**
698-
* <p>Updates an AWS Batch compute environment.</p>
698+
* <p>Updates an Batch compute environment.</p>
699699
*/
700700
public updateComputeEnvironment(
701701
args: UpdateComputeEnvironmentCommandInput,

clients/client-batch/BatchClient.ts

+7-6
Original file line numberDiff line numberDiff line change
@@ -275,16 +275,17 @@ type BatchClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandler
275275
export interface BatchClientResolvedConfig extends BatchClientResolvedConfigType {}
276276

277277
/**
278-
* <p>Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing is a common means for
279-
* developers, scientists, and engineers to access large amounts of compute resources. AWS Batch uses the advantages of
278+
* <fullname>Batch</fullname>
279+
* <p>Using Batch, you can run batch computing workloads on the Cloud. Batch computing is a common means for
280+
* developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of
280281
* this computing workload to remove the undifferentiated heavy lifting of configuring and managing required
281282
* infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these
282-
* advantages, AWS Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively
283+
* advantages, Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively
283284
* helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.</p>
284-
* <p>As a fully managed service, AWS Batch can run batch computing workloads of any scale. AWS Batch automatically
285+
* <p>As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically
285286
* provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific
286-
* workloads. With AWS Batch, there's no need to install or manage batch computing software. This means that you can focus
287-
* your time and energy on analyzing results and solving your specific problems.</p>
287+
* workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus
288+
* your time and energy on analyzing results and solving your specific problems. </p>
288289
*/
289290
export class BatchClient extends __Client<
290291
__HttpHandlerOptions,

clients/client-batch/README.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,18 @@
77

88
AWS SDK for JavaScript Batch Client for Node.js, Browser and React Native.
99

10-
<p>Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing is a common means for
11-
developers, scientists, and engineers to access large amounts of compute resources. AWS Batch uses the advantages of
10+
<fullname>Batch</fullname>
11+
12+
<p>Using Batch, you can run batch computing workloads on the Cloud. Batch computing is a common means for
13+
developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of
1214
this computing workload to remove the undifferentiated heavy lifting of configuring and managing required
1315
infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these
14-
advantages, AWS Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively
16+
advantages, Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively
1517
helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.</p>
16-
<p>As a fully managed service, AWS Batch can run batch computing workloads of any scale. AWS Batch automatically
18+
<p>As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically
1719
provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific
18-
workloads. With AWS Batch, there's no need to install or manage batch computing software. This means that you can focus
19-
your time and energy on analyzing results and solving your specific problems.</p>
20+
workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus
21+
your time and energy on analyzing results and solving your specific problems. </p>
2022

2123
## Installing
2224

clients/client-batch/commands/CancelJobCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export interface CancelJobCommandInput extends CancelJobRequest {}
2121
export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBearer {}
2222

2323
/**
24-
* <p>Cancels a job in an AWS Batch job queue. Jobs that are in the <code>SUBMITTED</code>, <code>PENDING</code>, or
24+
* <p>Cancels a job in an Batch job queue. Jobs that are in the <code>SUBMITTED</code>, <code>PENDING</code>, or
2525
* <code>RUNNABLE</code> state are canceled. Jobs that have progressed to <code>STARTING</code> or <code>RUNNING</code>
2626
* aren't canceled, but the API operation still succeeds, even if no job is canceled. These jobs must be terminated with
2727
* the <a>TerminateJob</a> operation.</p>

0 commit comments

Comments
 (0)