aws-sdk-personalize 1.32.0 → 1.36.0

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

@@ -365,8 +365,195 @@ module Aws::Personalize
       include Aws::Structure
     end
 
-    # Describes a deployed solution version, otherwise known as a campaign.
-    # For more information on campaigns, see CreateCampaign.
+    # Contains information on a batch segment job.
+    #
+    # @!attribute [rw] job_name
+    #   The name of the batch segment job.
+    #   @return [String]
+    #
+    # @!attribute [rw] batch_segment_job_arn
+    #   The Amazon Resource Name (ARN) of the batch segment job.
+    #   @return [String]
+    #
+    # @!attribute [rw] filter_arn
+    #   The ARN of the filter used on the batch segment job.
+    #   @return [String]
+    #
+    # @!attribute [rw] failure_reason
+    #   If the batch segment job failed, the reason for the failure.
+    #   @return [String]
+    #
+    # @!attribute [rw] solution_version_arn
+    #   The Amazon Resource Name (ARN) of the solution version used by the
+    #   batch segment job to generate batch segments.
+    #   @return [String]
+    #
+    # @!attribute [rw] num_results
+    #   The number of predicted users generated by the batch segment job for
+    #   each line of input data.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] job_input
+    #   The Amazon S3 path that leads to the input data used to generate the
+    #   batch segment job.
+    #   @return [Types::BatchSegmentJobInput]
+    #
+    # @!attribute [rw] job_output
+    #   The Amazon S3 bucket that contains the output data generated by the
+    #   batch segment job.
+    #   @return [Types::BatchSegmentJobOutput]
+    #
+    # @!attribute [rw] role_arn
+    #   The ARN of the Amazon Identity and Access Management (IAM) role that
+    #   requested the batch segment job.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the batch segment 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 segment job was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] last_updated_date_time
+    #   The time at which the batch segment job last updated.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchSegmentJob AWS API Documentation
+    #
+    class BatchSegmentJob < Struct.new(
+      :job_name,
+      :batch_segment_job_arn,
+      :filter_arn,
+      :failure_reason,
+      :solution_version_arn,
+      :num_results,
+      :job_input,
+      :job_output,
+      :role_arn,
+      :status,
+      :creation_date_time,
+      :last_updated_date_time)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The input configuration of a batch segment job.
+    #
+    # @note When making an API call, you may pass BatchSegmentJobInput
+    #   data as a hash:
+    #
+    #       {
+    #         s3_data_source: { # required
+    #           path: "S3Location", # required
+    #           kms_key_arn: "KmsKeyArn",
+    #         },
+    #       }
+    #
+    # @!attribute [rw] s3_data_source
+    #   The configuration details of an Amazon S3 input or output bucket.
+    #   @return [Types::S3DataConfig]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchSegmentJobInput AWS API Documentation
+    #
+    class BatchSegmentJobInput < Struct.new(
+      :s3_data_source)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The output configuration parameters of a batch segment job.
+    #
+    # @note When making an API call, you may pass BatchSegmentJobOutput
+    #   data as a hash:
+    #
+    #       {
+    #         s3_data_destination: { # required
+    #           path: "S3Location", # required
+    #           kms_key_arn: "KmsKeyArn",
+    #         },
+    #       }
+    #
+    # @!attribute [rw] s3_data_destination
+    #   The configuration details of an Amazon S3 input or output bucket.
+    #   @return [Types::S3DataConfig]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchSegmentJobOutput AWS API Documentation
+    #
+    class BatchSegmentJobOutput < Struct.new(
+      :s3_data_destination)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A truncated version of the BatchSegmentJob datatype. The
+    # ListBatchSegmentJobs operation returns a list of batch segment job
+    # summaries.
+    #
+    # @!attribute [rw] batch_segment_job_arn
+    #   The Amazon Resource Name (ARN) of the batch segment job.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_name
+    #   The name of the batch segment job.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the batch segment 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 segment job was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] last_updated_date_time
+    #   The time at which the batch segment job was last updated.
+    #   @return [Time]
+    #
+    # @!attribute [rw] failure_reason
+    #   If the batch segment job failed, the reason for the failure.
+    #   @return [String]
+    #
+    # @!attribute [rw] solution_version_arn
+    #   The Amazon Resource Name (ARN) of the solution version used by the
+    #   batch segment job to generate batch segments.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchSegmentJobSummary AWS API Documentation
+    #
+    class BatchSegmentJobSummary < Struct.new(
+      :batch_segment_job_arn,
+      :job_name,
+      :status,
+      :creation_date_time,
+      :last_updated_date_time,
+      :failure_reason,
+      :solution_version_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # An object that describes the deployment of a solution version. For
+    # more information on campaigns, see CreateCampaign.
     #
     # @!attribute [rw] name
     #   The name of the campaign.
@@ -448,12 +635,11 @@ module Aws::Personalize
     #       }
     #
     # @!attribute [rw] item_exploration_config
-    #   A string to string map specifying the exploration configuration
-    #   hyperparameters, including `explorationWeight` and
-    #   `explorationItemAgeCutOff`, you want to use to configure the amount
-    #   of item exploration Amazon Personalize uses when recommending items.
-    #   Provide `itemExplorationConfig` data only if your solution uses the
-    #   [User-Personalization][1] recipe.
+    #   Specifies the exploration configuration hyperparameters, including
+    #   `explorationWeight` and `explorationItemAgeCutOff`, you want to use
+    #   to configure the amount of item exploration Amazon Personalize uses
+    #   when recommending items. Provide `itemExplorationConfig` data only
+    #   if your solution uses the [User-Personalization][1] recipe.
     #
     #
     #
@@ -728,6 +914,90 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass CreateBatchSegmentJobRequest
+    #   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
+    #       }
+    #
+    # @!attribute [rw] job_name
+    #   The name of the batch segment job to create.
+    #   @return [String]
+    #
+    # @!attribute [rw] solution_version_arn
+    #   The Amazon Resource Name (ARN) of the solution version you want the
+    #   batch segment job to use to generate batch segments.
+    #   @return [String]
+    #
+    # @!attribute [rw] filter_arn
+    #   The ARN of the filter to apply to the batch segment job. For more
+    #   information on using filters, see filter-batch.
+    #   @return [String]
+    #
+    # @!attribute [rw] num_results
+    #   The number of predicted users generated by the batch segment job for
+    #   each line of input data.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] job_input
+    #   The Amazon S3 path for the input data used to generate the batch
+    #   segment job.
+    #   @return [Types::BatchSegmentJobInput]
+    #
+    # @!attribute [rw] job_output
+    #   The Amazon S3 path for the bucket where the job's output will be
+    #   stored.
+    #   @return [Types::BatchSegmentJobOutput]
+    #
+    # @!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 output Amazon S3
+    #   buckets respectively.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchSegmentJobRequest AWS API Documentation
+    #
+    class CreateBatchSegmentJobRequest < Struct.new(
+      :job_name,
+      :solution_version_arn,
+      :filter_arn,
+      :num_results,
+      :job_input,
+      :job_output,
+      :role_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] batch_segment_job_arn
+    #   The ARN of the batch segment job.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchSegmentJobResponse AWS API Documentation
+    #
+    class CreateBatchSegmentJobResponse < Struct.new(
+      :batch_segment_job_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass CreateCampaignRequest
     #   data as a hash:
     #
@@ -856,6 +1126,7 @@ module Aws::Personalize
     #         name: "Name", # required
     #         role_arn: "RoleArn",
     #         kms_key_arn: "KmsKeyArn",
+    #         domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
     #       }
     #
     # @!attribute [rw] name
@@ -873,12 +1144,21 @@ module Aws::Personalize
     #   used to encrypt the datasets.
     #   @return [String]
     #
+    # @!attribute [rw] domain
+    #   The domain of the dataset group. Specify a domain to create a Domain
+    #   dataset group. The domain you specify determines the default schemas
+    #   for datasets and the use cases available for recommenders. If you
+    #   don't specify a domain, you create a Custom dataset group with
+    #   solution versions that you deploy with a campaign.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetGroupRequest AWS API Documentation
     #
     class CreateDatasetGroupRequest < Struct.new(
       :name,
       :role_arn,
-      :kms_key_arn)
+      :kms_key_arn,
+      :domain)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -887,10 +1167,15 @@ module Aws::Personalize
     #   The Amazon Resource Name (ARN) of the new dataset group.
     #   @return [String]
     #
+    # @!attribute [rw] domain
+    #   The domain for the new Domain dataset group.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetGroupResponse AWS API Documentation
     #
     class CreateDatasetGroupResponse < Struct.new(
-      :dataset_group_arn)
+      :dataset_group_arn,
+      :domain)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1100,12 +1385,75 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass CreateRecommenderRequest
+    #   data as a hash:
+    #
+    #       {
+    #         name: "Name", # required
+    #         dataset_group_arn: "Arn", # required
+    #         recipe_arn: "Arn", # required
+    #         recommender_config: {
+    #           item_exploration_config: {
+    #             "ParameterName" => "ParameterValue",
+    #           },
+    #         },
+    #       }
+    #
+    # @!attribute [rw] name
+    #   The name of the recommender.
+    #   @return [String]
+    #
+    # @!attribute [rw] dataset_group_arn
+    #   The Amazon Resource Name (ARN) of the destination domain dataset
+    #   group for the recommender.
+    #   @return [String]
+    #
+    # @!attribute [rw] recipe_arn
+    #   The Amazon Resource Name (ARN) of the recipe that the recommender
+    #   will use. For a recommender, a recipe is a Domain dataset group use
+    #   case. Only Domain dataset group use cases can be used to create a
+    #   recommender. For information about use cases see [Choosing
+    #   recommender use cases][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html
+    #   @return [String]
+    #
+    # @!attribute [rw] recommender_config
+    #   The configuration details of the recommender.
+    #   @return [Types::RecommenderConfig]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateRecommenderRequest AWS API Documentation
+    #
+    class CreateRecommenderRequest < Struct.new(
+      :name,
+      :dataset_group_arn,
+      :recipe_arn,
+      :recommender_config)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateRecommenderResponse AWS API Documentation
+    #
+    class CreateRecommenderResponse < Struct.new(
+      :recommender_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass CreateSchemaRequest
     #   data as a hash:
     #
     #       {
     #         name: "Name", # required
     #         schema: "AvroSchema", # required
+    #         domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
     #       }
     #
     # @!attribute [rw] name
@@ -1116,11 +1464,18 @@ module Aws::Personalize
     #   A schema in Avro JSON format.
     #   @return [String]
     #
+    # @!attribute [rw] domain
+    #   The domain for the schema. If you are creating a schema for a
+    #   dataset in a Domain dataset group, specify the domain you chose when
+    #   you created the Domain dataset group.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSchemaRequest AWS API Documentation
     #
     class CreateSchemaRequest < Struct.new(
       :name,
-      :schema)
+      :schema,
+      :domain)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1628,6 +1983,10 @@ module Aws::Personalize
     #   If creating a dataset group fails, provides the reason why.
     #   @return [String]
     #
+    # @!attribute [rw] domain
+    #   The domain of a Domain dataset group.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetGroup AWS API Documentation
     #
     class DatasetGroup < Struct.new(
@@ -1638,7 +1997,8 @@ module Aws::Personalize
       :kms_key_arn,
       :creation_date_time,
       :last_updated_date_time,
-      :failure_reason)
+      :failure_reason,
+      :domain)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1678,6 +2038,10 @@ module Aws::Personalize
     #   If creating a dataset group fails, the reason behind the failure.
     #   @return [String]
     #
+    # @!attribute [rw] domain
+    #   The domain of a Domain dataset group.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetGroupSummary AWS API Documentation
     #
     class DatasetGroupSummary < Struct.new(
@@ -1686,7 +2050,8 @@ module Aws::Personalize
       :status,
       :creation_date_time,
       :last_updated_date_time,
-      :failure_reason)
+      :failure_reason,
+      :domain)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1835,6 +2200,11 @@ module Aws::Personalize
     #   The date and time (in Unix time) that the schema was last updated.
     #   @return [Time]
     #
+    # @!attribute [rw] domain
+    #   The domain of a schema that you created for a dataset in a Domain
+    #   dataset group.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetSchema AWS API Documentation
     #
     class DatasetSchema < Struct.new(
@@ -1842,7 +2212,8 @@ module Aws::Personalize
       :schema_arn,
       :schema,
       :creation_date_time,
-      :last_updated_date_time)
+      :last_updated_date_time,
+      :domain)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1866,13 +2237,19 @@ module Aws::Personalize
     #   The date and time (in Unix time) that the schema was last updated.
     #   @return [Time]
     #
+    # @!attribute [rw] domain
+    #   The domain of a schema that you created for a dataset in a Domain
+    #   dataset group.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetSchemaSummary AWS API Documentation
     #
     class DatasetSchemaSummary < Struct.new(
       :name,
       :schema_arn,
       :creation_date_time,
-      :last_updated_date_time)
+      :last_updated_date_time,
+      :domain)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2142,6 +2519,25 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DeleteRecommenderRequest
+    #   data as a hash:
+    #
+    #       {
+    #         recommender_arn: "Arn", # required
+    #       }
+    #
+    # @!attribute [rw] recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender to delete.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteRecommenderRequest AWS API Documentation
+    #
+    class DeleteRecommenderRequest < Struct.new(
+      :recommender_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DeleteSchemaRequest
     #   data as a hash:
     #
@@ -2242,6 +2638,37 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DescribeBatchSegmentJobRequest
+    #   data as a hash:
+    #
+    #       {
+    #         batch_segment_job_arn: "Arn", # required
+    #       }
+    #
+    # @!attribute [rw] batch_segment_job_arn
+    #   The ARN of the batch segment job to describe.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchSegmentJobRequest AWS API Documentation
+    #
+    class DescribeBatchSegmentJobRequest < Struct.new(
+      :batch_segment_job_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] batch_segment_job
+    #   Information on the specified batch segment job.
+    #   @return [Types::BatchSegmentJob]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchSegmentJobResponse AWS API Documentation
+    #
+    class DescribeBatchSegmentJobResponse < Struct.new(
+      :batch_segment_job)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DescribeCampaignRequest
     #   data as a hash:
     #
@@ -2507,39 +2934,70 @@ module Aws::Personalize
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFilterResponse AWS API Documentation
     #
-    class DescribeFilterResponse < Struct.new(
-      :filter)
+    class DescribeFilterResponse < Struct.new(
+      :filter)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass DescribeRecipeRequest
+    #   data as a hash:
+    #
+    #       {
+    #         recipe_arn: "Arn", # required
+    #       }
+    #
+    # @!attribute [rw] recipe_arn
+    #   The Amazon Resource Name (ARN) of the recipe to describe.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipeRequest AWS API Documentation
+    #
+    class DescribeRecipeRequest < Struct.new(
+      :recipe_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] recipe
+    #   An object that describes the recipe.
+    #   @return [Types::Recipe]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipeResponse AWS API Documentation
+    #
+    class DescribeRecipeResponse < Struct.new(
+      :recipe)
       SENSITIVE = []
       include Aws::Structure
     end
 
-    # @note When making an API call, you may pass DescribeRecipeRequest
+    # @note When making an API call, you may pass DescribeRecommenderRequest
     #   data as a hash:
     #
     #       {
-    #         recipe_arn: "Arn", # required
+    #         recommender_arn: "Arn", # required
     #       }
     #
-    # @!attribute [rw] recipe_arn
-    #   The Amazon Resource Name (ARN) of the recipe to describe.
+    # @!attribute [rw] recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender to describe.
     #   @return [String]
     #
-    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipeRequest AWS API Documentation
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecommenderRequest AWS API Documentation
     #
-    class DescribeRecipeRequest < Struct.new(
-      :recipe_arn)
+    class DescribeRecommenderRequest < Struct.new(
+      :recommender_arn)
       SENSITIVE = []
       include Aws::Structure
     end
 
-    # @!attribute [rw] recipe
-    #   An object that describes the recipe.
-    #   @return [Types::Recipe]
+    # @!attribute [rw] recommender
+    #   The properties of the recommender.
+    #   @return [Types::Recommender]
     #
-    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipeResponse AWS API Documentation
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecommenderResponse AWS API Documentation
     #
-    class DescribeRecipeResponse < Struct.new(
-      :recipe)
+    class DescribeRecommenderResponse < Struct.new(
+      :recommender)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3238,6 +3696,57 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListBatchSegmentJobsRequest
+    #   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 that the
+    #   batch segment jobs used to generate batch segments.
+    #   @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 segment 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/ListBatchSegmentJobsRequest AWS API Documentation
+    #
+    class ListBatchSegmentJobsRequest < Struct.new(
+      :solution_version_arn,
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] batch_segment_jobs
+    #   A list containing information on each job that is returned.
+    #   @return [Array<Types::BatchSegmentJobSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   The token to use to retrieve 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/ListBatchSegmentJobsResponse AWS API Documentation
+    #
+    class ListBatchSegmentJobsResponse < Struct.new(
+      :batch_segment_jobs,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListCampaignsRequest
     #   data as a hash:
     #
@@ -3590,6 +4099,7 @@ module Aws::Personalize
     #         recipe_provider: "SERVICE", # accepts SERVICE
     #         next_token: "NextToken",
     #         max_results: 1,
+    #         domain: "ECOMMERCE", # accepts ECOMMERCE, VIDEO_ON_DEMAND
     #       }
     #
     # @!attribute [rw] recipe_provider
@@ -3605,12 +4115,20 @@ module Aws::Personalize
     #   The maximum number of recipes to return.
     #   @return [Integer]
     #
+    # @!attribute [rw] domain
+    #   Filters returned recipes by domain for a Domain dataset group. Only
+    #   recipes (Domain dataset group use cases) for this domain are
+    #   included in the response. If you don't specify a domain, only
+    #   non-domain recipes are returned.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipesRequest AWS API Documentation
     #
     class ListRecipesRequest < Struct.new(
       :recipe_provider,
       :next_token,
-      :max_results)
+      :max_results,
+      :domain)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3632,6 +4150,57 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListRecommendersRequest
+    #   data as a hash:
+    #
+    #       {
+    #         dataset_group_arn: "Arn",
+    #         next_token: "NextToken",
+    #         max_results: 1,
+    #       }
+    #
+    # @!attribute [rw] dataset_group_arn
+    #   The Amazon Resource Name (ARN) of the Domain dataset group to list
+    #   the recommenders for. When a Domain dataset group is not specified,
+    #   all the recommenders associated with the account are listed.
+    #   @return [String]
+    #
+    # @!attribute [rw] next_token
+    #   A token returned from the previous call to `ListRecommenders` for
+    #   getting the next set of recommenders (if they exist).
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of recommenders to return.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecommendersRequest AWS API Documentation
+    #
+    class ListRecommendersRequest < Struct.new(
+      :dataset_group_arn,
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] recommenders
+    #   A list of the recommenders.
+    #   @return [Array<Types::RecommenderSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   A token for getting the next set of recommenders (if they exist).
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecommendersResponse AWS API Documentation
+    #
+    class ListRecommendersResponse < Struct.new(
+      :recommenders,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListSchemasRequest
     #   data as a hash:
     #
@@ -3896,6 +4465,11 @@ module Aws::Personalize
     #   The date and time (in Unix time) that the recipe was last updated.
     #   @return [Time]
     #
+    # @!attribute [rw] domain
+    #   The domain of the recipe (if the recipe is a Domain dataset group
+    #   use case).
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecipeSummary AWS API Documentation
     #
     class RecipeSummary < Struct.new(
@@ -3903,11 +4477,218 @@ module Aws::Personalize
       :recipe_arn,
       :status,
       :creation_date_time,
+      :last_updated_date_time,
+      :domain)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Describes a recommendation generator for a Domain dataset group. You
+    # create a recommender in a Domain dataset group for a specific domain
+    # use case (domain recipe), and specify the recommender in a
+    # [GetRecommendations][1] request.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
+    #
+    # @!attribute [rw] recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender.
+    #   @return [String]
+    #
+    # @!attribute [rw] dataset_group_arn
+    #   The Amazon Resource Name (ARN) of the Domain dataset group that
+    #   contains the recommender.
+    #   @return [String]
+    #
+    # @!attribute [rw] name
+    #   The name of the recommender.
+    #   @return [String]
+    #
+    # @!attribute [rw] recipe_arn
+    #   The Amazon Resource Name (ARN) of the recipe (Domain dataset group
+    #   use case) that the recommender was created for.
+    #   @return [String]
+    #
+    # @!attribute [rw] recommender_config
+    #   The configuration details of the recommender.
+    #   @return [Types::RecommenderConfig]
+    #
+    # @!attribute [rw] creation_date_time
+    #   The date and time (in Unix format) that the recommender was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] last_updated_date_time
+    #   The date and time (in Unix format) that the recommender was last
+    #   updated.
+    #   @return [Time]
+    #
+    # @!attribute [rw] status
+    #   The status of the recommender.
+    #
+    #   A recommender can be in one of the following states:
+    #
+    #   * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
+    #     FAILED
+    #
+    #   * DELETE PENDING &gt; DELETE IN\_PROGRESS
+    #   @return [String]
+    #
+    # @!attribute [rw] failure_reason
+    #   If a recommender fails, the reason behind the failure.
+    #   @return [String]
+    #
+    # @!attribute [rw] latest_recommender_update
+    #   Provides a summary of the latest updates to the recommender.
+    #   @return [Types::RecommenderUpdateSummary]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/Recommender AWS API Documentation
+    #
+    class Recommender < Struct.new(
+      :recommender_arn,
+      :dataset_group_arn,
+      :name,
+      :recipe_arn,
+      :recommender_config,
+      :creation_date_time,
+      :last_updated_date_time,
+      :status,
+      :failure_reason,
+      :latest_recommender_update)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The configuration details of the recommender.
+    #
+    # @note When making an API call, you may pass RecommenderConfig
+    #   data as a hash:
+    #
+    #       {
+    #         item_exploration_config: {
+    #           "ParameterName" => "ParameterValue",
+    #         },
+    #       }
+    #
+    # @!attribute [rw] item_exploration_config
+    #   Specifies the exploration configuration hyperparameters, including
+    #   `explorationWeight` and `explorationItemAgeCutOff`, you want to use
+    #   to configure the amount of item exploration Amazon Personalize uses
+    #   when recommending items. Provide `itemExplorationConfig` data only
+    #   if your recommenders generate personalized recommendations for a
+    #   user (not popular items or similar items).
+    #   @return [Hash<String,String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecommenderConfig AWS API Documentation
+    #
+    class RecommenderConfig < Struct.new(
+      :item_exploration_config)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides a summary of the properties of the recommender.
+    #
+    # @!attribute [rw] name
+    #   The name of the recommender.
+    #   @return [String]
+    #
+    # @!attribute [rw] recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender.
+    #   @return [String]
+    #
+    # @!attribute [rw] dataset_group_arn
+    #   The Amazon Resource Name (ARN) of the Domain dataset group that
+    #   contains the recommender.
+    #   @return [String]
+    #
+    # @!attribute [rw] recipe_arn
+    #   The Amazon Resource Name (ARN) of the recipe (Domain dataset group
+    #   use case) that the recommender was created for.
+    #   @return [String]
+    #
+    # @!attribute [rw] recommender_config
+    #   The configuration details of the recommender.
+    #   @return [Types::RecommenderConfig]
+    #
+    # @!attribute [rw] status
+    #   The status of the recommender. A recommender can be in one of the
+    #   following states:
+    #
+    #   * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
+    #     FAILED
+    #
+    #   * DELETE PENDING &gt; DELETE IN\_PROGRESS
+    #   @return [String]
+    #
+    # @!attribute [rw] creation_date_time
+    #   The date and time (in Unix format) that the recommender was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] last_updated_date_time
+    #   The date and time (in Unix format) that the recommender was last
+    #   updated.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecommenderSummary AWS API Documentation
+    #
+    class RecommenderSummary < Struct.new(
+      :name,
+      :recommender_arn,
+      :dataset_group_arn,
+      :recipe_arn,
+      :recommender_config,
+      :status,
+      :creation_date_time,
       :last_updated_date_time)
       SENSITIVE = []
       include Aws::Structure
     end
 
+    # Provides a summary of the properties of a recommender update. For a
+    # complete listing, call the DescribeRecommender API.
+    #
+    # @!attribute [rw] recommender_config
+    #   The configuration details of the recommender update.
+    #   @return [Types::RecommenderConfig]
+    #
+    # @!attribute [rw] creation_date_time
+    #   The date and time (in Unix format) that the recommender update was
+    #   created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] last_updated_date_time
+    #   The date and time (in Unix time) that the recommender update was
+    #   last updated.
+    #   @return [Time]
+    #
+    # @!attribute [rw] status
+    #   The status of the recommender update.
+    #
+    #   A recommender can be in one of the following states:
+    #
+    #   * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
+    #     FAILED
+    #
+    #   * DELETE PENDING &gt; DELETE IN\_PROGRESS
+    #   @return [String]
+    #
+    # @!attribute [rw] failure_reason
+    #   If a recommender update fails, the reason behind the failure.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecommenderUpdateSummary AWS API Documentation
+    #
+    class RecommenderUpdateSummary < Struct.new(
+      :recommender_config,
+      :creation_date_time,
+      :last_updated_date_time,
+      :status,
+      :failure_reason)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The specified resource already exists.
     #
     # @!attribute [rw] message
@@ -4211,7 +4992,7 @@ module Aws::Personalize
     end
 
     # An object that provides information about a specific version of a
-    # Solution.
+    # Solution in a Custom dataset group.
     #
     # @!attribute [rw] solution_version_arn
     #   The ARN of the solution version.
@@ -4467,5 +5248,47 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass UpdateRecommenderRequest
+    #   data as a hash:
+    #
+    #       {
+    #         recommender_arn: "Arn", # required
+    #         recommender_config: { # required
+    #           item_exploration_config: {
+    #             "ParameterName" => "ParameterValue",
+    #           },
+    #         },
+    #       }
+    #
+    # @!attribute [rw] recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender to modify.
+    #   @return [String]
+    #
+    # @!attribute [rw] recommender_config
+    #   The configuration details of the recommender.
+    #   @return [Types::RecommenderConfig]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateRecommenderRequest AWS API Documentation
+    #
+    class UpdateRecommenderRequest < Struct.new(
+      :recommender_arn,
+      :recommender_config)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] recommender_arn
+    #   The same recommender Amazon Resource Name (ARN) as given in the
+    #   request.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateRecommenderResponse AWS API Documentation
+    #
+    class UpdateRecommenderResponse < Struct.new(
+      :recommender_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
   end
 end