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

Class: Aws::Pinpoint::Types::ImportJobResponse

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

Overview

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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

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

Returns:

  • (String)

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

#completed_piecesInteger

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

Returns:

  • (Integer)

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

#completion_dateString

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

Returns:

  • (String)

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

#creation_dateString

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

Returns:

  • (String)

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

#definitionTypes::ImportJobResource

The resource settings that apply to the import job.

Returns:

#failed_piecesInteger

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

Returns:

  • (Integer)

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

#failuresArray<String>

An array of entries, one for each of the first 100 entries that weren\'t processed successfully (failed) by the import 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 import job, if any.

#idString

The unique identifier for the import job.

Returns:

  • (String)

    The unique identifier for the import job.

#job_statusString

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.

Possible values:

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

Returns:

  • (String)

    The status of the import job.

#total_failuresInteger

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.

Returns:

  • (Integer)

    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.

#total_piecesInteger

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.

Returns:

  • (Integer)

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

#total_processedInteger

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

Returns:

  • (Integer)

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

#typeString

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

Returns:

  • (String)

    The job type.