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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::ImportJobResponse

Defined in:

gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

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

• #completed_pieces ⇒ Integer

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

• #completion_date ⇒ String

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

• #creation_date ⇒ String

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

• #definition ⇒ Types::ImportJobResource

  The resource settings that apply to the import job.

• #failed_pieces ⇒ Integer

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

• #id ⇒ String

  The unique identifier for the import job.

• #job_status ⇒ String

  The status of the import job.

• #total_failures ⇒ 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_pieces ⇒ Integer

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

• #total_processed ⇒ Integer

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

• #type ⇒ String

  The job type.

Instance Attribute Details

#application_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7793

class ImportJobResponse < Struct.new(
  :application_id,
  :completed_pieces,
  :completion_date,
  :creation_date,
  :definition,
  :failed_pieces,
  :failures,
  :id,
  :job_status,
  :total_failures,
  :total_pieces,
  :total_processed,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#completed_pieces ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7793

class ImportJobResponse < Struct.new(
  :application_id,
  :completed_pieces,
  :completion_date,
  :creation_date,
  :definition,
  :failed_pieces,
  :failures,
  :id,
  :job_status,
  :total_failures,
  :total_pieces,
  :total_processed,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#completion_date ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7793

class ImportJobResponse < Struct.new(
  :application_id,
  :completed_pieces,
  :completion_date,
  :creation_date,
  :definition,
  :failed_pieces,
  :failures,
  :id,
  :job_status,
  :total_failures,
  :total_pieces,
  :total_processed,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7793

class ImportJobResponse < Struct.new(
  :application_id,
  :completed_pieces,
  :completion_date,
  :creation_date,
  :definition,
  :failed_pieces,
  :failures,
  :id,
  :job_status,
  :total_failures,
  :total_pieces,
  :total_processed,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#definition ⇒ Types::ImportJobResource

The resource settings that apply to the import job.

Returns:

• (Types::ImportJobResource)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7793

class ImportJobResponse < Struct.new(
  :application_id,
  :completed_pieces,
  :completion_date,
  :creation_date,
  :definition,
  :failed_pieces,
  :failures,
  :id,
  :job_status,
  :total_failures,
  :total_pieces,
  :total_processed,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#failed_pieces ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7793

class ImportJobResponse < Struct.new(
  :application_id,
  :completed_pieces,
  :completion_date,
  :creation_date,
  :definition,
  :failed_pieces,
  :failures,
  :id,
  :job_status,
  :total_failures,
  :total_pieces,
  :total_processed,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#failures ⇒ 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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7793

class ImportJobResponse < Struct.new(
  :application_id,
  :completed_pieces,
  :completion_date,
  :creation_date,
  :definition,
  :failed_pieces,
  :failures,
  :id,
  :job_status,
  :total_failures,
  :total_pieces,
  :total_processed,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier for the import job.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7793

class ImportJobResponse < Struct.new(
  :application_id,
  :completed_pieces,
  :completion_date,
  :creation_date,
  :definition,
  :failed_pieces,
  :failures,
  :id,
  :job_status,
  :total_failures,
  :total_pieces,
  :total_processed,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#job_status ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7793

class ImportJobResponse < Struct.new(
  :application_id,
  :completed_pieces,
  :completion_date,
  :creation_date,
  :definition,
  :failed_pieces,
  :failures,
  :id,
  :job_status,
  :total_failures,
  :total_pieces,
  :total_processed,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#total_failures ⇒ 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.

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7793

class ImportJobResponse < Struct.new(
  :application_id,
  :completed_pieces,
  :completion_date,
  :creation_date,
  :definition,
  :failed_pieces,
  :failures,
  :id,
  :job_status,
  :total_failures,
  :total_pieces,
  :total_processed,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#total_pieces ⇒ Integer

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)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7793

class ImportJobResponse < Struct.new(
  :application_id,
  :completed_pieces,
  :completion_date,
  :creation_date,
  :definition,
  :failed_pieces,
  :failures,
  :id,
  :job_status,
  :total_failures,
  :total_pieces,
  :total_processed,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#total_processed ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7793

class ImportJobResponse < Struct.new(
  :application_id,
  :completed_pieces,
  :completion_date,
  :creation_date,
  :definition,
  :failed_pieces,
  :failures,
  :id,
  :job_status,
  :total_failures,
  :total_pieces,
  :total_processed,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7793

class ImportJobResponse < Struct.new(
  :application_id,
  :completed_pieces,
  :completion_date,
  :creation_date,
  :definition,
  :failed_pieces,
  :failures,
  :id,
  :job_status,
  :total_failures,
  :total_pieces,
  :total_processed,
  :type)
  SENSITIVE = []
  include Aws::Structure
end