aws-sdk-personalize 1.19.0 → 1.24.0

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

@@ -3,7 +3,7 @@
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
@@ -45,6 +45,8 @@ module Aws::Personalize
     CreateBatchInferenceJobResponse = Shapes::StructureShape.new(name: 'CreateBatchInferenceJobResponse')
     CreateCampaignRequest = Shapes::StructureShape.new(name: 'CreateCampaignRequest')
     CreateCampaignResponse = Shapes::StructureShape.new(name: 'CreateCampaignResponse')
+    CreateDatasetExportJobRequest = Shapes::StructureShape.new(name: 'CreateDatasetExportJobRequest')
+    CreateDatasetExportJobResponse = Shapes::StructureShape.new(name: 'CreateDatasetExportJobResponse')
     CreateDatasetGroupRequest = Shapes::StructureShape.new(name: 'CreateDatasetGroupRequest')
     CreateDatasetGroupResponse = Shapes::StructureShape.new(name: 'CreateDatasetGroupResponse')
     CreateDatasetImportJobRequest = Shapes::StructureShape.new(name: 'CreateDatasetImportJobRequest')
@@ -63,6 +65,10 @@ module Aws::Personalize
     CreateSolutionVersionResponse = Shapes::StructureShape.new(name: 'CreateSolutionVersionResponse')
     DataSource = Shapes::StructureShape.new(name: 'DataSource')
     Dataset = Shapes::StructureShape.new(name: 'Dataset')
+    DatasetExportJob = Shapes::StructureShape.new(name: 'DatasetExportJob')
+    DatasetExportJobOutput = Shapes::StructureShape.new(name: 'DatasetExportJobOutput')
+    DatasetExportJobSummary = Shapes::StructureShape.new(name: 'DatasetExportJobSummary')
+    DatasetExportJobs = Shapes::ListShape.new(name: 'DatasetExportJobs')
     DatasetGroup = Shapes::StructureShape.new(name: 'DatasetGroup')
     DatasetGroupSummary = Shapes::StructureShape.new(name: 'DatasetGroupSummary')
     DatasetGroups = Shapes::ListShape.new(name: 'DatasetGroups')
@@ -95,6 +101,8 @@ module Aws::Personalize
     DescribeBatchInferenceJobResponse = Shapes::StructureShape.new(name: 'DescribeBatchInferenceJobResponse')
     DescribeCampaignRequest = Shapes::StructureShape.new(name: 'DescribeCampaignRequest')
     DescribeCampaignResponse = Shapes::StructureShape.new(name: 'DescribeCampaignResponse')
+    DescribeDatasetExportJobRequest = Shapes::StructureShape.new(name: 'DescribeDatasetExportJobRequest')
+    DescribeDatasetExportJobResponse = Shapes::StructureShape.new(name: 'DescribeDatasetExportJobResponse')
     DescribeDatasetGroupRequest = Shapes::StructureShape.new(name: 'DescribeDatasetGroupRequest')
     DescribeDatasetGroupResponse = Shapes::StructureShape.new(name: 'DescribeDatasetGroupResponse')
     DescribeDatasetImportJobRequest = Shapes::StructureShape.new(name: 'DescribeDatasetImportJobRequest')
@@ -140,6 +148,7 @@ module Aws::Personalize
     HPOResourceConfig = Shapes::StructureShape.new(name: 'HPOResourceConfig')
     HyperParameterRanges = Shapes::StructureShape.new(name: 'HyperParameterRanges')
     HyperParameters = Shapes::MapShape.new(name: 'HyperParameters')
+    IngestionMode = Shapes::StringShape.new(name: 'IngestionMode')
     IntegerHyperParameterRange = Shapes::StructureShape.new(name: 'IntegerHyperParameterRange')
     IntegerHyperParameterRanges = Shapes::ListShape.new(name: 'IntegerHyperParameterRanges')
     IntegerMaxValue = Shapes::IntegerShape.new(name: 'IntegerMaxValue')
@@ -152,6 +161,8 @@ module Aws::Personalize
     ListBatchInferenceJobsResponse = Shapes::StructureShape.new(name: 'ListBatchInferenceJobsResponse')
     ListCampaignsRequest = Shapes::StructureShape.new(name: 'ListCampaignsRequest')
     ListCampaignsResponse = Shapes::StructureShape.new(name: 'ListCampaignsResponse')
+    ListDatasetExportJobsRequest = Shapes::StructureShape.new(name: 'ListDatasetExportJobsRequest')
+    ListDatasetExportJobsResponse = Shapes::StructureShape.new(name: 'ListDatasetExportJobsResponse')
     ListDatasetGroupsRequest = Shapes::StructureShape.new(name: 'ListDatasetGroupsRequest')
     ListDatasetGroupsResponse = Shapes::StructureShape.new(name: 'ListDatasetGroupsResponse')
     ListDatasetImportJobsRequest = Shapes::StructureShape.new(name: 'ListDatasetImportJobsRequest')
@@ -344,6 +355,16 @@ module Aws::Personalize
     CreateCampaignResponse.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "campaignArn"))
     CreateCampaignResponse.struct_class = Types::CreateCampaignResponse
 
+    CreateDatasetExportJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "jobName"))
+    CreateDatasetExportJobRequest.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetArn"))
+    CreateDatasetExportJobRequest.add_member(:ingestion_mode, Shapes::ShapeRef.new(shape: IngestionMode, location_name: "ingestionMode"))
+    CreateDatasetExportJobRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
+    CreateDatasetExportJobRequest.add_member(:job_output, Shapes::ShapeRef.new(shape: DatasetExportJobOutput, required: true, location_name: "jobOutput"))
+    CreateDatasetExportJobRequest.struct_class = Types::CreateDatasetExportJobRequest
+
+    CreateDatasetExportJobResponse.add_member(:dataset_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetExportJobArn"))
+    CreateDatasetExportJobResponse.struct_class = Types::CreateDatasetExportJobResponse
+
     CreateDatasetGroupRequest.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
     CreateDatasetGroupRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn"))
     CreateDatasetGroupRequest.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "kmsKeyArn"))
@@ -425,6 +446,31 @@ module Aws::Personalize
     Dataset.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
     Dataset.struct_class = Types::Dataset
 
+    DatasetExportJob.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, location_name: "jobName"))
+    DatasetExportJob.add_member(:dataset_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetExportJobArn"))
+    DatasetExportJob.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetArn"))
+    DatasetExportJob.add_member(:ingestion_mode, Shapes::ShapeRef.new(shape: IngestionMode, location_name: "ingestionMode"))
+    DatasetExportJob.add_member(:role_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "roleArn"))
+    DatasetExportJob.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
+    DatasetExportJob.add_member(:job_output, Shapes::ShapeRef.new(shape: DatasetExportJobOutput, location_name: "jobOutput"))
+    DatasetExportJob.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
+    DatasetExportJob.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
+    DatasetExportJob.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
+    DatasetExportJob.struct_class = Types::DatasetExportJob
+
+    DatasetExportJobOutput.add_member(:s3_data_destination, Shapes::ShapeRef.new(shape: S3DataConfig, required: true, location_name: "s3DataDestination"))
+    DatasetExportJobOutput.struct_class = Types::DatasetExportJobOutput
+
+    DatasetExportJobSummary.add_member(:dataset_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetExportJobArn"))
+    DatasetExportJobSummary.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, location_name: "jobName"))
+    DatasetExportJobSummary.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
+    DatasetExportJobSummary.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
+    DatasetExportJobSummary.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
+    DatasetExportJobSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
+    DatasetExportJobSummary.struct_class = Types::DatasetExportJobSummary
+
+    DatasetExportJobs.member = Shapes::ShapeRef.new(shape: DatasetExportJobSummary)
+
     DatasetGroup.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
     DatasetGroup.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetGroupArn"))
     DatasetGroup.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
@@ -556,6 +602,12 @@ module Aws::Personalize
     DescribeCampaignResponse.add_member(:campaign, Shapes::ShapeRef.new(shape: Campaign, location_name: "campaign"))
     DescribeCampaignResponse.struct_class = Types::DescribeCampaignResponse
 
+    DescribeDatasetExportJobRequest.add_member(:dataset_export_job_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetExportJobArn"))
+    DescribeDatasetExportJobRequest.struct_class = Types::DescribeDatasetExportJobRequest
+
+    DescribeDatasetExportJobResponse.add_member(:dataset_export_job, Shapes::ShapeRef.new(shape: DatasetExportJob, location_name: "datasetExportJob"))
+    DescribeDatasetExportJobResponse.struct_class = Types::DescribeDatasetExportJobResponse
+
     DescribeDatasetGroupRequest.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetGroupArn"))
     DescribeDatasetGroupRequest.struct_class = Types::DescribeDatasetGroupRequest
 
@@ -733,6 +785,15 @@ module Aws::Personalize
     ListCampaignsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
     ListCampaignsResponse.struct_class = Types::ListCampaignsResponse
 
+    ListDatasetExportJobsRequest.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetArn"))
+    ListDatasetExportJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
+    ListDatasetExportJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
+    ListDatasetExportJobsRequest.struct_class = Types::ListDatasetExportJobsRequest
+
+    ListDatasetExportJobsResponse.add_member(:dataset_export_jobs, Shapes::ShapeRef.new(shape: DatasetExportJobs, location_name: "datasetExportJobs"))
+    ListDatasetExportJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
+    ListDatasetExportJobsResponse.struct_class = Types::ListDatasetExportJobsResponse
+
     ListDatasetGroupsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
     ListDatasetGroupsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
     ListDatasetGroupsRequest.struct_class = Types::ListDatasetGroupsRequest
@@ -980,6 +1041,19 @@ module Aws::Personalize
         o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
       end)
 
+      api.add_operation(:create_dataset_export_job, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "CreateDatasetExportJob"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: CreateDatasetExportJobRequest)
+        o.output = Shapes::ShapeRef.new(shape: CreateDatasetExportJobResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyExistsException)
+        o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
+      end)
+
       api.add_operation(:create_dataset_group, Seahorse::Model::Operation.new.tap do |o|
         o.name = "CreateDatasetGroup"
         o.http_method = "POST"
@@ -1182,6 +1256,16 @@ module Aws::Personalize
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
       end)
 
+      api.add_operation(:describe_dataset_export_job, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DescribeDatasetExportJob"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: DescribeDatasetExportJobRequest)
+        o.output = Shapes::ShapeRef.new(shape: DescribeDatasetExportJobResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+      end)
+
       api.add_operation(:describe_dataset_group, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DescribeDatasetGroup"
         o.http_method = "POST"
@@ -1315,6 +1399,22 @@ module Aws::Personalize
         )
       end)
 
+      api.add_operation(:list_dataset_export_jobs, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListDatasetExportJobs"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ListDatasetExportJobsRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListDatasetExportJobsResponse)
+        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_dataset_groups, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListDatasetGroups"
         o.http_method = "POST"
@@ -1386,6 +1486,12 @@ module Aws::Personalize
         o.output = Shapes::ShapeRef.new(shape: ListFiltersResponse)
         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_recipes, Seahorse::Model::Operation.new.tap do |o|

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

@@ -3,7 +3,7 @@
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 

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

@@ -3,7 +3,7 @@
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 

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

@@ -3,7 +3,7 @@
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
@@ -240,9 +240,15 @@ module Aws::Personalize
     #       }
     #
     # @!attribute [rw] item_exploration_config
-    #   A string to string map specifying the inference hyperparameters you
-    #   wish to use for hyperparameter optimization. See
-    #   customizing-solution-config-hpo.
+    #   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.
+    #   See [User-Personalization][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJobConfig AWS API Documentation
@@ -442,9 +448,16 @@ module Aws::Personalize
     #       }
     #
     # @!attribute [rw] item_exploration_config
-    #   A string to string map specifying the inference hyperparameters you
-    #   wish to use for hyperparameter optimization. See
-    #   customizing-solution-config-hpo.
+    #   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.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CampaignConfig AWS API Documentation
@@ -656,8 +669,12 @@ module Aws::Personalize
     #
     # @!attribute [rw] filter_arn
     #   The ARN of the filter to apply to the batch inference job. For more
-    #   information on using filters, see Using Filters with Amazon
-    #   Personalize.
+    #   information on using filters, see [Filtering Batch
+    #   Recommendations][1]..
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html
     #   @return [String]
     #
     # @!attribute [rw] num_results
@@ -676,7 +693,7 @@ module Aws::Personalize
     #
     # @!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
+    #   permissions to read and write to your input and output Amazon S3
     #   buckets respectively.
     #   @return [String]
     #
@@ -766,6 +783,73 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass CreateDatasetExportJobRequest
+    #   data as a hash:
+    #
+    #       {
+    #         job_name: "Name", # required
+    #         dataset_arn: "Arn", # required
+    #         ingestion_mode: "BULK", # accepts BULK, PUT, ALL
+    #         role_arn: "RoleArn", # required
+    #         job_output: { # required
+    #           s3_data_destination: { # required
+    #             path: "S3Location", # required
+    #             kms_key_arn: "KmsKeyArn",
+    #           },
+    #         },
+    #       }
+    #
+    # @!attribute [rw] job_name
+    #   The name for the dataset export job.
+    #   @return [String]
+    #
+    # @!attribute [rw] dataset_arn
+    #   The Amazon Resource Name (ARN) of the dataset that contains the data
+    #   to export.
+    #   @return [String]
+    #
+    # @!attribute [rw] ingestion_mode
+    #   The data to export, based on how you imported the data. You can
+    #   choose to export only `BULK` data that you imported using a dataset
+    #   import job, only `PUT` data that you imported incrementally (using
+    #   the console, PutEvents, PutUsers and PutItems operations), or `ALL`
+    #   for both types. The default value is `PUT`.
+    #   @return [String]
+    #
+    # @!attribute [rw] role_arn
+    #   The Amazon Resource Name (ARN) of the AWS Identity and Access
+    #   Management service role that has permissions to add data to your
+    #   output Amazon S3 bucket.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_output
+    #   The path to the Amazon S3 bucket where the job's output is stored.
+    #   @return [Types::DatasetExportJobOutput]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetExportJobRequest AWS API Documentation
+    #
+    class CreateDatasetExportJobRequest < Struct.new(
+      :job_name,
+      :dataset_arn,
+      :ingestion_mode,
+      :role_arn,
+      :job_output)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] dataset_export_job_arn
+    #   The Amazon Resource Name (ARN) of the dataset export job.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetExportJobResponse AWS API Documentation
+    #
+    class CreateDatasetExportJobResponse < Struct.new(
+      :dataset_export_job_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass CreateDatasetGroupRequest
     #   data as a hash:
     #
@@ -988,20 +1072,10 @@ module Aws::Personalize
     #   @return [String]
     #
     # @!attribute [rw] filter_expression
-    #   The filter expression that designates the interaction types that the
-    #   filter will filter out. A filter expression must follow the
-    #   following format:
-    #
-    #   `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
-    #
-    #   Where "EVENT\_TYPE" is the type of event to filter out. To filter
-    #   out all items with any interactions history, set `"*"` as the
-    #   EVENT\_TYPE. For more information, see [Using Filters with Amazon
-    #   Personalize][1].
-    #
-    #
-    #
-    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
+    #   The filter expression defines which items are included or excluded
+    #   from recommendations. Filter expression must follow specific format
+    #   rules. For information about filter expression structure and syntax,
+    #   see filter-expressions.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilterRequest AWS API Documentation
@@ -1159,12 +1233,20 @@ module Aws::Personalize
     #   When your have multiple event types (using an `EVENT_TYPE` schema
     #   field), this parameter specifies which event type (for example,
     #   'click' or 'like') is used for training the model.
+    #
+    #   If you do not provide an `eventType`, Amazon Personalize will use
+    #   all interactions for training with equal weight regardless of type.
     #   @return [String]
     #
     # @!attribute [rw] solution_config
     #   The configuration to use with the solution. When `performAutoML` is
     #   set to true, Amazon Personalize only evaluates the `autoMLConfig`
     #   section of the solution configuration.
+    #
+    #   <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective`
+    #   at this time.
+    #
+    #    </note>
     #   @return [Types::SolutionConfig]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionRequest AWS API Documentation
@@ -1218,7 +1300,12 @@ module Aws::Personalize
     #   The `UPDATE` option can only be used when you already have an active
     #   solution version created from the input solution using the `FULL`
     #   option and the input solution was trained with the
-    #   native-recipe-hrnn-coldstart recipe.
+    #   [User-Personalization][1] recipe or the [HRNN-Coldstart][2] recipe.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
+    #   [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionVersionRequest AWS API Documentation
@@ -1256,7 +1343,7 @@ module Aws::Personalize
     #   The path to the Amazon S3 bucket where the data that you want to
     #   upload to your dataset is stored. For example:
     #
-    #   `s3://bucket-name/training-data.csv`
+    #   `s3://bucket-name/folder-name/`
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DataSource AWS API Documentation
@@ -1330,6 +1417,163 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # Describes a job that exports a dataset to an Amazon S3 bucket. For
+    # more information, see CreateDatasetExportJob.
+    #
+    # A dataset export job can be in one of the following states:
+    #
+    # * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
+    #   FAILED
+    #
+    # ^
+    #
+    # @!attribute [rw] job_name
+    #   The name of the export job.
+    #   @return [String]
+    #
+    # @!attribute [rw] dataset_export_job_arn
+    #   The Amazon Resource Name (ARN) of the dataset export job.
+    #   @return [String]
+    #
+    # @!attribute [rw] dataset_arn
+    #   The Amazon Resource Name (ARN) of the dataset to export.
+    #   @return [String]
+    #
+    # @!attribute [rw] ingestion_mode
+    #   The data to export, based on how you imported the data. You can
+    #   choose to export `BULK` data that you imported using a dataset
+    #   import job, `PUT` data that you imported incrementally (using the
+    #   console, PutEvents, PutUsers and PutItems operations), or `ALL` for
+    #   both types. The default value is `PUT`.
+    #   @return [String]
+    #
+    # @!attribute [rw] role_arn
+    #   The Amazon Resource Name (ARN) of the AWS Identity and Access
+    #   Management service role that has permissions to add data to your
+    #   output Amazon S3 bucket.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the dataset export job.
+    #
+    #   A dataset export job can be in one of the following states:
+    #
+    #   * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
+    #     FAILED
+    #
+    #   ^
+    #   @return [String]
+    #
+    # @!attribute [rw] job_output
+    #   The path to the Amazon S3 bucket where the job's output is stored.
+    #   For example:
+    #
+    #   `s3://bucket-name/folder-name/`
+    #   @return [Types::DatasetExportJobOutput]
+    #
+    # @!attribute [rw] creation_date_time
+    #   The creation date and time (in Unix time) of the dataset export job.
+    #   @return [Time]
+    #
+    # @!attribute [rw] last_updated_date_time
+    #   The date and time (in Unix time) the status of the dataset export
+    #   job was last updated.
+    #   @return [Time]
+    #
+    # @!attribute [rw] failure_reason
+    #   If a dataset export job fails, provides the reason why.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetExportJob AWS API Documentation
+    #
+    class DatasetExportJob < Struct.new(
+      :job_name,
+      :dataset_export_job_arn,
+      :dataset_arn,
+      :ingestion_mode,
+      :role_arn,
+      :status,
+      :job_output,
+      :creation_date_time,
+      :last_updated_date_time,
+      :failure_reason)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The output configuration parameters of a dataset export job.
+    #
+    # @note When making an API call, you may pass DatasetExportJobOutput
+    #   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/DatasetExportJobOutput AWS API Documentation
+    #
+    class DatasetExportJobOutput < Struct.new(
+      :s3_data_destination)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides a summary of the properties of a dataset export job. For a
+    # complete listing, call the DescribeDatasetExportJob API.
+    #
+    # @!attribute [rw] dataset_export_job_arn
+    #   The Amazon Resource Name (ARN) of the dataset export job.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_name
+    #   The name of the dataset export job.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the dataset export job.
+    #
+    #   A dataset export job can be in one of the following states:
+    #
+    #   * CREATE PENDING &gt; CREATE IN\_PROGRESS &gt; ACTIVE -or- CREATE
+    #     FAILED
+    #
+    #   ^
+    #   @return [String]
+    #
+    # @!attribute [rw] creation_date_time
+    #   The date and time (in Unix time) that the dataset export job was
+    #   created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] last_updated_date_time
+    #   The date and time (in Unix time) that the dataset export job status
+    #   was last updated.
+    #   @return [Time]
+    #
+    # @!attribute [rw] failure_reason
+    #   If a dataset export job fails, the reason behind the failure.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DatasetExportJobSummary AWS API Documentation
+    #
+    class DatasetExportJobSummary < Struct.new(
+      :dataset_export_job_arn,
+      :job_name,
+      :status,
+      :creation_date_time,
+      :last_updated_date_time,
+      :failure_reason)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # A dataset group is a collection of related datasets (Interactions,
     # User, and Item). You create a dataset group by calling
     # CreateDatasetGroup. You then create a dataset and add it to a dataset
@@ -1544,7 +1788,8 @@ module Aws::Personalize
     #   @return [Time]
     #
     # @!attribute [rw] last_updated_date_time
-    #   The date and time (in Unix time) that the dataset was last updated.
+    #   The date and time (in Unix time) that the dataset import job status
+    #   was last updated.
     #   @return [Time]
     #
     # @!attribute [rw] failure_reason
@@ -2025,6 +2270,48 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DescribeDatasetExportJobRequest
+    #   data as a hash:
+    #
+    #       {
+    #         dataset_export_job_arn: "Arn", # required
+    #       }
+    #
+    # @!attribute [rw] dataset_export_job_arn
+    #   The Amazon Resource Name (ARN) of the dataset export job to
+    #   describe.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetExportJobRequest AWS API Documentation
+    #
+    class DescribeDatasetExportJobRequest < Struct.new(
+      :dataset_export_job_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] dataset_export_job
+    #   Information about the dataset export job, including the status.
+    #
+    #   The status is one of the following values:
+    #
+    #   * CREATE PENDING
+    #
+    #   * CREATE IN\_PROGRESS
+    #
+    #   * ACTIVE
+    #
+    #   * CREATE FAILED
+    #   @return [Types::DatasetExportJob]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetExportJobResponse AWS API Documentation
+    #
+    class DescribeDatasetExportJobResponse < Struct.new(
+      :dataset_export_job)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DescribeDatasetGroupRequest
     #   data as a hash:
     #
@@ -2533,17 +2820,9 @@ module Aws::Personalize
     #
     # @!attribute [rw] filter_expression
     #   Specifies the type of item interactions to filter out of
-    #   recommendation results. The filter expression must follow the
-    #   following format:
-    #
-    #   `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
-    #
-    #   Where "EVENT\_TYPE" is the type of event to filter out. For more
-    #   information, see [Using Filters with Amazon Personalize][1].
-    #
-    #
-    #
-    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
+    #   recommendation results. The filter expression must follow specific
+    #   format rules. For information about filter expression structure and
+    #   syntax, see filter-expressions.
     #   @return [String]
     #
     # @!attribute [rw] status
@@ -2646,9 +2925,7 @@ module Aws::Personalize
       include Aws::Structure
     end
 
-    # Describes the properties for hyperparameter optimization (HPO). For
-    # use with the bring-your-own-recipe feature. Do not use for Amazon
-    # Personalize native recipes.
+    # Describes the properties for hyperparameter optimization (HPO).
     #
     # @note When making an API call, you may pass HPOConfig
     #   data as a hash:
@@ -2689,6 +2966,11 @@ module Aws::Personalize
     #
     # @!attribute [rw] hpo_objective
     #   The metric to optimize during HPO.
+    #
+    #   <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective`
+    #   at this time.
+    #
+    #    </note>
     #   @return [Types::HPOObjective]
     #
     # @!attribute [rw] hpo_resource_config
@@ -2711,6 +2993,11 @@ module Aws::Personalize
 
     # The metric to optimize during hyperparameter optimization (HPO).
     #
+    # <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective` at
+    # this time.
+    #
+    #  </note>
+    #
     # @note When making an API call, you may pass HPOObjective
     #   data as a hash:
     #
@@ -2935,7 +3222,7 @@ module Aws::Personalize
     #   @return [Array<Types::BatchInferenceJobSummary>]
     #
     # @!attribute [rw] next_token
-    #   The token to use to retreive the next page of results. The value is
+    #   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]
     #
@@ -2999,6 +3286,57 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListDatasetExportJobsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         dataset_arn: "Arn",
+    #         next_token: "NextToken",
+    #         max_results: 1,
+    #       }
+    #
+    # @!attribute [rw] dataset_arn
+    #   The Amazon Resource Name (ARN) of the dataset to list the dataset
+    #   export jobs for.
+    #   @return [String]
+    #
+    # @!attribute [rw] next_token
+    #   A token returned from the previous call to `ListDatasetExportJobs`
+    #   for getting the next set of dataset export jobs (if they exist).
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of dataset export jobs to return.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetExportJobsRequest AWS API Documentation
+    #
+    class ListDatasetExportJobsRequest < Struct.new(
+      :dataset_arn,
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] dataset_export_jobs
+    #   The list of dataset export jobs.
+    #   @return [Array<Types::DatasetExportJobSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   A token for getting the next set of dataset export jobs (if they
+    #   exist).
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetExportJobsResponse AWS API Documentation
+    #
+    class ListDatasetExportJobsResponse < Struct.new(
+      :dataset_export_jobs,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListDatasetGroupsRequest
     #   data as a hash:
     #
@@ -3633,7 +3971,9 @@ module Aws::Personalize
     #
     # @!attribute [rw] event_type
     #   The event type (for example, 'click' or 'like') that is used for
-    #   training the model.
+    #   training the model. If no `eventType` is provided, Amazon
+    #   Personalize uses all interactions for training with equal weight
+    #   regardless of type.
     #   @return [String]
     #
     # @!attribute [rw] solution_config
@@ -3863,17 +4203,23 @@ module Aws::Personalize
     #   @return [Float]
     #
     # @!attribute [rw] training_mode
-    #   The scope of training used to create the solution version. The
-    #   `FULL` option trains the solution version based on the entirety of
-    #   the input solution's training data, while the `UPDATE` option
-    #   processes only the training data that has changed since the creation
-    #   of the last solution version. Choose `UPDATE` when you want to start
-    #   recommending items added to the dataset without retraining the
-    #   model.
-    #
-    #   The `UPDATE` option can only be used after you've created a
-    #   solution version with the `FULL` option and the training solution
-    #   uses the native-recipe-hrnn-coldstart.
+    #   The scope of training to be performed when creating the solution
+    #   version. The `FULL` option trains the solution version based on the
+    #   entirety of the input solution's training data, while the `UPDATE`
+    #   option processes only the data that has changed in comparison to the
+    #   input solution. Choose `UPDATE` when you want to incrementally
+    #   update your solution version instead of creating an entirely new
+    #   one.
+    #
+    #   The `UPDATE` option can only be used when you already have an active
+    #   solution version created from the input solution using the `FULL`
+    #   option and the input solution was trained with the
+    #   [User-Personalization][1] recipe or the [HRNN-Coldstart][2] recipe.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
+    #   [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
     #   @return [String]
     #
     # @!attribute [rw] tuned_hpo_params