Amazon Simple Storage Service
API Reference (API Version 2006-03-01)

DescribeJob

Retrieves the configuration parameters and status for an Amazon S3 batch operations job.

Request Syntax

GET /v20180820/jobs/id HTTP/1.1 x-amz-account-id: AccountId

URI Request Parameters

The request requires the following URI parameters.

id

The ID for the job whose information you want to retrieve.

Length constraints: Minimum length of 5. Maximum length of 36.

x-amz-account-id

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <DescribeJobResult> <Job> <ConfirmationRequired>boolean</ConfirmationRequired> <CreationTime>timestamp</CreationTime> <Description>string</Description> <FailureReasons> <JobFailure> <FailureCode>string</FailureCode> <FailureReason>string</FailureReason> </JobFailure> </FailureReasons> <JobArn>string</JobArn> <JobId>string</JobId> <Manifest> <Location> <ETag>string</ETag> <ObjectArn>string</ObjectArn> <ObjectVersionId>string</ObjectVersionId> </Location> <Spec> <Fields> <INVALID-TYPE-NAME>string</INVALID-TYPE-NAME> </Fields> <Format>string</Format> </Spec> </Manifest> <Operation> <S3PutObjectAcl> <AccessControlPolicy> <AccessControlList> <Grants> <S3Grant> <Grantee> <DisplayName>string</DisplayName> <Identifier>string</Identifier> <TypeIdentifier>string</TypeIdentifier> </Grantee> <Permission>string</Permission> </S3Grant> </Grants> <Owner> <DisplayName>string</DisplayName> <ID>string</ID> </Owner> </AccessControlList> <CannedAccessControlList>string</CannedAccessControlList> </AccessControlPolicy> </S3PutObjectAcl> </Operation> <Priority>integer</Priority> <ProgressSummary> <NumberOfTasksFailed>long</NumberOfTasksFailed> <NumberOfTasksSucceeded>long</NumberOfTasksSucceeded> <TotalNumberOfTasks>long</TotalNumberOfTasks> </ProgressSummary> <Report> <Bucket>string</Bucket> <Enabled>boolean</Enabled> <Format>string</Format> <Prefix>string</Prefix> <ReportScope>string</ReportScope> </Report> <RoleArn>string</RoleArn> <Status>string</Status> <StatusUpdateReason>string</StatusUpdateReason> <SuspendedCause>string</SuspendedCause> <SuspendedDate>timestamp</SuspendedDate> <TerminationDate>timestamp</TerminationDate> </Job> </DescribeJobResult>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service.

DescribeJobResult

Root level tag for the DescribeJobResult parameters.

Required: Yes

Job

Contains the configuration parameters and status for the job specified in the Describe Job request.

Type: JobDescriptor object

Errors

BadRequestException

HTTP Status Code: 400

InternalServiceException

HTTP Status Code: 500

NotFoundException

HTTP Status Code: 400

TooManyRequestsException

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: