aws-sdk-personalizeruntime 1.15.0 → 1.20.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: bca3cda9086671e924fcdcbef06ed8512c5bcb3b739252136e0d611a53e6183b
4
- data.tar.gz: '08239b4123a122038843509022232693644606fb86903c74e82240256276ea51'
3
+ metadata.gz: 65924bd264553e8a084c1cc6e004b60aaba2aeded9521cdf8c2aed28a16708dc
4
+ data.tar.gz: be4fb259801b0721f0cdf95ee8a9cd6b7047e92cb8b84785bd4d80ba0c368258
5
5
  SHA512:
6
- metadata.gz: ec053f1a913ed5dc228ebb9a9387a98285260824305afb0f359ff7d01745aca5cf19ccb7a12ccfe226448fff36378847e44518ea36f1bb0b71840247accaf221
7
- data.tar.gz: 69bef1f5d19579f612de9dbcb5525c282bf2d9ceb1361d81a085a034a474249ab47794eb6606818369da6e45750396aa2d447a51e3e32ac378a83d17340cb826
6
+ metadata.gz: b77388d5330a06a02f2aba3977b3c43cf9b1c9c81a678115920f5b3974682c8623b5d5e995aa769248d5e56d8ee5f3fa4a0ae000534d37c99cef4cf38c6d153e
7
+ data.tar.gz: 653c44a394d0cd9ede9166520df7c14fd655af3fd9d270afb91727977b1570d04c491dadd363c9f8e19ef9bad03abaf322e890d3d3e37fbae65df8156e91c89c
@@ -7,6 +7,7 @@
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
10
+
10
11
  require 'aws-sdk-core'
11
12
  require 'aws-sigv4'
12
13
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-personalizeruntime/customizations'
44
45
  #
45
46
  # See {Errors} for more information.
46
47
  #
47
- # @service
48
+ # @!group service
48
49
  module Aws::PersonalizeRuntime
49
50
 
50
- GEM_VERSION = '1.15.0'
51
+ GEM_VERSION = '1.20.0'
51
52
 
52
53
  end
@@ -85,13 +85,28 @@ module Aws::PersonalizeRuntime
85
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
86
  # credentials.
87
87
  #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
88
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
89
103
  # from an EC2 IMDS on an EC2 instance.
90
104
  #
91
- # * `Aws::SharedCredentials` - Used for loading credentials from a
92
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
93
107
  #
94
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
95
110
  #
96
111
  # When `:credentials` are not configured directly, the following
97
112
  # locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::PersonalizeRuntime
101
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
102
117
  # * `~/.aws/credentials`
103
118
  # * `~/.aws/config`
104
- # * EC2 IMDS instance profile - When used by default, the timeouts are
105
- # very aggressive. Construct and pass an instance of
106
- # `Aws::InstanceProfileCredentails` to enable retries and extended
107
- # timeouts.
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
108
123
  #
109
124
  # @option options [required, String] :region
110
125
  # The AWS region to connect to. The configured `:region` is
@@ -341,8 +356,32 @@ module Aws::PersonalizeRuntime
341
356
  # current location or device type.
342
357
  #
343
358
  # @option params [String] :filter_arn
344
- # The Amazon Resource Name (ARN) of a filter you created to include or
345
- # exclude items from recommendations for a given user.
359
+ # The Amazon Resource Name (ARN) of a filter you created to include
360
+ # items or exclude items from recommendations for a given user. For more
361
+ # information, see [Filtering Recommendations][1].
362
+ #
363
+ #
364
+ #
365
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
366
+ #
367
+ # @option params [Hash<String,String>] :filter_values
368
+ # The values to use when filtering recommendations. For each placeholder
369
+ # parameter in your filter expression, provide the parameter name (in
370
+ # matching case) as a key and the filter value(s) as the corresponding
371
+ # value. Separate multiple values for one parameter with a comma.
372
+ #
373
+ # For filter expressions that use an `INCLUDE` element to include items,
374
+ # you must provide values for all parameters that are defined in the
375
+ # expression. For filters with expressions that use an `EXCLUDE` element
376
+ # to exclude items, you can omit the `filter-values`.In this case,
377
+ # Amazon Personalize doesn't use that portion of the expression to
378
+ # filter recommendations.
379
+ #
380
+ # For more information, see [Filtering Recommendations][1].
381
+ #
382
+ #
383
+ #
384
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
346
385
  #
347
386
  # @return [Types::GetPersonalizedRankingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
348
387
  #
@@ -359,6 +398,9 @@ module Aws::PersonalizeRuntime
359
398
  # "AttributeName" => "AttributeValue",
360
399
  # },
361
400
  # filter_arn: "Arn",
401
+ # filter_values: {
402
+ # "FilterAttributeName" => "FilterAttributeValue",
403
+ # },
362
404
  # })
363
405
  #
364
406
  # @example Response structure
@@ -416,13 +458,32 @@ module Aws::PersonalizeRuntime
416
458
  #
417
459
  # @option params [String] :filter_arn
418
460
  # The ARN of the filter to apply to the returned recommendations. For
419
- # more information, see [Using Filters with Amazon Personalize][1].
461
+ # more information, see [Filtering Recommendations][1].
420
462
  #
421
463
  # When using this parameter, be sure the filter resource is `ACTIVE`.
422
464
  #
423
465
  #
424
466
  #
425
- # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
467
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
468
+ #
469
+ # @option params [Hash<String,String>] :filter_values
470
+ # The values to use when filtering recommendations. For each placeholder
471
+ # parameter in your filter expression, provide the parameter name (in
472
+ # matching case) as a key and the filter value(s) as the corresponding
473
+ # value. Separate multiple values for one parameter with a comma.
474
+ #
475
+ # For filter expressions that use an `INCLUDE` element to include items,
476
+ # you must provide values for all parameters that are defined in the
477
+ # expression. For filters with expressions that use an `EXCLUDE` element
478
+ # to exclude items, you can omit the `filter-values`.In this case,
479
+ # Amazon Personalize doesn't use that portion of the expression to
480
+ # filter recommendations.
481
+ #
482
+ # For more information, see [Filtering Recommendations][1].
483
+ #
484
+ #
485
+ #
486
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
426
487
  #
427
488
  # @return [Types::GetRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
428
489
  #
@@ -440,6 +501,9 @@ module Aws::PersonalizeRuntime
440
501
  # "AttributeName" => "AttributeValue",
441
502
  # },
442
503
  # filter_arn: "Arn",
504
+ # filter_values: {
505
+ # "FilterAttributeName" => "FilterAttributeValue",
506
+ # },
443
507
  # })
444
508
  #
445
509
  # @example Response structure
@@ -471,7 +535,7 @@ module Aws::PersonalizeRuntime
471
535
  params: params,
472
536
  config: config)
473
537
  context[:gem_name] = 'aws-sdk-personalizeruntime'
474
- context[:gem_version] = '1.15.0'
538
+ context[:gem_version] = '1.20.0'
475
539
  Seahorse::Client::Request.new(handlers, context)
476
540
  end
477
541
 
@@ -18,6 +18,9 @@ module Aws::PersonalizeRuntime
18
18
  AttributeValue = Shapes::StringShape.new(name: 'AttributeValue')
19
19
  Context = Shapes::MapShape.new(name: 'Context')
20
20
  ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
21
+ FilterAttributeName = Shapes::StringShape.new(name: 'FilterAttributeName')
22
+ FilterAttributeValue = Shapes::StringShape.new(name: 'FilterAttributeValue')
23
+ FilterValues = Shapes::MapShape.new(name: 'FilterValues')
21
24
  GetPersonalizedRankingRequest = Shapes::StructureShape.new(name: 'GetPersonalizedRankingRequest')
22
25
  GetPersonalizedRankingResponse = Shapes::StructureShape.new(name: 'GetPersonalizedRankingResponse')
23
26
  GetRecommendationsRequest = Shapes::StructureShape.new(name: 'GetRecommendationsRequest')
@@ -36,11 +39,15 @@ module Aws::PersonalizeRuntime
36
39
  Context.key = Shapes::ShapeRef.new(shape: AttributeName)
37
40
  Context.value = Shapes::ShapeRef.new(shape: AttributeValue)
38
41
 
42
+ FilterValues.key = Shapes::ShapeRef.new(shape: FilterAttributeName)
43
+ FilterValues.value = Shapes::ShapeRef.new(shape: FilterAttributeValue)
44
+
39
45
  GetPersonalizedRankingRequest.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "campaignArn"))
40
46
  GetPersonalizedRankingRequest.add_member(:input_list, Shapes::ShapeRef.new(shape: InputList, required: true, location_name: "inputList"))
41
47
  GetPersonalizedRankingRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserID, required: true, location_name: "userId"))
42
48
  GetPersonalizedRankingRequest.add_member(:context, Shapes::ShapeRef.new(shape: Context, location_name: "context"))
43
49
  GetPersonalizedRankingRequest.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
50
+ GetPersonalizedRankingRequest.add_member(:filter_values, Shapes::ShapeRef.new(shape: FilterValues, location_name: "filterValues"))
44
51
  GetPersonalizedRankingRequest.struct_class = Types::GetPersonalizedRankingRequest
45
52
 
46
53
  GetPersonalizedRankingResponse.add_member(:personalized_ranking, Shapes::ShapeRef.new(shape: ItemList, location_name: "personalizedRanking"))
@@ -53,6 +60,7 @@ module Aws::PersonalizeRuntime
53
60
  GetRecommendationsRequest.add_member(:num_results, Shapes::ShapeRef.new(shape: NumResults, location_name: "numResults"))
54
61
  GetRecommendationsRequest.add_member(:context, Shapes::ShapeRef.new(shape: Context, location_name: "context"))
55
62
  GetRecommendationsRequest.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
63
+ GetRecommendationsRequest.add_member(:filter_values, Shapes::ShapeRef.new(shape: FilterValues, location_name: "filterValues"))
56
64
  GetRecommendationsRequest.struct_class = Types::GetRecommendationsRequest
57
65
 
58
66
  GetRecommendationsResponse.add_member(:item_list, Shapes::ShapeRef.new(shape: ItemList, location_name: "itemList"))
@@ -21,6 +21,9 @@ module Aws::PersonalizeRuntime
21
21
  # "AttributeName" => "AttributeValue",
22
22
  # },
23
23
  # filter_arn: "Arn",
24
+ # filter_values: {
25
+ # "FilterAttributeName" => "FilterAttributeValue",
26
+ # },
24
27
  # }
25
28
  #
26
29
  # @!attribute [rw] campaign_arn
@@ -47,10 +50,36 @@ module Aws::PersonalizeRuntime
47
50
  # @return [Hash<String,String>]
48
51
  #
49
52
  # @!attribute [rw] filter_arn
50
- # The Amazon Resource Name (ARN) of a filter you created to include or
51
- # exclude items from recommendations for a given user.
53
+ # The Amazon Resource Name (ARN) of a filter you created to include
54
+ # items or exclude items from recommendations for a given user. For
55
+ # more information, see [Filtering Recommendations][1].
56
+ #
57
+ #
58
+ #
59
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
52
60
  # @return [String]
53
61
  #
62
+ # @!attribute [rw] filter_values
63
+ # The values to use when filtering recommendations. For each
64
+ # placeholder parameter in your filter expression, provide the
65
+ # parameter name (in matching case) as a key and the filter value(s)
66
+ # as the corresponding value. Separate multiple values for one
67
+ # parameter with a comma.
68
+ #
69
+ # For filter expressions that use an `INCLUDE` element to include
70
+ # items, you must provide values for all parameters that are defined
71
+ # in the expression. For filters with expressions that use an
72
+ # `EXCLUDE` element to exclude items, you can omit the
73
+ # `filter-values`.In this case, Amazon Personalize doesn't use that
74
+ # portion of the expression to filter recommendations.
75
+ #
76
+ # For more information, see [Filtering Recommendations][1].
77
+ #
78
+ #
79
+ #
80
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
81
+ # @return [Hash<String,String>]
82
+ #
54
83
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRankingRequest AWS API Documentation
55
84
  #
56
85
  class GetPersonalizedRankingRequest < Struct.new(
@@ -58,7 +87,8 @@ module Aws::PersonalizeRuntime
58
87
  :input_list,
59
88
  :user_id,
60
89
  :context,
61
- :filter_arn)
90
+ :filter_arn,
91
+ :filter_values)
62
92
  SENSITIVE = []
63
93
  include Aws::Structure
64
94
  end
@@ -93,6 +123,9 @@ module Aws::PersonalizeRuntime
93
123
  # "AttributeName" => "AttributeValue",
94
124
  # },
95
125
  # filter_arn: "Arn",
126
+ # filter_values: {
127
+ # "FilterAttributeName" => "FilterAttributeValue",
128
+ # },
96
129
  # }
97
130
  #
98
131
  # @!attribute [rw] campaign_arn
@@ -126,15 +159,36 @@ module Aws::PersonalizeRuntime
126
159
  #
127
160
  # @!attribute [rw] filter_arn
128
161
  # The ARN of the filter to apply to the returned recommendations. For
129
- # more information, see [Using Filters with Amazon Personalize][1].
162
+ # more information, see [Filtering Recommendations][1].
130
163
  #
131
164
  # When using this parameter, be sure the filter resource is `ACTIVE`.
132
165
  #
133
166
  #
134
167
  #
135
- # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
168
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
136
169
  # @return [String]
137
170
  #
171
+ # @!attribute [rw] filter_values
172
+ # The values to use when filtering recommendations. For each
173
+ # placeholder parameter in your filter expression, provide the
174
+ # parameter name (in matching case) as a key and the filter value(s)
175
+ # as the corresponding value. Separate multiple values for one
176
+ # parameter with a comma.
177
+ #
178
+ # For filter expressions that use an `INCLUDE` element to include
179
+ # items, you must provide values for all parameters that are defined
180
+ # in the expression. For filters with expressions that use an
181
+ # `EXCLUDE` element to exclude items, you can omit the
182
+ # `filter-values`.In this case, Amazon Personalize doesn't use that
183
+ # portion of the expression to filter recommendations.
184
+ #
185
+ # For more information, see [Filtering Recommendations][1].
186
+ #
187
+ #
188
+ #
189
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
190
+ # @return [Hash<String,String>]
191
+ #
138
192
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendationsRequest AWS API Documentation
139
193
  #
140
194
  class GetRecommendationsRequest < Struct.new(
@@ -143,7 +197,8 @@ module Aws::PersonalizeRuntime
143
197
  :user_id,
144
198
  :num_results,
145
199
  :context,
146
- :filter_arn)
200
+ :filter_arn,
201
+ :filter_values)
147
202
  SENSITIVE = []
148
203
  include Aws::Structure
149
204
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-personalizeruntime
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.15.0
4
+ version: 1.20.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-08-06 00:00:00.000000000 Z
11
+ date: 2020-12-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.99.0
22
+ version: 3.109.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.99.0
32
+ version: 3.109.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement