Class: Aws::Personalize::Types::BatchInferenceJob

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

Overview

Contains information on a batch inference job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_inference_job_arnString

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

Returns:

  • (String)


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 213

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

#batch_inference_job_configTypes::BatchInferenceJobConfig

A string to string map of the configuration details of a batch inference job.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 213

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

#creation_date_timeTime

The time at which the batch inference job was created.

Returns:

  • (Time)


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 213

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

#failure_reasonString

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

Returns:

  • (String)


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 213

class BatchInferenceJob < Struct.new(
  :job_name,
  :batch_inference_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :batch_inference_job_config,
  :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 inference job.

Returns:

  • (String)


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 213

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

#job_inputTypes::BatchInferenceJobInput

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 213

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

#job_nameString

The name of the batch inference job.

Returns:

  • (String)


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 213

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

#job_outputTypes::BatchInferenceJobOutput

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 213

class BatchInferenceJob < Struct.new(
  :job_name,
  :batch_inference_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :batch_inference_job_config,
  :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 inference job was last updated.

Returns:

  • (Time)


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 213

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

#num_resultsInteger

The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.

Returns:

  • (Integer)


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 213

class BatchInferenceJob < Struct.new(
  :job_name,
  :batch_inference_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :batch_inference_job_config,
  :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 inference job.

Returns:

  • (String)


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 213

class BatchInferenceJob < Struct.new(
  :job_name,
  :batch_inference_job_arn,
  :filter_arn,
  :failure_reason,
  :solution_version_arn,
  :num_results,
  :job_input,
  :job_output,
  :batch_inference_job_config,
  :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 from which the batch inference job was created.

Returns:

  • (String)


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 213

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

#statusString

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

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED

Returns:

  • (String)


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 213

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