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

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

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

The unique ID of the application to which the import job applies.

Returns:

  • (String)


4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4707

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)
  include Aws::Structure
end

#completed_piecesInteger

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

Returns:

  • (Integer)


4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4707

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)
  include Aws::Structure
end

#completion_dateString

The date the import job completed in ISO 8601 format.

Returns:

  • (String)


4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4707

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)
  include Aws::Structure
end

#creation_dateString

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

Returns:

  • (String)


4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4707

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)
  include Aws::Structure
end

#definitionTypes::ImportJobResource

The import job settings.



4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4707

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)
  include Aws::Structure
end

#failed_piecesInteger

The number of pieces that have failed to import as of the time of the request.

Returns:

  • (Integer)


4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4707

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)
  include Aws::Structure
end

#failuresArray<String>

Returns:

  • (Array<String>)


4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4707

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)
  include Aws::Structure
end

#idString

The unique ID of the import job.

Returns:

  • (String)


4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4707

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)
  include Aws::Structure
end

#job_statusString

The status of the import job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed to import.

Returns:

  • (String)


4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4707

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)
  include Aws::Structure
end

#total_failuresInteger

The number of endpoints that failed to import; for example, because of syntax errors.

Returns:

  • (Integer)


4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4707

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)
  include Aws::Structure
end

#total_piecesInteger

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

Returns:

  • (Integer)


4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4707

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)
  include Aws::Structure
end

#total_processedInteger

The number of endpoints that were processed by the import job.

Returns:

  • (Integer)


4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4707

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)
  include Aws::Structure
end

#typeString

The job type. Will be Import.

Returns:

  • (String)


4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4707

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)
  include Aws::Structure
end