You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::ExportJobResponse

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

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

Returns:

  • (String) —

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

#completed_pieces ⇒ Integer

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

Returns:

  • (Integer) —

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

#completion_date ⇒ String

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

Returns:

  • (String) —

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

#creation_date ⇒ String

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

Returns:

  • (String) —

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

#definition ⇒ Types::ExportJobResource

The resource settings that apply to the export job.

Returns:

#failed_pieces ⇒ Integer

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

Returns:

  • (Integer) —

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

#failures ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#id ⇒ String

The unique identifier for the export job.

Returns:

  • (String) —

    The unique identifier for the export job.

#job_status ⇒ String

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.

Possible values:

  • CREATED
  • PREPARING_FOR_INITIALIZATION
  • INITIALIZING
  • PROCESSING
  • PENDING_JOB
  • COMPLETING
  • COMPLETED
  • FAILING
  • FAILED

Returns:

  • (String) —

    The status of the export job.

#total_failures ⇒ Integer

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.

Returns:

  • (Integer) —

    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.

#total_pieces ⇒ Integer

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.

Returns:

  • (Integer) —

    The total number of pieces that must be processed to complete the export job.

#total_processed ⇒ Integer

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

Returns:

  • (Integer) —

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

#type ⇒ String

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

Returns:

  • (String) —

    The job type.