Amazon Deadline Cloud Deadline Cloud Monitors API
The Deadline Cloud Monitors API from Amazon Deadline Cloud — 2 operation(s) for deadline cloud monitors.
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-monitors-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 Monitors 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/monitors:
post:
operationId: CreateMonitor
summary: Create Monitor
description: Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and
fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download
the job's results.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMonitorResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'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/CreateMonitorRequest'
tags:
- Monitors
get:
operationId: ListMonitors
summary: List Monitors
description: Gets a list of your monitors in Deadline Cloud.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListMonitorsResponse'
'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/ListMonitorsRequest'
tags:
- Monitors
/2023-10-12/monitors/{monitorId}:
get:
operationId: GetMonitor
summary: Get Monitor
description: Gets information about the specified monitor.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetMonitorResponse'
'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/GetMonitorRequest'
tags:
- Monitors
patch:
operationId: UpdateMonitor
summary: Update Monitor
description: Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you
call UpdateMonitor.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMonitorResponse'
'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/UpdateMonitorRequest'
tags:
- Monitors
delete:
operationId: DeleteMonitor
summary: Delete Monitor
description: Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms
to the monitor.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteMonitorResponse'
'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/DeleteMonitorRequest'
tags:
- Monitors
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
CreateMonitorRequest:
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 name that you give the monitor that is displayed in the Deadline Cloud console. 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.
identityCenterInstanceArn:
type: string
description: The Amazon Resource Name of the IAM Identity Center instance that authenticates monitor users.
identityCenterRegion:
type: string
description: The Region where IAM Identity Center is enabled. Required when IAM Identity Center is in a different
Region than the monitor.
subdomain:
type: string
description: The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
roleArn:
type: string
description: The Amazon Resource Name of the IAM role that the monitor uses to connect to Deadline Cloud. Every
user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources.
tags:
type: object
additionalProperties:
type: string
description: The tags to add to your monitor. 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
- identityCenterInstanceArn
- subdomain
- roleArn
CreateMonitorResponse:
type: object
properties:
monitorId:
type: string
description: The unique identifier of the monitor.
identityCenterApplicationArn:
type: string
description: The Amazon Resource Name that IAM Identity Center assigns to the monitor.
required:
- monitorId
- identityCenterApplicationArn
DeleteMonitorRequest:
type: object
properties:
monitorId:
type: string
description: The unique identifier of the monitor to delete. This ID is returned by the CreateMonitor operation,
and is included in the response to the GetMonitor operation.
required:
- monitorId
DeleteMonitorResponse:
type: object
properties: {}
GetMonitorRequest:
type: object
properties:
monitorId:
type: string
description: The unique identifier for the monitor. This ID is returned by the CreateMonitor operation.
required:
- monitorId
GetMonitorResponse:
type: object
properties:
monitorId:
type: string
description: The unique identifier for the monitor.
displayName:
type: string
description: The name used to identify the monitor on the Deadline Cloud console. 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.
subdomain:
type: string
description: The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
url:
type: string
description: The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
roleArn:
type: string
description: The Amazon Resource Name of the IAM role for the monitor. Users of the monitor use this role to access
Deadline Cloud resources.
identityCenterInstanceArn:
type: string
description: The Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor
users.
identityCenterRegion:
type: string
description: The Region where IAM Identity Center is enabled.
identityCenterApplicationArn:
type: string
description: The Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created.
createdAt:
type: string
format: date-time
description: The UNIX timestamp of the date and time that the monitor was created.
createdBy:
type: string
description: The user name of the person that created the monitor.
updatedAt:
type: string
format: date-time
description: The UNIX timestamp of the last date and time that the monitor was updated.
updatedBy:
type: string
description: The user name of the person that last updated the monitor.
required:
- monitorId
- displayName
- subdomain
- url
- roleArn
- identityCenterInstanceArn
- identityCenterApplicationArn
- createdAt
- createdBy
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
ListMonitorsRequest:
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.
ListMonitorsResponse:
type: object
properties:
monitors:
type: array
items:
$ref: '#/components/schemas/MonitorSummary'
description: A list of MonitorSummary objects that describe your monitors in the Deadline Cloud.
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:
- monitors
MonitorSummary:
type: object
properties:
monitorId:
type: string
description: The unique identifier for the monitor.
displayName:
type: string
description: The name of the monitor that displays on the Deadline Cloud console. 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.
subdomain:
type: string
description: The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
url:
type: string
description: The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
roleArn:
type: string
description: The Amazon Resource Name of the IAM role for the monitor. Users of the monitor use this role to access
Deadline Cloud resources.
identityCenterInstanceArn:
type: string
description: The Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor
users.
identityCenterRegion:
type: string
description: The Region where IAM Identity Center is enabled.
identityCenterApplicationArn:
type: string
description: The Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created.
createdAt:
type: string
format: date-time
description: The UNIX timestamp of the date and time that the monitor was created.
createdBy:
type: string
description: The user name of the person that created the monitor.
updatedAt:
type: string
format: date-time
description: The UNIX timestamp of the date and time that the monitor was last updated.
updatedBy:
type: string
description: The user name of the person that last updated the monitor.
required:
- monitorId
- displayName
- subdomain
- url
- roleArn
- identityCenterInstanceArn
- identityCenterApplicationArn
- createdAt
- createdBy
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
UpdateMonitorRequest:
type: object
properties:
monitorId:
type: string
description: The unique identifier of the monitor to update.
subdomain:
type: string
description: The new value of the subdomain to use when forming the monitor URL.
displayName:
type: string
description: The new value to use for the monitor's display name. 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.
roleArn:
type: string
description: The Amazon Resource Name of the new IAM role to use with the monitor.
required:
- monitorId
UpdateMonitorResponse:
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)