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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Export job response.

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

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

Returns:

  • (String)


4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4354

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_piecesInteger

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

Returns:

  • (Integer)


4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4354

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_dateString

The date the job completed in ISO 8601 format.

Returns:

  • (String)


4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4354

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_dateString

The date the job was created in ISO 8601 format.

Returns:

  • (String)


4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4354

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

#definitionTypes::ExportJobResource

The export job settings.



4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4354

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_piecesInteger

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

Returns:

  • (Integer)


4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4354

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

#failuresArray<String>

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

Returns:

  • (Array<String>)


4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4354

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

#idString

The unique ID of the job.

Returns:

  • (String)


4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4354

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_statusString

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)


4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4354

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_failuresInteger

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

Returns:

  • (Integer)


4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4354

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_piecesInteger

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)


4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4354

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_processedInteger

The number of endpoints that were processed by the job.

Returns:

  • (Integer)


4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4354

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

#typeString

The job type. Will be 'EXPORT'.

Returns:

  • (String)


4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4354

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