Class: Aws::Personalize::Types::CreateBatchInferenceJobRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_inference_job_configTypes::BatchInferenceJobConfig

The configuration details of a batch inference job.



924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'lib/aws-sdk-personalize/types.rb', line 924

class CreateBatchInferenceJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :batch_inference_job_config,
  :tags,
  :batch_inference_job_mode,
  :theme_generation_config)
  SENSITIVE = []
  include Aws::Structure
end

#batch_inference_job_modeString

The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to ‘THEME_GENERATION`. If you don’t want to generate themes, use the default ‘BATCH_INFERENCE`.

When you get batch recommendations with themes, you will incur additional costs. For more information, see [Amazon Personalize pricing].

[1]: aws.amazon.com/personalize/pricing/

Returns:

  • (String)


924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'lib/aws-sdk-personalize/types.rb', line 924

class CreateBatchInferenceJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :batch_inference_job_config,
  :tags,
  :batch_inference_job_mode,
  :theme_generation_config)
  SENSITIVE = []
  include Aws::Structure
end

#filter_arnString

The ARN of the filter to apply to the batch inference job. For more information on using filters, see [Filtering batch recommendations].

[1]: docs.aws.amazon.com/personalize/latest/dg/filter-batch.html

Returns:

  • (String)


924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'lib/aws-sdk-personalize/types.rb', line 924

class CreateBatchInferenceJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :batch_inference_job_config,
  :tags,
  :batch_inference_job_mode,
  :theme_generation_config)
  SENSITIVE = []
  include Aws::Structure
end

#job_inputTypes::BatchInferenceJobInput

The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.



924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'lib/aws-sdk-personalize/types.rb', line 924

class CreateBatchInferenceJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :batch_inference_job_config,
  :tags,
  :batch_inference_job_mode,
  :theme_generation_config)
  SENSITIVE = []
  include Aws::Structure
end

#job_nameString

The name of the batch inference job to create.

Returns:

  • (String)


924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'lib/aws-sdk-personalize/types.rb', line 924

class CreateBatchInferenceJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :batch_inference_job_config,
  :tags,
  :batch_inference_job_mode,
  :theme_generation_config)
  SENSITIVE = []
  include Aws::Structure
end

#job_outputTypes::BatchInferenceJobOutput

The path to the Amazon S3 bucket where the job’s output will be stored.



924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'lib/aws-sdk-personalize/types.rb', line 924

class CreateBatchInferenceJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :batch_inference_job_config,
  :tags,
  :batch_inference_job_mode,
  :theme_generation_config)
  SENSITIVE = []
  include Aws::Structure
end

#num_resultsInteger

The number of recommendations to retrieve.

Returns:

  • (Integer)


924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'lib/aws-sdk-personalize/types.rb', line 924

class CreateBatchInferenceJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :batch_inference_job_config,
  :tags,
  :batch_inference_job_mode,
  :theme_generation_config)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.

Returns:

  • (String)


924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'lib/aws-sdk-personalize/types.rb', line 924

class CreateBatchInferenceJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :batch_inference_job_config,
  :tags,
  :batch_inference_job_mode,
  :theme_generation_config)
  SENSITIVE = []
  include Aws::Structure
end

#solution_version_arnString

The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

Returns:

  • (String)


924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'lib/aws-sdk-personalize/types.rb', line 924

class CreateBatchInferenceJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :batch_inference_job_config,
  :tags,
  :batch_inference_job_mode,
  :theme_generation_config)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of [tags] to apply to the batch inference job.

[1]: docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html

Returns:



924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'lib/aws-sdk-personalize/types.rb', line 924

class CreateBatchInferenceJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :batch_inference_job_config,
  :tags,
  :batch_inference_job_mode,
  :theme_generation_config)
  SENSITIVE = []
  include Aws::Structure
end

#theme_generation_configTypes::ThemeGenerationConfig

For theme generation jobs, specify the name of the column in your Items dataset that contains each item’s name.



924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'lib/aws-sdk-personalize/types.rb', line 924

class CreateBatchInferenceJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :batch_inference_job_config,
  :tags,
  :batch_inference_job_mode,
  :theme_generation_config)
  SENSITIVE = []
  include Aws::Structure
end