Class: Aws::Personalize::Types::CreateBatchInferenceJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Personalize::Types::CreateBatchInferenceJobRequest
- Includes:
- Structure
- Defined in:
- 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
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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 retreive.
-
#role_arn ⇒ String
The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and out 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.
Instance Attribute Details
#filter_arn ⇒ String
The ARN of the filter to apply to the batch inference job. For more information on using filters, see Using Filters with Amazon Personalize.
614 615 616 617 618 619 620 621 622 623 624 |
# File 'lib/aws-sdk-personalize/types.rb', line 614 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn) 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.
614 615 616 617 618 619 620 621 622 623 624 |
# File 'lib/aws-sdk-personalize/types.rb', line 614 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn) SENSITIVE = [] include Aws::Structure end |
#job_name ⇒ String
The name of the batch inference job to create.
614 615 616 617 618 619 620 621 622 623 624 |
# File 'lib/aws-sdk-personalize/types.rb', line 614 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn) SENSITIVE = [] include Aws::Structure end |
#job_output ⇒ Types::BatchInferenceJobOutput
The path to the Amazon S3 bucket where the job’s output will be stored.
614 615 616 617 618 619 620 621 622 623 624 |
# File 'lib/aws-sdk-personalize/types.rb', line 614 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn) SENSITIVE = [] include Aws::Structure end |
#num_results ⇒ Integer
The number of recommendations to retreive.
614 615 616 617 618 619 620 621 622 623 624 |
# File 'lib/aws-sdk-personalize/types.rb', line 614 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn) 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 out Amazon S3 buckets respectively.
614 615 616 617 618 619 620 621 622 623 624 |
# File 'lib/aws-sdk-personalize/types.rb', line 614 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn) 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.
614 615 616 617 618 619 620 621 622 623 624 |
# File 'lib/aws-sdk-personalize/types.rb', line 614 class CreateBatchInferenceJobRequest < Struct.new( :job_name, :solution_version_arn, :filter_arn, :num_results, :job_input, :job_output, :role_arn) SENSITIVE = [] include Aws::Structure end |