@aws-sdk/client-batch 3.296.0 → 3.298.0

package/dist-types/Batch.d.ts

@@ -25,6 +25,7 @@ import { UpdateComputeEnvironmentCommandInput, UpdateComputeEnvironmentCommandOu
 import { UpdateJobQueueCommandInput, UpdateJobQueueCommandOutput } from "./commands/UpdateJobQueueCommand";
 import { UpdateSchedulingPolicyCommandInput, UpdateSchedulingPolicyCommandOutput } from "./commands/UpdateSchedulingPolicyCommand";
 /**
+ * @public
  * <fullname>Batch</fullname>
  *          <p>Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for
  *    developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of
@@ -39,15 +40,26 @@ import { UpdateSchedulingPolicyCommandInput, UpdateSchedulingPolicyCommandOutput
  */
 export declare class Batch extends BatchClient {
     /**
-     * <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 progressed to the <code>STARTING</code> or <code>RUNNING</code>
-     *    state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be
-     *    terminated with the <a>TerminateJob</a> operation.</p>
+     * @public
+     * <p>Cancels a job in an Batch job queue. Jobs that are in the
+     *       <code>SUBMITTED</code>
+     *       or
+     *         <code>PENDING</code>
+     *       are
+     *       canceled. A job
+     *         in<code>RUNNABLE</code> remains in <code>RUNNABLE</code> until it reaches the head of the
+     *       job queue. Then the job status is updated to
+     *       <code>FAILED</code>.</p>
+     *          <p>Jobs that progressed to the <code>STARTING</code> or
+     *         <code>RUNNING</code> state aren't canceled. However, the API operation still succeeds, even
+     *       if no job is canceled. These jobs must be terminated with the <a>TerminateJob</a>
+     *       operation.</p>
      */
     cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise<CancelJobCommandOutput>;
     cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void;
     cancelJob(args: CancelJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelJobCommandOutput) => void): void;
     /**
+     * @public
      * <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>
@@ -132,6 +144,7 @@ export declare class Batch extends BatchClient {
     createComputeEnvironment(args: CreateComputeEnvironmentCommandInput, cb: (err: any, data?: CreateComputeEnvironmentCommandOutput) => void): void;
     createComputeEnvironment(args: CreateComputeEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateComputeEnvironmentCommandOutput) => void): void;
     /**
+     * @public
      * <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 Batch scheduler places jobs onto
@@ -143,12 +156,14 @@ export declare class Batch extends BatchClient {
     createJobQueue(args: CreateJobQueueCommandInput, cb: (err: any, data?: CreateJobQueueCommandOutput) => void): void;
     createJobQueue(args: CreateJobQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobQueueCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates an Batch scheduling policy.</p>
      */
     createSchedulingPolicy(args: CreateSchedulingPolicyCommandInput, options?: __HttpHandlerOptions): Promise<CreateSchedulingPolicyCommandOutput>;
     createSchedulingPolicy(args: CreateSchedulingPolicyCommandInput, cb: (err: any, data?: CreateSchedulingPolicyCommandOutput) => void): void;
     createSchedulingPolicy(args: CreateSchedulingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSchedulingPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -158,6 +173,7 @@ export declare class Batch extends BatchClient {
     deleteComputeEnvironment(args: DeleteComputeEnvironmentCommandInput, cb: (err: any, data?: DeleteComputeEnvironmentCommandOutput) => void): void;
     deleteComputeEnvironment(args: DeleteComputeEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteComputeEnvironmentCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified job queue. You must first disable submissions for a queue with the <a>UpdateJobQueue</a> operation. All jobs in the queue are eventually terminated when you delete a job queue.
      *    The jobs are terminated at a rate of about 16 jobs each second.</p>
      *          <p>It's not necessary to disassociate compute environments from a queue before submitting a
@@ -167,6 +183,7 @@ export declare class Batch extends BatchClient {
     deleteJobQueue(args: DeleteJobQueueCommandInput, cb: (err: any, data?: DeleteJobQueueCommandOutput) => void): void;
     deleteJobQueue(args: DeleteJobQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteJobQueueCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified scheduling policy.</p>
      *          <p>You can't delete a scheduling policy that's used in any job queues.</p>
      */
@@ -174,12 +191,14 @@ export declare class Batch extends BatchClient {
     deleteSchedulingPolicy(args: DeleteSchedulingPolicyCommandInput, cb: (err: any, data?: DeleteSchedulingPolicyCommandOutput) => void): void;
     deleteSchedulingPolicy(args: DeleteSchedulingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSchedulingPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.</p>
      */
     deregisterJobDefinition(args: DeregisterJobDefinitionCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterJobDefinitionCommandOutput>;
     deregisterJobDefinition(args: DeregisterJobDefinitionCommandInput, cb: (err: any, data?: DeregisterJobDefinitionCommandOutput) => void): void;
     deregisterJobDefinition(args: DeregisterJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterJobDefinitionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes one or more of your compute environments.</p>
      *          <p>If you're using an unmanaged compute environment, you can use the <code>DescribeComputeEnvironment</code>
      *    operation to determine the <code>ecsClusterArn</code> that you launch your Amazon ECS container instances
@@ -189,6 +208,7 @@ export declare class Batch extends BatchClient {
     describeComputeEnvironments(args: DescribeComputeEnvironmentsCommandInput, cb: (err: any, data?: DescribeComputeEnvironmentsCommandOutput) => void): void;
     describeComputeEnvironments(args: DescribeComputeEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeComputeEnvironmentsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes a list of job definitions. You can specify a <code>status</code> (such as <code>ACTIVE</code>) to only
      *    return job definitions that match that status.</p>
      */
@@ -196,24 +216,28 @@ export declare class Batch extends BatchClient {
     describeJobDefinitions(args: DescribeJobDefinitionsCommandInput, cb: (err: any, data?: DescribeJobDefinitionsCommandOutput) => void): void;
     describeJobDefinitions(args: DescribeJobDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobDefinitionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes one or more of your job queues.</p>
      */
     describeJobQueues(args: DescribeJobQueuesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeJobQueuesCommandOutput>;
     describeJobQueues(args: DescribeJobQueuesCommandInput, cb: (err: any, data?: DescribeJobQueuesCommandOutput) => void): void;
     describeJobQueues(args: DescribeJobQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobQueuesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes a list of Batch jobs.</p>
      */
     describeJobs(args: DescribeJobsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeJobsCommandOutput>;
     describeJobs(args: DescribeJobsCommandInput, cb: (err: any, data?: DescribeJobsCommandOutput) => void): void;
     describeJobs(args: DescribeJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes one or more of your scheduling policies.</p>
      */
     describeSchedulingPolicies(args: DescribeSchedulingPoliciesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSchedulingPoliciesCommandOutput>;
     describeSchedulingPolicies(args: DescribeSchedulingPoliciesCommandInput, cb: (err: any, data?: DescribeSchedulingPoliciesCommandOutput) => void): void;
     describeSchedulingPolicies(args: DescribeSchedulingPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSchedulingPoliciesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns a list of Batch jobs.</p>
      *          <p>You must specify only one of the following items:</p>
      *          <ul>
@@ -234,12 +258,14 @@ export declare class Batch extends BatchClient {
     listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void;
     listJobs(args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns a list of Batch scheduling policies.</p>
      */
     listSchedulingPolicies(args: ListSchedulingPoliciesCommandInput, options?: __HttpHandlerOptions): Promise<ListSchedulingPoliciesCommandOutput>;
     listSchedulingPolicies(args: ListSchedulingPoliciesCommandInput, cb: (err: any, data?: ListSchedulingPoliciesCommandOutput) => void): void;
     listSchedulingPolicies(args: ListSchedulingPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSchedulingPoliciesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues,
      *  and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.</p>
      */
@@ -247,12 +273,14 @@ export declare class Batch extends BatchClient {
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Registers an Batch job definition.</p>
      */
     registerJobDefinition(args: RegisterJobDefinitionCommandInput, options?: __HttpHandlerOptions): Promise<RegisterJobDefinitionCommandOutput>;
     registerJobDefinition(args: RegisterJobDefinitionCommandInput, cb: (err: any, data?: RegisterJobDefinitionCommandOutput) => void): void;
     registerJobDefinition(args: RegisterJobDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterJobDefinitionCommandOutput) => void): void;
     /**
+     * @public
      * <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
@@ -271,6 +299,7 @@ export declare class Batch extends BatchClient {
     submitJob(args: SubmitJobCommandInput, cb: (err: any, data?: SubmitJobCommandOutput) => void): void;
     submitJob(args: SubmitJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubmitJobCommandOutput) => void): void;
     /**
+     * @public
      * <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 that
      *    are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues,
@@ -280,6 +309,7 @@ export declare class Batch extends BatchClient {
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Terminates a job in a job queue. Jobs that are in the <code>STARTING</code> or <code>RUNNING</code> state are
      *    terminated, which causes them to transition to <code>FAILED</code>. Jobs that have not progressed to the
      *     <code>STARTING</code> state are cancelled.</p>
@@ -288,24 +318,28 @@ export declare class Batch extends BatchClient {
     terminateJob(args: TerminateJobCommandInput, cb: (err: any, data?: TerminateJobCommandOutput) => void): void;
     terminateJob(args: TerminateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TerminateJobCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes specified tags from an Batch resource.</p>
      */
     untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates an Batch compute environment.</p>
      */
     updateComputeEnvironment(args: UpdateComputeEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<UpdateComputeEnvironmentCommandOutput>;
     updateComputeEnvironment(args: UpdateComputeEnvironmentCommandInput, cb: (err: any, data?: UpdateComputeEnvironmentCommandOutput) => void): void;
     updateComputeEnvironment(args: UpdateComputeEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateComputeEnvironmentCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates a job queue.</p>
      */
     updateJobQueue(args: UpdateJobQueueCommandInput, options?: __HttpHandlerOptions): Promise<UpdateJobQueueCommandOutput>;
     updateJobQueue(args: UpdateJobQueueCommandInput, cb: (err: any, data?: UpdateJobQueueCommandOutput) => void): void;
     updateJobQueue(args: UpdateJobQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobQueueCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates a scheduling policy.</p>
      */
     updateSchedulingPolicy(args: UpdateSchedulingPolicyCommandInput, options?: __HttpHandlerOptions): Promise<UpdateSchedulingPolicyCommandOutput>;

package/dist-types/BatchClient.d.ts

@@ -32,15 +32,24 @@ import { UpdateComputeEnvironmentCommandInput, UpdateComputeEnvironmentCommandOu
 import { UpdateJobQueueCommandInput, UpdateJobQueueCommandOutput } from "./commands/UpdateJobQueueCommand";
 import { UpdateSchedulingPolicyCommandInput, UpdateSchedulingPolicyCommandOutput } from "./commands/UpdateSchedulingPolicyCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = CancelJobCommandInput | CreateComputeEnvironmentCommandInput | CreateJobQueueCommandInput | CreateSchedulingPolicyCommandInput | DeleteComputeEnvironmentCommandInput | DeleteJobQueueCommandInput | DeleteSchedulingPolicyCommandInput | DeregisterJobDefinitionCommandInput | DescribeComputeEnvironmentsCommandInput | DescribeJobDefinitionsCommandInput | DescribeJobQueuesCommandInput | DescribeJobsCommandInput | DescribeSchedulingPoliciesCommandInput | ListJobsCommandInput | ListSchedulingPoliciesCommandInput | ListTagsForResourceCommandInput | RegisterJobDefinitionCommandInput | SubmitJobCommandInput | TagResourceCommandInput | TerminateJobCommandInput | UntagResourceCommandInput | UpdateComputeEnvironmentCommandInput | UpdateJobQueueCommandInput | UpdateSchedulingPolicyCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = CancelJobCommandOutput | CreateComputeEnvironmentCommandOutput | CreateJobQueueCommandOutput | CreateSchedulingPolicyCommandOutput | DeleteComputeEnvironmentCommandOutput | DeleteJobQueueCommandOutput | DeleteSchedulingPolicyCommandOutput | DeregisterJobDefinitionCommandOutput | DescribeComputeEnvironmentsCommandOutput | DescribeJobDefinitionsCommandOutput | DescribeJobQueuesCommandOutput | DescribeJobsCommandOutput | DescribeSchedulingPoliciesCommandOutput | ListJobsCommandOutput | ListSchedulingPoliciesCommandOutput | ListTagsForResourceCommandOutput | RegisterJobDefinitionCommandOutput | SubmitJobCommandOutput | TagResourceCommandOutput | TerminateJobCommandOutput | UntagResourceCommandOutput | UpdateComputeEnvironmentCommandOutput | UpdateJobQueueCommandOutput | UpdateSchedulingPolicyCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -130,23 +139,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type BatchClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of BatchClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of BatchClient class constructor that set the region, credentials and other options.
  */
 export interface BatchClientConfig extends BatchClientConfigType {
 }
+/**
+ * @public
+ */
 type BatchClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of BatchClient class. This is resolved and normalized from the {@link BatchClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of BatchClient class. This is resolved and normalized from the {@link BatchClientConfig | constructor configuration interface}.
  */
 export interface BatchClientResolvedConfig extends BatchClientResolvedConfigType {
 }
 /**
+ * @public
  * <fullname>Batch</fullname>
  *          <p>Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for
  *    developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of

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

@@ -4,20 +4,34 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
 import { CancelJobRequest, CancelJobResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CancelJobCommand}.
  */
 export interface CancelJobCommandInput extends CancelJobRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CancelJobCommand}.
  */
 export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBearer {
 }
 /**
- * <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 progressed to the <code>STARTING</code> or <code>RUNNING</code>
- *    state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be
- *    terminated with the <a>TerminateJob</a> operation.</p>
+ * @public
+ * <p>Cancels a job in an Batch job queue. Jobs that are in the
+ *       <code>SUBMITTED</code>
+ *       or
+ *         <code>PENDING</code>
+ *       are
+ *       canceled. A job
+ *         in<code>RUNNABLE</code> remains in <code>RUNNABLE</code> until it reaches the head of the
+ *       job queue. Then the job status is updated to
+ *       <code>FAILED</code>.</p>
+ *          <p>Jobs that progressed to the <code>STARTING</code> or
+ *         <code>RUNNING</code> state aren't canceled. However, the API operation still succeeds, even
+ *       if no job is canceled. These jobs must be terminated with the <a>TerminateJob</a>
+ *       operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -28,6 +42,8 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea
  * const response = await client.send(command);
  * ```
  *
+ * @param CancelJobCommandInput - {@link CancelJobCommandInput}
+ * @returns {@link CancelJobCommandOutput}
  * @see {@link CancelJobCommandInput} for command's `input` shape.
  * @see {@link CancelJobCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -57,11 +73,20 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea
 export declare class CancelJobCommand extends $Command<CancelJobCommandInput, CancelJobCommandOutput, BatchClientResolvedConfig> {
     readonly input: CancelJobCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CancelJobCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelJobCommandInput, CancelJobCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
 import { CreateComputeEnvironmentRequest, CreateComputeEnvironmentResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateComputeEnvironmentCommand}.
  */
 export interface CreateComputeEnvironmentCommandInput extends CreateComputeEnvironmentRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateComputeEnvironmentCommand}.
  */
 export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvironmentResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
@@ -103,6 +108,8 @@ export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvi
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateComputeEnvironmentCommandInput - {@link CreateComputeEnvironmentCommandInput}
+ * @returns {@link CreateComputeEnvironmentCommandOutput}
  * @see {@link CreateComputeEnvironmentCommandInput} for command's `input` shape.
  * @see {@link CreateComputeEnvironmentCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -210,11 +217,20 @@ export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvi
 export declare class CreateComputeEnvironmentCommand extends $Command<CreateComputeEnvironmentCommandInput, CreateComputeEnvironmentCommandOutput, BatchClientResolvedConfig> {
     readonly input: CreateComputeEnvironmentCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateComputeEnvironmentCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateComputeEnvironmentCommandInput, CreateComputeEnvironmentCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
 import { CreateJobQueueRequest, CreateJobQueueResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateJobQueueCommand}.
  */
 export interface CreateJobQueueCommandInput extends CreateJobQueueRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateJobQueueCommand}.
  */
 export interface CreateJobQueueCommandOutput extends CreateJobQueueResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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 Batch scheduler places jobs onto
@@ -30,6 +35,8 @@ export interface CreateJobQueueCommandOutput extends CreateJobQueueResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateJobQueueCommandInput - {@link CreateJobQueueCommandInput}
+ * @returns {@link CreateJobQueueCommandOutput}
  * @see {@link CreateJobQueueCommandInput} for command's `input` shape.
  * @see {@link CreateJobQueueCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -101,11 +108,20 @@ export interface CreateJobQueueCommandOutput extends CreateJobQueueResponse, __M
 export declare class CreateJobQueueCommand extends $Command<CreateJobQueueCommandInput, CreateJobQueueCommandOutput, BatchClientResolvedConfig> {
     readonly input: CreateJobQueueCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateJobQueueCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateJobQueueCommandInput, CreateJobQueueCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
 import { CreateSchedulingPolicyRequest, CreateSchedulingPolicyResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateSchedulingPolicyCommand}.
  */
 export interface CreateSchedulingPolicyCommandInput extends CreateSchedulingPolicyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateSchedulingPolicyCommand}.
  */
 export interface CreateSchedulingPolicyCommandOutput extends CreateSchedulingPolicyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates an Batch scheduling policy.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateSchedulingPolicyCommandOutput extends CreateSchedulingPol
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateSchedulingPolicyCommandInput - {@link CreateSchedulingPolicyCommandInput}
+ * @returns {@link CreateSchedulingPolicyCommandOutput}
  * @see {@link CreateSchedulingPolicyCommandInput} for command's `input` shape.
  * @see {@link CreateSchedulingPolicyCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -42,11 +49,20 @@ export interface CreateSchedulingPolicyCommandOutput extends CreateSchedulingPol
 export declare class CreateSchedulingPolicyCommand extends $Command<CreateSchedulingPolicyCommandInput, CreateSchedulingPolicyCommandOutput, BatchClientResolvedConfig> {
     readonly input: CreateSchedulingPolicyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateSchedulingPolicyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSchedulingPolicyCommandInput, CreateSchedulingPolicyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
 import { DeleteComputeEnvironmentRequest, DeleteComputeEnvironmentResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DeleteComputeEnvironmentCommand}.
  */
 export interface DeleteComputeEnvironmentCommandInput extends DeleteComputeEnvironmentRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeleteComputeEnvironmentCommand}.
  */
 export interface DeleteComputeEnvironmentCommandOutput extends DeleteComputeEnvironmentResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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
@@ -28,6 +33,8 @@ export interface DeleteComputeEnvironmentCommandOutput extends DeleteComputeEnvi
  * const response = await client.send(command);
  * ```
  *
+ * @param DeleteComputeEnvironmentCommandInput - {@link DeleteComputeEnvironmentCommandInput}
+ * @returns {@link DeleteComputeEnvironmentCommandOutput}
  * @see {@link DeleteComputeEnvironmentCommandInput} for command's `input` shape.
  * @see {@link DeleteComputeEnvironmentCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -56,11 +63,20 @@ export interface DeleteComputeEnvironmentCommandOutput extends DeleteComputeEnvi
 export declare class DeleteComputeEnvironmentCommand extends $Command<DeleteComputeEnvironmentCommandInput, DeleteComputeEnvironmentCommandOutput, BatchClientResolvedConfig> {
     readonly input: DeleteComputeEnvironmentCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeleteComputeEnvironmentCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteComputeEnvironmentCommandInput, DeleteComputeEnvironmentCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
 import { DeleteJobQueueRequest, DeleteJobQueueResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DeleteJobQueueCommand}.
  */
 export interface DeleteJobQueueCommandInput extends DeleteJobQueueRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeleteJobQueueCommand}.
  */
 export interface DeleteJobQueueCommandOutput extends DeleteJobQueueResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes the specified job queue. You must first disable submissions for a queue with the <a>UpdateJobQueue</a> operation. All jobs in the queue are eventually terminated when you delete a job queue.
  *    The jobs are terminated at a rate of about 16 jobs each second.</p>
  *          <p>It's not necessary to disassociate compute environments from a queue before submitting a
@@ -28,6 +33,8 @@ export interface DeleteJobQueueCommandOutput extends DeleteJobQueueResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param DeleteJobQueueCommandInput - {@link DeleteJobQueueCommandInput}
+ * @returns {@link DeleteJobQueueCommandOutput}
  * @see {@link DeleteJobQueueCommandInput} for command's `input` shape.
  * @see {@link DeleteJobQueueCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -56,11 +63,20 @@ export interface DeleteJobQueueCommandOutput extends DeleteJobQueueResponse, __M
 export declare class DeleteJobQueueCommand extends $Command<DeleteJobQueueCommandInput, DeleteJobQueueCommandOutput, BatchClientResolvedConfig> {
     readonly input: DeleteJobQueueCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeleteJobQueueCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteJobQueueCommandInput, DeleteJobQueueCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { BatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BatchClient";
 import { DeleteSchedulingPolicyRequest, DeleteSchedulingPolicyResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DeleteSchedulingPolicyCommand}.
  */
 export interface DeleteSchedulingPolicyCommandInput extends DeleteSchedulingPolicyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeleteSchedulingPolicyCommand}.
  */
 export interface DeleteSchedulingPolicyCommandOutput extends DeleteSchedulingPolicyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes the specified scheduling policy.</p>
  *          <p>You can't delete a scheduling policy that's used in any job queues.</p>
  * @example
@@ -26,6 +31,8 @@ export interface DeleteSchedulingPolicyCommandOutput extends DeleteSchedulingPol
  * const response = await client.send(command);
  * ```
  *
+ * @param DeleteSchedulingPolicyCommandInput - {@link DeleteSchedulingPolicyCommandInput}
+ * @returns {@link DeleteSchedulingPolicyCommandOutput}
  * @see {@link DeleteSchedulingPolicyCommandInput} for command's `input` shape.
  * @see {@link DeleteSchedulingPolicyCommandOutput} for command's `response` shape.
  * @see {@link BatchClientResolvedConfig | config} for BatchClient's `config` shape.
@@ -43,11 +50,20 @@ export interface DeleteSchedulingPolicyCommandOutput extends DeleteSchedulingPol
 export declare class DeleteSchedulingPolicyCommand extends $Command<DeleteSchedulingPolicyCommandInput, DeleteSchedulingPolicyCommandOutput, BatchClientResolvedConfig> {
     readonly input: DeleteSchedulingPolicyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeleteSchedulingPolicyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSchedulingPolicyCommandInput, DeleteSchedulingPolicyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }