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

Batch Operations Common Elements

Description

The following tables list common request, response, and special error elements for Amazon S3 control operations.

Requests

Element Description
AccountId The account ID for the Amazon S3 account that is associated with the batch operations job.

Type: String

FunctionArn The Amazon Resource Name (ARN) of the AWS Lambda function that you want to invoke with a batch operations job.

Type: String

Default: None

Restrictions: Max length is 1,024 characters.

LogType

The type of log that you want Lambda to produce when invoked by a batch operations job.

Type: String

Valid values: None | Tail

UserArguments

The arguments that you want to pass to each invocation of a Lambda function by a batch operations job.

Restrictions: The total length of arguments must be fewer than or equal to 20,480 characters

S3CopyObjectAction

A container element used to specify the parameters of a batch operations Copy Object request.

Type: Container

Child Elements

Element Type Restrictions
TargetResource S3BucketArnString
AccessControlList S3AccessControlList
CannedAccessControlList S3CannedAccessControlList
MetadataDirective S3MetadataDirective
ModifiedSinceConstraint TimeStamp
NewObjectMetadata S3ObjectMetadata
NewObjectTagging S3TagSet
RedirectLocation String Must be between 1 and 2,048 characters
RequesterPays Boolean
StorageClass S3StorageClass
UnmodifiedSinceConstraint TimeStamp
TargetResource

The ARN of the Amazon S3 bucket that you want to use with a batch operations job.

Type: String

Restrictions: The value must be between 1 and 128 characters long.

AccessControlList A container element that is used to specify the permission grants for an object copied as part of a batch operations job.

Type: Container

Child Elements

Element Type Restrictions
Owner S3ObjectOwner Required
Grants S3GrantList Required
S3ObjectOwner

Type: Container

Child Elements

Element Type Restrictions
ID String

Required

Maximum length is 1,024 characters
DisplayName String

Required

Maximum length is 1,024 characters
S3GrantList

Type: List

List Item Type: S3Grant

S3Grant A permission grant for an Amazon S3 resource.

Type: Container

Child Elements

Element Type Restrictions
Grantee S3Grantee Required
Permission S3Permission Required
S3Grantee A grantee for an S3Grant.

Type: Container

Child Elements

Element Type Restrictions
TypeIdentifier S3GranteeTypeIdentifier Required
Identifier String

Required

Maximum length is 1,024 characters
DisplayName String

Required

Maximum length is 1,024 characters
S3GranteeTypeIdentifier Identifies the type of grantee that is used to grant permissions for an Amazon S3 resource.

Type: String

Valid values: CANONICAL | EMAIL_ADDRESS | GROUP

S3Permission Specifies an access permission to be granted for an Amazon S3 resource.

Type: String

Valid values: FULL_CONTROL | READ | WRITE | READ_ACP | WRITE_ACP

S3MetadataDirective

Type: String

Valid values: COPY | REPLACE

S3StorageClass

Type: String

Valid values: STANDARD | STANDARD_IA | ONEZONE_IA | GLACIER | INTELLIGENT_TIERING | DEEP_ARCHIVE

JobId The ID of the batch operations job that you want to perform an action on.

Type: String

Restrictions: Must be between 5 and 36 characters long.

JobPriority

Type: Integer

Restrictions: The value must be between 0 and 2^31 - 1 (2147483647)

JobReport
JobStatus

Type: String

Valid values: Active | Cancelled | Cancelling | Complete | Completing | Failed | Failing | New | Paused | Pausing | Preparing | Ready

JobStatusUpdateReason

Type: String

Restrictions: Maximum length is 256 characters

JobReport

Type: Container

Child Elements

Element Type Restrictions
AccountId AccountId
Bucket String

Required

Must be between 1 and 128 characters
Format String

Required

Valid values: JobReport_CSV_20180820
Prefix String

Required

Must be between 1 and 512 characters long
ReportScope String

Required

Valid values: AllTasks | FailedTasksOnly

Responses

Element Description
JobDescriptor

Type: Container

Child Elements

Element Type Restrictions
JobId JobId
Name String Must be between 1 and 256 characters
JobArn String Must be between 1 and 1,250 characters
Status JobStatus
Manifest JobManifest
Action JobAction
Priority JobPriority
ProgressSummary JobProgressSummary
StatusUpdateReason JobStatusUpdateReason
FailureReasons JobFailureReasonList
Report JobReport
CreationTime JobCreationTime
TerminationTime JobTerminationTime
JobProgressSummary

Type: Container

Child Elements

Element Type
TotalNumberOfTasks Long
NumberOfTasksSucceeded Long
NumberOfTasksFailed Long
JobFailureReasonList

Type: List

List Item Type: JobFailureReason

JobFailureReason

Type: String

Valid values: ErrorReadingManifest | ErrorWritingReport | TaskFailureThresholdExceeded

Elements Common to Requests and Responses

Element Description
JobAction

A container element that is used to specify what action you want batch operations or Amazon S3 public lockdown to perform.

Type: Container

Child Elements

Element Type Restrictions
LambdaInvoke LambdaInvokeAction
S3CopyObject S3CopyObjectAction
S3SetObjectAcl S3SetObjectAclAction
S3SetObjectTagging S3SetObjectTaggingAction
S3InitiateRestoreObject S3InitiateRestoreObjectAction

Restrictions: Exactly one child element is required when JobAction is used in a request.

JobManifest

Type: Container

Child Elements

Element Type Restrictions
Spec JobManifestSpec Required in requests
Location JobManifestLocation Required in requests
JobManifestSpec

Type: Container

Child Elements

Element Type Restrictions
Format String Required in requests

Valid values: S3Foreman_CSV_20180820 | S3InventoryReport_CSV_20161130

Fields List

List Item Type: String

Each entry must be between 1 and 1,024 characters
JobManifestLocation

Type: Container

Child Elements

Element Type Restrictions
AccountId AccountId
ObjectArn String Required in requests

Must be between 1 and 2,000 characters

ObjectVersionId String Must be between 1 and 2,000 characters
ETag String Must be between 1 and 1,024 characters
S3BucketArnString

Type: String

Restrictions: Must be between 1 and 128 characters

S3AccessControlPolicy

Type: Container

Child Elements

Element Type
AccessControlList S3AccessControlList
CannedAccessControlList S3CannedAccessControlList
S3AccessControlList

Type: Container

Child Elements

Element Type
Owner S3ObjectOwner
Grants S3GrantList
S3CannedAccessControlList

Type: String

Valid values: PRIVATE | PUBLIC_READ | PUBLIC_READ_WRITE | AWS_EXEC_READ | AUTHENTICATED_READ | BUCKET_OWNER_READ | BUCKET_OWNER_FULL_CONTROL

S3TagSet

Type: List

List Item Type: S3Tag

S3Tag

Type: Container

Child Elements

Element Type Restrictions
Key String Required

Must be between 1 and 1,024 characters

Value String Required

Must be between 1 and 1,024 characters

S3ObjectMetadata

Type: Container

Child Elements

Element Type Restrictions
CacheControl String Must be between 1 and 1,024 characters
ContentDisposition String Must be between 1 and 1,024 characters
ContentEncoding String Must be between 1 and 1,024 characters
ContentLanguage String Must be between 1 and 1,024 characters
UserMetadata S3UserMetadata
ContentLength Integer Must be greater than or equal to 0
ContentMD5 String Must be between 1 and 1,024 characters
ContentType String Must be between 1 and 1,024 characters
HttpExpiresDate TimeStamp
RequesterCharged Boolean
S3UserMetadata

Type: Map

Restrictions: The total length of the key + value must be fewer than or equal to 8,192 characters

Actions

Action Description
LambdaInvokeAction A container element that is used to specify the AWS Lambda action that you want to invoke with a batch operations job.

Type: Container

Child Elements

Element Type Restrictions
FunctionArn String

Required

Must be between 1 and 1,024 characters
LogType String

Required

Valid values: None | Tail
UserArguments UserArguments Required
S3CopyObject

A container element that is used to specify the parameters of a batch operations Copy Object request.

Type: Container

Child Elements

Element Type Restrictions
TargetResource S3BucketArnString
AccessControlList S3AccessControlList
CannedAccessControlList S3CannedAccessControlList
MetadataDirective S3MetadataDirective
ModifiedSinceConstraint TimeStamp
NewObjectMetadata S3ObjectMetadata
NewObjectTagging S3TagSet
RedirectLocation String Must be between 1 and 2,048 characters
RequesterPays Boolean
StorageClass S3StorageClass
UnmodifiedSinceConstraint TimeStamp
S3SetObjectAcl

Type: Container

Child Elements

Element Type Restrictions
AccessControlPolicy S3AccessControlPolicy Required
S3SetObjectTagging

Type: Container

Child Elements

Element Type Restrictions
TagSet S3TagSet
S3InitiateRestoreObject

Type: Container

Child Elements

Element Type Restrictions
ExpirationInDays Integer Must be greater than or equal to 0

Special Errors

Error Description
TooManyRequestsException

Type: Container

Child elements: Message (type: String)

BadRequestException

Type: Container

Child elements: Message (type: String)

IdempotencyException

Type: Container

Child elements: Message (type: String)

InternalServiceException

Type: Container

Child elements: Message (type: String)

NotFoundException

Type: Container

Child elements: Message (type: String)

NoSuchAccount

Type: Container

Child elements: Message (type: String)