DescribeJob - Amazon Simple Storage Service
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

DescribeJob

Retrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

Related actions include:

Request Syntax

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

URI Request Parameters

The request uses 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.

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

Required: Yes

x-amz-account-id

Length Constraints: Maximum length of 64.

Pattern: ^\d{12}$

Required: Yes

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> <LambdaInvoke> <FunctionArn>string</FunctionArn> </LambdaInvoke> <S3InitiateRestoreObject> <ExpirationInDays>integer</ExpirationInDays> <GlacierJobTier>string</GlacierJobTier> </S3InitiateRestoreObject> <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> <S3PutObjectCopy> <AccessControlGrants> <S3Grant> <Grantee> <DisplayName>string</DisplayName> <Identifier>string</Identifier> <TypeIdentifier>string</TypeIdentifier> </Grantee> <Permission>string</Permission> </S3Grant> </AccessControlGrants> <CannedAccessControlList>string</CannedAccessControlList> <MetadataDirective>string</MetadataDirective> <ModifiedSinceConstraint>timestamp</ModifiedSinceConstraint> <NewObjectMetadata> <CacheControl>string</CacheControl> <ContentDisposition>string</ContentDisposition> <ContentEncoding>string</ContentEncoding> <ContentLanguage>string</ContentLanguage> <ContentLength>long</ContentLength> <ContentMD5>string</ContentMD5> <ContentType>string</ContentType> <HttpExpiresDate>timestamp</HttpExpiresDate> <RequesterCharged>boolean</RequesterCharged> <SSEAlgorithm>string</SSEAlgorithm> <UserMetadata> <entry> <key>string</key> <value>string</value> </entry> </UserMetadata> </NewObjectMetadata> <NewObjectTagging> <Tag> <Key>string</Key> <Value>string</Value> </Tag> </NewObjectTagging> <ObjectLockLegalHoldStatus>string</ObjectLockLegalHoldStatus> <ObjectLockMode>string</ObjectLockMode> <ObjectLockRetainUntilDate>timestamp</ObjectLockRetainUntilDate> <RedirectLocation>string</RedirectLocation> <RequesterPays>boolean</RequesterPays> <SSEAwsKmsKeyId>string</SSEAwsKmsKeyId> <StorageClass>string</StorageClass> <TargetKeyPrefix>string</TargetKeyPrefix> <TargetResource>string</TargetResource> <UnModifiedSinceConstraint>timestamp</UnModifiedSinceConstraint> </S3PutObjectCopy> <S3PutObjectLegalHold> <LegalHold> <Status>string</Status> </LegalHold> </S3PutObjectLegalHold> <S3PutObjectRetention> <BypassGovernanceRetention>boolean</BypassGovernanceRetention> <Retention> <Mode>string</Mode> <RetainUntilDate>timestamp</RetainUntilDate> </Retention> </S3PutObjectRetention> <S3PutObjectTagging> <TagSet> <Tag> <Key>string</Key> <Value>string</Value> </Tag> </TagSet> </S3PutObjectTagging> </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 data type

See Also

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