Documentation

Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.

See: newImportJobResponse smart constructor.

Create a value of ImportJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:completedPieces:ImportJobResponse', importJobResponse_completedPieces - The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.

$sel:failedPieces:ImportJobResponse', importJobResponse_failedPieces - The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.

$sel:totalProcessed:ImportJobResponse', importJobResponse_totalProcessed - The total number of endpoint definitions that were processed by the import job.

$sel:failures:ImportJobResponse', importJobResponse_failures - An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.

$sel:totalPieces:ImportJobResponse', importJobResponse_totalPieces - 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.

$sel:completionDate:ImportJobResponse', importJobResponse_completionDate - The date, in ISO 8601 format, when the import job was completed.

$sel:totalFailures:ImportJobResponse', importJobResponse_totalFailures - 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.

$sel:jobStatus:ImportJobResponse', importJobResponse_jobStatus - 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.

$sel:creationDate:ImportJobResponse', importJobResponse_creationDate - The date, in ISO 8601 format, when the import job was created.

$sel:type':ImportJobResponse', importJobResponse_type - The job type. This value is IMPORT for import jobs.

$sel:definition:ImportJobResponse', importJobResponse_definition - The resource settings that apply to the import job.

$sel:id:ImportJobResponse', importJobResponse_id - The unique identifier for the import job.

$sel:applicationId:ImportJobResponse', importJobResponse_applicationId - The unique identifier for the application that's associated with the import job.

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

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

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

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

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.

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

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.

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.

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

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

The resource settings that apply to the import job.

The unique identifier for the import job.

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