Amazon Deadline Cloud Deadline Cloud Queue Fleet Associations API

openapi: 3.1.0
info:
  title: AWSDeadlineCloud Queue Fleet 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-fleet-associations:
    put:
      operationId: CreateQueueFleetAssociation
      summary: Create Queue Fleet Association
      description: Creates an association between a queue and a fleet.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateQueueFleetAssociationResponse'
        '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/CreateQueueFleetAssociationRequest'
      tags:
      - Queue Fleet Associations
    get:
      operationId: ListQueueFleetAssociations
      summary: List Queue Fleet Associations
      description: Lists queue-fleet associations.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQueueFleetAssociationsResponse'
        '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/ListQueueFleetAssociationsRequest'
      tags:
      - Queue Fleet Associations
  /2023-10-12/farms/{farmId}/queue-fleet-associations/{queueId}/{fleetId}:
    delete:
      operationId: DeleteQueueFleetAssociation
      summary: Delete Queue Fleet Association
      description: Deletes a queue-fleet association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteQueueFleetAssociationResponse'
        '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/DeleteQueueFleetAssociationRequest'
      tags:
      - Queue Fleet Associations
    get:
      operationId: GetQueueFleetAssociation
      summary: Get Queue Fleet Association
      description: Gets a queue-fleet association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetQueueFleetAssociationResponse'
        '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/GetQueueFleetAssociationRequest'
      tags:
      - Queue Fleet Associations
    patch:
      operationId: UpdateQueueFleetAssociation
      summary: Update Queue Fleet Association
      description: Updates a queue-fleet association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateQueueFleetAssociationResponse'
        '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/UpdateQueueFleetAssociationRequest'
      tags:
      - Queue Fleet 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
    CreateQueueFleetAssociationRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The ID of the farm that the queue and fleet belong to.
        queueId:
          type: string
          description: The queue ID.
        fleetId:
          type: string
          description: The fleet ID.
      required:
      - farmId
      - queueId
      - fleetId
    CreateQueueFleetAssociationResponse:
      type: object
      properties: {}
    DeleteQueueFleetAssociationRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm that holds the queue-fleet association.
        queueId:
          type: string
          description: The queue ID of the queue-fleet association.
        fleetId:
          type: string
          description: The fleet ID of the queue-fleet association.
      required:
      - farmId
      - queueId
      - fleetId
    DeleteQueueFleetAssociationResponse:
      type: object
      properties: {}
    GetQueueFleetAssociationRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm that contains the queue-fleet association.
        queueId:
          type: string
          description: The queue ID for the queue-fleet association.
        fleetId:
          type: string
          description: The fleet ID for the queue-fleet association.
      required:
      - farmId
      - queueId
      - fleetId
    GetQueueFleetAssociationResponse:
      type: object
      properties:
        queueId:
          type: string
          description: The queue ID for the queue-fleet association.
        fleetId:
          type: string
          description: The fleet ID for the queue-fleet association.
        status:
          type: string
          enum:
          - ACTIVE
          - STOP_SCHEDULING_AND_COMPLETE_TASKS
          - STOP_SCHEDULING_AND_CANCEL_TASKS
          - STOPPED
          description: The status of the queue-fleet association.
        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:
      - queueId
      - fleetId
      - 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
    ListQueueFleetAssociationsRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID for the queue-fleet association list.
        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.
        queueId:
          type: string
          description: The queue ID for the queue-fleet association list.
        fleetId:
          type: string
          description: The fleet ID for the queue-fleet association list.
      required:
      - farmId
    ListQueueFleetAssociationsResponse:
      type: object
      properties:
        queueFleetAssociations:
          type: array
          items:
            $ref: '#/components/schemas/QueueFleetAssociationSummary'
          description: The queue-fleet associations 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:
      - queueFleetAssociations
    QueueFleetAssociationSummary:
      type: object
      properties:
        queueId:
          type: string
          description: The queue ID.
        fleetId:
          type: string
          description: The fleet ID.
        status:
          type: string
          enum:
          - ACTIVE
          - STOP_SCHEDULING_AND_COMPLETE_TASKS
          - STOP_SCHEDULING_AND_CANCEL_TASKS
          - STOPPED
          description: The status of task scheduling in the queue-fleet association. ACTIVE–Association is active. STOP_SCHEDULING_AND_COMPLETE_TASKS–Association
            has stopped scheduling new tasks and is completing current tasks. STOP_SCHEDULING_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 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:
      - queueId
      - fleetId
      - 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
    UpdateQueueFleetAssociationRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID to update.
        queueId:
          type: string
          description: The queue ID to update.
        fleetId:
          type: string
          description: The fleet ID to update.
        status:
          type: string
          enum:
          - ACTIVE
          - STOP_SCHEDULING_AND_COMPLETE_TASKS
          - STOP_SCHEDULING_AND_CANCEL_TASKS
          description: The status to update.
      required:
      - farmId
      - queueId
      - fleetId
      - status
    UpdateQueueFleetAssociationResponse:
      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)