Amazon Deadline Cloud Deadline Cloud Environments API

openapi: 3.1.0
info:
  title: AWSDeadlineCloud Environments 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/{queueId}/environments:
    post:
      operationId: CreateQueueEnvironment
      summary: Create Queue Environment
      description: Creates an environment for a queue that defines how jobs in the queue run.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateQueueEnvironmentResponse'
        '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/CreateQueueEnvironmentRequest'
      tags:
      - Environments
    get:
      operationId: ListQueueEnvironments
      summary: List Queue Environments
      description: Lists queue environments.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQueueEnvironmentsResponse'
        '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/ListQueueEnvironmentsRequest'
      tags:
      - Environments
  /2023-10-12/farms/{farmId}/queues/{queueId}/environments/{queueEnvironmentId}:
    delete:
      operationId: DeleteQueueEnvironment
      summary: Delete Queue Environment
      description: Deletes a queue environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteQueueEnvironmentResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '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/DeleteQueueEnvironmentRequest'
      tags:
      - Environments
    get:
      operationId: GetQueueEnvironment
      summary: Get Queue Environment
      description: Gets a queue environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetQueueEnvironmentResponse'
        '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/GetQueueEnvironmentRequest'
      tags:
      - Environments
    patch:
      operationId: UpdateQueueEnvironment
      summary: Update Queue Environment
      description: Updates the queue environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateQueueEnvironmentResponse'
        '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/UpdateQueueEnvironmentRequest'
      tags:
      - Environments
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
    CreateQueueEnvironmentRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm to connect to the environment.
        queueId:
          type: string
          description: The queue ID to connect the queue and environment.
        clientToken:
          type: string
          description: The unique token which the server uses to recognize retries of the same request.
        priority:
          type: integer
          description: Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority
            (activated first and deactivated last). If two environments share the same priority value, the environment created
            first takes higher priority.
        templateType:
          type: string
          enum:
          - JSON
          - YAML
          description: The template's file type, JSON or YAML.
        template:
          type: string
          description: The environment template to use in the queue.
      required:
      - farmId
      - queueId
      - priority
      - templateType
      - template
    CreateQueueEnvironmentResponse:
      type: object
      properties:
        queueEnvironmentId:
          type: string
          description: The queue environment ID.
      required:
      - queueEnvironmentId
    DeleteQueueEnvironmentRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm from which to remove the queue environment.
        queueId:
          type: string
          description: The queue ID of the queue environment to delete.
        queueEnvironmentId:
          type: string
          description: The queue environment ID of the queue environment to delete.
      required:
      - farmId
      - queueId
      - queueEnvironmentId
    DeleteQueueEnvironmentResponse:
      type: object
      properties: {}
    GetQueueEnvironmentRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID for the queue environment.
        queueId:
          type: string
          description: The queue ID for the queue environment.
        queueEnvironmentId:
          type: string
          description: The queue environment ID.
      required:
      - farmId
      - queueId
      - queueEnvironmentId
    GetQueueEnvironmentResponse:
      type: object
      properties:
        queueEnvironmentId:
          type: string
          description: The queue environment ID.
        name:
          type: string
          description: The name of the queue environment.
        priority:
          type: integer
          description: The priority of the queue environment.
        templateType:
          type: string
          enum:
          - JSON
          - YAML
          description: The type of template for the queue environment.
        template:
          type: string
          description: The template for the queue environment.
        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:
      - queueEnvironmentId
      - name
      - priority
      - templateType
      - template
      - 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
    ListQueueEnvironmentsRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID for the queue environment list.
        queueId:
          type: string
          description: The queue ID for the queue environment 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.
      required:
      - farmId
      - queueId
    ListQueueEnvironmentsResponse:
      type: object
      properties:
        environments:
          type: array
          items:
            $ref: '#/components/schemas/QueueEnvironmentSummary'
          description: The environments to include in the queue environments 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:
      - environments
    QueueEnvironmentSummary:
      type: object
      properties:
        queueEnvironmentId:
          type: string
          description: The queue environment ID.
        name:
          type: string
          description: The name of the queue environment.
        priority:
          type: integer
          description: The queue environment's priority.
      required:
      - queueEnvironmentId
      - name
      - priority
    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
    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
    UpdateQueueEnvironmentRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the queue environment to update.
        queueId:
          type: string
          description: The queue ID of the queue environment to update.
        queueEnvironmentId:
          type: string
          description: The queue environment ID to update.
        clientToken:
          type: string
          description: The unique token which the server uses to recognize retries of the same request.
        priority:
          type: integer
          description: The priority to update.
        templateType:
          type: string
          enum:
          - JSON
          - YAML
          description: The template type to update.
        template:
          type: string
          description: The template to update.
      required:
      - farmId
      - queueId
      - queueEnvironmentId
    UpdateQueueEnvironmentResponse:
      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)