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

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

Overview

Note:

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",
    },
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_inference_job_configTypes::BatchInferenceJobConfig

The configuration details of a batch inference job.



892
893
894
895
896
897
898
899
900
901
902
903
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 892

class CreateBatchInferenceJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :batch_inference_job_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..

Returns:

  • (String)


892
893
894
895
896
897
898
899
900
901
902
903
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 892

class CreateBatchInferenceJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :batch_inference_job_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.



892
893
894
895
896
897
898
899
900
901
902
903
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 892

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

#job_nameString

The name of the batch inference job to create.

Returns:

  • (String)


892
893
894
895
896
897
898
899
900
901
902
903
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 892

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

#job_outputTypes::BatchInferenceJobOutput

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



892
893
894
895
896
897
898
899
900
901
902
903
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 892

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

#num_resultsInteger

The number of recommendations to retreive.

Returns:

  • (Integer)


892
893
894
895
896
897
898
899
900
901
902
903
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 892

class CreateBatchInferenceJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :batch_inference_job_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)


892
893
894
895
896
897
898
899
900
901
902
903
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 892

class CreateBatchInferenceJobRequest < Struct.new(
  :job_name,
  :solution_version_arn,
  :filter_arn,
  :num_results,
  :job_input,
  :job_output,
  :role_arn,
  :batch_inference_job_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)


892
893
894
895
896
897
898
899
900
901
902
903
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 892

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