ListMonitors
Gets a list of your monitors in Deadline Cloud.
Request Syntax
GET /2023-10-12/monitors?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results to return. Use this parameter with
NextTokento get results as a set of sequential pages.Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
The token for the next set of results, or
nullto start from the beginning.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"monitors": [
{
"createdAt": "string",
"createdBy": "string",
"displayName": "string",
"identityCenterApplicationArn": "string",
"identityCenterInstanceArn": "string",
"monitorId": "string",
"roleArn": "string",
"subdomain": "string",
"updatedAt": "string",
"updatedBy": "string",
"url": "string"
}
],
"nextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- monitors
-
A list of
MonitorSummaryobjects that describe your monitors in the Deadline Cloud.Type: Array of MonitorSummary objects
- nextToken
-
If Deadline Cloud returns
nextToken, then there are more results available. The value ofnextTokenis 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, thennextTokenis set tonull. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationExceptionerror.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permission to perform the action.
HTTP Status Code: 403
- InternalServerErrorException
-
Deadline Cloud can't process your request right now. Try again later.
HTTP Status Code: 500
- ThrottlingException
-
Your request exceeded a request rate quota.
HTTP Status Code: 429
- ValidationException
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
