Class: Aws::Personalize::Types::CreateBatchInferenceJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Personalize::Types::CreateBatchInferenceJobRequest
- Defined in:
- gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb
Overview
When making an API call, you may pass CreateBatchInferenceJobRequest data as a hash:
{
job_name: "Name", # required
solution_version_arn: "Arn", # required
filter_arn: "Arn",
num_results: 1,
job_input: { # required
s3_data_source: { # required
path: "S3Location", # required
kms_key_arn: "KmsKeyArn",
},
},
job_output: { # required
s3_data_destination: { # required
path: "S3Location", # required
kms_key_arn: "KmsKeyArn",
},
},
role_arn: "RoleArn", # required
batch_inference_job_config: {
item_exploration_config: {
"ParameterName" => "ParameterValue",
},
},
tags: [
{
tag_key: "TagKey", # required
tag_value: "TagValue", # required
},
],
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#batch_inference_job_config ⇒ Types::BatchInferenceJobConfig
The configuration details of a batch inference job.
-
#filter_arn ⇒ String
The ARN of the filter to apply to the batch inference job.
-
#job_input ⇒ Types::BatchInferenceJobInput
The Amazon S3 path that leads to the input file to base your recommendations on.
-
#job_name ⇒ String
The name of the batch inference job to create.
-
#job_output ⇒ Types::BatchInferenceJobOutput
The path to the Amazon S3 bucket where the job's output will be stored.
-
#num_results ⇒ Integer
The number of recommendations to retrieve.
-
#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.
-
#solution_version_arn ⇒ String
The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
-
#tags ⇒ Array<Types::Tag>
A list of [tags][1] to apply to the batch inference job.
Instance Attribute Details
#batch_inference_job_config ⇒ Types::BatchInferenceJobConfig
The configuration details of a batch inference job.
940 941 942 943 944 945 946 947 948 949 950 951 952 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 940 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn, :batch_inference_job_config, :tags) 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.
940 941 942 943 944 945 946 947 948 949 950 951 952 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 940 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn, :batch_inference_job_config, :tags) 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.
940 941 942 943 944 945 946 947 948 949 950 951 952 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 940 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn, :batch_inference_job_config, :tags) SENSITIVE = [] include Aws::Structure end |
#job_name ⇒ String
The name of the batch inference job to create.
940 941 942 943 944 945 946 947 948 949 950 951 952 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 940 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn, :batch_inference_job_config, :tags) SENSITIVE = [] include Aws::Structure end |
#job_output ⇒ Types::BatchInferenceJobOutput
The path to the Amazon S3 bucket where the job's output will be stored.
940 941 942 943 944 945 946 947 948 949 950 951 952 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 940 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn, :batch_inference_job_config, :tags) SENSITIVE = [] include Aws::Structure end |
#num_results ⇒ Integer
The number of recommendations to retrieve.
940 941 942 943 944 945 946 947 948 949 950 951 952 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 940 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn, :batch_inference_job_config, :tags) 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.
940 941 942 943 944 945 946 947 948 949 950 951 952 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 940 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn, :batch_inference_job_config, :tags) 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.
940 941 942 943 944 945 946 947 948 949 950 951 952 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 940 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn, :batch_inference_job_config, :tags) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
A list of tags to apply to the batch inference job.
940 941 942 943 944 945 946 947 948 949 950 951 952 |
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 940 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn, :batch_inference_job_config, :tags) SENSITIVE = [] include Aws::Structure end |