Skip to content

Commit

Permalink
feat(clients): update clients as of 07/29/2021 (#2631)
Browse files Browse the repository at this point in the history 
* chore(models): update models as of 07/29/2021

* feat(clients): update clients as of 07/29/2021
  • Loading branch information
@AllanZhengYP
AllanZhengYP committed Jul 29, 2021
1 parent 9b9a3a6 commit a34551e
Show file tree
Hide file tree
Showing 484 changed files with 51,511 additions and 9,525 deletions.
68 changes: 34 additions & 34 deletions clients/client-batch/Batch.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,20 +81,21 @@ import {
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";

/**
* <p>Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing is a common means for
* developers, scientists, and engineers to access large amounts of compute resources. AWS Batch uses the advantages of
* <fullname>Batch</fullname>
* <p>Using Batch, you can run batch computing workloads on the Cloud. Batch computing is a common means for
* developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of
* this computing workload to remove the undifferentiated heavy lifting of configuring and managing required
* infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these
* advantages, AWS Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively
* advantages, Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively
* helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.</p>
* <p>As a fully managed service, AWS Batch can run batch computing workloads of any scale. AWS Batch automatically
* <p>As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically
* provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific
* workloads. With AWS Batch, there's no need to install or manage batch computing software. This means that you can focus
* your time and energy on analyzing results and solving your specific problems.</p>
* workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus
* your time and energy on analyzing results and solving your specific problems. </p>
*/
export class Batch extends BatchClient {
/**
* <p>Cancels a job in an AWS Batch job queue. Jobs that are in the <code>SUBMITTED</code>, <code>PENDING</code>, or
* <p>Cancels a job in an Batch job queue. Jobs that are in the <code>SUBMITTED</code>, <code>PENDING</code>, or
* <code>RUNNABLE</code> state are canceled. Jobs that have progressed to <code>STARTING</code> or <code>RUNNING</code>
* aren't canceled, but the API operation still succeeds, even if no job is canceled. These jobs must be terminated with
* the <a>TerminateJob</a> operation.</p>
Expand Down Expand Up @@ -123,31 +124,30 @@ export class Batch extends BatchClient {
}

/**
* <p>Creates an AWS Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code> compute
* environments. <code>MANAGED</code> compute environments can use Amazon EC2 or AWS Fargate resources.
* <p>Creates an Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code> compute
* environments. <code>MANAGED</code> compute environments can use Amazon EC2 or Fargate resources.
* <code>UNMANAGED</code> compute environments can only use EC2 resources.</p>
* <p>In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources
* <p>In a managed compute environment, Batch manages the capacity and instance types of the compute resources
* within the environment. This is based on the compute resource specification that you define or the <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html">launch template</a> that you
* specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot
* Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can
* optionally set a maximum price so that Spot Instances only launch
* when
* the Spot Instance price is less than a specified percentage of the On-Demand price.</p>
*
* optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a
* specified percentage of the On-Demand price.</p>
* <note>
* <p>Multi-node parallel jobs aren't supported on Spot Instances.</p>
* </note>
* <p>In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility
* with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that
* each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html">container instance AMIs</a> in the
* <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
* 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
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
* 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 <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 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 <i>Amazon Elastic Container Service Developer Guide</i>.</p>
* <note>
* <p>AWS Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it
* <p>Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it
* doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible
* for managing the guest operating system (including its updates and security patches) and any additional application
* software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete
* software or utilities that you install on the compute resources. To use a new AMI for your Batch jobs, complete
* these steps:</p>
* <ol>
* <li>
Expand Down Expand Up @@ -195,9 +195,9 @@ export class Batch extends BatchClient {
}

/**
* <p>Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the
* <p>Creates an Batch job queue. When you create a job queue, you associate one or more compute environments to the
* queue and assign an order of preference for the compute environments.</p>
* <p>You also set a priority to the job queue that determines the order that the AWS Batch scheduler places jobs onto
* <p>You also set a priority to the job queue that determines the order that the Batch scheduler places jobs onto
* its associated compute environments. For example, if a compute environment is associated with more than one job
* queue, the job queue with a higher priority is given preference for scheduling jobs to that compute
* environment.</p>
Expand Down Expand Up @@ -232,8 +232,8 @@ export class Batch extends BatchClient {
}

/**
* <p>Deletes an AWS Batch compute environment.</p>
* <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
* <p>Deletes an Batch compute environment.</p>
* <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
* active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute
* environment enters an invalid state.</p>
*/
Expand Down Expand Up @@ -302,7 +302,7 @@ export class Batch extends BatchClient {
}

/**
* <p>Deregisters an AWS Batch job definition. Job definitions are permanently deleted after 180 days.</p>
* <p>Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.</p>
*/
public deregisterJobDefinition(
args: DeregisterJobDefinitionCommandInput,
Expand Down Expand Up @@ -434,7 +434,7 @@ export class Batch extends BatchClient {
}

/**
* <p>Describes a list of AWS Batch jobs.</p>
* <p>Describes a list of Batch jobs.</p>
*/
public describeJobs(
args: DescribeJobsCommandInput,
Expand Down Expand Up @@ -463,7 +463,7 @@ export class Batch extends BatchClient {
}

/**
* <p>Returns a list of AWS Batch jobs.</p>
* <p>Returns a list of Batch jobs.</p>
* <p>You must specify only one of the following items:</p>
* <ul>
* <li>
Expand Down Expand Up @@ -503,7 +503,7 @@ export class Batch extends BatchClient {
}

/**
* <p>Lists the tags for an AWS Batch resource. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job
* <p>Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, and job
* queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.</p>
*/
public listTagsForResource(
Expand Down Expand Up @@ -536,7 +536,7 @@ export class Batch extends BatchClient {
}

/**
* <p>Registers an AWS Batch job definition.</p>
* <p>Registers an Batch job definition.</p>
*/
public registerJobDefinition(
args: RegisterJobDefinitionCommandInput,
Expand Down Expand Up @@ -568,7 +568,7 @@ export class Batch extends BatchClient {
}

/**
* <p>Submits an AWS Batch job from a job definition. Parameters that are specified during <a>SubmitJob</a>
* <p>Submits an Batch job from a job definition. Parameters that are specified during <a>SubmitJob</a>
* override parameters defined in the job definition. vCPU and memory requirements that are specified in the
* <code>ResourceRequirements</code> objects in the job definition are the exception. They can't be overridden this way
* using the <code>memory</code> and <code>vcpus</code> parameters. Rather, you must specify updates to job definition
Expand Down Expand Up @@ -604,8 +604,8 @@ export class Batch extends BatchClient {

/**
* <p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a
* resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags
* associated with that resource are deleted as well. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job
* resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that
* are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, and job
* queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.</p>
*/
public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
Expand Down Expand Up @@ -663,7 +663,7 @@ export class Batch extends BatchClient {
}

/**
* <p>Deletes specified tags from an AWS Batch resource.</p>
* <p>Deletes specified tags from an Batch resource.</p>
*/
public untagResource(
args: UntagResourceCommandInput,
Expand Down Expand Up @@ -695,7 +695,7 @@ export class Batch extends BatchClient {
}

/**
* <p>Updates an AWS Batch compute environment.</p>
* <p>Updates an Batch compute environment.</p>
*/
public updateComputeEnvironment(
args: UpdateComputeEnvironmentCommandInput,
Expand Down
13 changes: 7 additions & 6 deletions clients/client-batch/BatchClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -275,16 +275,17 @@ type BatchClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandler
export interface BatchClientResolvedConfig extends BatchClientResolvedConfigType {}

/**
* <p>Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing is a common means for
* developers, scientists, and engineers to access large amounts of compute resources. AWS Batch uses the advantages of
* <fullname>Batch</fullname>
* <p>Using Batch, you can run batch computing workloads on the Cloud. Batch computing is a common means for
* developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of
* this computing workload to remove the undifferentiated heavy lifting of configuring and managing required
* infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these
* advantages, AWS Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively
* advantages, Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively
* helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.</p>
* <p>As a fully managed service, AWS Batch can run batch computing workloads of any scale. AWS Batch automatically
* <p>As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically
* provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific
* workloads. With AWS Batch, there's no need to install or manage batch computing software. This means that you can focus
* your time and energy on analyzing results and solving your specific problems.</p>
* workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus
* your time and energy on analyzing results and solving your specific problems. </p>
*/
export class BatchClient extends __Client<
__HttpHandlerOptions,
Expand Down
14 changes: 8 additions & 6 deletions clients/client-batch/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,18 @@

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

<p>Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing is a common means for
developers, scientists, and engineers to access large amounts of compute resources. AWS Batch uses the advantages of
<fullname>Batch</fullname>

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

## Installing

Expand Down
2 changes: 1 addition & 1 deletion clients/client-batch/commands/CancelJobCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export interface CancelJobCommandInput extends CancelJobRequest {}
export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBearer {}

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

0 comments on commit a34551e

Please sign in to comment.