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

CreateJob

Creates an Amazon S3 batch operations job.

Request Syntax

POST /v20180820/jobs HTTP/1.1 x-amz-account-id: AccountId <?xml version="1.0" encoding="UTF-8"?> <CreateJobRequest xmlns="http://awss3control.amazonaws.com/doc/2018-08-20/"> <ClientRequestToken>string</ClientRequestToken> <ConfirmationRequired>boolean</ConfirmationRequired> <Description>string</Description> <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> <Report> <Bucket>string</Bucket> <Enabled>boolean</Enabled> <Format>string</Format> <Prefix>string</Prefix> <ReportScope>string</ReportScope> </Report> <RoleArn>string</RoleArn> </CreateJobRequest>

URI Request Parameters

The request requires the following URI parameters.

x-amz-account-id

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

Request Body

The request accepts the following data in XML format.

CreateJobRequest

A root-level tag for the CreateJobRequest parameters.

Required: Yes

ClientRequestToken

An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

Type: String

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

Required: Yes

ConfirmationRequired

Indicates whether confirmation is required before Amazon S3 runs the job. By default, ConfirmationRequired is false.

Type: Boolean

Required: No

Description

A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

Type: String

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

Required: No

Manifest

Configuration parameters for the manifest.

Type: JobManifest object

Required: Yes

Operation

The operation that you want this job to perform on each object listed in the manifest. For more information about the available operations, see Available Operations in the Amazon Simple Storage Service Developer Guide.

Type: JobOperation object

Required: Yes

Priority

The numerical priority for this job. Higher numbers indicate higher priority.

Type: Integer

Valid range: Minimum value of 0. Maximum value of 2147483647.

Required: Yes

Report

Configuration parameters for the optional job-completion report.

Type: JobReport object

Required: Yes

RoleArn

The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that batch operations use to execute this job's operation on each object in the manifest.

Type: String

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

Required: Yes

Response Syntax

HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <CreateJobResult> <JobId>string</JobId> </CreateJobResult>

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.

CreateJobResult

Root level tag for the CreateJobResult parameters.

Required: Yes

JobId

The ID for this job. Amazon S3 generates this ID automatically and returns it after a successful Create Job request.

Type: String

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

Errors

BadRequestException

HTTP Status Code: 400

IdempotencyException

HTTP Status Code: 400

InternalServiceException

HTTP Status Code: 500

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: