Amazon Pinpoint
REST API Reference

Segment Export Jobs

The Segment Export Jobs resource represents jobs that export endpoint definitions for a segment. A segment designates which users receive messages from a campaign or journey.

You can use this resource to retrieve information about the export jobs for a segment. This includes checking the status of an in-progress export job and accessing the history of your export jobs.

URI

/v1/apps/application-id/segments/segment-id/jobs/export

HTTP Methods

GET

Operation ID: GetSegmentExportJobs

Retrieves information about the status and settings of the export jobs for a segment.

Path Parameters

Name Type Required Description
segment-id String True

The unique identifier for the segment.

application-id String True

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Header Parameters

Name Type Required Description
accept String False

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

Query Parameters

Name Type Required Description
page-size String False

The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

token String False

The NextToken string that specifies which page of results to return in a paginated response.

Responses

Status Code Response Model Description
200 ExportJobsResponse

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 Segment Export Jobs resource.

Responses

Status Code Response Model Description
200 None

The request succeeded.

Schemas

Response Bodies

Example ExportJobsResponse

{ "Item": [ { "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": { "SegmentId": "string", "SegmentVersion": integer, "S3UrlPrefix": "string", "RoleArn": "string" } } ], "NextToken": "string" }

Example MessageBody

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

Properties

ExportJobResource

Provides information about the resource settings for a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

Property Type Required Description
SegmentId

string

False

The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

SegmentVersion

integer

False

The version of the segment that the endpoint definitions were exported from.

S3UrlPrefix

string

True

The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

RoleArn

string

True

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.

ExportJobResponse

Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

Property Type Required Description
ApplicationId

string

True

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

Id

string

True

The unique identifier for the export job.

JobStatus

string

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

True

The status of the export 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 export job, as of the time of the request.

FailedPieces

integer

False

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

TotalPieces

integer

False

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

CreationDate

string

True

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

CompletionDate

string

False

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

Type

string

True

The job type. This value is EXPORT for export jobs.

TotalFailures

integer

False

The total number of endpoint definitions that weren't processed successfully (failed) by the export 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 export 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 export job, if any.

Definition

ExportJobResource

True

The resource settings that apply to the export job.

ExportJobsResponse

Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.

Property Type Required Description
Item

Array of type ExportJobResponse

True

An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).

NextToken

string

False

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

MessageBody

Provides information about an API request or response.

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:

GetSegmentExportJobs