Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . pinpoint ]

create-export-job

Description

Creates an export job.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-export-job
--application-id <value>
--export-job-request <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--application-id (string)

--export-job-request (structure)

Shorthand Syntax:

RoleArn=string,S3UrlPrefix=string,SegmentId=string

JSON Syntax:

{
  "RoleArn": "string",
  "S3UrlPrefix": "string",
  "SegmentId": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ExportJobResponse -> (structure)

ApplicationId -> (string)

The unique ID of the application to which the job applies.

CompletedPieces -> (integer)

The number of pieces that have successfully completed as of the time of the request.

CompletionDate -> (string)

The date the job completed in ISO 8601 format.

CreationDate -> (string)

The date the job was created in ISO 8601 format.

Definition -> (structure)

The export job settings.

RoleArn -> (string)

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.

S3UrlPrefix -> (string)

A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.

SegmentId -> (string)

The ID of the segment to export endpoints from. If not present, all endpoints are exported.

FailedPieces -> (integer)

The number of pieces that failed to be processed as of the time of the request.

Failures -> (list)

Provides up to 100 of the first failed entries for the job, if any exist.

(string)

Id -> (string)

The unique ID of the job.

JobStatus -> (string)

The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.

TotalFailures -> (integer)

The number of endpoints that were not processed; for example, because of syntax errors.

TotalPieces -> (integer)

The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.

TotalProcessed -> (integer)

The number of endpoints that were processed by the job.

Type -> (string)

The job type. Will be 'EXPORT'.