Amazon Pinpoint
REST API Reference

Import Job

The Import Job resource represents a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket. An endpoint uniquely identifies a mobile device, email address, or phone number that can receive a message.

You can use the Import Job resource to retrieve information about the status and settings of a specific import job for an application. To create or update an import job for an application or to retrieve information about all the import jobs for an application, use the Import Jobs resource.

URI

/v1/apps/application-id/jobs/import/job-id

HTTP Methods

GET

Operation ID: GetImportJob

Retrieves information about the status and settings of a specific import job for an application.

Path Parameters

Name Type Required Description
application-id String True

The unique identifier for the application.

job-id String True

The unique identifier for the job.

Header Parameters

Name Type Required Description
accept String False

Indicates which content types, expressed as MIME types, the client understands.

Responses

Status Code Response Model Description
200 ImportJobResponse

The request succeeded.

400 MessageBody

The request contains a syntax error (BadRequestException).

403 MessageBody

The request was denied because access to the specified resource is forbidden (ForbiddenException).

404 MessageBody

The request failed because the specified resource was not found (NotFoundException).

405 MessageBody

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

429 MessageBody

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

500 MessageBody

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

OPTIONS

Retrieves information about the communication requirements and options that are available for the Import Job resource.

Responses

Status Code Response Model Description
200 None

The request succeeded.

Schemas

Response Bodies

Example ImportJobResponse

{ "ApplicationId": "string", "Id": "string", "JobStatus": enum, "CompletedPieces": integer, "FailedPieces": integer, "TotalPieces": integer, "CreationDate": "string", "CompletionDate": "string", "Type": "string", "TotalFailures": integer, "TotalProcessed": integer, "Failures": [ "string" ], "Definition": { "S3Url": "string", "RoleArn": "string", "ExternalId": "string", "Format": enum, "RegisterEndpoints": boolean, "DefineSegment": boolean, "SegmentName": "string", "SegmentId": "string" } }

Example MessageBody

{ "RequestID": "string", "Message": "string" }

Properties

ImportJobResource

Property Type Required Description
S3Url

string

True

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from files in this location, including any subfolders that the folder contains.

The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

RoleArn

string

True

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

ExternalId

string

True

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

Format

string

Values: CSV | JSON

True

The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location includes multiple files that use mixed formats, Amazon Pinpoint imports only the files that use the specified format.

RegisterEndpoints

boolean

False

Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

DefineSegment

boolean

False

Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.

SegmentName

string

False

The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

SegmentId

string

False

The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.

ImportJobResponse

Property Type Required Description
ApplicationId

string

True

The unique identifier for the application that's associated with the import job.

Id

string

True

The unique identifier for the import job.

JobStatus

string

Values: CREATED | INITIALIZING | PENDING_JOB | PROCESSING | COMPLETING | COMPLETED | FAILING | FAILED

True

The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

CompletedPieces

integer

False

The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.

FailedPieces

integer

False

The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.

TotalPieces

integer

False

The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.

CreationDate

string

True

The date, in ISO 8601 format, when the import job was created.

CompletionDate

string

False

The date, in ISO 8601 format, when the import job was completed.

Type

string

True

The job type. This value is IMPORT for import jobs.

TotalFailures

integer

False

The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.

TotalProcessed

integer

False

The total number of endpoint definitions that were processed by the import job.

Failures

Array of type string

False

An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.

Definition

ImportJobResource

True

The resource settings that apply to the import job.

MessageBody

Property Type Required Description
RequestID

string

False

The unique identifier for the request or response.

Message

string

False

The message that's returned from the API.

See Also

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

GetImportJob