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

DescribeJob

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

Permissions: To use the DescribeJob operation, you must have permission to perform the s3:DescribeJob action.

Related actions include:

Request Syntax


GET /v20180820/jobs/id HTTP/1.1
Host: s3-control.amazonaws.com
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

The AWS account ID associated with the S3 Batch Operations job.

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

<DescribeJobResult>
   <Job>
      <ConfirmationRequired>booleanConfirmationRequired>
      <CreationTime>timestampCreationTime>
      <Description>stringDescription>
      <FailureReasons>
         
            <FailureCode>stringFailureCode>
            <FailureReason>stringFailureReason>
         
      FailureReasons>
      <GeneratedManifestDescriptor>
         <Format>stringFormat>
         <Location>
            <ETag>stringETag>
            <ObjectArn>stringObjectArn>
            <ObjectVersionId>stringObjectVersionId>
         Location>
      GeneratedManifestDescriptor>
      <JobArn>stringJobArn>
      <JobId>stringJobId>
      <Manifest>
         <Location>
            <ETag>stringETag>
            <ObjectArn>stringObjectArn>
            <ObjectVersionId>stringObjectVersionId>
         Location>
         <Spec>
            <Fields>
               string
            Fields>
            <Format>stringFormat>
         Spec>
      Manifest>
      <ManifestGenerator>
         <S3JobManifestGenerator>
            <EnableManifestOutput>booleanEnableManifestOutput>
            <ExpectedBucketOwner>stringExpectedBucketOwner>
            <Filter>
               <CreatedAfter>timestampCreatedAfter>
               <CreatedBefore>timestampCreatedBefore>
               <EligibleForReplication>booleanEligibleForReplication>
               <KeyNameConstraint>
                  <MatchAnyPrefix>
                     string
                  MatchAnyPrefix>
                  <MatchAnySubstring>
                     string
                  MatchAnySubstring>
                  <MatchAnySuffix>
                     string
                  MatchAnySuffix>
               KeyNameConstraint>
               <MatchAnyObjectEncryption>
                  
                     <DSSE-KMS>
                        <KmsKeyArn>stringKmsKeyArn>
                     DSSE-KMS>
                     <NOT-SSE>
                     NOT-SSE>
                     <SSE-C>
                     SSE-C>
                     <SSE-KMS>
                        <BucketKeyEnabled>booleanBucketKeyEnabled>
                        <KmsKeyArn>stringKmsKeyArn>
                     SSE-KMS>
                     <SSE-S3>
                     SSE-S3>
                  
               MatchAnyObjectEncryption>
               <MatchAnyStorageClass>
                  string
               MatchAnyStorageClass>
               <ObjectReplicationStatuses>
                  string
               ObjectReplicationStatuses>
               <ObjectSizeGreaterThanBytes>longObjectSizeGreaterThanBytes>
               <ObjectSizeLessThanBytes>longObjectSizeLessThanBytes>
            Filter>
            <ManifestOutputLocation>
               <Bucket>stringBucket>
               <ExpectedManifestBucketOwner>stringExpectedManifestBucketOwner>
               <ManifestEncryption>
                  <SSE-KMS>
                     <KeyId>stringKeyId>
                  SSE-KMS>
                  <SSE-S3>
                  SSE-S3>
               ManifestEncryption>
               <ManifestFormat>stringManifestFormat>
               <ManifestPrefix>stringManifestPrefix>
            ManifestOutputLocation>
            <SourceBucket>stringSourceBucket>
         S3JobManifestGenerator>
      ManifestGenerator>
      <Operation>
         <LambdaInvoke>
            <FunctionArn>stringFunctionArn>
            <InvocationSchemaVersion>stringInvocationSchemaVersion>
            <UserArguments>
               
                  string
                  string
               
            UserArguments>
         LambdaInvoke>
         <S3ComputeObjectChecksum>
            <ChecksumAlgorithm>stringChecksumAlgorithm>
            <ChecksumType>stringChecksumType>
         S3ComputeObjectChecksum>
         <S3DeleteObjectTagging>
         S3DeleteObjectTagging>
         <S3InitiateRestoreObject>
            <ExpirationInDays>integerExpirationInDays>
            <GlacierJobTier>stringGlacierJobTier>
         S3InitiateRestoreObject>
         <S3PutObjectAcl>
            <AccessControlPolicy>
               <AccessControlList>
                  <Grants>
                     
                        <Grantee>
                           <DisplayName>stringDisplayName>
                           <Identifier>stringIdentifier>
                           <TypeIdentifier>stringTypeIdentifier>
                        Grantee>
                        <Permission>stringPermission>
                     
                  Grants>
                  <Owner>
                     <DisplayName>stringDisplayName>
                     <ID>stringID>
                  Owner>
               AccessControlList>
               <CannedAccessControlList>stringCannedAccessControlList>
            AccessControlPolicy>
         S3PutObjectAcl>
         <S3PutObjectCopy>
            <AccessControlGrants>
               
                  <Grantee>
                     <DisplayName>stringDisplayName>
                     <Identifier>stringIdentifier>
                     <TypeIdentifier>stringTypeIdentifier>
                  Grantee>
                  <Permission>stringPermission>
               
            AccessControlGrants>
            <AnnotationDirective>stringAnnotationDirective>
            <BucketKeyEnabled>booleanBucketKeyEnabled>
            <CannedAccessControlList>stringCannedAccessControlList>
            <ChecksumAlgorithm>stringChecksumAlgorithm>
            <MetadataDirective>stringMetadataDirective>
            <ModifiedSinceConstraint>timestampModifiedSinceConstraint>
            <NewObjectMetadata>
               <CacheControl>stringCacheControl>
               <ContentDisposition>stringContentDisposition>
               <ContentEncoding>stringContentEncoding>
               <ContentLanguage>stringContentLanguage>
               <ContentLength>longContentLength>
               <ContentMD5>stringContentMD5>
               <ContentType>stringContentType>
               <HttpExpiresDate>timestampHttpExpiresDate>
               <RequesterCharged>booleanRequesterCharged>
               <SSEAlgorithm>stringSSEAlgorithm>
               <UserMetadata>
                  
                     string
                     string
                  
               UserMetadata>
            NewObjectMetadata>
            <NewObjectTagging>
               
                  <Key>stringKey>
                  <Value>stringValue>
               
            NewObjectTagging>
            <ObjectLockEventHold>stringObjectLockEventHold>
            <ObjectLockEventHoldDuration>
               <Days>integerDays>
               <Years>integerYears>
            ObjectLockEventHoldDuration>
            <ObjectLockLegalHoldStatus>stringObjectLockLegalHoldStatus>
            <ObjectLockMode>stringObjectLockMode>
            <ObjectLockRetainUntilDate>timestampObjectLockRetainUntilDate>
            <RedirectLocation>stringRedirectLocation>
            <RequesterPays>booleanRequesterPays>
            <SSEAwsKmsKeyId>stringSSEAwsKmsKeyId>
            <StorageClass>stringStorageClass>
            <TargetKeyPrefix>stringTargetKeyPrefix>
            <TargetResource>stringTargetResource>
            <UnModifiedSinceConstraint>timestampUnModifiedSinceConstraint>
         S3PutObjectCopy>
         <S3PutObjectLegalHold>
            <LegalHold>
               <Status>stringStatus>
            LegalHold>
         S3PutObjectLegalHold>
         <S3PutObjectRetention>
            <BypassGovernanceRetention>booleanBypassGovernanceRetention>
            <Retention>
               <EventHold>stringEventHold>
               <EventHoldDuration>
                  <Days>integerDays>
                  <Years>integerYears>
               EventHoldDuration>
               <Mode>stringMode>
               <RetainUntilDate>timestampRetainUntilDate>
            Retention>
         S3PutObjectRetention>
         <S3PutObjectTagging>
            <TagSet>
               
                  <Key>stringKey>
                  <Value>stringValue>
               
            TagSet>
         S3PutObjectTagging>
         <S3ReplicateObject>
         S3ReplicateObject>
         <S3UpdateObjectEncryption>
            <ObjectEncryption>
               <SSE-KMS>
                  <BucketKeyEnabled>booleanBucketKeyEnabled>
                  <KMSKeyArn>stringKMSKeyArn>
               SSE-KMS>
            ObjectEncryption>
         S3UpdateObjectEncryption>
      Operation>
      <Priority>integerPriority>
      <ProgressSummary>
         <NumberOfTasksFailed>longNumberOfTasksFailed>
         <NumberOfTasksSucceeded>longNumberOfTasksSucceeded>
         <Timers>
            <ElapsedTimeInActiveSeconds>longElapsedTimeInActiveSeconds>
         Timers>
         <TotalNumberOfTasks>longTotalNumberOfTasks>
      ProgressSummary>
      <Report>
         <Bucket>stringBucket>
         <Enabled>booleanEnabled>
         <ExpectedBucketOwner>stringExpectedBucketOwner>
         <Format>stringFormat>
         <Prefix>stringPrefix>
         <ReportScope>stringReportScope>
      Report>
      <RoleArn>stringRoleArn>
      <Status>stringStatus>
      <StatusUpdateReason>stringStatusUpdateReason>
      <SuspendedCause>stringSuspendedCause>
      <SuspendedDate>timestampSuspendedDate>
      <TerminationDate>timestampTerminationDate>
   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

Errors

BadRequestException

HTTP Status Code: 400

InternalServiceException

HTTP Status Code: 500

NotFoundException

HTTP Status Code: 400

TooManyRequestsException

HTTP Status Code: 400