@aws-sdk/client-batch 3.750.0 → 3.757.0

package/dist-types/models/models_0.d.ts

@@ -986,6 +986,59 @@ export interface CreateComputeEnvironmentResponse {
      */
     computeEnvironmentArn?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface CreateConsumableResourceRequest {
+    /**
+     * <p>The name of the consumable resource. Must be unique.</p>
+     * @public
+     */
+    consumableResourceName: string | undefined;
+    /**
+     * <p>The total amount of the consumable resource that is available. Must be non-negative.</p>
+     * @public
+     */
+    totalQuantity?: number | undefined;
+    /**
+     * <p>Indicates whether the resource is available to be re-used after a job completes. Can be
+     *             one of: </p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>REPLENISHABLE</code> (default)</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>NON_REPLENISHABLE</code>
+     *                </p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    resourceType?: string | undefined;
+    /**
+     * <p>The tags that you apply to the consumable resource to help you categorize and organize your
+     *             resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>
+     * @public
+     */
+    tags?: Record<string, string> | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateConsumableResourceResponse {
+    /**
+     * <p>The name of the consumable resource.</p>
+     * @public
+     */
+    consumableResourceName: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the consumable resource.</p>
+     * @public
+     */
+    consumableResourceArn: string | undefined;
+}
 /**
  * <p>The order that compute environments are tried in for job placement within a queue. Compute
  *    environments are tried in ascending order. For example, if two compute environments are
@@ -1293,6 +1346,21 @@ export interface DeleteComputeEnvironmentRequest {
  */
 export interface DeleteComputeEnvironmentResponse {
 }
+/**
+ * @public
+ */
+export interface DeleteConsumableResourceRequest {
+    /**
+     * <p>The name or ARN of the consumable resource that will be deleted.</p>
+     * @public
+     */
+    consumableResource: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteConsumableResourceResponse {
+}
 /**
  * <p>Contains the parameters for <code>DeleteJobQueue</code>.</p>
  * @public
@@ -1561,6 +1629,75 @@ export interface DescribeComputeEnvironmentsResponse {
      */
     nextToken?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface DescribeConsumableResourceRequest {
+    /**
+     * <p>The name or ARN of the consumable resource whose description will be returned.</p>
+     * @public
+     */
+    consumableResource: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DescribeConsumableResourceResponse {
+    /**
+     * <p>The name of the consumable resource.</p>
+     * @public
+     */
+    consumableResourceName: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the consumable resource.</p>
+     * @public
+     */
+    consumableResourceArn: string | undefined;
+    /**
+     * <p>The total amount of the consumable resource that is available.</p>
+     * @public
+     */
+    totalQuantity?: number | undefined;
+    /**
+     * <p>The amount of the consumable resource that is currently in use.</p>
+     * @public
+     */
+    inUseQuantity?: number | undefined;
+    /**
+     * <p>The amount of the consumable resource that is currently available to use.</p>
+     * @public
+     */
+    availableQuantity?: number | undefined;
+    /**
+     * <p>Indicates whether the resource is available to be re-used after a job completes. Can be
+     *             one of: </p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>REPLENISHABLE</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>NON_REPLENISHABLE</code>
+     *                </p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    resourceType?: string | undefined;
+    /**
+     * <p>The Unix timestamp (in milliseconds) for when the consumable resource was created.</p>
+     * @public
+     */
+    createdAt?: number | undefined;
+    /**
+     * <p>The tags that you apply to the consumable resource to help you categorize and organize your
+     *             resources. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>
+     * @public
+     */
+    tags?: Record<string, string> | undefined;
+}
 /**
  * <p>Contains the parameters for <code>DescribeJobDefinitions</code>.</p>
  * @public
@@ -1611,6 +1748,33 @@ export interface DescribeJobDefinitionsRequest {
      */
     nextToken?: string | undefined;
 }
+/**
+ * <p>Information about a consumable resource required to run a job.</p>
+ * @public
+ */
+export interface ConsumableResourceRequirement {
+    /**
+     * <p>The name or ARN of the consumable resource.</p>
+     * @public
+     */
+    consumableResource?: string | undefined;
+    /**
+     * <p>The quantity of the consumable resource that is needed.</p>
+     * @public
+     */
+    quantity?: number | undefined;
+}
+/**
+ * <p>Contains a list of consumable resources required by a job.</p>
+ * @public
+ */
+export interface ConsumableResourceProperties {
+    /**
+     * <p>The list of consumable resources required by a job.</p>
+     * @public
+     */
+    consumableResourceList?: ConsumableResourceRequirement[] | undefined;
+}
 /**
  * <p>A key-value pair object.</p>
  * @public
@@ -3722,6 +3886,11 @@ export interface NodeRangeProperty {
      * @public
      */
     eksProperties?: EksProperties | undefined;
+    /**
+     * <p>Contains a list of consumable resources required by a job.</p>
+     * @public
+     */
+    consumableResourceProperties?: ConsumableResourceProperties | undefined;
 }
 /**
  * <p>An object that represents the node properties of a multi-node parallel job.</p>
@@ -3974,6 +4143,11 @@ export interface JobDefinition {
      * @public
      */
     containerOrchestrationType?: OrchestrationType | undefined;
+    /**
+     * <p>Contains a list of consumable resources required by the job.</p>
+     * @public
+     */
+    consumableResourceProperties?: ConsumableResourceProperties | undefined;
 }
 /**
  * @public
@@ -5259,6 +5433,11 @@ export interface JobDetail {
      * @public
      */
     isTerminated?: boolean | undefined;
+    /**
+     * <p>Contains a list of consumable resources required by the job.</p>
+     * @public
+     */
+    consumableResourceProperties?: ConsumableResourceProperties | undefined;
 }
 /**
  * @public
@@ -5375,7 +5554,7 @@ export interface GetJobQueueSnapshotResponse {
 }
 /**
  * <p>A filter name and value pair that's used to return a more specific list of results from a
- *     <code>ListJobs</code> API operation.</p>
+ *     <code>ListJobs</code> or <code>ListJobsByConsumableResource</code> API operation.</p>
  * @public
  */
 export interface KeyValuesPair {
@@ -5390,6 +5569,113 @@ export interface KeyValuesPair {
      */
     values?: string[] | undefined;
 }
+/**
+ * @public
+ */
+export interface ListConsumableResourcesRequest {
+    /**
+     * <p>The filters to apply to the consumable resource list query. If used, only those consumable
+     *             resources that match the filter are listed. Filter names and values can be:</p>
+     *          <ul>
+     *             <li>
+     *                <p>name: <code>CONSUMABLE_RESOURCE_NAME </code>
+     *                </p>
+     *                <p>values: case-insensitive matches for the consumable resource name. If a filter
+     *                     value ends with an asterisk (*), it matches any consumable resource name that begins
+     *                     with the string before the '*'.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    filters?: KeyValuesPair[] | undefined;
+    /**
+     * <p>The maximum number of results returned by <code>ListConsumableResources</code> in paginated
+     *             output. When this parameter is used, <code>ListConsumableResources</code> only returns
+     *             <code>maxResults</code> results in a single page and a <code>nextToken</code> response
+     *             element. The remaining results of the initial request can be seen by sending another
+     *             <code>ListConsumableResources</code> request with the returned <code>nextToken</code> value.
+     *             This value can be between 1 and 100. If this parameter isn't
+     *             used, then <code>ListConsumableResources</code> returns up to 100 results and
+     *             a <code>nextToken</code> value if applicable.</p>
+     * @public
+     */
+    maxResults?: number | undefined;
+    /**
+     * <p>The <code>nextToken</code> value returned from a previous paginated
+     *             <code>ListConsumableResources</code> request where <code>maxResults</code> was used and the
+     *             results exceeded the value of that parameter. Pagination continues from the end of the previous
+     *             results that returned the <code>nextToken</code> value. This value is <code>null</code> when
+     *             there are no more results to return.</p>
+     *          <note>
+     *             <p>Treat this token as an opaque identifier that's only used to
+     *  retrieve the next items in a list and not for other programmatic purposes.</p>
+     *          </note>
+     * @public
+     */
+    nextToken?: string | undefined;
+}
+/**
+ * <p>Current information about a consumable resource.</p>
+ * @public
+ */
+export interface ConsumableResourceSummary {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the consumable resource.</p>
+     * @public
+     */
+    consumableResourceArn: string | undefined;
+    /**
+     * <p>The name of the consumable resource.</p>
+     * @public
+     */
+    consumableResourceName: string | undefined;
+    /**
+     * <p>The total amount of the consumable resource that is available.</p>
+     * @public
+     */
+    totalQuantity?: number | undefined;
+    /**
+     * <p>The amount of the consumable resource that is currently in use.</p>
+     * @public
+     */
+    inUseQuantity?: number | undefined;
+    /**
+     * <p>Indicates whether the resource is available to be re-used after a job completes. Can be
+     *             one of: </p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>REPLENISHABLE</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>NON_REPLENISHABLE</code>
+     *                </p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    resourceType?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListConsumableResourcesResponse {
+    /**
+     * <p>A list of consumable resources that match the request.</p>
+     * @public
+     */
+    consumableResources: ConsumableResourceSummary[] | undefined;
+    /**
+     * <p>The <code>nextToken</code> value to include in a future <code>ListConsumableResources</code>
+     *             request. When the results of a <code>ListConsumableResources</code> request exceed <code>maxResults</code>,
+     *             this value can be used to retrieve the next page of results. This value is <code>null</code>
+     *             when there are no more results to return.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+}
 /**
  * <p>Contains the parameters for <code>ListJobs</code>.</p>
  * @public
@@ -5638,6 +5924,180 @@ export interface ListJobsResponse {
      */
     nextToken?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface ListJobsByConsumableResourceRequest {
+    /**
+     * <p>The name or ARN of the consumable resource.</p>
+     * @public
+     */
+    consumableResource: string | undefined;
+    /**
+     * <p>The filters to apply to the job list query. If used, only those jobs requiring the specified
+     *             consumable resource (<code>consumableResource</code>) and that match the value of the filters
+     *             are listed. The filter names and values can be:</p>
+     *          <ul>
+     *             <li>
+     *                <p>name: <code>JOB_STATUS</code>
+     *                </p>
+     *                <p>values: <code>SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>name: <code>JOB_NAME </code>
+     *                </p>
+     *                <p>The values are case-insensitive matches for the job name. If a filter value ends
+     *                     with an asterisk (*), it matches any job name that begins with the string before
+     *                     the '*'.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    filters?: KeyValuesPair[] | undefined;
+    /**
+     * <p>The maximum number of results returned by <code>ListJobsByConsumableResource</code> in paginated
+     *             output. When this parameter is used, <code>ListJobsByConsumableResource</code> only returns
+     *             <code>maxResults</code> results in a single page and a <code>nextToken</code> response
+     *             element. The remaining results of the initial request can be seen by sending another
+     *             <code>ListJobsByConsumableResource</code> request with the returned <code>nextToken</code> value.
+     *             This value can be between 1 and 100. If this parameter isn't
+     *             used, then <code>ListJobsByConsumableResource</code> returns up to 100 results
+     *             and a <code>nextToken</code> value if applicable.</p>
+     * @public
+     */
+    maxResults?: number | undefined;
+    /**
+     * <p>The <code>nextToken</code> value returned from a previous paginated
+     *             <code>ListJobsByConsumableResource</code> request where <code>maxResults</code> was used and the
+     *             results exceeded the value of that parameter. Pagination continues from the end of the previous
+     *             results that returned the <code>nextToken</code> value. This value is <code>null</code> when
+     *             there are no more results to return.</p>
+     *          <note>
+     *             <p>Treat this token as an opaque identifier that's only used to
+     *  retrieve the next items in a list and not for other programmatic purposes.</p>
+     *          </note>
+     * @public
+     */
+    nextToken?: string | undefined;
+}
+/**
+ * <p>Current information about a consumable resource required by a job.</p>
+ * @public
+ */
+export interface ListJobsByConsumableResourceSummary {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the job.</p>
+     * @public
+     */
+    jobArn: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the job queue.</p>
+     * @public
+     */
+    jobQueueArn: string | undefined;
+    /**
+     * <p>The name of the job.</p>
+     * @public
+     */
+    jobName: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the job definition.</p>
+     * @public
+     */
+    jobDefinitionArn?: string | undefined;
+    /**
+     * <p>The fair-share scheduling policy identifier for the job.</p>
+     * @public
+     */
+    shareIdentifier?: string | undefined;
+    /**
+     * <p>The status of the job. Can be one of:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>SUBMITTED</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>PENDING</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>RUNNABLE</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>STARTING</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>RUNNING</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>SUCCEEDED</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>FAILED</code>
+     *                </p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    jobStatus: string | undefined;
+    /**
+     * <p>The total amount of the consumable resource that is available.</p>
+     * @public
+     */
+    quantity: number | undefined;
+    /**
+     * <p>A short, human-readable string to provide more details for the current status of the job.</p>
+     * @public
+     */
+    statusReason?: string | undefined;
+    /**
+     * <p>The Unix timestamp for when the job was started. More specifically, it's when the job transitioned
+     *             from the <code>STARTING</code> state to the <code>RUNNING</code> state.</p>
+     * @public
+     */
+    startedAt?: number | undefined;
+    /**
+     * <p>The Unix timestamp (in milliseconds) for when the consumable resource was created.</p>
+     * @public
+     */
+    createdAt: number | undefined;
+    /**
+     * <p>Contains a list of consumable resources required by the job.</p>
+     * @public
+     */
+    consumableResourceProperties: ConsumableResourceProperties | undefined;
+}
+/**
+ * @public
+ */
+export interface ListJobsByConsumableResourceResponse {
+    /**
+     * <p>The list of jobs that require the specified consumable resources.</p>
+     * @public
+     */
+    jobs: ListJobsByConsumableResourceSummary[] | undefined;
+    /**
+     * <p>The <code>nextToken</code> value to include in a future <code>ListJobsByConsumableResource</code>
+     *             request. When the results of a <code>ListJobsByConsumableResource</code> request exceed
+     *             <code>maxResults</code>, this value can be used to retrieve the next page of results. This
+     *             value is <code>null</code> when there are no more results to return.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+}
 /**
  * <p>Contains the parameters for <code>ListSchedulingPolicies</code>.</p>
  * @public
@@ -5865,6 +6325,11 @@ export interface RegisterJobDefinitionRequest {
      * @public
      */
     ecsProperties?: EcsProperties | undefined;
+    /**
+     * <p>Contains a list of consumable resources required by the job.</p>
+     * @public
+     */
+    consumableResourceProperties?: ConsumableResourceProperties | undefined;
 }
 /**
  * @public
@@ -6153,6 +6618,11 @@ export interface NodePropertyOverride {
      * @public
      */
     eksPropertiesOverride?: EksPropertiesOverride | undefined;
+    /**
+     * <p>An object that contains overrides for the consumable resources of a job.</p>
+     * @public
+     */
+    consumableResourcePropertiesOverride?: ConsumableResourceProperties | undefined;
 }
 /**
  * <p>An object that represents any node overrides to a job definition that's used in a <a href="https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html">SubmitJob</a> API
@@ -6330,6 +6800,11 @@ export interface SubmitJobRequest {
      * @public
      */
     ecsPropertiesOverride?: EcsPropertiesOverride | undefined;
+    /**
+     * <p>An object that contains overrides for the consumable resources of a job.</p>
+     * @public
+     */
+    consumableResourcePropertiesOverride?: ConsumableResourceProperties | undefined;
 }
 /**
  * @public
@@ -6852,6 +7327,80 @@ export interface UpdateComputeEnvironmentResponse {
      */
     computeEnvironmentArn?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface UpdateConsumableResourceRequest {
+    /**
+     * <p>The name or ARN of the consumable resource to be updated.</p>
+     * @public
+     */
+    consumableResource: string | undefined;
+    /**
+     * <p>Indicates how the quantity of the consumable resource will be updated. Must be one of:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>SET</code>
+     *                </p>
+     *                <p>Sets the quantity of the resource to the value specified by the <code>quantity</code>
+     *                     parameter.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>ADD</code>
+     *                </p>
+     *                <p>Increases the quantity of the resource by the value specified by the <code>quantity</code>
+     *                     parameter.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>REMOVE</code>
+     *                </p>
+     *                <p>Reduces the quantity of the resource by the value specified by the <code>quantity</code>
+     *                     parameter.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    operation?: string | undefined;
+    /**
+     * <p>The change in the total quantity of the consumable resource. The <code>operation</code>
+     *             parameter determines whether the value specified here will be the new total quantity, or
+     *             the amount by which the total quantity will be increased or reduced. Must be a non-negative
+     *             value.</p>
+     * @public
+     */
+    quantity?: number | undefined;
+    /**
+     * <p>If this parameter is specified and two update requests with identical payloads and
+     *           <code>clientToken</code>s are received, these requests are considered the same request and
+     *           the second request is rejected. A <code>clientToken</code> is valid for 8 hours or until
+     *           one hour after the consumable resource is deleted, whichever is less.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateConsumableResourceResponse {
+    /**
+     * <p>The name of the consumable resource to be updated.</p>
+     * @public
+     */
+    consumableResourceName: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the consumable resource.</p>
+     * @public
+     */
+    consumableResourceArn: string | undefined;
+    /**
+     * <p>The total amount of the consumable resource that is available.</p>
+     * @public
+     */
+    totalQuantity?: number | undefined;
+}
 /**
  * <p>Contains the parameters for <code>UpdateJobQueue</code>.</p>
  * @public

package/dist-types/pagination/ListConsumableResourcesPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListConsumableResourcesCommandInput, ListConsumableResourcesCommandOutput } from "../commands/ListConsumableResourcesCommand";
+import { BatchPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListConsumableResources: (config: BatchPaginationConfiguration, input: ListConsumableResourcesCommandInput, ...rest: any[]) => Paginator<ListConsumableResourcesCommandOutput>;

package/dist-types/pagination/ListJobsByConsumableResourcePaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListJobsByConsumableResourceCommandInput, ListJobsByConsumableResourceCommandOutput } from "../commands/ListJobsByConsumableResourceCommand";
+import { BatchPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListJobsByConsumableResource: (config: BatchPaginationConfiguration, input: ListJobsByConsumableResourceCommandInput, ...rest: any[]) => Paginator<ListJobsByConsumableResourceCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -2,5 +2,7 @@ export * from "./DescribeComputeEnvironmentsPaginator";
 export * from "./DescribeJobDefinitionsPaginator";
 export * from "./DescribeJobQueuesPaginator";
 export * from "./Interfaces";
+export * from "./ListConsumableResourcesPaginator";
+export * from "./ListJobsByConsumableResourcePaginator";
 export * from "./ListJobsPaginator";
 export * from "./ListSchedulingPoliciesPaginator";