aws-sdk-personalize 1.12.0 → 1.13.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c19c1c9271cb6cabf94b32c458927b8401f5ab163751b150188f37c0c4495dfb
4
- data.tar.gz: 988d920bd5b44f11c9b9445aed8d47e5f80f766712ae02262bc9e539e9b2604f
3
+ metadata.gz: 366385df0d7899098cab3a61939b22572e20453efc9aa039a85807222bdee51a
4
+ data.tar.gz: e7f5448deecd704482dd8c0357796e50d760bd543d0f7b5ece832fcb0bf38613
5
5
  SHA512:
6
- metadata.gz: 9e64869d87dfc0ec152e2c3c7f0a0f5c7c769796c80615c39fcd4fdec711a90444eb5398fc84d8f40c1b3ff3df8f23958eeb7fcb02e5d98f226328a4289419ca
7
- data.tar.gz: 209667e0405b44a2b9d662eeccd6e37237ef1e13237be8f28ee11fbcdea409364b19821961211085e619e780eaee9480285ea426a397ede7ae1e971f6b25bd21
6
+ metadata.gz: 97a29b9597b0974b380dedf461724232ec25f93df603ec6c9633dfa6d44edf64bf3bc490c81072b4b5cbc9dbbd295edffcb18a1e3766fbdf2234429465986b80
7
+ data.tar.gz: dc40a08c959f6599b053a7637e7f3f59e2613db1650d491c5fb0c0749902179f7c3c199d23acef539e19899e325c447c5c73a17072fb8a185525cfe9b987f366
@@ -45,6 +45,6 @@ require_relative 'aws-sdk-personalize/customizations'
45
45
  # @service
46
46
  module Aws::Personalize
47
47
 
48
- GEM_VERSION = '1.12.0'
48
+ GEM_VERSION = '1.13.0'
49
49
 
50
50
  end
@@ -329,6 +329,11 @@ module Aws::Personalize
329
329
  # The Amazon Resource Name (ARN) of the solution version that will be
330
330
  # used to generate the batch inference recommendations.
331
331
  #
332
+ # @option params [String] :filter_arn
333
+ # The ARN of the filter to apply to the batch inference job. For more
334
+ # information on using filters, see Using Filters with Amazon
335
+ # Personalize.
336
+ #
332
337
  # @option params [Integer] :num_results
333
338
  # The number of recommendations to retreive.
334
339
  #
@@ -354,6 +359,7 @@ module Aws::Personalize
354
359
  # resp = client.create_batch_inference_job({
355
360
  # job_name: "Name", # required
356
361
  # solution_version_arn: "Arn", # required
362
+ # filter_arn: "Arn",
357
363
  # num_results: 1,
358
364
  # job_input: { # required
359
365
  # s3_data_source: { # required
@@ -790,6 +796,52 @@ module Aws::Personalize
790
796
  req.send_request(options)
791
797
  end
792
798
 
799
+ # Creates a recommendation filter. For more information, see Using
800
+ # Filters with Amazon Personalize.
801
+ #
802
+ # @option params [required, String] :name
803
+ # The name of the filter to create.
804
+ #
805
+ # @option params [required, String] :dataset_group_arn
806
+ # The ARN of the dataset group that the filter will belong to.
807
+ #
808
+ # @option params [required, String] :filter_expression
809
+ # The filter expression that designates the interaction types that the
810
+ # filter will filter out. A filter expression must follow the following
811
+ # format:
812
+ #
813
+ # `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
814
+ #
815
+ # Where "EVENT\_TYPE" is the type of event to filter out. To filter
816
+ # out all items with any interactions history, set `"*"` as the
817
+ # EVENT\_TYPE. For more information, see Using Filters with Amazon
818
+ # Personalize.
819
+ #
820
+ # @return [Types::CreateFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
821
+ #
822
+ # * {Types::CreateFilterResponse#filter_arn #filter_arn} => String
823
+ #
824
+ # @example Request syntax with placeholder values
825
+ #
826
+ # resp = client.create_filter({
827
+ # name: "Name", # required
828
+ # dataset_group_arn: "Arn", # required
829
+ # filter_expression: "FilterExpression", # required
830
+ # })
831
+ #
832
+ # @example Response structure
833
+ #
834
+ # resp.filter_arn #=> String
835
+ #
836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilter AWS API Documentation
837
+ #
838
+ # @overload create_filter(params = {})
839
+ # @param [Hash] params ({})
840
+ def create_filter(params = {}, options = {})
841
+ req = build_request(:create_filter, params)
842
+ req.send_request(options)
843
+ end
844
+
793
845
  # Creates an Amazon Personalize schema from the specified schema string.
794
846
  # The schema you create must be in Avro JSON format.
795
847
  #
@@ -1181,6 +1233,28 @@ module Aws::Personalize
1181
1233
  req.send_request(options)
1182
1234
  end
1183
1235
 
1236
+ # Deletes a filter.
1237
+ #
1238
+ # @option params [required, String] :filter_arn
1239
+ # The ARN of the filter to delete.
1240
+ #
1241
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1242
+ #
1243
+ # @example Request syntax with placeholder values
1244
+ #
1245
+ # resp = client.delete_filter({
1246
+ # filter_arn: "Arn", # required
1247
+ # })
1248
+ #
1249
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteFilter AWS API Documentation
1250
+ #
1251
+ # @overload delete_filter(params = {})
1252
+ # @param [Hash] params ({})
1253
+ def delete_filter(params = {}, options = {})
1254
+ req = build_request(:delete_filter, params)
1255
+ req.send_request(options)
1256
+ end
1257
+
1184
1258
  # Deletes a schema. Before deleting a schema, you must delete all
1185
1259
  # datasets referencing the schema. For more information on schemas, see
1186
1260
  # CreateSchema.
@@ -1308,6 +1382,7 @@ module Aws::Personalize
1308
1382
  #
1309
1383
  # resp.batch_inference_job.job_name #=> String
1310
1384
  # resp.batch_inference_job.batch_inference_job_arn #=> String
1385
+ # resp.batch_inference_job.filter_arn #=> String
1311
1386
  # resp.batch_inference_job.failure_reason #=> String
1312
1387
  # resp.batch_inference_job.solution_version_arn #=> String
1313
1388
  # resp.batch_inference_job.num_results #=> Integer
@@ -1563,6 +1638,41 @@ module Aws::Personalize
1563
1638
  req.send_request(options)
1564
1639
  end
1565
1640
 
1641
+ # Describes a filter's properties.
1642
+ #
1643
+ # @option params [required, String] :filter_arn
1644
+ # The ARN of the filter to describe.
1645
+ #
1646
+ # @return [Types::DescribeFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1647
+ #
1648
+ # * {Types::DescribeFilterResponse#filter #filter} => Types::Filter
1649
+ #
1650
+ # @example Request syntax with placeholder values
1651
+ #
1652
+ # resp = client.describe_filter({
1653
+ # filter_arn: "Arn", # required
1654
+ # })
1655
+ #
1656
+ # @example Response structure
1657
+ #
1658
+ # resp.filter.name #=> String
1659
+ # resp.filter.filter_arn #=> String
1660
+ # resp.filter.creation_date_time #=> Time
1661
+ # resp.filter.last_updated_date_time #=> Time
1662
+ # resp.filter.dataset_group_arn #=> String
1663
+ # resp.filter.failure_reason #=> String
1664
+ # resp.filter.filter_expression #=> String
1665
+ # resp.filter.status #=> String
1666
+ #
1667
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFilter AWS API Documentation
1668
+ #
1669
+ # @overload describe_filter(params = {})
1670
+ # @param [Hash] params ({})
1671
+ def describe_filter(params = {}, options = {})
1672
+ req = build_request(:describe_filter, params)
1673
+ req.send_request(options)
1674
+ end
1675
+
1566
1676
  # Describes a recipe.
1567
1677
  #
1568
1678
  # A recipe contains three items:
@@ -2121,6 +2231,52 @@ module Aws::Personalize
2121
2231
  req.send_request(options)
2122
2232
  end
2123
2233
 
2234
+ # Lists all filters that belong to a given dataset group.
2235
+ #
2236
+ # @option params [String] :dataset_group_arn
2237
+ # The ARN of the dataset group that contains the filters.
2238
+ #
2239
+ # @option params [String] :next_token
2240
+ # A token returned from the previous call to `ListFilters` for getting
2241
+ # the next set of filters (if they exist).
2242
+ #
2243
+ # @option params [Integer] :max_results
2244
+ # The maximum number of filters to return.
2245
+ #
2246
+ # @return [Types::ListFiltersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2247
+ #
2248
+ # * {Types::ListFiltersResponse#filters #filters} => Array<Types::FilterSummary>
2249
+ # * {Types::ListFiltersResponse#next_token #next_token} => String
2250
+ #
2251
+ # @example Request syntax with placeholder values
2252
+ #
2253
+ # resp = client.list_filters({
2254
+ # dataset_group_arn: "Arn",
2255
+ # next_token: "NextToken",
2256
+ # max_results: 1,
2257
+ # })
2258
+ #
2259
+ # @example Response structure
2260
+ #
2261
+ # resp.filters #=> Array
2262
+ # resp.filters[0].name #=> String
2263
+ # resp.filters[0].filter_arn #=> String
2264
+ # resp.filters[0].creation_date_time #=> Time
2265
+ # resp.filters[0].last_updated_date_time #=> Time
2266
+ # resp.filters[0].dataset_group_arn #=> String
2267
+ # resp.filters[0].failure_reason #=> String
2268
+ # resp.filters[0].status #=> String
2269
+ # resp.next_token #=> String
2270
+ #
2271
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListFilters AWS API Documentation
2272
+ #
2273
+ # @overload list_filters(params = {})
2274
+ # @param [Hash] params ({})
2275
+ def list_filters(params = {}, options = {})
2276
+ req = build_request(:list_filters, params)
2277
+ req.send_request(options)
2278
+ end
2279
+
2124
2280
  # Returns a list of available recipes. The response provides the
2125
2281
  # properties for each recipe, including the recipe's Amazon Resource
2126
2282
  # Name (ARN).
@@ -2373,7 +2529,7 @@ module Aws::Personalize
2373
2529
  params: params,
2374
2530
  config: config)
2375
2531
  context[:gem_name] = 'aws-sdk-personalize'
2376
- context[:gem_version] = '1.12.0'
2532
+ context[:gem_version] = '1.13.0'
2377
2533
  Seahorse::Client::Request.new(handlers, context)
2378
2534
  end
2379
2535
 
@@ -49,6 +49,8 @@ module Aws::Personalize
49
49
  CreateDatasetResponse = Shapes::StructureShape.new(name: 'CreateDatasetResponse')
50
50
  CreateEventTrackerRequest = Shapes::StructureShape.new(name: 'CreateEventTrackerRequest')
51
51
  CreateEventTrackerResponse = Shapes::StructureShape.new(name: 'CreateEventTrackerResponse')
52
+ CreateFilterRequest = Shapes::StructureShape.new(name: 'CreateFilterRequest')
53
+ CreateFilterResponse = Shapes::StructureShape.new(name: 'CreateFilterResponse')
52
54
  CreateSchemaRequest = Shapes::StructureShape.new(name: 'CreateSchemaRequest')
53
55
  CreateSchemaResponse = Shapes::StructureShape.new(name: 'CreateSchemaResponse')
54
56
  CreateSolutionRequest = Shapes::StructureShape.new(name: 'CreateSolutionRequest')
@@ -80,6 +82,7 @@ module Aws::Personalize
80
82
  DeleteDatasetGroupRequest = Shapes::StructureShape.new(name: 'DeleteDatasetGroupRequest')
81
83
  DeleteDatasetRequest = Shapes::StructureShape.new(name: 'DeleteDatasetRequest')
82
84
  DeleteEventTrackerRequest = Shapes::StructureShape.new(name: 'DeleteEventTrackerRequest')
85
+ DeleteFilterRequest = Shapes::StructureShape.new(name: 'DeleteFilterRequest')
83
86
  DeleteSchemaRequest = Shapes::StructureShape.new(name: 'DeleteSchemaRequest')
84
87
  DeleteSolutionRequest = Shapes::StructureShape.new(name: 'DeleteSolutionRequest')
85
88
  DescribeAlgorithmRequest = Shapes::StructureShape.new(name: 'DescribeAlgorithmRequest')
@@ -98,6 +101,8 @@ module Aws::Personalize
98
101
  DescribeEventTrackerResponse = Shapes::StructureShape.new(name: 'DescribeEventTrackerResponse')
99
102
  DescribeFeatureTransformationRequest = Shapes::StructureShape.new(name: 'DescribeFeatureTransformationRequest')
100
103
  DescribeFeatureTransformationResponse = Shapes::StructureShape.new(name: 'DescribeFeatureTransformationResponse')
104
+ DescribeFilterRequest = Shapes::StructureShape.new(name: 'DescribeFilterRequest')
105
+ DescribeFilterResponse = Shapes::StructureShape.new(name: 'DescribeFilterResponse')
101
106
  DescribeRecipeRequest = Shapes::StructureShape.new(name: 'DescribeRecipeRequest')
102
107
  DescribeRecipeResponse = Shapes::StructureShape.new(name: 'DescribeRecipeResponse')
103
108
  DescribeSchemaRequest = Shapes::StructureShape.new(name: 'DescribeSchemaRequest')
@@ -118,6 +123,10 @@ module Aws::Personalize
118
123
  FeatureTransformation = Shapes::StructureShape.new(name: 'FeatureTransformation')
119
124
  FeatureTransformationParameters = Shapes::MapShape.new(name: 'FeatureTransformationParameters')
120
125
  FeaturizationParameters = Shapes::MapShape.new(name: 'FeaturizationParameters')
126
+ Filter = Shapes::StructureShape.new(name: 'Filter')
127
+ FilterExpression = Shapes::StringShape.new(name: 'FilterExpression')
128
+ FilterSummary = Shapes::StructureShape.new(name: 'FilterSummary')
129
+ Filters = Shapes::ListShape.new(name: 'Filters')
121
130
  GetSolutionMetricsRequest = Shapes::StructureShape.new(name: 'GetSolutionMetricsRequest')
122
131
  GetSolutionMetricsResponse = Shapes::StructureShape.new(name: 'GetSolutionMetricsResponse')
123
132
  HPOConfig = Shapes::StructureShape.new(name: 'HPOConfig')
@@ -147,6 +156,8 @@ module Aws::Personalize
147
156
  ListDatasetsResponse = Shapes::StructureShape.new(name: 'ListDatasetsResponse')
148
157
  ListEventTrackersRequest = Shapes::StructureShape.new(name: 'ListEventTrackersRequest')
149
158
  ListEventTrackersResponse = Shapes::StructureShape.new(name: 'ListEventTrackersResponse')
159
+ ListFiltersRequest = Shapes::StructureShape.new(name: 'ListFiltersRequest')
160
+ ListFiltersResponse = Shapes::StructureShape.new(name: 'ListFiltersResponse')
150
161
  ListRecipesRequest = Shapes::StructureShape.new(name: 'ListRecipesRequest')
151
162
  ListRecipesResponse = Shapes::StructureShape.new(name: 'ListRecipesResponse')
152
163
  ListSchemasRequest = Shapes::StructureShape.new(name: 'ListSchemasRequest')
@@ -225,6 +236,7 @@ module Aws::Personalize
225
236
 
226
237
  BatchInferenceJob.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, location_name: "jobName"))
227
238
  BatchInferenceJob.add_member(:batch_inference_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "batchInferenceJobArn"))
239
+ BatchInferenceJob.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
228
240
  BatchInferenceJob.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
229
241
  BatchInferenceJob.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
230
242
  BatchInferenceJob.add_member(:num_results, Shapes::ShapeRef.new(shape: NumBatchResults, location_name: "numResults"))
@@ -299,6 +311,7 @@ module Aws::Personalize
299
311
 
300
312
  CreateBatchInferenceJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "jobName"))
301
313
  CreateBatchInferenceJobRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "solutionVersionArn"))
314
+ CreateBatchInferenceJobRequest.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
302
315
  CreateBatchInferenceJobRequest.add_member(:num_results, Shapes::ShapeRef.new(shape: NumBatchResults, location_name: "numResults"))
303
316
  CreateBatchInferenceJobRequest.add_member(:job_input, Shapes::ShapeRef.new(shape: BatchInferenceJobInput, required: true, location_name: "jobInput"))
304
317
  CreateBatchInferenceJobRequest.add_member(:job_output, Shapes::ShapeRef.new(shape: BatchInferenceJobOutput, required: true, location_name: "jobOutput"))
@@ -350,6 +363,14 @@ module Aws::Personalize
350
363
  CreateEventTrackerResponse.add_member(:tracking_id, Shapes::ShapeRef.new(shape: TrackingId, location_name: "trackingId"))
351
364
  CreateEventTrackerResponse.struct_class = Types::CreateEventTrackerResponse
352
365
 
366
+ CreateFilterRequest.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
367
+ CreateFilterRequest.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetGroupArn"))
368
+ CreateFilterRequest.add_member(:filter_expression, Shapes::ShapeRef.new(shape: FilterExpression, required: true, location_name: "filterExpression"))
369
+ CreateFilterRequest.struct_class = Types::CreateFilterRequest
370
+
371
+ CreateFilterResponse.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
372
+ CreateFilterResponse.struct_class = Types::CreateFilterResponse
373
+
353
374
  CreateSchemaRequest.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
354
375
  CreateSchemaRequest.add_member(:schema, Shapes::ShapeRef.new(shape: AvroSchema, required: true, location_name: "schema"))
355
376
  CreateSchemaRequest.struct_class = Types::CreateSchemaRequest
@@ -493,6 +514,9 @@ module Aws::Personalize
493
514
  DeleteEventTrackerRequest.add_member(:event_tracker_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "eventTrackerArn"))
494
515
  DeleteEventTrackerRequest.struct_class = Types::DeleteEventTrackerRequest
495
516
 
517
+ DeleteFilterRequest.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "filterArn"))
518
+ DeleteFilterRequest.struct_class = Types::DeleteFilterRequest
519
+
496
520
  DeleteSchemaRequest.add_member(:schema_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "schemaArn"))
497
521
  DeleteSchemaRequest.struct_class = Types::DeleteSchemaRequest
498
522
 
@@ -547,6 +571,12 @@ module Aws::Personalize
547
571
  DescribeFeatureTransformationResponse.add_member(:feature_transformation, Shapes::ShapeRef.new(shape: FeatureTransformation, location_name: "featureTransformation"))
548
572
  DescribeFeatureTransformationResponse.struct_class = Types::DescribeFeatureTransformationResponse
549
573
 
574
+ DescribeFilterRequest.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "filterArn"))
575
+ DescribeFilterRequest.struct_class = Types::DescribeFilterRequest
576
+
577
+ DescribeFilterResponse.add_member(:filter, Shapes::ShapeRef.new(shape: Filter, location_name: "filter"))
578
+ DescribeFilterResponse.struct_class = Types::DescribeFilterResponse
579
+
550
580
  DescribeRecipeRequest.add_member(:recipe_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "recipeArn"))
551
581
  DescribeRecipeRequest.struct_class = Types::DescribeRecipeRequest
552
582
 
@@ -604,6 +634,27 @@ module Aws::Personalize
604
634
  FeaturizationParameters.key = Shapes::ShapeRef.new(shape: ParameterName)
605
635
  FeaturizationParameters.value = Shapes::ShapeRef.new(shape: ParameterValue)
606
636
 
637
+ Filter.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
638
+ Filter.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
639
+ Filter.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
640
+ Filter.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
641
+ Filter.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetGroupArn"))
642
+ Filter.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
643
+ Filter.add_member(:filter_expression, Shapes::ShapeRef.new(shape: FilterExpression, location_name: "filterExpression"))
644
+ Filter.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
645
+ Filter.struct_class = Types::Filter
646
+
647
+ FilterSummary.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
648
+ FilterSummary.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
649
+ FilterSummary.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
650
+ FilterSummary.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
651
+ FilterSummary.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetGroupArn"))
652
+ FilterSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
653
+ FilterSummary.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
654
+ FilterSummary.struct_class = Types::FilterSummary
655
+
656
+ Filters.member = Shapes::ShapeRef.new(shape: FilterSummary)
657
+
607
658
  GetSolutionMetricsRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "solutionVersionArn"))
608
659
  GetSolutionMetricsRequest.struct_class = Types::GetSolutionMetricsRequest
609
660
 
@@ -702,6 +753,15 @@ module Aws::Personalize
702
753
  ListEventTrackersResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
703
754
  ListEventTrackersResponse.struct_class = Types::ListEventTrackersResponse
704
755
 
756
+ ListFiltersRequest.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetGroupArn"))
757
+ ListFiltersRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
758
+ ListFiltersRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
759
+ ListFiltersRequest.struct_class = Types::ListFiltersRequest
760
+
761
+ ListFiltersResponse.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, location_name: "Filters"))
762
+ ListFiltersResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
763
+ ListFiltersResponse.struct_class = Types::ListFiltersResponse
764
+
705
765
  ListRecipesRequest.add_member(:recipe_provider, Shapes::ShapeRef.new(shape: RecipeProvider, location_name: "recipeProvider"))
706
766
  ListRecipesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
707
767
  ListRecipesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
@@ -941,6 +1001,18 @@ module Aws::Personalize
941
1001
  o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
942
1002
  end)
943
1003
 
1004
+ api.add_operation(:create_filter, Seahorse::Model::Operation.new.tap do |o|
1005
+ o.name = "CreateFilter"
1006
+ o.http_method = "POST"
1007
+ o.http_request_uri = "/"
1008
+ o.input = Shapes::ShapeRef.new(shape: CreateFilterRequest)
1009
+ o.output = Shapes::ShapeRef.new(shape: CreateFilterResponse)
1010
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1011
+ o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyExistsException)
1012
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1013
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
1014
+ end)
1015
+
944
1016
  api.add_operation(:create_schema, Seahorse::Model::Operation.new.tap do |o|
945
1017
  o.name = "CreateSchema"
946
1018
  o.http_method = "POST"
@@ -1020,6 +1092,16 @@ module Aws::Personalize
1020
1092
  o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
1021
1093
  end)
1022
1094
 
1095
+ api.add_operation(:delete_filter, Seahorse::Model::Operation.new.tap do |o|
1096
+ o.name = "DeleteFilter"
1097
+ o.http_method = "POST"
1098
+ o.http_request_uri = "/"
1099
+ o.input = Shapes::ShapeRef.new(shape: DeleteFilterRequest)
1100
+ o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
1101
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1102
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1103
+ end)
1104
+
1023
1105
  api.add_operation(:delete_schema, Seahorse::Model::Operation.new.tap do |o|
1024
1106
  o.name = "DeleteSchema"
1025
1107
  o.http_method = "POST"
@@ -1122,6 +1204,16 @@ module Aws::Personalize
1122
1204
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1123
1205
  end)
1124
1206
 
1207
+ api.add_operation(:describe_filter, Seahorse::Model::Operation.new.tap do |o|
1208
+ o.name = "DescribeFilter"
1209
+ o.http_method = "POST"
1210
+ o.http_request_uri = "/"
1211
+ o.input = Shapes::ShapeRef.new(shape: DescribeFilterRequest)
1212
+ o.output = Shapes::ShapeRef.new(shape: DescribeFilterResponse)
1213
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1214
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1215
+ end)
1216
+
1125
1217
  api.add_operation(:describe_recipe, Seahorse::Model::Operation.new.tap do |o|
1126
1218
  o.name = "DescribeRecipe"
1127
1219
  o.http_method = "POST"
@@ -1268,6 +1360,16 @@ module Aws::Personalize
1268
1360
  )
1269
1361
  end)
1270
1362
 
1363
+ api.add_operation(:list_filters, Seahorse::Model::Operation.new.tap do |o|
1364
+ o.name = "ListFilters"
1365
+ o.http_method = "POST"
1366
+ o.http_request_uri = "/"
1367
+ o.input = Shapes::ShapeRef.new(shape: ListFiltersRequest)
1368
+ o.output = Shapes::ShapeRef.new(shape: ListFiltersResponse)
1369
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
1370
+ o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
1371
+ end)
1372
+
1271
1373
  api.add_operation(:list_recipes, Seahorse::Model::Operation.new.tap do |o|
1272
1374
  o.name = "ListRecipes"
1273
1375
  o.http_method = "POST"
@@ -142,6 +142,10 @@ module Aws::Personalize
142
142
  # The Amazon Resource Name (ARN) of the batch inference job.
143
143
  # @return [String]
144
144
  #
145
+ # @!attribute [rw] filter_arn
146
+ # The ARN of the filter used on the batch inference job.
147
+ # @return [String]
148
+ #
145
149
  # @!attribute [rw] failure_reason
146
150
  # If the batch inference job failed, the reason for the failure.
147
151
  # @return [String]
@@ -198,6 +202,7 @@ module Aws::Personalize
198
202
  class BatchInferenceJob < Struct.new(
199
203
  :job_name,
200
204
  :batch_inference_job_arn,
205
+ :filter_arn,
201
206
  :failure_reason,
202
207
  :solution_version_arn,
203
208
  :num_results,
@@ -537,6 +542,7 @@ module Aws::Personalize
537
542
  # {
538
543
  # job_name: "Name", # required
539
544
  # solution_version_arn: "Arn", # required
545
+ # filter_arn: "Arn",
540
546
  # num_results: 1,
541
547
  # job_input: { # required
542
548
  # s3_data_source: { # required
@@ -562,6 +568,12 @@ module Aws::Personalize
562
568
  # used to generate the batch inference recommendations.
563
569
  # @return [String]
564
570
  #
571
+ # @!attribute [rw] filter_arn
572
+ # The ARN of the filter to apply to the batch inference job. For more
573
+ # information on using filters, see Using Filters with Amazon
574
+ # Personalize.
575
+ # @return [String]
576
+ #
565
577
  # @!attribute [rw] num_results
566
578
  # The number of recommendations to retreive.
567
579
  # @return [Integer]
@@ -587,6 +599,7 @@ module Aws::Personalize
587
599
  class CreateBatchInferenceJobRequest < Struct.new(
588
600
  :job_name,
589
601
  :solution_version_arn,
602
+ :filter_arn,
590
603
  :num_results,
591
604
  :job_input,
592
605
  :job_output,
@@ -844,6 +857,56 @@ module Aws::Personalize
844
857
  include Aws::Structure
845
858
  end
846
859
 
860
+ # @note When making an API call, you may pass CreateFilterRequest
861
+ # data as a hash:
862
+ #
863
+ # {
864
+ # name: "Name", # required
865
+ # dataset_group_arn: "Arn", # required
866
+ # filter_expression: "FilterExpression", # required
867
+ # }
868
+ #
869
+ # @!attribute [rw] name
870
+ # The name of the filter to create.
871
+ # @return [String]
872
+ #
873
+ # @!attribute [rw] dataset_group_arn
874
+ # The ARN of the dataset group that the filter will belong to.
875
+ # @return [String]
876
+ #
877
+ # @!attribute [rw] filter_expression
878
+ # The filter expression that designates the interaction types that the
879
+ # filter will filter out. A filter expression must follow the
880
+ # following format:
881
+ #
882
+ # `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
883
+ #
884
+ # Where "EVENT\_TYPE" is the type of event to filter out. To filter
885
+ # out all items with any interactions history, set `"*"` as the
886
+ # EVENT\_TYPE. For more information, see Using Filters with Amazon
887
+ # Personalize.
888
+ # @return [String]
889
+ #
890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilterRequest AWS API Documentation
891
+ #
892
+ class CreateFilterRequest < Struct.new(
893
+ :name,
894
+ :dataset_group_arn,
895
+ :filter_expression)
896
+ include Aws::Structure
897
+ end
898
+
899
+ # @!attribute [rw] filter_arn
900
+ # The ARN of the new filter.
901
+ # @return [String]
902
+ #
903
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilterResponse AWS API Documentation
904
+ #
905
+ class CreateFilterResponse < Struct.new(
906
+ :filter_arn)
907
+ include Aws::Structure
908
+ end
909
+
847
910
  # @note When making an API call, you may pass CreateSchemaRequest
848
911
  # data as a hash:
849
912
  #
@@ -1670,6 +1733,24 @@ module Aws::Personalize
1670
1733
  include Aws::Structure
1671
1734
  end
1672
1735
 
1736
+ # @note When making an API call, you may pass DeleteFilterRequest
1737
+ # data as a hash:
1738
+ #
1739
+ # {
1740
+ # filter_arn: "Arn", # required
1741
+ # }
1742
+ #
1743
+ # @!attribute [rw] filter_arn
1744
+ # The ARN of the filter to delete.
1745
+ # @return [String]
1746
+ #
1747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteFilterRequest AWS API Documentation
1748
+ #
1749
+ class DeleteFilterRequest < Struct.new(
1750
+ :filter_arn)
1751
+ include Aws::Structure
1752
+ end
1753
+
1673
1754
  # @note When making an API call, you may pass DeleteSchemaRequest
1674
1755
  # data as a hash:
1675
1756
  #
@@ -1950,6 +2031,35 @@ module Aws::Personalize
1950
2031
  include Aws::Structure
1951
2032
  end
1952
2033
 
2034
+ # @note When making an API call, you may pass DescribeFilterRequest
2035
+ # data as a hash:
2036
+ #
2037
+ # {
2038
+ # filter_arn: "Arn", # required
2039
+ # }
2040
+ #
2041
+ # @!attribute [rw] filter_arn
2042
+ # The ARN of the filter to describe.
2043
+ # @return [String]
2044
+ #
2045
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFilterRequest AWS API Documentation
2046
+ #
2047
+ class DescribeFilterRequest < Struct.new(
2048
+ :filter_arn)
2049
+ include Aws::Structure
2050
+ end
2051
+
2052
+ # @!attribute [rw] filter
2053
+ # The filter's details.
2054
+ # @return [Types::Filter]
2055
+ #
2056
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFilterResponse AWS API Documentation
2057
+ #
2058
+ class DescribeFilterResponse < Struct.new(
2059
+ :filter)
2060
+ include Aws::Structure
2061
+ end
2062
+
1953
2063
  # @note When making an API call, you may pass DescribeRecipeRequest
1954
2064
  # data as a hash:
1955
2065
  #
@@ -2220,6 +2330,105 @@ module Aws::Personalize
2220
2330
  include Aws::Structure
2221
2331
  end
2222
2332
 
2333
+ # Contains information on a recommendation filter, including its ARN,
2334
+ # status, and filter expression.
2335
+ #
2336
+ # @!attribute [rw] name
2337
+ # The name of the filter.
2338
+ # @return [String]
2339
+ #
2340
+ # @!attribute [rw] filter_arn
2341
+ # The ARN of the filter.
2342
+ # @return [String]
2343
+ #
2344
+ # @!attribute [rw] creation_date_time
2345
+ # The time at which the filter was created.
2346
+ # @return [Time]
2347
+ #
2348
+ # @!attribute [rw] last_updated_date_time
2349
+ # The time at which the filter was last updated.
2350
+ # @return [Time]
2351
+ #
2352
+ # @!attribute [rw] dataset_group_arn
2353
+ # The ARN of the dataset group to which the filter belongs.
2354
+ # @return [String]
2355
+ #
2356
+ # @!attribute [rw] failure_reason
2357
+ # If the filter failed, the reason for its failure.
2358
+ # @return [String]
2359
+ #
2360
+ # @!attribute [rw] filter_expression
2361
+ # Specifies the type of item interactions to filter out of
2362
+ # recommendation results. The filter expression must follow the
2363
+ # following format:
2364
+ #
2365
+ # `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
2366
+ #
2367
+ # Where "EVENT\_TYPE" is the type of event to filter out. For more
2368
+ # information, see Using Filters with Amazon Personalize.
2369
+ # @return [String]
2370
+ #
2371
+ # @!attribute [rw] status
2372
+ # The status of the filter.
2373
+ # @return [String]
2374
+ #
2375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/Filter AWS API Documentation
2376
+ #
2377
+ class Filter < Struct.new(
2378
+ :name,
2379
+ :filter_arn,
2380
+ :creation_date_time,
2381
+ :last_updated_date_time,
2382
+ :dataset_group_arn,
2383
+ :failure_reason,
2384
+ :filter_expression,
2385
+ :status)
2386
+ include Aws::Structure
2387
+ end
2388
+
2389
+ # A short summary of a filter's attributes.
2390
+ #
2391
+ # @!attribute [rw] name
2392
+ # The name of the filter.
2393
+ # @return [String]
2394
+ #
2395
+ # @!attribute [rw] filter_arn
2396
+ # The ARN of the filter.
2397
+ # @return [String]
2398
+ #
2399
+ # @!attribute [rw] creation_date_time
2400
+ # The time at which the filter was created.
2401
+ # @return [Time]
2402
+ #
2403
+ # @!attribute [rw] last_updated_date_time
2404
+ # The time at which the filter was last updated.
2405
+ # @return [Time]
2406
+ #
2407
+ # @!attribute [rw] dataset_group_arn
2408
+ # The ARN of the dataset group to which the filter belongs.
2409
+ # @return [String]
2410
+ #
2411
+ # @!attribute [rw] failure_reason
2412
+ # If the filter failed, the reason for the failure.
2413
+ # @return [String]
2414
+ #
2415
+ # @!attribute [rw] status
2416
+ # The status of the filter.
2417
+ # @return [String]
2418
+ #
2419
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/FilterSummary AWS API Documentation
2420
+ #
2421
+ class FilterSummary < Struct.new(
2422
+ :name,
2423
+ :filter_arn,
2424
+ :creation_date_time,
2425
+ :last_updated_date_time,
2426
+ :dataset_group_arn,
2427
+ :failure_reason,
2428
+ :status)
2429
+ include Aws::Structure
2430
+ end
2431
+
2223
2432
  # @note When making an API call, you may pass GetSolutionMetricsRequest
2224
2433
  # data as a hash:
2225
2434
  #
@@ -2782,6 +2991,53 @@ module Aws::Personalize
2782
2991
  include Aws::Structure
2783
2992
  end
2784
2993
 
2994
+ # @note When making an API call, you may pass ListFiltersRequest
2995
+ # data as a hash:
2996
+ #
2997
+ # {
2998
+ # dataset_group_arn: "Arn",
2999
+ # next_token: "NextToken",
3000
+ # max_results: 1,
3001
+ # }
3002
+ #
3003
+ # @!attribute [rw] dataset_group_arn
3004
+ # The ARN of the dataset group that contains the filters.
3005
+ # @return [String]
3006
+ #
3007
+ # @!attribute [rw] next_token
3008
+ # A token returned from the previous call to `ListFilters` for getting
3009
+ # the next set of filters (if they exist).
3010
+ # @return [String]
3011
+ #
3012
+ # @!attribute [rw] max_results
3013
+ # The maximum number of filters to return.
3014
+ # @return [Integer]
3015
+ #
3016
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListFiltersRequest AWS API Documentation
3017
+ #
3018
+ class ListFiltersRequest < Struct.new(
3019
+ :dataset_group_arn,
3020
+ :next_token,
3021
+ :max_results)
3022
+ include Aws::Structure
3023
+ end
3024
+
3025
+ # @!attribute [rw] filters
3026
+ # A list of returned filters.
3027
+ # @return [Array<Types::FilterSummary>]
3028
+ #
3029
+ # @!attribute [rw] next_token
3030
+ # A token for getting the next set of filters (if they exist).
3031
+ # @return [String]
3032
+ #
3033
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListFiltersResponse AWS API Documentation
3034
+ #
3035
+ class ListFiltersResponse < Struct.new(
3036
+ :filters,
3037
+ :next_token)
3038
+ include Aws::Structure
3039
+ end
3040
+
2785
3041
  # @note When making an API call, you may pass ListRecipesRequest
2786
3042
  # data as a hash:
2787
3043
  #
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-personalize
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.12.0
4
+ version: 1.13.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-05-28 00:00:00.000000000 Z
11
+ date: 2020-06-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core