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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_inference_job_config ⇒ Types::BatchInferenceJobConfig

The configuration details of a batch inference job.

Returns:



878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/aws-sdk-personalize/types.rb', line 878

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_mode ⇒ String

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) 


878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/aws-sdk-personalize/types.rb', line 878

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_arn ⇒ String

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) 


878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/aws-sdk-personalize/types.rb', line 878

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_input ⇒ Types::BatchInferenceJobInput

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

Returns:



878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/aws-sdk-personalize/types.rb', line 878

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_name ⇒ String

The name of the batch inference job to create.

Returns:

  • (String) 


878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/aws-sdk-personalize/types.rb', line 878

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_output ⇒ Types::BatchInferenceJobOutput

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

Returns:



878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/aws-sdk-personalize/types.rb', line 878

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_results ⇒ Integer

The number of recommendations to retrieve.

Returns:

  • (Integer) 


878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/aws-sdk-personalize/types.rb', line 878

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_arn ⇒ String

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) 


878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/aws-sdk-personalize/types.rb', line 878

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_arn ⇒ String

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

Returns:

  • (String) 


878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/aws-sdk-personalize/types.rb', line 878

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

#tags ⇒ Array<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:



878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/aws-sdk-personalize/types.rb', line 878

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_config ⇒ Types::ThemeGenerationConfig

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

Returns:



878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/aws-sdk-personalize/types.rb', line 878

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