DescribeJobs
Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.
Request Syntax
POST /DescribeJobs HTTP/1.1
Content-type: application/json
{
"filters": {
"fromDate": "string",
"jobIDs": [ "string" ],
"toDate": "string"
},
"maxResults": number,
"nextToken": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- filters
-
A set of filters by which to return Jobs.
Type: DescribeJobsRequestFilters object
Required: No
- maxResults
-
Maximum number of Jobs to retrieve.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- nextToken
-
The token of the next Job to retrieve.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"items": [
{
"arn": "string",
"creationDateTime": "string",
"endDateTime": "string",
"initiatedBy": "string",
"jobID": "string",
"participatingResources": [
{
"launchStatus": "string",
"participatingResourceID": { ... }
}
],
"participatingServers": [
{
"launchActionsStatus": {
"runs": [
{
"action": {
"actionCode": "string",
"actionId": "string",
"actionVersion": "string",
"active": boolean,
"category": "string",
"description": "string",
"name": "string",
"optional": boolean,
"order": number,
"parameters": {
"string" : {
"type": "string",
"value": "string"
}
},
"type": "string"
},
"failureReason": "string",
"runId": "string",
"status": "string"
}
],
"ssmAgentDiscoveryDatetime": "string"
},
"launchStatus": "string",
"recoveryInstanceID": "string",
"sourceServerID": "string"
}
],
"status": "string",
"tags": {
"string" : "string"
},
"type": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- UninitializedAccountException
-
The account performing the request has not been initialized.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints specified by the AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
