Amazon Deadline Cloud

Amazon Deadline Cloud Farms API

Operations for managing render farms

Documentation GitHub OpenAPI

Operations 5

POST /2023-10-12/farms Create Farm #

GET /2023-10-12/farms List Farms #

GET /2023-10-12/farms/{farmId} Get Farm #

PATCH /2023-10-12/farms/{farmId} Update Farm #

DELETE /2023-10-12/farms/{farmId} Delete Farm #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-deadline-cloud:amazon-deadline-cloud-farms-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: AWSDeadlineCloud Farms 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:
    post:
      operationId: CreateFarm
      summary: Create Farm
      description: Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders
        gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline
        Cloud farms are a useful container for large projects.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFarmResponse'
        '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/CreateFarmRequest'
      tags:
      - Farms
    get:
      operationId: ListFarms
      summary: List Farms
      description: Lists farms.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFarmsResponse'
        '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/ListFarmsRequest'
      tags:
      - Farms
  /2023-10-12/farms/{farmId}:
    get:
      operationId: GetFarm
      summary: Get Farm
      description: Get a farm.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFarmResponse'
        '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/GetFarmRequest'
      tags:
      - Farms
    patch:
      operationId: UpdateFarm
      summary: Update Farm
      description: Updates a farm.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFarmResponse'
        '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/UpdateFarmRequest'
      tags:
      - Farms
    delete:
      operationId: DeleteFarm
      summary: Delete Farm
      description: Deletes a farm.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteFarmResponse'
        '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/DeleteFarmRequest'
      tags:
      - Farms
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
    CreateFarmRequest:
      type: object
      properties:
        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 farm. 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 farm. 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.
        kmsKeyArn:
          type: string
          description: The ARN of the KMS key to use on the farm.
        costScaleFactor:
          type: number
          description: A multiplier applied to the farm's calculated costs for usage data and budget tracking. A value less
            than 1 represents a discount, a value greater than 1 represents a premium, and a value of 1 represents no adjustment.
            The default value is 1.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags to add to your farm. 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:
      - displayName
    CreateFarmResponse:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID.
      required:
      - farmId
    DeleteFarmRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm to delete.
      required:
      - farmId
    DeleteFarmResponse:
      type: object
      properties: {}
    FarmSummary:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID.
        displayName:
          type: string
          description: The display name of the farm. 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.
        kmsKeyArn:
          type: string
          description: The ARN for the KMS key.
        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:
      - farmId
      - displayName
      - createdAt
      - createdBy
    GetFarmRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm.
      required:
      - farmId
    GetFarmResponse:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID of the farm to get.
        displayName:
          type: string
          description: The display name of the farm. 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.
        kmsKeyArn:
          type: string
          description: The ARN of the KMS key used on the farm.
        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.
        description:
          type: string
          description: The description of the farm. 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.
        costScaleFactor:
          type: number
          description: A multiplier applied to the farm's calculated costs for usage data and budget tracking. A value less
            than 1 represents a discount, a value greater than 1 represents a premium, and a value of 1 represents no adjustment.
      required:
      - farmId
      - displayName
      - createdAt
      - createdBy
      - costScaleFactor
    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
    ListFarmsRequest:
      type: object
      properties:
        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.
        principalId:
          type: string
          description: The principal ID of the member to list on the farm.
    ListFarmsResponse:
      type: object
      properties:
        farms:
          type: array
          items:
            $ref: '#/components/schemas/FarmSummary'
          description: Farms 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:
      - farms
    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
    UpdateFarmRequest:
      type: object
      properties:
        farmId:
          type: string
          description: The farm ID to update.
        displayName:
          type: string
          description: The display name of the farm 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 farm 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.
        costScaleFactor:
          type: number
          description: A multiplier applied to the farm's calculated costs for usage data and budget tracking. A value less
            than 1 represents a discount, a value greater than 1 represents a premium, and a value of 1 represents no adjustment.
      required:
      - farmId
    UpdateFarmResponse:
      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)