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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::ExportJobResponse

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Export job response.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #application_id ⇒ String

  The unique ID of the application associated with the export job.

• #completed_pieces ⇒ Integer

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

• #completion_date ⇒ String

  The date the job completed in ISO 8601 format.

• #creation_date ⇒ String

  The date the job was created in ISO 8601 format.

• #definition ⇒ Types::ExportJobResource

  The export job settings.

• #failed_pieces ⇒ Integer

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

• #failures ⇒ Array<String>

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

• #id ⇒ String

  The unique ID of the job.

• #job_status ⇒ String

  The status of the job.

• #total_failures ⇒ Integer

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

• #total_pieces ⇒ Integer

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

• #total_processed ⇒ Integer

  The number of endpoints that were processed by the job.

• #type ⇒ String

  The job type.

Instance Attribute Details

#application_id ⇒ String

The unique ID of the application associated with the export job.

Returns:

• (String)

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

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

#completed_pieces ⇒ Integer

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

Returns:

• (Integer)

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

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

#completion_date ⇒ String

The date the job completed in ISO 8601 format.

Returns:

• (String)

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

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

#creation_date ⇒ String

The date the job was created in ISO 8601 format.

Returns:

• (String)

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

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

#definition ⇒ Types::ExportJobResource

The export job settings.

Returns:

• (Types::ExportJobResource)

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

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

#failed_pieces ⇒ Integer

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

Returns:

• (Integer)

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

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

#failures ⇒ Array<String>

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

Returns:

• (Array<String>)

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

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

#id ⇒ String

The unique ID of the job.

Returns:

• (String)

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

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

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

Returns:

• (String)

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

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

#total_failures ⇒ Integer

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

Returns:

• (Integer)

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

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

#total_pieces ⇒ Integer

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

Returns:

• (Integer)

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

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

#total_processed ⇒ Integer

The number of endpoints that were processed by the job.

Returns:

• (Integer)

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

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

#type ⇒ String

The job type. Will be ‘EXPORT’.

Returns:

• (String)

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

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