Amazon Deadline Cloud Deadline Cloud Sessions API
The Deadline Cloud Sessions API from Amazon Deadline Cloud — 3 operation(s) for deadline cloud sessions.
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-sessions-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 Sessions API
version: '2023-10-12'
description: Generated from AWS's published Smithy model for AWSDeadlineCloud. 4 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}/workers/{workerId}/sessions:
get:
operationId: ListSessionsForWorker
summary: List Sessions For Worker
description: Lists sessions for a worker.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListSessionsForWorkerResponse'
'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/ListSessionsForWorkerRequest'
tags:
- Sessions
/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/sessions/{sessionId}:
get:
operationId: GetSession
summary: Get Session
description: Gets a session.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetSessionResponse'
'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/GetSessionRequest'
tags:
- Sessions
patch:
operationId: UpdateSession
summary: Update Session
description: Updates a session.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSessionResponse'
'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/UpdateSessionRequest'
tags:
- Sessions
/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/sessions:
get:
operationId: ListSessions
summary: List Sessions
description: Lists sessions.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListSessionsResponse'
'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/ListSessionsRequest'
tags:
- Sessions
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
GetSessionRequest:
type: object
properties:
farmId:
type: string
description: The farm ID for the session.
queueId:
type: string
description: The queue ID for the session.
jobId:
type: string
description: The job ID for the session.
sessionId:
type: string
description: The session ID.
required:
- farmId
- queueId
- jobId
- sessionId
GetSessionResponse:
type: object
properties:
sessionId:
type: string
description: The session ID.
fleetId:
type: string
description: The fleet ID for the session.
workerId:
type: string
description: The worker ID for the session.
startedAt:
type: string
format: date-time
description: The date and time the resource started running.
lifecycleStatus:
type: string
enum:
- STARTED
- UPDATE_IN_PROGRESS
- UPDATE_SUCCEEDED
- UPDATE_FAILED
- ENDED
description: The life cycle status of the session.
endedAt:
type: string
format: date-time
description: The date and time the resource ended running.
targetLifecycleStatus:
type: string
enum:
- ENDED
description: The life cycle status with which the session started.
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.
log:
$ref: '#/components/schemas/LogConfiguration'
hostProperties:
$ref: '#/components/schemas/HostPropertiesResponse'
workerLog:
$ref: '#/components/schemas/LogConfiguration'
required:
- sessionId
- fleetId
- workerId
- startedAt
- lifecycleStatus
- log
HostPropertiesResponse:
type: object
properties:
ipAddresses:
$ref: '#/components/schemas/IpAddresses'
hostName:
type: string
description: The host name.
ec2InstanceArn:
type: string
description: The ARN of the host EC2 instance.
ec2InstanceType:
type: string
description: The instance type of the host EC2 instance.
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
IpAddresses:
type: object
properties:
ipV4Addresses:
type: array
items:
type: string
description: The IpV4 address of the network.
ipV6Addresses:
type: array
items:
type: string
description: The IpV6 address for the network and node component.
ListSessionsForWorkerRequest:
type: object
properties:
farmId:
type: string
description: The farm ID for the session.
fleetId:
type: string
description: The fleet ID for the session.
workerId:
type: string
description: The worker ID for the session.
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
- workerId
ListSessionsForWorkerResponse:
type: object
properties:
sessions:
type: array
items:
$ref: '#/components/schemas/WorkerSessionSummary'
description: The sessions in the response.
nextToken:
type: string
description: The token for the next set of results, or null to start from the beginning.
required:
- sessions
ListSessionsRequest:
type: object
properties:
farmId:
type: string
description: The farm ID for the list of sessions.
queueId:
type: string
description: The queue ID for the list of sessions
jobId:
type: string
description: The job ID for the list of sessions.
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
ListSessionsResponse:
type: object
properties:
sessions:
type: array
items:
$ref: '#/components/schemas/SessionSummary'
description: The sessions 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:
- sessions
LogConfiguration:
type: object
properties:
logDriver:
type: string
description: The log drivers for worker related logs.
options:
type: object
additionalProperties:
type: string
description: The options for a log driver.
parameters:
type: object
additionalProperties:
type: string
description: The parameters for the log configuration.
error:
type: string
description: The log configuration error details.
required:
- logDriver
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
SessionSummary:
type: object
properties:
sessionId:
type: string
description: The session ID.
fleetId:
type: string
description: The fleet ID.
workerId:
type: string
description: The worker ID.
startedAt:
type: string
format: date-time
description: The date and time the resource started running.
lifecycleStatus:
type: string
enum:
- STARTED
- UPDATE_IN_PROGRESS
- UPDATE_SUCCEEDED
- UPDATE_FAILED
- ENDED
description: The life cycle status for the session.
endedAt:
type: string
format: date-time
description: The date and time the resource ended running.
targetLifecycleStatus:
type: string
enum:
- ENDED
description: The target life cycle status for the session.
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:
- sessionId
- fleetId
- workerId
- startedAt
- lifecycleStatus
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
UpdateSessionRequest:
type: object
properties:
farmId:
type: string
description: The farm ID to update in the session.
queueId:
type: string
description: The queue ID to update in the session.
jobId:
type: string
description: The job ID to update in the session.
sessionId:
type: string
description: The session ID to update.
clientToken:
type: string
description: The unique token which the server uses to recognize retries of the same request.
targetLifecycleStatus:
type: string
enum:
- ENDED
description: The life cycle status to update in the session.
required:
- farmId
- queueId
- jobId
- sessionId
- targetLifecycleStatus
UpdateSessionResponse:
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
WorkerSessionSummary:
type: object
properties:
sessionId:
type: string
description: The session ID for the session action.
queueId:
type: string
description: The queue ID for the queue associated to the worker.
jobId:
type: string
description: The job ID for the job associated with the worker's session.
startedAt:
type: string
format: date-time
description: The date and time the resource started running.
lifecycleStatus:
type: string
enum:
- STARTED
- UPDATE_IN_PROGRESS
- UPDATE_SUCCEEDED
- UPDATE_FAILED
- ENDED
description: The life cycle status for the worker's session.
endedAt:
type: string
format: date-time
description: The date and time the resource ended running.
targetLifecycleStatus:
type: string
enum:
- ENDED
description: The life cycle status
required:
- sessionId
- queueId
- jobId
- startedAt
- lifecycleStatus
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)