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

DescribeJob

Describes a job.

Requires permission to access the DescribeJob action.

Request Syntax


GET /jobs/jobId?beforeSubstitution=beforeSubstitution HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

beforeSubstitution

A flag that provides a view of the job document before and after the substitution parameters have been resolved with their exact values.

jobId

The unique identifier you assigned to this job when it was created.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "documentSource": "string",
   "job": { 
      "abortConfig": { 
         "criteriaList": [ 
            { 
               "action": "string",
               "failureType": "string",
               "minNumberOfExecutedThings": number,
               "thresholdPercentage": number
            }
         ]
      },
      "comment": "string",
      "completedAt": number,
      "createdAt": number,
      "description": "string",
      "destinationPackageVersions": [ "string" ],
      "documentParameters": { 
         "string" : "string" 
      },
      "forceCanceled": boolean,
      "isConcurrent": boolean,
      "jobArn": "string",
      "jobExecutionsRetryConfig": { 
         "criteriaList": [ 
            { 
               "failureType": "string",
               "numberOfRetries": number
            }
         ]
      },
      "jobExecutionsRolloutConfig": { 
         "exponentialRate": { 
            "baseRatePerMinute": number,
            "incrementFactor": number,
            "rateIncreaseCriteria": { 
               "numberOfNotifiedThings": number,
               "numberOfSucceededThings": number
            }
         },
         "maximumPerMinute": number
      },
      "jobId": "string",
      "jobProcessDetails": { 
         "numberOfCanceledThings": number,
         "numberOfFailedThings": number,
         "numberOfInProgressThings": number,
         "numberOfQueuedThings": number,
         "numberOfRejectedThings": number,
         "numberOfRemovedThings": number,
         "numberOfSucceededThings": number,
         "numberOfTimedOutThings": number,
         "processingTargets": [ "string" ]
      },
      "jobTemplateArn": "string",
      "lastUpdatedAt": number,
      "namespaceId": "string",
      "presignedUrlConfig": { 
         "expiresInSec": number,
         "roleArn": "string"
      },
      "reasonCode": "string",
      "scheduledJobRollouts": [ 
         { 
            "startTime": "string"
         }
      ],
      "schedulingConfig": { 
         "endBehavior": "string",
         "endTime": "string",
         "maintenanceWindows": [ 
            { 
               "durationInMinutes": number,
               "startTime": "string"
            }
         ],
         "startTime": "string"
      },
      "status": "string",
      "targets": [ "string" ],
      "targetSelection": "string",
      "timeoutConfig": { 
         "inProgressTimeoutInMinutes": number
      }
   }
}

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.

documentSource

An S3 link to the job document.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1350.

job

Information about the job.

Type: Job object

Errors

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400