Amazon Deadline Cloud Deadline Cloud Queue Limit Associations API

openapi: 3.1.0
info:
  title: AWSDeadlineCloud Queue Limit Associations 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}/queue-limit-associations:
    put:
      operationId: CreateQueueLimitAssociation
      summary: Create Queue Limit Association
      description: Associates a limit with a particular queue. After the limit is associated, all workers for jobs that specify
        the limit associated with the queue are subject to the limit. You can't associate two limits with the same amountRequirementName
        to the same queue.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateQueueLimitAssociationResponse'
        '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/CreateQueueLimitAssociationRequest'
      tags:
      - Queue Limit Associations
    get:
      operationId: ListQueueLimitAssociations
      summary: List Queue Limit Associations
      description: Gets a list of the associations between queues and limits defined in a farm.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQueueLimitAssociationsResponse'
        '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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListQueueLimitAssociationsRequest'
      tags:
      - Queue Limit Associations
  /2023-10-12/farms/{farmId}/queue-limit-associations/{queueId}/{limitId}:
    delete:
      operationId: DeleteQueueLimitAssociation
      summary: Delete Queue Limit Association
      description: Removes the association between a queue and a limit. You must use the UpdateQueueLimitAssociation operation
        to set the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not
        change immediately. Use the GetQueueLimitAssociation operation to see if the status changed to STOPPED before deleting
        the association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteQueueLimitAssociationResponse'
        '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/DeleteQueueLimitAssociationRequest'
      tags:
      - Queue Limit Associations
    get:
      operationId: GetQueueLimitAssociation
      summary: Get Queue Limit Association
      description: Gets information about a specific association between a queue and a limit.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetQueueLimitAssociationResponse'
        '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/GetQueueLimitAssociationRequest'
      tags:
      - Queue Limit Associations
    patch:
      operationId: UpdateQueueLimitAssociation
      summary: Update Queue Limit Association
      description: Updates the status of the queue. If you set the status to one of the STOP_LIMIT_USAGE* values, there will
        be a delay before the status transitions to the STOPPED state.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateQueueLimitAssociationResponse'
        '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/UpdateQueueLimitAssociationRequest'
      tags:
      - Queue Limit Associations
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
    CreateQueueLimitAssociationRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The unique identifier of the farm that contains the queue and limit to associate.
        queueId:
          type: string
          description: The unique identifier of the queue to associate with the limit.
        limitId:
          type: string
          description: The unique identifier of the limit to associate with the queue.
      required:
      - farmId
      - queueId
      - limitId
    CreateQueueLimitAssociationResponse:
      type: object
      properties: {}
    DeleteQueueLimitAssociationRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The unique identifier of the farm that contains the queue and limit to disassociate.
        queueId:
          type: string
          description: The unique identifier of the queue to disassociate.
        limitId:
          type: string
          description: The unique identifier of the limit to disassociate.
      required:
      - farmId
      - queueId
      - limitId
    DeleteQueueLimitAssociationResponse:
      type: object
      properties: {}
    GetQueueLimitAssociationRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The unique identifier of the farm that contains the associated queue and limit.
        queueId:
          type: string
          description: The unique identifier of the queue associated with the limit.
        limitId:
          type: string
          description: The unique identifier of the limit associated with the queue.
      required:
      - farmId
      - queueId
      - limitId
    GetQueueLimitAssociationResponse:
      type: object
      properties:
        queueId:
          type: string
          description: The unique identifier of the queue associated with the limit.
        limitId:
          type: string
          description: The unique identifier of the limit associated with the queue.
        status:
          type: string
          enum:
          - ACTIVE
          - STOP_LIMIT_USAGE_AND_COMPLETE_TASKS
          - STOP_LIMIT_USAGE_AND_CANCEL_TASKS
          - STOPPED
          description: The current status of the limit.
        createdAt:
          type: string
          format: date-time
          description: The Unix timestamp of the date and time that the association was created.
        createdBy:
          type: string
          description: The user identifier of the person that created the association.
        updatedAt:
          type: string
          format: date-time
          description: The Unix timestamp of the date and time that the association was last updated.
        updatedBy:
          type: string
          description: The user identifier of the person that last updated the association.
      required:
      - queueId
      - limitId
      - status
      - 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
    ListQueueLimitAssociationsRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The unique identifier of the farm that contains the limits and associations.
        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 associations to return in each page of results.
        queueId:
          type: string
          description: Specifies that the operation should return only the queue limit associations for the specified queue.
            If you specify both the queueId and the limitId, only the specified limit is returned if it exists.
        limitId:
          type: string
          description: Specifies that the operation should return only the queue limit associations for the specified limit.
            If you specify both the queueId and the limitId, only the specified limit is returned if it exists.
      required:
      - farmId
    ListQueueLimitAssociationsResponse:
      type: object
      properties:
        queueLimitAssociations:
          type: array
          items:
            $ref: '#/components/schemas/QueueLimitAssociationSummary'
          description: A list of associations between limits and queues in the farm specified in the request.
        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:
      - queueLimitAssociations
    QueueLimitAssociationSummary:
      type: object
      properties:
        queueId:
          type: string
          description: The unique identifier of the queue in the association.
        limitId:
          type: string
          description: The unique identifier of the limit in the association.
        status:
          type: string
          enum:
          - ACTIVE
          - STOP_LIMIT_USAGE_AND_COMPLETE_TASKS
          - STOP_LIMIT_USAGE_AND_CANCEL_TASKS
          - STOPPED
          description: The status of task scheduling in the queue-limit association. ACTIVE - Association is active. STOP_LIMIT_USAGE_AND_COMPLETE_TASKS
            - Association has stopped scheduling new tasks and is completing current tasks. STOP_LIMIT_USAGE_AND_CANCEL_TASKS
            - Association has stopped scheduling new tasks and is canceling current tasks. STOPPED - Association has been
            stopped.
        createdAt:
          type: string
          format: date-time
          description: The Unix timestamp of the date and time that the association was created.
        createdBy:
          type: string
          description: The user identifier of the person that created the association.
        updatedAt:
          type: string
          format: date-time
          description: The Unix timestamp of the date and time that the association was last updated.
        updatedBy:
          type: string
          description: The user identifier of the person that updated the association.
      required:
      - queueId
      - limitId
      - status
      - 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
    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
    UpdateQueueLimitAssociationRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The unique identifier of the farm that contains the associated queues and limits.
        queueId:
          type: string
          description: The unique identifier of the queue associated to the limit.
        limitId:
          type: string
          description: The unique identifier of the limit associated to the queue.
        status:
          type: string
          enum:
          - ACTIVE
          - STOP_LIMIT_USAGE_AND_COMPLETE_TASKS
          - STOP_LIMIT_USAGE_AND_CANCEL_TASKS
          description: 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.
      required:
      - farmId
      - queueId
      - limitId
      - status
    UpdateQueueLimitAssociationResponse:
      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
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)