Amazon Deadline Cloud Queues API

openapi: 3.1.0
info:
  title: AWSDeadlineCloud Queues API
  version: '2023-10-12'
  description: Generated from AWS's published Smithy model for AWSDeadlineCloud. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://deadline.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /2023-10-12/farms/{farmId}/queues:
    post:
      operationId: CreateQueue
      summary: Create Queue
      description: Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to
        pull resources and indicate where to output completed jobs.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateQueueResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateQueueRequest'
      tags:
      - Queues
    get:
      operationId: ListQueues
      summary: List Queues
      description: Lists queues.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQueuesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListQueuesRequest'
      tags:
      - Queues
  /2023-10-12/farms/{farmId}/queues/{queueId}:
    get:
      operationId: GetQueue
      summary: Get Queue
      description: Gets a queue.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetQueueResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetQueueRequest'
      tags:
      - Queues
    patch:
      operationId: UpdateQueue
      summary: Update Queue
      description: Updates a queue.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateQueueResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateQueueRequest'
      tags:
      - Queues
    delete:
      operationId: DeleteQueue
      summary: Delete Queue
      description: Deletes a queue. You can't recover the jobs in a queue if you delete the queue. Deleting the queue also
        deletes the jobs in that queue.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteQueueResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteQueueRequest'
      tags:
      - Queues
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: deadline
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
        context:
          type: object
          additionalProperties:
            type: string
          description: Information about the resources in use when the exception was thrown.
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - CONFLICT_EXCEPTION
          - CONCURRENT_MODIFICATION
          - RESOURCE_ALREADY_EXISTS
          - RESOURCE_IN_USE
          - STATUS_CONFLICT
          description: A description of the error.
        resourceId:
          type: string
          description: The identifier of the resource in use.
        resourceType:
          type: string
          description: The type of the resource in use.
        context:
          type: object
          additionalProperties:
            type: string
          description: Information about the resources in use when the exception was thrown.
      required:
      - message
      - reason
      - resourceId
      - resourceType
    CreateQueueRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm to connect to the queue.
        clientToken:
          type: string
          description: The unique token which the server uses to recognize retries of the same request.
        displayName:
          type: string
          description: The display name of the queue. 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.
        description:
          type: string
          description: The description of the queue. 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.
        defaultBudgetAction:
          type: string
          enum:
          - NONE
          - STOP_SCHEDULING_AND_COMPLETE_TASKS
          - STOP_SCHEDULING_AND_CANCEL_TASKS
          description: The default action to take on a queue if a budget isn't configured.
        jobAttachmentSettings:
          $ref: '#/components/schemas/JobAttachmentSettings'
        roleArn:
          type: string
          description: The IAM role ARN that workers will use while running jobs for this queue.
        jobRunAsUser:
          $ref: '#/components/schemas/JobRunAsUser'
        requiredFileSystemLocationNames:
          type: array
          items:
            type: string
          description: The file system location name to include in the queue.
        allowedStorageProfileIds:
          type: array
          items:
            type: string
          description: The storage profile IDs to include in the queue.
        tags:
          type: object
          additionalProperties:
            type: string
          description: Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values
            can be empty strings.
        schedulingConfiguration:
          $ref: '#/components/schemas/SchedulingConfiguration'
      required:
      - farmId
      - displayName
    CreateQueueResponse:
      type: object
      properties:
        queueId:
          type: string
          description: The queue ID.
      required:
      - queueId
    DeleteQueueRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The ID of the farm from which to remove the queue.
        queueId:
          type: string
          description: The queue ID of the queue to delete.
      required:
      - farmId
      - queueId
    DeleteQueueResponse:
      type: object
      properties: {}
    GetQueueRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm in the queue.
        queueId:
          type: string
          description: The queue ID for the queue to retrieve.
      required:
      - farmId
      - queueId
    GetQueueResponse:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID for the queue.
        queueId:
          type: string
          description: The queue ID.
        displayName:
          type: string
          description: The display name of the queue. 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.
        status:
          type: string
          enum:
          - IDLE
          - SCHEDULING
          - SCHEDULING_BLOCKED
          description: The status of the queue. ACTIVE–The queue is active. SCHEDULING–The queue is scheduling. SCHEDULING_BLOCKED–The
            queue scheduling is blocked. See the provided reason.
        defaultBudgetAction:
          type: string
          enum:
          - NONE
          - STOP_SCHEDULING_AND_COMPLETE_TASKS
          - STOP_SCHEDULING_AND_CANCEL_TASKS
          description: The default action taken on a queue if a budget wasn't configured.
        blockedReason:
          type: string
          enum:
          - NO_BUDGET_CONFIGURED
          - BUDGET_THRESHOLD_REACHED
          description: The reason the queue was blocked.
        createdAt:
          type: string
          format: date-time
          description: The date and time the resource was created.
        createdBy:
          type: string
          description: The user or system that created this resource.
        updatedAt:
          type: string
          format: date-time
          description: The date and time the resource was updated.
        updatedBy:
          type: string
          description: The user or system that updated this resource.
        description:
          type: string
          description: The description of the queue. 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.
        jobAttachmentSettings:
          $ref: '#/components/schemas/JobAttachmentSettings'
        roleArn:
          type: string
          description: The IAM role ARN.
        requiredFileSystemLocationNames:
          type: array
          items:
            type: string
          description: A list of the required file system location names in the queue.
        allowedStorageProfileIds:
          type: array
          items:
            type: string
          description: The storage profile IDs for the queue.
        jobRunAsUser:
          $ref: '#/components/schemas/JobRunAsUser'
        schedulingConfiguration:
          $ref: '#/components/schemas/SchedulingConfiguration'
      required:
      - farmId
      - queueId
      - displayName
      - status
      - defaultBudgetAction
      - createdAt
      - createdBy
    InternalServerErrorException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: The number of seconds a client should wait before retrying the request.
      required:
      - message
    JobAttachmentSettings:
      type: object
      properties:
        s3BucketName:
          type: string
          description: The Amazon S3 bucket name.
        rootPrefix:
          type: string
          description: The root prefix.
      required:
      - s3BucketName
      - rootPrefix
    JobRunAsUser:
      type: object
      properties:
        posix:
          $ref: '#/components/schemas/PosixUser'
        windows:
          $ref: '#/components/schemas/WindowsUser'
        runAs:
          type: string
          enum:
          - QUEUE_CONFIGURED_USER
          - WORKER_AGENT_USER
          description: Specifies whether the job should run using the queue's system user or if the job should run using the
            worker agent system user.
      required:
      - runAs
    ListQueuesRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the queue.
        nextToken:
          type: string
          description: The token for the next set of results, or null to start from the beginning.
        maxResults:
          type: integer
          description: The maximum number of results to return. Use this parameter with NextToken to get results as a set
            of sequential pages.
        principalId:
          type: string
          description: The principal IDs to include in the list of queues.
        status:
          type: string
          enum:
          - IDLE
          - SCHEDULING
          - SCHEDULING_BLOCKED
          description: The status of the queues listed. ACTIVE–The queues are active. SCHEDULING–The queues are scheduling.
            SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.
      required:
      - farmId
    ListQueuesResponse:
      type: object
      properties:
        queues:
          type: array
          items:
            $ref: '#/components/schemas/QueueSummary'
          description: The queues on the list.
        nextToken:
          type: string
          description: If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken
            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 nextToken is set to null. Each pagination
            token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException
            error.
      required:
      - queues
    PosixUser:
      type: object
      properties:
        user:
          type: string
          description: The name of the POSIX user.
        group:
          type: string
          description: The name of the POSIX user's group.
      required:
      - user
      - group
    PriorityBalancedSchedulingConfiguration:
      type: object
      properties:
        renderingTaskBuffer:
          type: integer
          description: The rendering task buffer controls worker stickiness. A worker only switches from its current job to
            another job at the same priority if the other job has fewer rendering tasks by more than this buffer value. Higher
            values make workers stickier to their current jobs. The default value is 1.
    PriorityFifoSchedulingConfiguration:
      type: object
      properties: {}
    QueueSummary:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID.
        queueId:
          type: string
          description: The queue ID.
        displayName:
          type: string
          description: The display name of the queue summary to update. 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.
        status:
          type: string
          enum:
          - IDLE
          - SCHEDULING
          - SCHEDULING_BLOCKED
          description: That status of the queue.
        defaultBudgetAction:
          type: string
          enum:
          - NONE
          - STOP_SCHEDULING_AND_COMPLETE_TASKS
          - STOP_SCHEDULING_AND_CANCEL_TASKS
          description: The default action taken on a queue summary if a budget wasn't configured.
        blockedReason:
          type: string
          enum:
          - NO_BUDGET_CONFIGURED
          - BUDGET_THRESHOLD_REACHED
          description: The reason the queue is blocked, if applicable.
        createdAt:
          type: string
          format: date-time
          description: The date and time the resource was created.
        createdBy:
          type: string
          description: The user or system that created this resource.
        updatedAt:
          type: string
          format: date-time
          description: The date and time the resource was updated.
        updatedBy:
          type: string
          description: The user or system that updated this resource.
      required:
      - farmId
      - queueId
      - displayName
      - status
      - defaultBudgetAction
      - createdAt
      - createdBy
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The identifier of the resource that couldn't be found.
        resourceType:
          type: string
          description: The type of the resource that couldn't be found.
        context:
          type: object
          additionalProperties:
            type: string
          description: Information about the resources in use when the exception was thrown.
      required:
      - message
      - resourceId
      - resourceType
    SchedulingConfiguration:
      type: object
      properties:
        priorityFifo:
          $ref: '#/components/schemas/PriorityFifoSchedulingConfiguration'
        priorityBalanced:
          $ref: '#/components/schemas/PriorityBalancedSchedulingConfiguration'
        weightedBalanced:
          $ref: '#/components/schemas/WeightedBalancedSchedulingConfiguration'
      description: Exactly one member is set.
    SchedulingMaxPriorityOverride:
      type: object
      properties:
        alwaysScheduleFirst:
          $ref: '#/components/schemas/SchedulingMaxPriorityOverrideAlwaysScheduleFirst'
      description: Exactly one member is set.
    SchedulingMaxPriorityOverrideAlwaysScheduleFirst:
      type: object
      properties: {}
    SchedulingMinPriorityOverride:
      type: object
      properties:
        alwaysScheduleLast:
          $ref: '#/components/schemas/SchedulingMinPriorityOverrideAlwaysScheduleLast'
      description: Exactly one member is set.
    SchedulingMinPriorityOverrideAlwaysScheduleLast:
      type: object
      properties: {}
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - SERVICE_QUOTA_EXCEEDED_EXCEPTION
          - KMS_KEY_LIMIT_EXCEEDED
          - DEPENDENCY_LIMIT_EXCEEDED
          description: A string that describes the reason the quota was exceeded.
        resourceType:
          type: string
          description: The type of the affected resource
        serviceCode:
          type: string
          description: Identifies the service that exceeded the quota.
        quotaCode:
          type: string
          description: Identifies the quota that has been exceeded.
        resourceId:
          type: string
          description: The identifier of the affected resource.
        context:
          type: object
          additionalProperties:
            type: string
          description: Information about the resources in use when the exception was thrown.
      required:
      - message
      - reason
      - resourceType
      - serviceCode
      - quotaCode
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
        serviceCode:
          type: string
          description: Identifies the service that is being throttled.
        quotaCode:
          type: string
          description: Identifies the quota that is being throttled.
        retryAfterSeconds:
          type: integer
          description: The number of seconds a client should wait before retrying the request.
        context:
          type: object
          additionalProperties:
            type: string
          description: Information about the resources in use when the exception was thrown.
      required:
      - message
    UpdateQueueRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID to update in the queue.
        queueId:
          type: string
          description: The queue ID to update.
        clientToken:
          type: string
          description: The idempotency token to update in the queue.
        displayName:
          type: string
          description: The display name of the queue to update. 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.
        description:
          type: string
          description: The description of the queue to update. 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.
        defaultBudgetAction:
          type: string
          enum:
          - NONE
          - STOP_SCHEDULING_AND_COMPLETE_TASKS
          - STOP_SCHEDULING_AND_CANCEL_TASKS
          description: The default action to take for a queue update if a budget isn't configured.
        jobAttachmentSettings:
          $ref: '#/components/schemas/JobAttachmentSettings'
        roleArn:
          type: string
          description: The IAM role ARN that's used to run jobs from this queue.
        jobRunAsUser:
          $ref: '#/components/schemas/JobRunAsUser'
        requiredFileSystemLocationNamesToAdd:
          type: array
          items:
            type: string
          description: The required file system location names to add to the queue.
        requiredFileSystemLocationNamesToRemove:
          type: array
          items:
            type: string
          description: The required file system location names to remove from the queue.
        allowedStorageProfileIdsToAdd:
          type: array
          items:
            type: string
          description: The storage profile IDs to add.
        allowedStorageProfileIdsToRemove:
          type: array
          items:
            type: string
          description: The storage profile ID to remove.
        schedulingConfiguration:
          $ref: '#/components/schemas/SchedulingConfiguration'
      required:
      - farmId
      - queueId
    UpdateQueueResponse:
      type: object
      properties: {}
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          enum:
          - UNKNOWN_OPERATION
          - CANNOT_PARSE
          - FIELD_VALIDATION_FAILED
          - OTHER
          description: The reason that the request failed validation.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: A list of fields that failed validation.
        context:
          type: object
          additionalProperties:
            type: string
          description: Information about the resources in use when the exception was thrown.
      required:
      - message
      - reason
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the validation exception.
        message:
          type: string
          description: The error message for the validation exception.
      required:
      - name
      - message
    WeightedBalancedSchedulingConfiguration:
      type: object
      properties:
        priorityWeight:
          type: number
          description: The weight applied to job priority in the scheduling formula. Higher values give more influence to
            job priority. A value of 0 means priority is ignored. The default value is 100.0.
        errorWeight:
          type: number
          description: The weight applied to the number of errors on a job. A negative value means jobs without errors are
            scheduled first. A value of 0 means errors are ignored. The default value is -10.0.
        submissionTimeWeight:
          type: number
          description: The weight applied to job submission time. A positive value means earlier jobs are scheduled first.
            A value of 0 means submission time is ignored. The default value is 3.0.
        renderingTaskWeight:
          type: number
          description: The weight applied to the number of tasks currently rendering on a job. A negative value means jobs
            that are not already rendering are scheduled next. A value of 0 means the rendering state is ignored. The default
            value is -100.0.
        renderingTaskBuffer:
          type: integer
          description: The rendering task buffer is subtracted from the number of rendering tasks before applying the rendering
            task weight. This creates a stickiness effect where workers prefer to stay with their current job. Higher values
            make workers stickier. The default value is 1. The buffer is only applied in the weight calculation for a job
            if the worker is currently assigned to that job.
        maxPriorityOverride:
          $ref: '#/components/schemas/SchedulingMaxPriorityOverride'
        minPriorityOverride:
          $ref: '#/components/schemas/SchedulingMinPriorityOverride'
    WindowsUser:
      type: object
      properties:
        user:
          type: string
          description: The user.
        passwordArn:
          type: string
          description: The password ARN for the Windows user.
      required:
      - user
      - passwordArn
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/deadline/service/2023-10-12/deadline-2023-10-12.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)