@aws-sdk/client-deadline 3.734.0 → 3.737.0

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

@@ -1,4 +1,333 @@
-import { ComparisonOperator, DateTimeFilterExpression, DefaultQueueBudgetAction, EnvironmentTemplateType, FileSystemLocation, HostPropertiesResponse, JobAttachmentSettings, JobLifecycleStatus, JobParameter, JobRunAsUser, JobTargetTaskRunStatus, ParameterSpace, QueueBlockedReason, QueueMember, QueueStatus, StepLifecycleStatus, StepTargetTaskRunStatus, StorageProfileOperatingSystemFamily, StorageProfileSummary, TaskParameterValue, TaskRunStatus, TaskTargetRunStatus, WorkerStatus } from "./models_0";
+import { ComparisonOperator, DateTimeFilterExpression, DeadlinePrincipalType, DefaultQueueBudgetAction, EnvironmentTemplateType, FileSystemLocation, HostPropertiesResponse, JobAttachmentSettings, JobLifecycleStatus, JobParameter, JobRunAsUser, JobTargetTaskRunStatus, MembershipLevel, ParameterSpace, QueueBlockedReason, QueueStatus, SessionLifecycleTargetStatus, StepLifecycleStatus, StepTargetTaskRunStatus, StorageProfileOperatingSystemFamily, StorageProfileSummary, TaskParameterValue, TaskRunStatus, TaskTargetRunStatus, WorkerStatus } from "./models_0";
+/**
+ * @public
+ * @enum
+ */
+export declare const UpdateJobLifecycleStatus: {
+    readonly ARCHIVED: "ARCHIVED";
+};
+/**
+ * @public
+ */
+export type UpdateJobLifecycleStatus = (typeof UpdateJobLifecycleStatus)[keyof typeof UpdateJobLifecycleStatus];
+/**
+ * @public
+ */
+export interface UpdateJobRequest {
+    /**
+     * <p>The unique token which the server uses to recognize retries of the same request.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+    /**
+     * <p>The task status to update the job's tasks to.</p>
+     * @public
+     */
+    targetTaskRunStatus?: JobTargetTaskRunStatus | undefined;
+    /**
+     * <p>The job priority to update.</p>
+     * @public
+     */
+    priority?: number | undefined;
+    /**
+     * <p>The number of task failures before the job stops running and is marked as <code>FAILED</code>.</p>
+     * @public
+     */
+    maxFailedTasksCount?: number | undefined;
+    /**
+     * <p>The maximum number of retries for a job.</p>
+     * @public
+     */
+    maxRetriesPerTask?: number | undefined;
+    /**
+     * <p>The status of a job in its lifecycle. When you change the status of the job to
+     *             <code>ARCHIVED</code>, the job can't be scheduled or archived.</p>
+     *          <important>
+     *             <p>An archived jobs and its steps and tasks are deleted after 120 days. The job can't be
+     *             recovered.</p>
+     *          </important>
+     * @public
+     */
+    lifecycleStatus?: UpdateJobLifecycleStatus | undefined;
+    /**
+     * <p>The maximum number of worker hosts that can concurrently process a job. When the
+     *             <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the
+     *          job, even if the fleets assigned to the job's queue has available workers.</p>
+     *          <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no
+     *          maximum number of workers.</p>
+     *          <p>If you don't specify the <code>maxWorkerCount</code>, the default is -1.</p>
+     *          <p>The maximum number of workers that can process tasks in the job.</p>
+     * @public
+     */
+    maxWorkerCount?: number | undefined;
+    /**
+     * <p>The farm ID of the job to update.</p>
+     * @public
+     */
+    farmId: string | undefined;
+    /**
+     * <p>The queue ID of the job to update.</p>
+     * @public
+     */
+    queueId: string | undefined;
+    /**
+     * <p>The job ID to update.</p>
+     * @public
+     */
+    jobId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateJobResponse {
+}
+/**
+ * @public
+ */
+export interface UpdateSessionRequest {
+    /**
+     * <p>The unique token which the server uses to recognize retries of the same request.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+    /**
+     * <p>The life cycle status to update in the session.</p>
+     * @public
+     */
+    targetLifecycleStatus: SessionLifecycleTargetStatus | undefined;
+    /**
+     * <p>The farm ID to update in the session.</p>
+     * @public
+     */
+    farmId: string | undefined;
+    /**
+     * <p>The queue ID to update in the session.</p>
+     * @public
+     */
+    queueId: string | undefined;
+    /**
+     * <p>The job ID to update in the session.</p>
+     * @public
+     */
+    jobId: string | undefined;
+    /**
+     * <p>The session ID to update.</p>
+     * @public
+     */
+    sessionId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateSessionResponse {
+}
+/**
+ * @public
+ */
+export interface UpdateStepRequest {
+    /**
+     * <p>The task status to update the step's tasks to.</p>
+     * @public
+     */
+    targetTaskRunStatus: StepTargetTaskRunStatus | undefined;
+    /**
+     * <p>The unique token which the server uses to recognize retries of the same request.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+    /**
+     * <p>The farm ID to update.</p>
+     * @public
+     */
+    farmId: string | undefined;
+    /**
+     * <p>The queue ID to update.</p>
+     * @public
+     */
+    queueId: string | undefined;
+    /**
+     * <p>The job ID to update.</p>
+     * @public
+     */
+    jobId: string | undefined;
+    /**
+     * <p>The step ID to update.</p>
+     * @public
+     */
+    stepId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateStepResponse {
+}
+/**
+ * @public
+ */
+export interface UpdateTaskRequest {
+    /**
+     * <p>The unique token which the server uses to recognize retries of the same request.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+    /**
+     * <p>The run status with which to start the task.</p>
+     * @public
+     */
+    targetRunStatus: TaskTargetRunStatus | undefined;
+    /**
+     * <p>The farm ID to update.</p>
+     * @public
+     */
+    farmId: string | undefined;
+    /**
+     * <p>The queue ID to update.</p>
+     * @public
+     */
+    queueId: string | undefined;
+    /**
+     * <p>The job ID to update.</p>
+     * @public
+     */
+    jobId: string | undefined;
+    /**
+     * <p>The step ID to update.</p>
+     * @public
+     */
+    stepId: string | undefined;
+    /**
+     * <p>The task ID to update.</p>
+     * @public
+     */
+    taskId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateTaskResponse {
+}
+/**
+ * @public
+ */
+export interface ListQueueEnvironmentsRequest {
+    /**
+     * <p>The farm ID for the queue environment list.</p>
+     * @public
+     */
+    farmId: string | undefined;
+    /**
+     * <p>The queue ID for the queue environment list.</p>
+     * @public
+     */
+    queueId: string | undefined;
+    /**
+     * <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+    /**
+     * <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
+     * @public
+     */
+    maxResults?: number | undefined;
+}
+/**
+ * <p>The summary of a queue environment.</p>
+ * @public
+ */
+export interface QueueEnvironmentSummary {
+    /**
+     * <p>The queue environment ID.</p>
+     * @public
+     */
+    queueEnvironmentId: string | undefined;
+    /**
+     * <p>The name of the queue environment.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The queue environment's priority.</p>
+     * @public
+     */
+    priority: number | undefined;
+}
+/**
+ * @public
+ */
+export interface ListQueueEnvironmentsResponse {
+    /**
+     * <p>The environments to include in the queue environments list.</p>
+     * @public
+     */
+    environments: QueueEnvironmentSummary[] | undefined;
+    /**
+     * <p>If Deadline Cloud returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 <code>ValidationException</code> error.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListQueueMembersRequest {
+    /**
+     * <p>The farm ID for the queue.</p>
+     * @public
+     */
+    farmId: string | undefined;
+    /**
+     * <p>The queue ID to include on the list.</p>
+     * @public
+     */
+    queueId: string | undefined;
+    /**
+     * <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+    /**
+     * <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
+     * @public
+     */
+    maxResults?: number | undefined;
+}
+/**
+ * <p>The details of a queue member.</p>
+ * @public
+ */
+export interface QueueMember {
+    /**
+     * <p>The farm ID.</p>
+     * @public
+     */
+    farmId: string | undefined;
+    /**
+     * <p>The queue ID.</p>
+     * @public
+     */
+    queueId: string | undefined;
+    /**
+     * <p>The principal ID of the queue member.</p>
+     * @public
+     */
+    principalId: string | undefined;
+    /**
+     * <p>The principal type of the queue member.</p>
+     * @public
+     */
+    principalType: DeadlinePrincipalType | undefined;
+    /**
+     * <p>The identity store ID.</p>
+     * @public
+     */
+    identityStoreId: string | undefined;
+    /**
+     * <p>The queue member's membership level.</p>
+     * @public
+     */
+    membershipLevel: MembershipLevel | undefined;
+}
 /**
  * @public
  */
@@ -331,6 +660,54 @@ export interface UpdateFarmRequest {
  */
 export interface UpdateFarmResponse {
 }
+/**
+ * @public
+ */
+export interface UpdateLimitRequest {
+    /**
+     * <p>The unique identifier of the farm that contains the limit.</p>
+     * @public
+     */
+    farmId: string | undefined;
+    /**
+     * <p>The unique identifier of the limit to update.</p>
+     * @public
+     */
+    limitId: string | undefined;
+    /**
+     * <p>The new display name of the limit.</p>
+     *          <important>
+     *             <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
+     *          </important>
+     * @public
+     */
+    displayName?: string | undefined;
+    /**
+     * <p>The new description of the limit.</p>
+     *          <important>
+     *             <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p>
+     *          </important>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>The maximum number of resources constrained by this limit. When all of the resources are
+     *          in use, steps that require the limit won't be scheduled until the resource is
+     *          available.</p>
+     *          <p>If more than the new maximum number is currently in use, running jobs finish but no new
+     *          jobs are started until the number of resources in use is below the new maximum
+     *          number.</p>
+     *          <p>The <code>maxCount</code> must not be 0. If the value is -1, there is no restriction on
+     *          the number of resources that can be acquired for this limit.</p>
+     * @public
+     */
+    maxCount?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateLimitResponse {
+}
 /**
  * @public
  */
@@ -453,6 +830,80 @@ export interface GetQueueFleetAssociationResponse {
      */
     updatedBy?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface GetQueueLimitAssociationRequest {
+    /**
+     * <p>The unique identifier of the farm that contains the associated queue and limit.</p>
+     * @public
+     */
+    farmId: string | undefined;
+    /**
+     * <p>The unique identifier of the queue associated with the limit.</p>
+     * @public
+     */
+    queueId: string | undefined;
+    /**
+     * <p>The unique identifier of the limit associated with the queue.</p>
+     * @public
+     */
+    limitId: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const QueueLimitAssociationStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly STOPPED: "STOPPED";
+    readonly STOP_LIMIT_USAGE_AND_CANCEL_TASKS: "STOP_LIMIT_USAGE_AND_CANCEL_TASKS";
+    readonly STOP_LIMIT_USAGE_AND_COMPLETE_TASKS: "STOP_LIMIT_USAGE_AND_COMPLETE_TASKS";
+};
+/**
+ * @public
+ */
+export type QueueLimitAssociationStatus = (typeof QueueLimitAssociationStatus)[keyof typeof QueueLimitAssociationStatus];
+/**
+ * @public
+ */
+export interface GetQueueLimitAssociationResponse {
+    /**
+     * <p>The Unix timestamp of the date and time that the association was created.</p>
+     * @public
+     */
+    createdAt: Date | undefined;
+    /**
+     * <p>The user identifier of the person that created the association.</p>
+     * @public
+     */
+    createdBy: string | undefined;
+    /**
+     * <p>The Unix timestamp of the date and time that the association was last updated.</p>
+     * @public
+     */
+    updatedAt?: Date | undefined;
+    /**
+     * <p>The user identifier of the person that last updated the association.</p>
+     * @public
+     */
+    updatedBy?: string | undefined;
+    /**
+     * <p>The unique identifier of the queue associated with the limit.</p>
+     * @public
+     */
+    queueId: string | undefined;
+    /**
+     * <p>The unique identifier of the limit associated with the queue.</p>
+     * @public
+     */
+    limitId: string | undefined;
+    /**
+     * <p>The current status of the limit.</p>
+     * @public
+     */
+    status: QueueLimitAssociationStatus | undefined;
+}
 /**
  * @public
  */
@@ -1009,6 +1460,117 @@ export interface ListQueueFleetAssociationsResponse {
      */
     nextToken?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface ListQueueLimitAssociationsRequest {
+    /**
+     * <p>The unique identifier of the farm that contains the limits and associations.</p>
+     * @public
+     */
+    farmId: string | undefined;
+    /**
+     * <p>Specifies that the operation should return only the queue limit associations for the
+     *          specified queue. If you specify both the <code>queueId</code> and the <code>limitId</code>,
+     *          only the specified limit is returned if it exists.</p>
+     * @public
+     */
+    queueId?: string | undefined;
+    /**
+     * <p>Specifies that the operation should return only the queue limit associations for the
+     *          specified limit. If you specify both the <code>queueId</code> and the <code>limitId</code>,
+     *          only the specified limit is returned if it exists.</p>
+     * @public
+     */
+    limitId?: string | undefined;
+    /**
+     * <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+    /**
+     * <p>The maximum number of associations to return in each page of results.</p>
+     * @public
+     */
+    maxResults?: number | undefined;
+}
+/**
+ * <p>Provides information about the association between a queue and a limit.</p>
+ * @public
+ */
+export interface QueueLimitAssociationSummary {
+    /**
+     * <p>The Unix timestamp of the date and time that the association was created.</p>
+     * @public
+     */
+    createdAt: Date | undefined;
+    /**
+     * <p>The user identifier of the person that created the association.</p>
+     * @public
+     */
+    createdBy: string | undefined;
+    /**
+     * <p>The Unix timestamp of the date and time that the association was last updated.</p>
+     * @public
+     */
+    updatedAt?: Date | undefined;
+    /**
+     * <p>The user identifier of the person that updated the association.</p>
+     * @public
+     */
+    updatedBy?: string | undefined;
+    /**
+     * <p>The unique identifier of the queue in the association.</p>
+     * @public
+     */
+    queueId: string | undefined;
+    /**
+     * <p>The unique identifier of the limit in the association.</p>
+     * @public
+     */
+    limitId: string | undefined;
+    /**
+     * <p>The status of task scheduling in the queue-limit association.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>ACTIVE</code> - Association is active.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>STOP_LIMIT_USAGE_AND_COMPLETE_TASKS</code> - Association has stopped
+     *                scheduling new tasks and is completing current tasks.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>STOP_LIMIT_USAGE_AND_CANCEL_TASKS</code> - Association has stopped
+     *                scheduling new tasks and is canceling current tasks.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>STOPPED</code> - Association has been stopped.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    status: QueueLimitAssociationStatus | undefined;
+}
+/**
+ * @public
+ */
+export interface ListQueueLimitAssociationsResponse {
+    /**
+     * <p>A list of associations between limits and queues in the farm specified in the
+     *          request.</p>
+     * @public
+     */
+    queueLimitAssociations: QueueLimitAssociationSummary[] | undefined;
+    /**
+     * <p>If Deadline Cloud returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 <code>ValidationException</code> error.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+}
 /**
  * @public
  */
@@ -1557,6 +2119,16 @@ export interface JobSearchSummary {
      * @public
      */
     jobParameters?: Record<string, JobParameter> | undefined;
+    /**
+     * <p>The maximum number of worker hosts that can concurrently process a job. When the
+     *             <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the
+     *          job, even if the fleets assigned to the job's queue has available workers.</p>
+     *          <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no
+     *          maximum number of workers.</p>
+     *          <p>If you don't specify the <code>maxWorkerCount</code>, the default is -1.</p>
+     * @public
+     */
+    maxWorkerCount?: number | undefined;
     /**
      * <p>The job ID for the source job.</p>
      * @public
@@ -2089,6 +2661,51 @@ export interface UpdateQueueFleetAssociationRequest {
  */
 export interface UpdateQueueFleetAssociationResponse {
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const UpdateQueueLimitAssociationStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly STOP_LIMIT_USAGE_AND_CANCEL_TASKS: "STOP_LIMIT_USAGE_AND_CANCEL_TASKS";
+    readonly STOP_LIMIT_USAGE_AND_COMPLETE_TASKS: "STOP_LIMIT_USAGE_AND_COMPLETE_TASKS";
+};
+/**
+ * @public
+ */
+export type UpdateQueueLimitAssociationStatus = (typeof UpdateQueueLimitAssociationStatus)[keyof typeof UpdateQueueLimitAssociationStatus];
+/**
+ * @public
+ */
+export interface UpdateQueueLimitAssociationRequest {
+    /**
+     * <p>The unique identifier of the farm that contains the associated queues and limits.</p>
+     * @public
+     */
+    farmId: string | undefined;
+    /**
+     * <p>The unique identifier of the queue associated to the limit.</p>
+     * @public
+     */
+    queueId: string | undefined;
+    /**
+     * <p>The unique identifier of the limit associated to the queue.</p>
+     * @public
+     */
+    limitId: string | undefined;
+    /**
+     * <p>Sets the status of the limit. You can mark the limit active, or you can stop usage of
+     *          the limit and either complete existing tasks or cancel any existing tasks immediately.
+     *       </p>
+     * @public
+     */
+    status: UpdateQueueLimitAssociationStatus | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateQueueLimitAssociationResponse {
+}
 /**
  * <p>The type of search filter to apply.</p>
  * @public
@@ -2372,6 +2989,10 @@ export declare const UpdateQueueEnvironmentRequestFilterSensitiveLog: (obj: Upda
  * @internal
  */
 export declare const UpdateFarmRequestFilterSensitiveLog: (obj: UpdateFarmRequest) => any;
+/**
+ * @internal
+ */
+export declare const UpdateLimitRequestFilterSensitiveLog: (obj: UpdateLimitRequest) => any;
 /**
  * @internal
  */

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

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListLimitsCommandInput, ListLimitsCommandOutput } from "../commands/ListLimitsCommand";
+import { DeadlinePaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListLimits: (config: DeadlinePaginationConfiguration, input: ListLimitsCommandInput, ...rest: any[]) => Paginator<ListLimitsCommandOutput>;

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

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListQueueLimitAssociationsCommandInput, ListQueueLimitAssociationsCommandOutput } from "../commands/ListQueueLimitAssociationsCommand";
+import { DeadlinePaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListQueueLimitAssociations: (config: DeadlinePaginationConfiguration, input: ListQueueLimitAssociationsCommandInput, ...rest: any[]) => Paginator<ListQueueLimitAssociationsCommandOutput>;

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

@@ -10,10 +10,12 @@ export * from "./ListJobMembersPaginator";
 export * from "./ListJobParameterDefinitionsPaginator";
 export * from "./ListJobsPaginator";
 export * from "./ListLicenseEndpointsPaginator";
+export * from "./ListLimitsPaginator";
 export * from "./ListMeteredProductsPaginator";
 export * from "./ListMonitorsPaginator";
 export * from "./ListQueueEnvironmentsPaginator";
 export * from "./ListQueueFleetAssociationsPaginator";
+export * from "./ListQueueLimitAssociationsPaginator";
 export * from "./ListQueueMembersPaginator";
 export * from "./ListQueuesPaginator";
 export * from "./ListSessionActionsPaginator";