Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeJobs

Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances 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

{
   "accountID": "string",
   "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.

accountID

Request to describe job log items by Account ID.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12,}

Required: No

filters

Request to describe Job log filters.

Type: DescribeJobsRequestFilters object

Required: No

maxResults

Request to describe job log items by max results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

Request to describe job log items by next token.

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",
         "participatingServers": [ 
            { 
               "launchedEc2InstanceID": "string",
               "launchStatus": "string",
               "postLaunchActionsStatus": { 
                  "postLaunchActionsLaunchStatusList": [ 
                     { 
                        "executionID": "string",
                        "executionStatus": "string",
                        "failureReason": "string",
                        "ssmDocument": { 
                           "actionName": "string",
                           "externalParameters": { 
                              "string" : { ... }
                           },
                           "mustSucceedForCutover": boolean,
                           "parameters": { 
                              "string" : [ 
                                 { 
                                    "parameterName": "string",
                                    "parameterType": "string"
                                 }
                              ]
                           },
                           "ssmDocumentName": "string",
                           "timeoutSeconds": number
                        },
                        "ssmDocumentType": "string"
                     }
                  ],
                  "ssmAgentDiscoveryDatetime": "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.

items

Request to describe Job log items.

Type: Array of Job objects

nextToken

Request to describe Job response by next token.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Errors.

UninitializedAccountException

Uninitialized account exception.

HTTP Status Code: 400

ValidationException

Validate exception.

HTTP Status Code: 400