aws-sdk-personalize 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c19c1c9271cb6cabf94b32c458927b8401f5ab163751b150188f37c0c4495dfb
-  data.tar.gz: 988d920bd5b44f11c9b9445aed8d47e5f80f766712ae02262bc9e539e9b2604f
+  metadata.gz: 366385df0d7899098cab3a61939b22572e20453efc9aa039a85807222bdee51a
+  data.tar.gz: e7f5448deecd704482dd8c0357796e50d760bd543d0f7b5ece832fcb0bf38613
 SHA512:
-  metadata.gz: 9e64869d87dfc0ec152e2c3c7f0a0f5c7c769796c80615c39fcd4fdec711a90444eb5398fc84d8f40c1b3ff3df8f23958eeb7fcb02e5d98f226328a4289419ca
-  data.tar.gz: 209667e0405b44a2b9d662eeccd6e37237ef1e13237be8f28ee11fbcdea409364b19821961211085e619e780eaee9480285ea426a397ede7ae1e971f6b25bd21
+  metadata.gz: 97a29b9597b0974b380dedf461724232ec25f93df603ec6c9633dfa6d44edf64bf3bc490c81072b4b5cbc9dbbd295edffcb18a1e3766fbdf2234429465986b80
+  data.tar.gz: dc40a08c959f6599b053a7637e7f3f59e2613db1650d491c5fb0c0749902179f7c3c199d23acef539e19899e325c447c5c73a17072fb8a185525cfe9b987f366

data/lib/aws-sdk-personalize.rb

@@ -45,6 +45,6 @@ require_relative 'aws-sdk-personalize/customizations'
 # @service
 module Aws::Personalize
 
-  GEM_VERSION = '1.12.0'
+  GEM_VERSION = '1.13.0'
 
 end

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

@@ -329,6 +329,11 @@ module Aws::Personalize
     #   The Amazon Resource Name (ARN) of the solution version that will be
     #   used to generate the batch inference recommendations.
     #
+    # @option params [String] :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.
+    #
     # @option params [Integer] :num_results
     #   The number of recommendations to retreive.
     #
@@ -354,6 +359,7 @@ module Aws::Personalize
     #   resp = client.create_batch_inference_job({
     #     job_name: "Name", # required
     #     solution_version_arn: "Arn", # required
+    #     filter_arn: "Arn",
     #     num_results: 1,
     #     job_input: { # required
     #       s3_data_source: { # required
@@ -790,6 +796,52 @@ module Aws::Personalize
       req.send_request(options)
     end
 
+    # Creates a recommendation filter. For more information, see Using
+    # Filters with Amazon Personalize.
+    #
+    # @option params [required, String] :name
+    #   The name of the filter to create.
+    #
+    # @option params [required, String] :dataset_group_arn
+    #   The ARN of the dataset group that the filter will belong to.
+    #
+    # @option params [required, String] :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.
+    #
+    # @return [Types::CreateFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateFilterResponse#filter_arn #filter_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_filter({
+    #     name: "Name", # required
+    #     dataset_group_arn: "Arn", # required
+    #     filter_expression: "FilterExpression", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.filter_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilter AWS API Documentation
+    #
+    # @overload create_filter(params = {})
+    # @param [Hash] params ({})
+    def create_filter(params = {}, options = {})
+      req = build_request(:create_filter, params)
+      req.send_request(options)
+    end
+
     # Creates an Amazon Personalize schema from the specified schema string.
     # The schema you create must be in Avro JSON format.
     #
@@ -1181,6 +1233,28 @@ module Aws::Personalize
       req.send_request(options)
     end
 
+    # Deletes a filter.
+    #
+    # @option params [required, String] :filter_arn
+    #   The ARN of the filter to delete.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_filter({
+    #     filter_arn: "Arn", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteFilter AWS API Documentation
+    #
+    # @overload delete_filter(params = {})
+    # @param [Hash] params ({})
+    def delete_filter(params = {}, options = {})
+      req = build_request(:delete_filter, params)
+      req.send_request(options)
+    end
+
     # Deletes a schema. Before deleting a schema, you must delete all
     # datasets referencing the schema. For more information on schemas, see
     # CreateSchema.
@@ -1308,6 +1382,7 @@ module Aws::Personalize
     #
     #   resp.batch_inference_job.job_name #=> String
     #   resp.batch_inference_job.batch_inference_job_arn #=> String
+    #   resp.batch_inference_job.filter_arn #=> String
     #   resp.batch_inference_job.failure_reason #=> String
     #   resp.batch_inference_job.solution_version_arn #=> String
     #   resp.batch_inference_job.num_results #=> Integer
@@ -1563,6 +1638,41 @@ module Aws::Personalize
       req.send_request(options)
     end
 
+    # Describes a filter's properties.
+    #
+    # @option params [required, String] :filter_arn
+    #   The ARN of the filter to describe.
+    #
+    # @return [Types::DescribeFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeFilterResponse#filter #filter} => Types::Filter
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_filter({
+    #     filter_arn: "Arn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.filter.name #=> String
+    #   resp.filter.filter_arn #=> String
+    #   resp.filter.creation_date_time #=> Time
+    #   resp.filter.last_updated_date_time #=> Time
+    #   resp.filter.dataset_group_arn #=> String
+    #   resp.filter.failure_reason #=> String
+    #   resp.filter.filter_expression #=> String
+    #   resp.filter.status #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFilter AWS API Documentation
+    #
+    # @overload describe_filter(params = {})
+    # @param [Hash] params ({})
+    def describe_filter(params = {}, options = {})
+      req = build_request(:describe_filter, params)
+      req.send_request(options)
+    end
+
     # Describes a recipe.
     #
     # A recipe contains three items:
@@ -2121,6 +2231,52 @@ module Aws::Personalize
       req.send_request(options)
     end
 
+    # Lists all filters that belong to a given dataset group.
+    #
+    # @option params [String] :dataset_group_arn
+    #   The ARN of the dataset group that contains the filters.
+    #
+    # @option params [String] :next_token
+    #   A token returned from the previous call to `ListFilters` for getting
+    #   the next set of filters (if they exist).
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of filters to return.
+    #
+    # @return [Types::ListFiltersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListFiltersResponse#filters #filters} => Array<Types::FilterSummary>
+    #   * {Types::ListFiltersResponse#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_filters({
+    #     dataset_group_arn: "Arn",
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.filters #=> Array
+    #   resp.filters[0].name #=> String
+    #   resp.filters[0].filter_arn #=> String
+    #   resp.filters[0].creation_date_time #=> Time
+    #   resp.filters[0].last_updated_date_time #=> Time
+    #   resp.filters[0].dataset_group_arn #=> String
+    #   resp.filters[0].failure_reason #=> String
+    #   resp.filters[0].status #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListFilters AWS API Documentation
+    #
+    # @overload list_filters(params = {})
+    # @param [Hash] params ({})
+    def list_filters(params = {}, options = {})
+      req = build_request(:list_filters, params)
+      req.send_request(options)
+    end
+
     # Returns a list of available recipes. The response provides the
     # properties for each recipe, including the recipe's Amazon Resource
     # Name (ARN).
@@ -2373,7 +2529,7 @@ module Aws::Personalize
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalize'
-      context[:gem_version] = '1.12.0'
+      context[:gem_version] = '1.13.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -49,6 +49,8 @@ module Aws::Personalize
     CreateDatasetResponse = Shapes::StructureShape.new(name: 'CreateDatasetResponse')
     CreateEventTrackerRequest = Shapes::StructureShape.new(name: 'CreateEventTrackerRequest')
     CreateEventTrackerResponse = Shapes::StructureShape.new(name: 'CreateEventTrackerResponse')
+    CreateFilterRequest = Shapes::StructureShape.new(name: 'CreateFilterRequest')
+    CreateFilterResponse = Shapes::StructureShape.new(name: 'CreateFilterResponse')
     CreateSchemaRequest = Shapes::StructureShape.new(name: 'CreateSchemaRequest')
     CreateSchemaResponse = Shapes::StructureShape.new(name: 'CreateSchemaResponse')
     CreateSolutionRequest = Shapes::StructureShape.new(name: 'CreateSolutionRequest')
@@ -80,6 +82,7 @@ module Aws::Personalize
     DeleteDatasetGroupRequest = Shapes::StructureShape.new(name: 'DeleteDatasetGroupRequest')
     DeleteDatasetRequest = Shapes::StructureShape.new(name: 'DeleteDatasetRequest')
     DeleteEventTrackerRequest = Shapes::StructureShape.new(name: 'DeleteEventTrackerRequest')
+    DeleteFilterRequest = Shapes::StructureShape.new(name: 'DeleteFilterRequest')
     DeleteSchemaRequest = Shapes::StructureShape.new(name: 'DeleteSchemaRequest')
     DeleteSolutionRequest = Shapes::StructureShape.new(name: 'DeleteSolutionRequest')
     DescribeAlgorithmRequest = Shapes::StructureShape.new(name: 'DescribeAlgorithmRequest')
@@ -98,6 +101,8 @@ module Aws::Personalize
     DescribeEventTrackerResponse = Shapes::StructureShape.new(name: 'DescribeEventTrackerResponse')
     DescribeFeatureTransformationRequest = Shapes::StructureShape.new(name: 'DescribeFeatureTransformationRequest')
     DescribeFeatureTransformationResponse = Shapes::StructureShape.new(name: 'DescribeFeatureTransformationResponse')
+    DescribeFilterRequest = Shapes::StructureShape.new(name: 'DescribeFilterRequest')
+    DescribeFilterResponse = Shapes::StructureShape.new(name: 'DescribeFilterResponse')
     DescribeRecipeRequest = Shapes::StructureShape.new(name: 'DescribeRecipeRequest')
     DescribeRecipeResponse = Shapes::StructureShape.new(name: 'DescribeRecipeResponse')
     DescribeSchemaRequest = Shapes::StructureShape.new(name: 'DescribeSchemaRequest')
@@ -118,6 +123,10 @@ module Aws::Personalize
     FeatureTransformation = Shapes::StructureShape.new(name: 'FeatureTransformation')
     FeatureTransformationParameters = Shapes::MapShape.new(name: 'FeatureTransformationParameters')
     FeaturizationParameters = Shapes::MapShape.new(name: 'FeaturizationParameters')
+    Filter = Shapes::StructureShape.new(name: 'Filter')
+    FilterExpression = Shapes::StringShape.new(name: 'FilterExpression')
+    FilterSummary = Shapes::StructureShape.new(name: 'FilterSummary')
+    Filters = Shapes::ListShape.new(name: 'Filters')
     GetSolutionMetricsRequest = Shapes::StructureShape.new(name: 'GetSolutionMetricsRequest')
     GetSolutionMetricsResponse = Shapes::StructureShape.new(name: 'GetSolutionMetricsResponse')
     HPOConfig = Shapes::StructureShape.new(name: 'HPOConfig')
@@ -147,6 +156,8 @@ module Aws::Personalize
     ListDatasetsResponse = Shapes::StructureShape.new(name: 'ListDatasetsResponse')
     ListEventTrackersRequest = Shapes::StructureShape.new(name: 'ListEventTrackersRequest')
     ListEventTrackersResponse = Shapes::StructureShape.new(name: 'ListEventTrackersResponse')
+    ListFiltersRequest = Shapes::StructureShape.new(name: 'ListFiltersRequest')
+    ListFiltersResponse = Shapes::StructureShape.new(name: 'ListFiltersResponse')
     ListRecipesRequest = Shapes::StructureShape.new(name: 'ListRecipesRequest')
     ListRecipesResponse = Shapes::StructureShape.new(name: 'ListRecipesResponse')
     ListSchemasRequest = Shapes::StructureShape.new(name: 'ListSchemasRequest')
@@ -225,6 +236,7 @@ module Aws::Personalize
 
     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(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
     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"))
@@ -299,6 +311,7 @@ module Aws::Personalize
 
     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(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
     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"))
@@ -350,6 +363,14 @@ module Aws::Personalize
     CreateEventTrackerResponse.add_member(:tracking_id, Shapes::ShapeRef.new(shape: TrackingId, location_name: "trackingId"))
     CreateEventTrackerResponse.struct_class = Types::CreateEventTrackerResponse
 
+    CreateFilterRequest.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
+    CreateFilterRequest.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetGroupArn"))
+    CreateFilterRequest.add_member(:filter_expression, Shapes::ShapeRef.new(shape: FilterExpression, required: true, location_name: "filterExpression"))
+    CreateFilterRequest.struct_class = Types::CreateFilterRequest
+
+    CreateFilterResponse.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
+    CreateFilterResponse.struct_class = Types::CreateFilterResponse
+
     CreateSchemaRequest.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
     CreateSchemaRequest.add_member(:schema, Shapes::ShapeRef.new(shape: AvroSchema, required: true, location_name: "schema"))
     CreateSchemaRequest.struct_class = Types::CreateSchemaRequest
@@ -493,6 +514,9 @@ module Aws::Personalize
     DeleteEventTrackerRequest.add_member(:event_tracker_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "eventTrackerArn"))
     DeleteEventTrackerRequest.struct_class = Types::DeleteEventTrackerRequest
 
+    DeleteFilterRequest.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "filterArn"))
+    DeleteFilterRequest.struct_class = Types::DeleteFilterRequest
+
     DeleteSchemaRequest.add_member(:schema_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "schemaArn"))
     DeleteSchemaRequest.struct_class = Types::DeleteSchemaRequest
 
@@ -547,6 +571,12 @@ module Aws::Personalize
     DescribeFeatureTransformationResponse.add_member(:feature_transformation, Shapes::ShapeRef.new(shape: FeatureTransformation, location_name: "featureTransformation"))
     DescribeFeatureTransformationResponse.struct_class = Types::DescribeFeatureTransformationResponse
 
+    DescribeFilterRequest.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "filterArn"))
+    DescribeFilterRequest.struct_class = Types::DescribeFilterRequest
+
+    DescribeFilterResponse.add_member(:filter, Shapes::ShapeRef.new(shape: Filter, location_name: "filter"))
+    DescribeFilterResponse.struct_class = Types::DescribeFilterResponse
+
     DescribeRecipeRequest.add_member(:recipe_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "recipeArn"))
     DescribeRecipeRequest.struct_class = Types::DescribeRecipeRequest
 
@@ -604,6 +634,27 @@ module Aws::Personalize
     FeaturizationParameters.key = Shapes::ShapeRef.new(shape: ParameterName)
     FeaturizationParameters.value = Shapes::ShapeRef.new(shape: ParameterValue)
 
+    Filter.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
+    Filter.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
+    Filter.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
+    Filter.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
+    Filter.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetGroupArn"))
+    Filter.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
+    Filter.add_member(:filter_expression, Shapes::ShapeRef.new(shape: FilterExpression, location_name: "filterExpression"))
+    Filter.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
+    Filter.struct_class = Types::Filter
+
+    FilterSummary.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
+    FilterSummary.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
+    FilterSummary.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
+    FilterSummary.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
+    FilterSummary.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetGroupArn"))
+    FilterSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
+    FilterSummary.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
+    FilterSummary.struct_class = Types::FilterSummary
+
+    Filters.member = Shapes::ShapeRef.new(shape: FilterSummary)
+
     GetSolutionMetricsRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "solutionVersionArn"))
     GetSolutionMetricsRequest.struct_class = Types::GetSolutionMetricsRequest
 
@@ -702,6 +753,15 @@ module Aws::Personalize
     ListEventTrackersResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
     ListEventTrackersResponse.struct_class = Types::ListEventTrackersResponse
 
+    ListFiltersRequest.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetGroupArn"))
+    ListFiltersRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
+    ListFiltersRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
+    ListFiltersRequest.struct_class = Types::ListFiltersRequest
+
+    ListFiltersResponse.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, location_name: "Filters"))
+    ListFiltersResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
+    ListFiltersResponse.struct_class = Types::ListFiltersResponse
+
     ListRecipesRequest.add_member(:recipe_provider, Shapes::ShapeRef.new(shape: RecipeProvider, location_name: "recipeProvider"))
     ListRecipesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
     ListRecipesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
@@ -941,6 +1001,18 @@ module Aws::Personalize
         o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
       end)
 
+      api.add_operation(:create_filter, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "CreateFilter"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: CreateFilterRequest)
+        o.output = Shapes::ShapeRef.new(shape: CreateFilterResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyExistsException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
+      end)
+
       api.add_operation(:create_schema, Seahorse::Model::Operation.new.tap do |o|
         o.name = "CreateSchema"
         o.http_method = "POST"
@@ -1020,6 +1092,16 @@ module Aws::Personalize
         o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
       end)
 
+      api.add_operation(:delete_filter, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DeleteFilter"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: DeleteFilterRequest)
+        o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
+        o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+      end)
+
       api.add_operation(:delete_schema, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DeleteSchema"
         o.http_method = "POST"
@@ -1122,6 +1204,16 @@ module Aws::Personalize
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
       end)
 
+      api.add_operation(:describe_filter, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DescribeFilter"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: DescribeFilterRequest)
+        o.output = Shapes::ShapeRef.new(shape: DescribeFilterResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+      end)
+
       api.add_operation(:describe_recipe, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DescribeRecipe"
         o.http_method = "POST"
@@ -1268,6 +1360,16 @@ module Aws::Personalize
         )
       end)
 
+      api.add_operation(:list_filters, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListFilters"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ListFiltersRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListFiltersResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
+      end)
+
       api.add_operation(:list_recipes, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListRecipes"
         o.http_method = "POST"

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

@@ -142,6 +142,10 @@ module Aws::Personalize
     #   The Amazon Resource Name (ARN) of the batch inference job.
     #   @return [String]
     #
+    # @!attribute [rw] filter_arn
+    #   The ARN of the filter used on the batch inference job.
+    #   @return [String]
+    #
     # @!attribute [rw] failure_reason
     #   If the batch inference job failed, the reason for the failure.
     #   @return [String]
@@ -198,6 +202,7 @@ module Aws::Personalize
     class BatchInferenceJob < Struct.new(
       :job_name,
       :batch_inference_job_arn,
+      :filter_arn,
       :failure_reason,
       :solution_version_arn,
       :num_results,
@@ -537,6 +542,7 @@ module Aws::Personalize
     #       {
     #         job_name: "Name", # required
     #         solution_version_arn: "Arn", # required
+    #         filter_arn: "Arn",
     #         num_results: 1,
     #         job_input: { # required
     #           s3_data_source: { # required
@@ -562,6 +568,12 @@ module Aws::Personalize
     #   used to generate the batch inference recommendations.
     #   @return [String]
     #
+    # @!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.
+    #   @return [String]
+    #
     # @!attribute [rw] num_results
     #   The number of recommendations to retreive.
     #   @return [Integer]
@@ -587,6 +599,7 @@ module Aws::Personalize
     class CreateBatchInferenceJobRequest < Struct.new(
       :job_name,
       :solution_version_arn,
+      :filter_arn,
       :num_results,
       :job_input,
       :job_output,
@@ -844,6 +857,56 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass CreateFilterRequest
+    #   data as a hash:
+    #
+    #       {
+    #         name: "Name", # required
+    #         dataset_group_arn: "Arn", # required
+    #         filter_expression: "FilterExpression", # required
+    #       }
+    #
+    # @!attribute [rw] name
+    #   The name of the filter to create.
+    #   @return [String]
+    #
+    # @!attribute [rw] dataset_group_arn
+    #   The ARN of the dataset group that the filter will belong to.
+    #   @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.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilterRequest AWS API Documentation
+    #
+    class CreateFilterRequest < Struct.new(
+      :name,
+      :dataset_group_arn,
+      :filter_expression)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] filter_arn
+    #   The ARN of the new filter.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilterResponse AWS API Documentation
+    #
+    class CreateFilterResponse < Struct.new(
+      :filter_arn)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass CreateSchemaRequest
     #   data as a hash:
     #
@@ -1670,6 +1733,24 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DeleteFilterRequest
+    #   data as a hash:
+    #
+    #       {
+    #         filter_arn: "Arn", # required
+    #       }
+    #
+    # @!attribute [rw] filter_arn
+    #   The ARN of the filter to delete.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteFilterRequest AWS API Documentation
+    #
+    class DeleteFilterRequest < Struct.new(
+      :filter_arn)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DeleteSchemaRequest
     #   data as a hash:
     #
@@ -1950,6 +2031,35 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DescribeFilterRequest
+    #   data as a hash:
+    #
+    #       {
+    #         filter_arn: "Arn", # required
+    #       }
+    #
+    # @!attribute [rw] filter_arn
+    #   The ARN of the filter to describe.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFilterRequest AWS API Documentation
+    #
+    class DescribeFilterRequest < Struct.new(
+      :filter_arn)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] filter
+    #   The filter's details.
+    #   @return [Types::Filter]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFilterResponse AWS API Documentation
+    #
+    class DescribeFilterResponse < Struct.new(
+      :filter)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DescribeRecipeRequest
     #   data as a hash:
     #
@@ -2220,6 +2330,105 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # Contains information on a recommendation filter, including its ARN,
+    # status, and filter expression.
+    #
+    # @!attribute [rw] name
+    #   The name of the filter.
+    #   @return [String]
+    #
+    # @!attribute [rw] filter_arn
+    #   The ARN of the filter.
+    #   @return [String]
+    #
+    # @!attribute [rw] creation_date_time
+    #   The time at which the filter was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] last_updated_date_time
+    #   The time at which the filter was last updated.
+    #   @return [Time]
+    #
+    # @!attribute [rw] dataset_group_arn
+    #   The ARN of the dataset group to which the filter belongs.
+    #   @return [String]
+    #
+    # @!attribute [rw] failure_reason
+    #   If the filter failed, the reason for its failure.
+    #   @return [String]
+    #
+    # @!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.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the filter.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/Filter AWS API Documentation
+    #
+    class Filter < Struct.new(
+      :name,
+      :filter_arn,
+      :creation_date_time,
+      :last_updated_date_time,
+      :dataset_group_arn,
+      :failure_reason,
+      :filter_expression,
+      :status)
+      include Aws::Structure
+    end
+
+    # A short summary of a filter's attributes.
+    #
+    # @!attribute [rw] name
+    #   The name of the filter.
+    #   @return [String]
+    #
+    # @!attribute [rw] filter_arn
+    #   The ARN of the filter.
+    #   @return [String]
+    #
+    # @!attribute [rw] creation_date_time
+    #   The time at which the filter was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] last_updated_date_time
+    #   The time at which the filter was last updated.
+    #   @return [Time]
+    #
+    # @!attribute [rw] dataset_group_arn
+    #   The ARN of the dataset group to which the filter belongs.
+    #   @return [String]
+    #
+    # @!attribute [rw] failure_reason
+    #   If the filter failed, the reason for the failure.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the filter.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/FilterSummary AWS API Documentation
+    #
+    class FilterSummary < Struct.new(
+      :name,
+      :filter_arn,
+      :creation_date_time,
+      :last_updated_date_time,
+      :dataset_group_arn,
+      :failure_reason,
+      :status)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass GetSolutionMetricsRequest
     #   data as a hash:
     #
@@ -2782,6 +2991,53 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListFiltersRequest
+    #   data as a hash:
+    #
+    #       {
+    #         dataset_group_arn: "Arn",
+    #         next_token: "NextToken",
+    #         max_results: 1,
+    #       }
+    #
+    # @!attribute [rw] dataset_group_arn
+    #   The ARN of the dataset group that contains the filters.
+    #   @return [String]
+    #
+    # @!attribute [rw] next_token
+    #   A token returned from the previous call to `ListFilters` for getting
+    #   the next set of filters (if they exist).
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of filters to return.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListFiltersRequest AWS API Documentation
+    #
+    class ListFiltersRequest < Struct.new(
+      :dataset_group_arn,
+      :next_token,
+      :max_results)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] filters
+    #   A list of returned filters.
+    #   @return [Array<Types::FilterSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   A token for getting the next set of filters (if they exist).
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListFiltersResponse AWS API Documentation
+    #
+    class ListFiltersResponse < Struct.new(
+      :filters,
+      :next_token)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListRecipesRequest
     #   data as a hash:
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalize
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core