Class: Aws::Personalize::Types::BatchSegmentJob

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

Overview

Contains information on a batch segment job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_segment_job_arnString

The Amazon Resource Name (ARN) of the batch segment job.

Returns:

  • (String)


447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 447

class BatchSegmentJob < Struct.new(
  :job_name,
  :batch_segment_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date_timeTime

The time at which the batch segment job was created.

Returns:

  • (Time)


447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 447

class BatchSegmentJob < Struct.new(
  :job_name,
  :batch_segment_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reasonString

If the batch segment job failed, the reason for the failure.

Returns:

  • (String)


447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 447

class BatchSegmentJob < Struct.new(
  :job_name,
  :batch_segment_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#filter_arnString

The ARN of the filter used on the batch segment job.

Returns:

  • (String)


447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 447

class BatchSegmentJob < Struct.new(
  :job_name,
  :batch_segment_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#job_inputTypes::BatchSegmentJobInput

The Amazon S3 path that leads to the input data used to generate the batch segment job.



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 447

class BatchSegmentJob < Struct.new(
  :job_name,
  :batch_segment_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#job_nameString

The name of the batch segment job.

Returns:

  • (String)


447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 447

class BatchSegmentJob < Struct.new(
  :job_name,
  :batch_segment_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#job_outputTypes::BatchSegmentJobOutput

The Amazon S3 bucket that contains the output data generated by the batch segment job.



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 447

class BatchSegmentJob < Struct.new(
  :job_name,
  :batch_segment_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date_timeTime

The time at which the batch segment job last updated.

Returns:

  • (Time)


447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 447

class BatchSegmentJob < Struct.new(
  :job_name,
  :batch_segment_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#num_resultsInteger

The number of predicted users generated by the batch segment job for each line of input data.

Returns:

  • (Integer)


447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 447

class BatchSegmentJob < Struct.new(
  :job_name,
  :batch_segment_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.

Returns:

  • (String)


447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 447

class BatchSegmentJob < Struct.new(
  :job_name,
  :batch_segment_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#solution_version_arnString

The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

Returns:

  • (String)


447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 447

class BatchSegmentJob < Struct.new(
  :job_name,
  :batch_segment_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the batch segment job. The status is one of the following values:

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED

Returns:

  • (String)


447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 447

class BatchSegmentJob < Struct.new(
  :job_name,
  :batch_segment_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :status,
  :creation_date_time,
  :last_updated_date_time)
  SENSITIVE = []
  include Aws::Structure
end