Amazon Deadline Cloud Deadline Cloud Limits API

openapi: 3.1.0
info:
  title: AWSDeadlineCloud Limits 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}/limits:
    post:
      operationId: CreateLimit
      summary: Create Limit
      description: Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can
        throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate
        the limit with one or more queues. You must add the amountRequirementName to a step in a job template to declare the
        limit requirement.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateLimitResponse'
        '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/CreateLimitRequest'
      tags:
      - Limits
    get:
      operationId: ListLimits
      summary: List Limits
      description: Gets a list of limits defined in the specified farm.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLimitsResponse'
        '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/ListLimitsRequest'
      tags:
      - Limits
  /2023-10-12/farms/{farmId}/limits/{limitId}:
    delete:
      operationId: DeleteLimit
      summary: Delete Limit
      description: Removes a limit from the specified farm. Before you delete a limit you must use the DeleteQueueLimitAssociation
        operation to remove the association with any queues.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteLimitResponse'
        '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/DeleteLimitRequest'
      tags:
      - Limits
    get:
      operationId: GetLimit
      summary: Get Limit
      description: Gets information about a specific limit.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLimitResponse'
        '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/GetLimitRequest'
      tags:
      - Limits
    patch:
      operationId: UpdateLimit
      summary: Update Limit
      description: Updates the properties of the specified limit.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateLimitResponse'
        '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/UpdateLimitRequest'
      tags:
      - Limits
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
    CreateLimitRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm that contains the limit.
        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 limit. 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.
        amountRequirementName:
          type: string
          description: The value that you specify as the name in the amounts field of the hostRequirements in a step of a
            job template to declare the limit requirement.
        maxCount:
          type: integer
          description: The maximum number of resources constrained by this limit. When all of the resources are in use, steps
            that require the limit won't be scheduled until the resource is available. The maxCount must not be 0. If the
            value is -1, there is no restriction on the number of resources that can be acquired for this limit.
        description:
          type: string
          description: A description of the limit. A description helps you identify the purpose of the limit. 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.
      required:
      - farmId
      - displayName
      - amountRequirementName
      - maxCount
    CreateLimitResponse:
      type: object
      properties:
        limitId:
          type: string
          description: A unique identifier for the limit. Use this identifier in other operations, such as CreateQueueLimitAssociation
            and DeleteLimit.
      required:
      - limitId
    DeleteLimitRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The unique identifier of the farm that contains the limit to delete.
        limitId:
          type: string
          description: The unique identifier of the limit to delete.
      required:
      - farmId
      - limitId
    DeleteLimitResponse:
      type: object
      properties: {}
    GetLimitRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The unique identifier of the farm that contains the limit.
        limitId:
          type: string
          description: The unique identifier of the limit to return.
      required:
      - farmId
      - limitId
    GetLimitResponse:
      type: object
      properties:
        farmId:
          type: string
          description: The unique identifier of the farm that contains the limit.
        limitId:
          type: string
          description: The unique identifier of the limit.
        currentCount:
          type: integer
          description: The number of resources from the limit that are being used by jobs. The result is delayed and may not
            be the count at the time that you called the operation.
        createdAt:
          type: string
          format: date-time
          description: The Unix timestamp of the date and time that the limit was created.
        createdBy:
          type: string
          description: The user identifier of the person that created the limit.
        updatedAt:
          type: string
          format: date-time
          description: The Unix timestamp of the date and time that the limit was last updated.
        updatedBy:
          type: string
          description: The user identifier of the person that last updated the limit.
        displayName:
          type: string
          description: The display name of the limit. 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.
        amountRequirementName:
          type: string
          description: The value that you specify as the name in the amounts field of the hostRequirements in a step of a
            job template to declare the limit requirement.
        maxCount:
          type: integer
          description: The maximum number of resources constrained by this limit. When all of the resources are in use, steps
            that require the limit won't be scheduled until the resource is available. The maxValue must not be 0. If the
            value is -1, there is no restriction on the number of resources that can be acquired for this limit.
        description:
          type: string
          description: The description of the limit that helps identify what the limit is used for. 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.
      required:
      - farmId
      - limitId
      - currentCount
      - createdAt
      - createdBy
      - displayName
      - amountRequirementName
      - maxCount
    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
    LimitSummary:
      type: object
      properties:
        farmId:
          type: string
          description: The unique identifier of the farm that contains the limit.
        limitId:
          type: string
          description: The unique identifier of the limit.
        currentCount:
          type: integer
          description: The number of resources from the limit that are being used by jobs. The result is delayed and may not
            be the count at the time that you called the operation.
        createdAt:
          type: string
          format: date-time
          description: The Unix timestamp of the date and time that the limit was created.
        createdBy:
          type: string
          description: The user identifier of the person that created the limit.
        updatedAt:
          type: string
          format: date-time
          description: The Unix timestamp of the date and time that the limit was last updated.
        updatedBy:
          type: string
          description: The user identifier of the person that last updated the limit.
        displayName:
          type: string
          description: The name of the limit used in lists to identify the limit. 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.
        amountRequirementName:
          type: string
          description: The value that you specify as the name in the amounts field of the hostRequirements in a step of a
            job template to declare the limit requirement.
        maxCount:
          type: integer
          description: The maximum number of resources constrained by this limit. When all of the resources are in use, steps
            that require the limit won't be scheduled until the resource is available. The maxValue must not be 0. If the
            value is -1, there is no restriction on the number of resources that can be acquired for this limit.
      required:
      - farmId
      - limitId
      - currentCount
      - createdAt
      - createdBy
      - displayName
      - amountRequirementName
      - maxCount
    ListLimitsRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The unique identifier of the farm that contains the limits.
        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 limits to return in each page of results.
      required:
      - farmId
    ListLimitsResponse:
      type: object
      properties:
        limits:
          type: array
          items:
            $ref: '#/components/schemas/LimitSummary'
          description: A list of limits that the farm contains.
        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:
      - limits
    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
    UpdateLimitRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The unique identifier of the farm that contains the limit.
        limitId:
          type: string
          description: The unique identifier of the limit to update.
        displayName:
          type: string
          description: The new display name of the limit. 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 new description of the limit. 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.
        maxCount:
          type: integer
          description: The maximum number of resources constrained by this limit. When all of the resources are in use, steps
            that require the limit won't be scheduled until the resource is available. If more than the new maximum number
            is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below
            the new maximum number. The maxCount must not be 0. If the value is -1, there is no restriction on the number
            of resources that can be acquired for this limit.
      required:
      - farmId
      - limitId
    UpdateLimitResponse:
      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)