aws-sdk-personalize 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba039375af63cb4543ace6efb8b88a697bf1eacc
-  data.tar.gz: d284796db16f4d705ed1a00a12939dbcbd3ead72
+  metadata.gz: b196ccf4986516a8f46f5a7faa06e234e28d46ff
+  data.tar.gz: 5275e41401ce4a37f0285eb86898aec1b726ba78
 SHA512:
-  metadata.gz: e09bc30db52b5f442affbfec4cf48816fa4963cdaf6dcd8b9084f75928a1a039cf8ea4b12a58929ef27681a1ba1e867b20d77ad632ea69b02e633060d03d8aea
-  data.tar.gz: ff58a356beda3ab9ef9898d24e01affebd796f1363d60241fa8f9a4d3dafc30c40d579caae1ebd7c0ed3a019be3a9f8b2d2b0a6535f0548c77f974fd44dd70b3
+  metadata.gz: f98345f7b5937f212252cf1e984873d4bb9724191ea3fe0ae3c90c9127b8be1a15d58081284ad93b3bb9acafd35ec38c19affbb11c52482bc2379e5ba178323c
+  data.tar.gz: ae5eec4fba2d788f2284fe64dfa19b5722fe4589eacb1068d07f0fcd3a5a7ea2275ceda2e4b09498d66d928fbb247692dacede8610c9aca48ed1396ee36b7f9c

data/lib/aws-sdk-personalize.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-personalize/customizations'
 # @service
 module Aws::Personalize
 
-  GEM_VERSION = '1.7.0'
+  GEM_VERSION = '1.8.0'
 
 end

data/lib/aws-sdk-personalize/client.rb

@@ -264,6 +264,71 @@ module Aws::Personalize
 
     # @!group API Operations
 
+    # Creates a batch inference job. The operation can handle up to 50
+    # million records and the input file must be in JSON format. For more
+    # information, see recommendations-batch.
+    #
+    # @option params [required, String] :job_name
+    #   The name of the batch inference job to create.
+    #
+    # @option params [required, String] :solution_version_arn
+    #   The Amazon Resource Name (ARN) of the solution version that will be
+    #   used to generate the batch inference recommendations.
+    #
+    # @option params [Integer] :num_results
+    #   The number of recommendations to retreive.
+    #
+    # @option params [required, Types::BatchInferenceJobInput] :job_input
+    #   The Amazon S3 path that leads to the input file to base your
+    #   recommendations on. The input material must be in JSON format.
+    #
+    # @option params [required, Types::BatchInferenceJobOutput] :job_output
+    #   The path to the Amazon S3 bucket where the job's output will be
+    #   stored.
+    #
+    # @option params [required, String] :role_arn
+    #   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.
+    #
+    # @return [Types::CreateBatchInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateBatchInferenceJobResponse#batch_inference_job_arn #batch_inference_job_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_batch_inference_job({
+    #     job_name: "Name", # required
+    #     solution_version_arn: "Arn", # required
+    #     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
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.batch_inference_job_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchInferenceJob AWS API Documentation
+    #
+    # @overload create_batch_inference_job(params = {})
+    # @param [Hash] params ({})
+    def create_batch_inference_job(params = {}, options = {})
+      req = build_request(:create_batch_inference_job, params)
+      req.send_request(options)
+    end
+
     # Creates a campaign by deploying a solution version. When a client
     # calls the [GetRecommendations][1] and [GetPersonalizedRanking][2]
     # APIs, a campaign is specified in the request.
@@ -1168,6 +1233,48 @@ module Aws::Personalize
       req.send_request(options)
     end
 
+    # Gets the properties of a batch inference job including name, Amazon
+    # Resource Name (ARN), status, input and output configurations, and the
+    # ARN of the solution version used to generate the recommendations.
+    #
+    # @option params [required, String] :batch_inference_job_arn
+    #   The ARN of the batch inference job to describe.
+    #
+    # @return [Types::DescribeBatchInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeBatchInferenceJobResponse#batch_inference_job #batch_inference_job} => Types::BatchInferenceJob
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_batch_inference_job({
+    #     batch_inference_job_arn: "Arn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.batch_inference_job.job_name #=> String
+    #   resp.batch_inference_job.batch_inference_job_arn #=> String
+    #   resp.batch_inference_job.failure_reason #=> String
+    #   resp.batch_inference_job.solution_version_arn #=> String
+    #   resp.batch_inference_job.num_results #=> Integer
+    #   resp.batch_inference_job.job_input.s3_data_source.path #=> String
+    #   resp.batch_inference_job.job_input.s3_data_source.kms_key_arn #=> String
+    #   resp.batch_inference_job.job_output.s3_data_destination.path #=> String
+    #   resp.batch_inference_job.job_output.s3_data_destination.kms_key_arn #=> String
+    #   resp.batch_inference_job.role_arn #=> String
+    #   resp.batch_inference_job.status #=> String
+    #   resp.batch_inference_job.creation_date_time #=> Time
+    #   resp.batch_inference_job.last_updated_date_time #=> Time
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchInferenceJob AWS API Documentation
+    #
+    # @overload describe_batch_inference_job(params = {})
+    # @param [Hash] params ({})
+    def describe_batch_inference_job(params = {}, options = {})
+      req = build_request(:describe_batch_inference_job, params)
+      req.send_request(options)
+    end
+
     # Describes the given campaign, including its status.
     #
     # A campaign can be in one of the following states:
@@ -1657,6 +1764,53 @@ module Aws::Personalize
       req.send_request(options)
     end
 
+    # Gets a list of the batch inference jobs that have been performed off
+    # of a solution version.
+    #
+    # @option params [String] :solution_version_arn
+    #   The Amazon Resource Name (ARN) of the solution version from which the
+    #   batch inference jobs were created.
+    #
+    # @option params [String] :next_token
+    #   The token to request the next page of results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of batch inference job results to return in each
+    #   page. The default value is 100.
+    #
+    # @return [Types::ListBatchInferenceJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListBatchInferenceJobsResponse#batch_inference_jobs #batch_inference_jobs} => Array<Types::BatchInferenceJobSummary>
+    #   * {Types::ListBatchInferenceJobsResponse#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_batch_inference_jobs({
+    #     solution_version_arn: "Arn",
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.batch_inference_jobs #=> Array
+    #   resp.batch_inference_jobs[0].batch_inference_job_arn #=> String
+    #   resp.batch_inference_jobs[0].job_name #=> String
+    #   resp.batch_inference_jobs[0].status #=> String
+    #   resp.batch_inference_jobs[0].creation_date_time #=> Time
+    #   resp.batch_inference_jobs[0].last_updated_date_time #=> Time
+    #   resp.batch_inference_jobs[0].failure_reason #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchInferenceJobs AWS API Documentation
+    #
+    # @overload list_batch_inference_jobs(params = {})
+    # @param [Hash] params ({})
+    def list_batch_inference_jobs(params = {}, options = {})
+      req = build_request(:list_batch_inference_jobs, params)
+      req.send_request(options)
+    end
+
     # Returns a list of campaigns that use the given solution. When a
     # solution is not specified, all the campaigns associated with the
     # account are listed. The response provides the properties for each
@@ -2142,7 +2296,7 @@ module Aws::Personalize
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalize'
-      context[:gem_version] = '1.7.0'
+      context[:gem_version] = '1.8.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-personalize/client_api.rb

@@ -19,6 +19,11 @@ module Aws::Personalize
     AutoMLConfig = Shapes::StructureShape.new(name: 'AutoMLConfig')
     AutoMLResult = Shapes::StructureShape.new(name: 'AutoMLResult')
     AvroSchema = Shapes::StringShape.new(name: 'AvroSchema')
+    BatchInferenceJob = Shapes::StructureShape.new(name: 'BatchInferenceJob')
+    BatchInferenceJobInput = Shapes::StructureShape.new(name: 'BatchInferenceJobInput')
+    BatchInferenceJobOutput = Shapes::StructureShape.new(name: 'BatchInferenceJobOutput')
+    BatchInferenceJobSummary = Shapes::StructureShape.new(name: 'BatchInferenceJobSummary')
+    BatchInferenceJobs = Shapes::ListShape.new(name: 'BatchInferenceJobs')
     Boolean = Shapes::BooleanShape.new(name: 'Boolean')
     Campaign = Shapes::StructureShape.new(name: 'Campaign')
     CampaignSummary = Shapes::StructureShape.new(name: 'CampaignSummary')
@@ -32,6 +37,8 @@ module Aws::Personalize
     ContinuousHyperParameterRanges = Shapes::ListShape.new(name: 'ContinuousHyperParameterRanges')
     ContinuousMaxValue = Shapes::FloatShape.new(name: 'ContinuousMaxValue')
     ContinuousMinValue = Shapes::FloatShape.new(name: 'ContinuousMinValue')
+    CreateBatchInferenceJobRequest = Shapes::StructureShape.new(name: 'CreateBatchInferenceJobRequest')
+    CreateBatchInferenceJobResponse = Shapes::StructureShape.new(name: 'CreateBatchInferenceJobResponse')
     CreateCampaignRequest = Shapes::StructureShape.new(name: 'CreateCampaignRequest')
     CreateCampaignResponse = Shapes::StructureShape.new(name: 'CreateCampaignResponse')
     CreateDatasetGroupRequest = Shapes::StructureShape.new(name: 'CreateDatasetGroupRequest')
@@ -77,6 +84,8 @@ module Aws::Personalize
     DeleteSolutionRequest = Shapes::StructureShape.new(name: 'DeleteSolutionRequest')
     DescribeAlgorithmRequest = Shapes::StructureShape.new(name: 'DescribeAlgorithmRequest')
     DescribeAlgorithmResponse = Shapes::StructureShape.new(name: 'DescribeAlgorithmResponse')
+    DescribeBatchInferenceJobRequest = Shapes::StructureShape.new(name: 'DescribeBatchInferenceJobRequest')
+    DescribeBatchInferenceJobResponse = Shapes::StructureShape.new(name: 'DescribeBatchInferenceJobResponse')
     DescribeCampaignRequest = Shapes::StructureShape.new(name: 'DescribeCampaignRequest')
     DescribeCampaignResponse = Shapes::StructureShape.new(name: 'DescribeCampaignResponse')
     DescribeDatasetGroupRequest = Shapes::StructureShape.new(name: 'DescribeDatasetGroupRequest')
@@ -126,6 +135,8 @@ module Aws::Personalize
     InvalidNextTokenException = Shapes::StructureShape.new(name: 'InvalidNextTokenException')
     KmsKeyArn = Shapes::StringShape.new(name: 'KmsKeyArn')
     LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
+    ListBatchInferenceJobsRequest = Shapes::StructureShape.new(name: 'ListBatchInferenceJobsRequest')
+    ListBatchInferenceJobsResponse = Shapes::StructureShape.new(name: 'ListBatchInferenceJobsResponse')
     ListCampaignsRequest = Shapes::StructureShape.new(name: 'ListCampaignsRequest')
     ListCampaignsResponse = Shapes::StructureShape.new(name: 'ListCampaignsResponse')
     ListDatasetGroupsRequest = Shapes::StructureShape.new(name: 'ListDatasetGroupsRequest')
@@ -151,6 +162,7 @@ module Aws::Personalize
     Metrics = Shapes::MapShape.new(name: 'Metrics')
     Name = Shapes::StringShape.new(name: 'Name')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
+    NumBatchResults = Shapes::IntegerShape.new(name: 'NumBatchResults')
     ParameterName = Shapes::StringShape.new(name: 'ParameterName')
     ParameterValue = Shapes::StringShape.new(name: 'ParameterValue')
     PerformAutoML = Shapes::BooleanShape.new(name: 'PerformAutoML')
@@ -165,6 +177,7 @@ module Aws::Personalize
     ResourceInUseException = Shapes::StructureShape.new(name: 'ResourceInUseException')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     RoleArn = Shapes::StringShape.new(name: 'RoleArn')
+    S3DataConfig = Shapes::StructureShape.new(name: 'S3DataConfig')
     S3Location = Shapes::StringShape.new(name: 'S3Location')
     Schemas = Shapes::ListShape.new(name: 'Schemas')
     Solution = Shapes::StructureShape.new(name: 'Solution')
@@ -209,6 +222,35 @@ module Aws::Personalize
     AutoMLResult.add_member(:best_recipe_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "bestRecipeArn"))
     AutoMLResult.struct_class = Types::AutoMLResult
 
+    BatchInferenceJob.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, location_name: "jobName"))
+    BatchInferenceJob.add_member(:batch_inference_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "batchInferenceJobArn"))
+    BatchInferenceJob.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
+    BatchInferenceJob.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
+    BatchInferenceJob.add_member(:num_results, Shapes::ShapeRef.new(shape: NumBatchResults, location_name: "numResults"))
+    BatchInferenceJob.add_member(:job_input, Shapes::ShapeRef.new(shape: BatchInferenceJobInput, location_name: "jobInput"))
+    BatchInferenceJob.add_member(:job_output, Shapes::ShapeRef.new(shape: BatchInferenceJobOutput, location_name: "jobOutput"))
+    BatchInferenceJob.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn"))
+    BatchInferenceJob.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
+    BatchInferenceJob.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
+    BatchInferenceJob.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
+    BatchInferenceJob.struct_class = Types::BatchInferenceJob
+
+    BatchInferenceJobInput.add_member(:s3_data_source, Shapes::ShapeRef.new(shape: S3DataConfig, required: true, location_name: "s3DataSource"))
+    BatchInferenceJobInput.struct_class = Types::BatchInferenceJobInput
+
+    BatchInferenceJobOutput.add_member(:s3_data_destination, Shapes::ShapeRef.new(shape: S3DataConfig, required: true, location_name: "s3DataDestination"))
+    BatchInferenceJobOutput.struct_class = Types::BatchInferenceJobOutput
+
+    BatchInferenceJobSummary.add_member(:batch_inference_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "batchInferenceJobArn"))
+    BatchInferenceJobSummary.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, location_name: "jobName"))
+    BatchInferenceJobSummary.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
+    BatchInferenceJobSummary.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
+    BatchInferenceJobSummary.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
+    BatchInferenceJobSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
+    BatchInferenceJobSummary.struct_class = Types::BatchInferenceJobSummary
+
+    BatchInferenceJobs.member = Shapes::ShapeRef.new(shape: BatchInferenceJobSummary)
+
     Campaign.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
     Campaign.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "campaignArn"))
     Campaign.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
@@ -253,6 +295,17 @@ module Aws::Personalize
 
     ContinuousHyperParameterRanges.member = Shapes::ShapeRef.new(shape: ContinuousHyperParameterRange)
 
+    CreateBatchInferenceJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "jobName"))
+    CreateBatchInferenceJobRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "solutionVersionArn"))
+    CreateBatchInferenceJobRequest.add_member(:num_results, Shapes::ShapeRef.new(shape: NumBatchResults, location_name: "numResults"))
+    CreateBatchInferenceJobRequest.add_member(:job_input, Shapes::ShapeRef.new(shape: BatchInferenceJobInput, required: true, location_name: "jobInput"))
+    CreateBatchInferenceJobRequest.add_member(:job_output, Shapes::ShapeRef.new(shape: BatchInferenceJobOutput, required: true, location_name: "jobOutput"))
+    CreateBatchInferenceJobRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
+    CreateBatchInferenceJobRequest.struct_class = Types::CreateBatchInferenceJobRequest
+
+    CreateBatchInferenceJobResponse.add_member(:batch_inference_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "batchInferenceJobArn"))
+    CreateBatchInferenceJobResponse.struct_class = Types::CreateBatchInferenceJobResponse
+
     CreateCampaignRequest.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
     CreateCampaignRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "solutionVersionArn"))
     CreateCampaignRequest.add_member(:min_provisioned_tps, Shapes::ShapeRef.new(shape: TransactionsPerSecond, required: true, location_name: "minProvisionedTPS"))
@@ -450,6 +503,12 @@ module Aws::Personalize
     DescribeAlgorithmResponse.add_member(:algorithm, Shapes::ShapeRef.new(shape: Algorithm, location_name: "algorithm"))
     DescribeAlgorithmResponse.struct_class = Types::DescribeAlgorithmResponse
 
+    DescribeBatchInferenceJobRequest.add_member(:batch_inference_job_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "batchInferenceJobArn"))
+    DescribeBatchInferenceJobRequest.struct_class = Types::DescribeBatchInferenceJobRequest
+
+    DescribeBatchInferenceJobResponse.add_member(:batch_inference_job, Shapes::ShapeRef.new(shape: BatchInferenceJob, location_name: "batchInferenceJob"))
+    DescribeBatchInferenceJobResponse.struct_class = Types::DescribeBatchInferenceJobResponse
+
     DescribeCampaignRequest.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "campaignArn"))
     DescribeCampaignRequest.struct_class = Types::DescribeCampaignRequest
 
@@ -588,6 +647,15 @@ module Aws::Personalize
     LimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
     LimitExceededException.struct_class = Types::LimitExceededException
 
+    ListBatchInferenceJobsRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
+    ListBatchInferenceJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
+    ListBatchInferenceJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
+    ListBatchInferenceJobsRequest.struct_class = Types::ListBatchInferenceJobsRequest
+
+    ListBatchInferenceJobsResponse.add_member(:batch_inference_jobs, Shapes::ShapeRef.new(shape: BatchInferenceJobs, location_name: "batchInferenceJobs"))
+    ListBatchInferenceJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
+    ListBatchInferenceJobsResponse.struct_class = Types::ListBatchInferenceJobsResponse
+
     ListCampaignsRequest.add_member(:solution_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionArn"))
     ListCampaignsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
     ListCampaignsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
@@ -702,6 +770,10 @@ module Aws::Personalize
     ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
     ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
 
+    S3DataConfig.add_member(:path, Shapes::ShapeRef.new(shape: S3Location, required: true, location_name: "path"))
+    S3DataConfig.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "kmsKeyArn"))
+    S3DataConfig.struct_class = Types::S3DataConfig
+
     Schemas.member = Shapes::ShapeRef.new(shape: DatasetSchemaSummary)
 
     Solution.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
@@ -787,6 +859,19 @@ module Aws::Personalize
         "uid" => "personalize-2018-05-22",
       }
 
+      api.add_operation(:create_batch_inference_job, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "CreateBatchInferenceJob"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: CreateBatchInferenceJobRequest)
+        o.output = Shapes::ShapeRef.new(shape: CreateBatchInferenceJobResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyExistsException)
+        o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
+      end)
+
       api.add_operation(:create_campaign, Seahorse::Model::Operation.new.tap do |o|
         o.name = "CreateCampaign"
         o.http_method = "POST"
@@ -961,6 +1046,16 @@ module Aws::Personalize
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
       end)
 
+      api.add_operation(:describe_batch_inference_job, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DescribeBatchInferenceJob"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: DescribeBatchInferenceJobRequest)
+        o.output = Shapes::ShapeRef.new(shape: DescribeBatchInferenceJobResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+      end)
+
       api.add_operation(:describe_campaign, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DescribeCampaign"
         o.http_method = "POST"
@@ -1072,6 +1167,22 @@ module Aws::Personalize
         o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
       end)
 
+      api.add_operation(:list_batch_inference_jobs, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListBatchInferenceJobs"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ListBatchInferenceJobsRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListBatchInferenceJobsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:list_campaigns, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListCampaigns"
         o.http_method = "POST"

data/lib/aws-sdk-personalize/types.rb

@@ -132,6 +132,182 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # Contains information on a batch inference job.
+    #
+    # @!attribute [rw] job_name
+    #   The name of the batch inference job.
+    #   @return [String]
+    #
+    # @!attribute [rw] batch_inference_job_arn
+    #   The Amazon Resource Name (ARN) of the batch inference job.
+    #   @return [String]
+    #
+    # @!attribute [rw] failure_reason
+    #   If the batch inference job failed, the reason for the failure.
+    #   @return [String]
+    #
+    # @!attribute [rw] solution_version_arn
+    #   The Amazon Resource Name (ARN) of the solution version from which
+    #   the batch inference job was created.
+    #   @return [String]
+    #
+    # @!attribute [rw] num_results
+    #   The number of recommendations generated by the batch inference job.
+    #   This number includes the error messages generated for failed input
+    #   records.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] job_input
+    #   The Amazon S3 path that leads to the input data used to generate the
+    #   batch inference job.
+    #   @return [Types::BatchInferenceJobInput]
+    #
+    # @!attribute [rw] job_output
+    #   The Amazon S3 bucket that contains the output data generated by the
+    #   batch inference job.
+    #   @return [Types::BatchInferenceJobOutput]
+    #
+    # @!attribute [rw] role_arn
+    #   The ARN of the Amazon Identity and Access Management (IAM) role that
+    #   requested the batch inference job.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the batch inference job. The status is one of the
+    #   following values:
+    #
+    #   * PENDING
+    #
+    #   * IN PROGRESS
+    #
+    #   * ACTIVE
+    #
+    #   * CREATE FAILED
+    #   @return [String]
+    #
+    # @!attribute [rw] creation_date_time
+    #   The time at which the batch inference job was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] last_updated_date_time
+    #   The time at which the batch inference job was last updated.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJob AWS API Documentation
+    #
+    class BatchInferenceJob < Struct.new(
+      :job_name,
+      :batch_inference_job_arn,
+      :failure_reason,
+      :solution_version_arn,
+      :num_results,
+      :job_input,
+      :job_output,
+      :role_arn,
+      :status,
+      :creation_date_time,
+      :last_updated_date_time)
+      include Aws::Structure
+    end
+
+    # The input configuration of a batch inference job.
+    #
+    # @note When making an API call, you may pass BatchInferenceJobInput
+    #   data as a hash:
+    #
+    #       {
+    #         s3_data_source: { # required
+    #           path: "S3Location", # required
+    #           kms_key_arn: "KmsKeyArn",
+    #         },
+    #       }
+    #
+    # @!attribute [rw] s3_data_source
+    #   The URI of the Amazon S3 location that contains your input data. The
+    #   Amazon S3 bucket must be in the same region as the API endpoint you
+    #   are calling.
+    #   @return [Types::S3DataConfig]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJobInput AWS API Documentation
+    #
+    class BatchInferenceJobInput < Struct.new(
+      :s3_data_source)
+      include Aws::Structure
+    end
+
+    # The output configuration parameters of a batch inference job.
+    #
+    # @note When making an API call, you may pass BatchInferenceJobOutput
+    #   data as a hash:
+    #
+    #       {
+    #         s3_data_destination: { # required
+    #           path: "S3Location", # required
+    #           kms_key_arn: "KmsKeyArn",
+    #         },
+    #       }
+    #
+    # @!attribute [rw] s3_data_destination
+    #   Information on the Amazon S3 bucket in which the batch inference
+    #   job's output is stored.
+    #   @return [Types::S3DataConfig]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJobOutput AWS API Documentation
+    #
+    class BatchInferenceJobOutput < Struct.new(
+      :s3_data_destination)
+      include Aws::Structure
+    end
+
+    # A truncated version of the BatchInferenceJob datatype. The
+    # ListBatchInferenceJobs operation returns a list of batch inference job
+    # summaries.
+    #
+    # @!attribute [rw] batch_inference_job_arn
+    #   The Amazon Resource Name (ARN) of the batch inference job.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_name
+    #   The name of the batch inference job.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the batch inference job. The status is one of the
+    #   following values:
+    #
+    #   * PENDING
+    #
+    #   * IN PROGRESS
+    #
+    #   * ACTIVE
+    #
+    #   * CREATE FAILED
+    #   @return [String]
+    #
+    # @!attribute [rw] creation_date_time
+    #   The time at which the batch inference job was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] last_updated_date_time
+    #   The time at which the batch inference job was last updated.
+    #   @return [Time]
+    #
+    # @!attribute [rw] failure_reason
+    #   If the batch inference job failed, the reason for the failure.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJobSummary AWS API Documentation
+    #
+    class BatchInferenceJobSummary < Struct.new(
+      :batch_inference_job_arn,
+      :job_name,
+      :status,
+      :creation_date_time,
+      :last_updated_date_time,
+      :failure_reason)
+      include Aws::Structure
+    end
+
     # Describes a deployed solution version, otherwise known as a campaign.
     # For more information on campaigns, see CreateCampaign.
     #
@@ -350,6 +526,80 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass CreateBatchInferenceJobRequest
+    #   data as a hash:
+    #
+    #       {
+    #         job_name: "Name", # required
+    #         solution_version_arn: "Arn", # required
+    #         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
+    #       }
+    #
+    # @!attribute [rw] job_name
+    #   The name of the batch inference job to create.
+    #   @return [String]
+    #
+    # @!attribute [rw] solution_version_arn
+    #   The Amazon Resource Name (ARN) of the solution version that will be
+    #   used to generate the batch inference recommendations.
+    #   @return [String]
+    #
+    # @!attribute [rw] num_results
+    #   The number of recommendations to retreive.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] job_input
+    #   The Amazon S3 path that leads to the input file to base your
+    #   recommendations on. The input material must be in JSON format.
+    #   @return [Types::BatchInferenceJobInput]
+    #
+    # @!attribute [rw] job_output
+    #   The path to the Amazon S3 bucket where the job's output will be
+    #   stored.
+    #   @return [Types::BatchInferenceJobOutput]
+    #
+    # @!attribute [rw] role_arn
+    #   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.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchInferenceJobRequest AWS API Documentation
+    #
+    class CreateBatchInferenceJobRequest < Struct.new(
+      :job_name,
+      :solution_version_arn,
+      :num_results,
+      :job_input,
+      :job_output,
+      :role_arn)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] batch_inference_job_arn
+    #   The ARN of the batch inference job.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchInferenceJobResponse AWS API Documentation
+    #
+    class CreateBatchInferenceJobResponse < Struct.new(
+      :batch_inference_job_arn)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass CreateCampaignRequest
     #   data as a hash:
     #
@@ -1480,6 +1730,35 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DescribeBatchInferenceJobRequest
+    #   data as a hash:
+    #
+    #       {
+    #         batch_inference_job_arn: "Arn", # required
+    #       }
+    #
+    # @!attribute [rw] batch_inference_job_arn
+    #   The ARN of the batch inference job to describe.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchInferenceJobRequest AWS API Documentation
+    #
+    class DescribeBatchInferenceJobRequest < Struct.new(
+      :batch_inference_job_arn)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] batch_inference_job
+    #   Information on the specified batch inference job.
+    #   @return [Types::BatchInferenceJob]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchInferenceJobResponse AWS API Documentation
+    #
+    class DescribeBatchInferenceJobResponse < Struct.new(
+      :batch_inference_job)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DescribeCampaignRequest
     #   data as a hash:
     #
@@ -2214,6 +2493,55 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListBatchInferenceJobsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         solution_version_arn: "Arn",
+    #         next_token: "NextToken",
+    #         max_results: 1,
+    #       }
+    #
+    # @!attribute [rw] solution_version_arn
+    #   The Amazon Resource Name (ARN) of the solution version from which
+    #   the batch inference jobs were created.
+    #   @return [String]
+    #
+    # @!attribute [rw] next_token
+    #   The token to request the next page of results.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of batch inference job results to return in each
+    #   page. The default value is 100.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchInferenceJobsRequest AWS API Documentation
+    #
+    class ListBatchInferenceJobsRequest < Struct.new(
+      :solution_version_arn,
+      :next_token,
+      :max_results)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] batch_inference_jobs
+    #   A list containing information on each job that is returned.
+    #   @return [Array<Types::BatchInferenceJobSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   The token to use to retreive the next page of results. The value is
+    #   `null` when there are no more results to return.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchInferenceJobsResponse AWS API Documentation
+    #
+    class ListBatchInferenceJobsResponse < Struct.new(
+      :batch_inference_jobs,
+      :next_token)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListCampaignsRequest
     #   data as a hash:
     #
@@ -2764,6 +3092,34 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # The configuration details of an Amazon S3 input or output bucket.
+    #
+    # @note When making an API call, you may pass S3DataConfig
+    #   data as a hash:
+    #
+    #       {
+    #         path: "S3Location", # required
+    #         kms_key_arn: "KmsKeyArn",
+    #       }
+    #
+    # @!attribute [rw] path
+    #   The file path of the Amazon S3 bucket.
+    #   @return [String]
+    #
+    # @!attribute [rw] kms_key_arn
+    #   The Amazon Resource Name (ARN) of the Amazon Key Management Service
+    #   (KMS) key that Amazon Personalize uses to encrypt or decrypt the
+    #   input and output files of a batch inference job.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/S3DataConfig AWS API Documentation
+    #
+    class S3DataConfig < Struct.new(
+      :path,
+      :kms_key_arn)
+      include Aws::Structure
+    end
+
     # An object that provides information about a solution. A solution is a
     # trained model that can be deployed as a campaign.
     #
@@ -2910,9 +3266,7 @@ module Aws::Personalize
     #   @return [String]
     #
     # @!attribute [rw] hpo_config
-    #   Describes the properties for hyperparameter optimization (HPO). For
-    #   use with the bring-your-own-recipe feature. Not used with Amazon
-    #   Personalize predefined recipes.
+    #   Describes the properties for hyperparameter optimization (HPO).
     #   @return [Types::HPOConfig]
     #
     # @!attribute [rw] algorithm_hyper_parameters

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalize
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core