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

Inherits:
Struct
  • Object
show all
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

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

Returns:

  • (String)


10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10397

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_piecesInteger

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

Returns:

  • (Integer)


10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10397

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_dateString

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

Returns:

  • (String)


10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10397

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_dateString

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

Returns:

  • (String)


10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10397

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

#definitionTypes::ImportJobResource

The resource settings that apply to the import job.



10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10397

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_piecesInteger

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

Returns:

  • (Integer)


10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10397

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

#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>)


10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10397

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

#idString

The unique identifier for the import job.

Returns:

  • (String)


10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10397

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_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.

Returns:

  • (String)


10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10397

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_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)


10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10397

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_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)


10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10397

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_processedInteger

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

Returns:

  • (Integer)


10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10397

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

#typeString

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

Returns:

  • (String)


10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 10397

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