Amazon Deadline Cloud Deadline Cloud Tasks API
The Deadline Cloud Tasks API from Amazon Deadline Cloud — 2 operation(s) for deadline cloud tasks.
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-tasks-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 Tasks 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}/queues/{queueId}/jobs/{jobId}/steps/{stepId}/tasks/{taskId}:
get:
operationId: GetTask
summary: Get Task
description: Gets a task.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetTaskResponse'
'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/GetTaskRequest'
tags:
- Tasks
patch:
operationId: UpdateTask
summary: Update Task
description: Updates a task.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTaskResponse'
'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/UpdateTaskRequest'
tags:
- Tasks
/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/steps/{stepId}/tasks:
get:
operationId: ListTasks
summary: List Tasks
description: Lists tasks for a job.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTasksResponse'
'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/ListTasksRequest'
tags:
- Tasks
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
GetTaskRequest:
type: object
properties:
farmId:
type: string
description: The farm ID of the farm connected to the task.
queueId:
type: string
description: The queue ID for the queue connected to the task.
jobId:
type: string
description: The job ID of the job connected to the task.
stepId:
type: string
description: The step ID for the step connected to the task.
taskId:
type: string
description: The task ID.
required:
- farmId
- queueId
- jobId
- stepId
- taskId
GetTaskResponse:
type: object
properties:
taskId:
type: string
description: The task ID.
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.
runStatus:
type: string
enum:
- PENDING
- READY
- ASSIGNED
- STARTING
- SCHEDULED
- INTERRUPTING
- RUNNING
- SUSPENDED
- CANCELED
- FAILED
- SUCCEEDED
- NOT_COMPATIBLE
description: The run status for the task.
targetRunStatus:
type: string
enum:
- READY
- FAILED
- SUCCEEDED
- CANCELED
- SUSPENDED
- PENDING
description: The run status with which to start the task.
failureRetryCount:
type: integer
description: The number of times that the task failed and was retried.
startedAt:
type: string
format: date-time
description: The date and time the resource started running.
endedAt:
type: string
format: date-time
description: The date and time the resource ended running.
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.
latestSessionActionId:
type: string
description: The latest session action ID for the task.
parameters:
type: object
additionalProperties:
$ref: '#/components/schemas/TaskParameterValue'
description: The parameters for the task.
required:
- taskId
- createdAt
- createdBy
- runStatus
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
ListTasksRequest:
type: object
properties:
farmId:
type: string
description: The farm ID connected to the tasks.
queueId:
type: string
description: The queue ID connected to the tasks.
jobId:
type: string
description: The job ID for the tasks.
stepId:
type: string
description: The step ID for the tasks.
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
- jobId
- stepId
ListTasksResponse:
type: object
properties:
tasks:
type: array
items:
$ref: '#/components/schemas/TaskSummary'
description: Tasks for the job.
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:
- tasks
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
TaskParameterValue:
type: object
properties:
int:
type: string
description: A signed integer represented as a string.
float:
type: string
description: A double precision IEEE-754 floating point number represented as a string.
string:
type: string
description: A UTF-8 string.
path:
type: string
description: A file system path represented as a string.
chunkInt:
type: string
description: A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as
a string.
description: Exactly one member is set.
TaskSummary:
type: object
properties:
taskId:
type: string
description: The task ID.
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.
runStatus:
type: string
enum:
- PENDING
- READY
- ASSIGNED
- STARTING
- SCHEDULED
- INTERRUPTING
- RUNNING
- SUSPENDED
- CANCELED
- FAILED
- SUCCEEDED
- NOT_COMPATIBLE
description: The run status of the task.
targetRunStatus:
type: string
enum:
- READY
- FAILED
- SUCCEEDED
- CANCELED
- SUSPENDED
- PENDING
description: The run status on which the started.
failureRetryCount:
type: integer
description: The number of times that the task failed and was retried.
startedAt:
type: string
format: date-time
description: The date and time the resource started running.
endedAt:
type: string
format: date-time
description: The date and time the resource ended running.
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.
latestSessionActionId:
type: string
description: The latest session action ID for the task.
parameters:
type: object
additionalProperties:
$ref: '#/components/schemas/TaskParameterValue'
description: The task parameters.
required:
- taskId
- createdAt
- createdBy
- runStatus
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
UpdateTaskRequest:
type: object
properties:
farmId:
type: string
description: The farm ID to update.
queueId:
type: string
description: The queue ID to update.
jobId:
type: string
description: The job ID to update.
stepId:
type: string
description: The step ID to update.
taskId:
type: string
description: The task ID to update.
clientToken:
type: string
description: The unique token which the server uses to recognize retries of the same request.
targetRunStatus:
type: string
enum:
- READY
- FAILED
- SUCCEEDED
- CANCELED
- SUSPENDED
- PENDING
description: The run status with which to start the task.
required:
- farmId
- queueId
- jobId
- stepId
- taskId
- targetRunStatus
UpdateTaskResponse:
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)