Amazon Deadline Cloud Deadline Cloud Budgets API

openapi: 3.1.0
info:
  title: AWSDeadlineCloud Budgets 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}/budgets:
    post:
      operationId: CreateBudget
      summary: Create Budget
      description: Creates a budget to set spending thresholds for your rendering activity.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBudgetResponse'
        '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/CreateBudgetRequest'
      tags:
      - Budgets
    get:
      operationId: ListBudgets
      summary: List Budgets
      description: A list of budgets in a farm.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBudgetsResponse'
        '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/ListBudgetsRequest'
      tags:
      - Budgets
  /2023-10-12/farms/{farmId}/budgets/{budgetId}:
    get:
      operationId: GetBudget
      summary: Get Budget
      description: Get a budget.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBudgetResponse'
        '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/GetBudgetRequest'
      tags:
      - Budgets
    patch:
      operationId: UpdateBudget
      summary: Update Budget
      description: Updates a budget that sets spending thresholds for rendering activity.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateBudgetResponse'
        '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/UpdateBudgetRequest'
      tags:
      - Budgets
    delete:
      operationId: DeleteBudget
      summary: Delete Budget
      description: Deletes a budget.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteBudgetResponse'
        '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/DeleteBudgetRequest'
      tags:
      - Budgets
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
    BudgetActionToAdd:
      type: object
      properties:
        type:
          type: string
          enum:
          - STOP_SCHEDULING_AND_COMPLETE_TASKS
          - STOP_SCHEDULING_AND_CANCEL_TASKS
          description: The type of budget action to add.
        thresholdPercentage:
          type: number
          description: The percentage threshold for the budget action to add.
        description:
          type: string
          description: A description for the budget action to add. 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:
      - type
      - thresholdPercentage
    BudgetActionToRemove:
      type: object
      properties:
        type:
          type: string
          enum:
          - STOP_SCHEDULING_AND_COMPLETE_TASKS
          - STOP_SCHEDULING_AND_CANCEL_TASKS
          description: The type of budget action to remove.
        thresholdPercentage:
          type: number
          description: The percentage threshold for the budget action to remove.
      required:
      - type
      - thresholdPercentage
    BudgetSchedule:
      type: object
      properties:
        fixed:
          $ref: '#/components/schemas/FixedBudgetSchedule'
      description: Exactly one member is set.
    BudgetSummary:
      type: object
      properties:
        budgetId:
          type: string
          description: The budget ID.
        usageTrackingResource:
          $ref: '#/components/schemas/UsageTrackingResource'
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The status of the budget. ACTIVE–The budget is being evaluated. INACTIVE–The budget is inactive. This
            can include Expired, Canceled, or deleted Deleted statuses.
        displayName:
          type: string
          description: The display name of the budget 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.
        approximateDollarLimit:
          type: number
          description: The approximate dollar limit of the budget.
        usages:
          $ref: '#/components/schemas/ConsumedUsages'
        createdBy:
          type: string
          description: The user or system that created this resource.
        createdAt:
          type: string
          format: date-time
          description: The date and time the resource was created.
        updatedBy:
          type: string
          description: The user or system that updated this resource.
        updatedAt:
          type: string
          format: date-time
          description: The date and time the resource was updated.
        description:
          type: string
          description: The description of the budget summary. 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:
      - budgetId
      - usageTrackingResource
      - status
      - displayName
      - approximateDollarLimit
      - usages
      - createdBy
      - createdAt
    ConsumedUsages:
      type: object
      properties:
        approximateDollarUsage:
          type: number
          description: The amount of the budget consumed.
      required:
      - approximateDollarUsage
    CreateBudgetRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID to include in this budget.
        displayName:
          type: string
          description: The display name of the budget. 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 budget. 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.
        clientToken:
          type: string
          description: The unique token which the server uses to recognize retries of the same request.
        usageTrackingResource:
          $ref: '#/components/schemas/UsageTrackingResource'
        approximateDollarLimit:
          type: number
          description: The dollar limit based on consumed usage.
        actions:
          type: array
          items:
            $ref: '#/components/schemas/BudgetActionToAdd'
          description: The budget actions to specify what happens when the budget runs out.
        schedule:
          $ref: '#/components/schemas/BudgetSchedule'
        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.
      required:
      - farmId
      - displayName
      - usageTrackingResource
      - approximateDollarLimit
      - actions
      - schedule
    CreateBudgetResponse:
      type: object
      properties:
        budgetId:
          type: string
          description: The budget ID.
      required:
      - budgetId
    DeleteBudgetRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm to remove from the budget.
        budgetId:
          type: string
          description: The budget ID of the budget to delete.
      required:
      - farmId
      - budgetId
    DeleteBudgetResponse:
      type: object
      properties: {}
    FixedBudgetSchedule:
      type: object
      properties:
        startTime:
          type: string
          format: date-time
          description: When the budget starts.
        endTime:
          type: string
          format: date-time
          description: When the budget ends.
      required:
      - startTime
      - endTime
    GetBudgetRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm connected to the budget.
        budgetId:
          type: string
          description: The budget ID.
      required:
      - farmId
      - budgetId
    GetBudgetResponse:
      type: object
      properties:
        budgetId:
          type: string
          description: The budget ID.
        usageTrackingResource:
          $ref: '#/components/schemas/UsageTrackingResource'
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The status of the budget. ACTIVE–Get a budget being evaluated. INACTIVE–Get an inactive budget. This
            can include expired, canceled, or deleted statuses.
        displayName:
          type: string
          description: The display name of the budget. 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.
        approximateDollarLimit:
          type: number
          description: The consumed usage limit for the budget.
        usages:
          $ref: '#/components/schemas/ConsumedUsages'
        createdBy:
          type: string
          description: The user or system that created this resource.
        createdAt:
          type: string
          format: date-time
          description: The date and time the resource was created.
        updatedBy:
          type: string
          description: The user or system that updated this resource.
        updatedAt:
          type: string
          format: date-time
          description: The date and time the resource was updated.
        description:
          type: string
          description: The description of the budget. 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.
        actions:
          type: array
          items:
            $ref: '#/components/schemas/ResponseBudgetAction'
          description: The budget actions for the budget.
        schedule:
          $ref: '#/components/schemas/BudgetSchedule'
        queueStoppedAt:
          type: string
          format: date-time
          description: The date and time the queue stopped.
      required:
      - budgetId
      - usageTrackingResource
      - status
      - displayName
      - approximateDollarLimit
      - usages
      - createdBy
      - createdAt
      - actions
      - schedule
    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
    ListBudgetsRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID associated with the budgets.
        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.
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The status to list for the budgets.
      required:
      - farmId
    ListBudgetsResponse:
      type: object
      properties:
        budgets:
          type: array
          items:
            $ref: '#/components/schemas/BudgetSummary'
          description: The budgets to include 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:
      - budgets
    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
    ResponseBudgetAction:
      type: object
      properties:
        type:
          type: string
          enum:
          - STOP_SCHEDULING_AND_COMPLETE_TASKS
          - STOP_SCHEDULING_AND_CANCEL_TASKS
          description: The action taken on the budget once scheduling stops.
        thresholdPercentage:
          type: number
          description: The percentage threshold for the budget.
        description:
          type: string
          description: The budget action description. 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:
      - type
      - thresholdPercentage
    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
    UpdateBudgetRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the budget to update.
        budgetId:
          type: string
          description: The budget ID to update.
        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 budget 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 budget 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:
          - ACTIVE
          - INACTIVE
          description: Updates the status of the budget. ACTIVE–The budget is being evaluated. INACTIVE–The budget is inactive.
            This can include Expired, Canceled, or deleted Deleted statuses.
        approximateDollarLimit:
          type: number
          description: The dollar limit to update on the budget. Based on consumed usage.
        actionsToAdd:
          type: array
          items:
            $ref: '#/components/schemas/BudgetActionToAdd'
          description: The budget actions to add. Budget actions specify what happens when the budget runs out.
        actionsToRemove:
          type: array
          items:
            $ref: '#/components/schemas/BudgetActionToRemove'
          description: The budget actions to remove from the budget.
        schedule:
          $ref: '#/components/schemas/BudgetSchedule'
      required:
      - farmId
      - budgetId
    UpdateBudgetResponse:
      type: object
      properties: {}
    UsageTrackingResource:
      type: object
      properties:
        queueId:
          type: string
          description: The queue ID.
      description: Exactly one member is set.
    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)