Amazon Deadline Cloud Deadline Cloud Volumes API
The Deadline Cloud Volumes API from Amazon Deadline Cloud — 2 operation(s) for deadline cloud volumes.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-deadline-cloud:amazon-deadline-cloud-volumes-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.1.0
info:
title: AWSDeadlineCloud Volumes API
version: '2023-10-12'
description: Generated from AWS's published Smithy model for AWSDeadlineCloud. 3 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}/fleets/{fleetId}/volumes/{volumeId}:
get:
operationId: GetVolume
summary: Get Volume
description: Gets a persistent volume.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetVolumeResponse'
'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/GetVolumeRequest'
example:
farmId: farm-1234567890abcdef1234567890abcdef
fleetId: fleet-1234567890abcdef1234567890abcdef
volumeId: volume-1234567890abcdef1234567890abcdef
tags:
- Volumes
delete:
operationId: DeleteVolume
summary: Delete Volume
description: Deletes a persistent volume.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteVolumeResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteVolumeRequest'
example:
farmId: farm-1234567890abcdef1234567890abcdef
fleetId: fleet-1234567890abcdef1234567890abcdef
volumeId: volume-1234567890abcdef1234567890abcdef
tags:
- Volumes
/2023-10-12/farms/{farmId}/fleets/{fleetId}/volumes:
get:
operationId: ListVolumes
summary: List Volumes
description: Lists the persistent volumes in a fleet.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListVolumesResponse'
'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/ListVolumesRequest'
example:
farmId: farm-1234567890abcdef1234567890abcdef
fleetId: fleet-1234567890abcdef1234567890abcdef
tags:
- Volumes
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: deadline
schemas:
AccessDeniedException:
type: object
properties:
message:
type: string
context:
type: object
additionalProperties:
type: string
description: Information about the resources in use when the exception was thrown.
required:
- message
ConflictException:
type: object
properties:
message:
type: string
reason:
type: string
enum:
- CONFLICT_EXCEPTION
- CONCURRENT_MODIFICATION
- RESOURCE_ALREADY_EXISTS
- RESOURCE_IN_USE
- STATUS_CONFLICT
description: A description of the error.
resourceId:
type: string
description: The identifier of the resource in use.
resourceType:
type: string
description: The type of the resource in use.
context:
type: object
additionalProperties:
type: string
description: Information about the resources in use when the exception was thrown.
required:
- message
- reason
- resourceId
- resourceType
DeleteVolumeRequest:
type: object
properties:
farmId:
type: string
description: The farm ID of the farm that contains the fleet.
fleetId:
type: string
description: The fleet ID of the fleet that contains the volume.
volumeId:
type: string
description: The volume ID of the volume to delete.
required:
- farmId
- fleetId
- volumeId
DeleteVolumeResponse:
type: object
properties: {}
GetVolumeRequest:
type: object
properties:
farmId:
type: string
description: The farm ID of the farm that contains the fleet.
fleetId:
type: string
description: The fleet ID of the fleet that contains the volume.
volumeId:
type: string
description: The volume ID of the volume to retrieve.
required:
- farmId
- fleetId
- volumeId
GetVolumeResponse:
type: object
properties:
volumeId:
type: string
description: The volume ID.
farmId:
type: string
description: The farm ID of the farm that contains the fleet.
fleetId:
type: string
description: The fleet ID of the fleet that contains the volume.
state:
type: string
enum:
- PENDING_CREATION
- PENDING_ATTACHMENT
- IN_USE
- AVAILABLE
- PENDING_DELETION
description: The state of the volume.
sizeGiB:
type: integer
description: The volume size in GiB.
availabilityZoneId:
type: string
description: The Availability Zone ID of the volume.
attachedWorkerId:
type: string
description: The worker ID of the worker the volume is attached to.
volumeType:
type: string
enum:
- gp3
description: The EBS volume type.
iops:
type: integer
description: The IOPS of the volume.
throughputMiB:
type: integer
description: The throughput of the volume in MiB.
createdAt:
type: string
format: date-time
description: The date and time the resource was created.
lastAssignedAt:
type: string
format: date-time
description: The date and time the volume was last assigned to a worker.
lastReleasedAt:
type: string
format: date-time
description: The date and time the volume was last released from a worker.
expiresAt:
type: string
format: date-time
description: The date and time the volume expires and will be deleted.
required:
- volumeId
- farmId
- fleetId
- state
- sizeGiB
- availabilityZoneId
- volumeType
- createdAt
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
ListVolumesRequest:
type: object
properties:
farmId:
type: string
description: The farm ID of the farm that contains the fleet.
fleetId:
type: string
description: The fleet ID of the fleet that contains the volumes.
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
- fleetId
ListVolumesResponse:
type: object
properties:
volumes:
type: array
items:
$ref: '#/components/schemas/VolumeSummary'
description: The volumes 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:
- volumes
ResourceNotFoundException:
type: object
properties:
message:
type: string
resourceId:
type: string
description: The identifier of the resource that couldn't be found.
resourceType:
type: string
description: The type of the resource that couldn't be found.
context:
type: object
additionalProperties:
type: string
description: Information about the resources in use when the exception was thrown.
required:
- message
- resourceId
- resourceType
ThrottlingException:
type: object
properties:
message:
type: string
serviceCode:
type: string
description: Identifies the service that is being throttled.
quotaCode:
type: string
description: Identifies the quota that is being throttled.
retryAfterSeconds:
type: integer
description: The number of seconds a client should wait before retrying the request.
context:
type: object
additionalProperties:
type: string
description: Information about the resources in use when the exception was thrown.
required:
- message
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
VolumeSummary:
type: object
properties:
volumeId:
type: string
description: The volume ID.
farmId:
type: string
description: The farm ID of the farm that contains the fleet.
fleetId:
type: string
description: The fleet ID of the fleet that contains the volume.
state:
type: string
enum:
- PENDING_CREATION
- PENDING_ATTACHMENT
- IN_USE
- AVAILABLE
- PENDING_DELETION
description: The state of the volume.
sizeGiB:
type: integer
description: The volume size in GiB.
availabilityZoneId:
type: string
description: The Availability Zone ID of the volume.
attachedWorkerId:
type: string
description: The worker ID of the worker the volume is attached to.
required:
- volumeId
- farmId
- fleetId
- state
- sizeGiB
- availabilityZoneId
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)