aws-sdk-cloudsearch 1.17.0 → 1.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f0acf369288ac5287749d9937f1379d9e73da2f9
4
- data.tar.gz: a3c9f84b060dd12d4fd982af61ccd856bb6fed22
3
+ metadata.gz: 3a2f21339be0e1b77d429deb90cfa6414dcb3413
4
+ data.tar.gz: c555cca2b0f3e8f7b36bb8a9f0463cf2c6719b9d
5
5
  SHA512:
6
- metadata.gz: 3ca5efa7f3de9a3959addea3b8864c6d6e8355bf4562ce0013d43c8af04942576409deef63bfefb436913522be7aa3c802fda6f8672f2ad88c6ea4264b51ea32
7
- data.tar.gz: aaaf81aa043b3dfd9fce45453f71d54ba4536d91d8c4d9895072655fec89da03eb1edd799c78a9b80cc99ec0a79e371d5f82f4efbd9fc3f0bc6902384197145c
6
+ metadata.gz: fa49c52e5596d165ec91e857281f3f2f65b613b4689e7d02c7a042809e87b8c66a3bb9b4e3e33d1c38057d5f01445616142f11a2e47d36dde8a943be8fca85e3
7
+ data.tar.gz: 95b0e0245afeb9f1dabf86babb9339bde686aee94640cd8988c94dabb4cfd37a2b22b0beb6da742426d3883499901ddb140fbbae569ed488cdd2aa165c01d17b
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-cloudsearch/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # cloud_search = Aws::CloudSearch::Client.new
28
+ # resp = cloud_search.build_suggesters(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon CloudSearch all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon CloudSearch are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::CloudSearch::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon CloudSearch API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-cloudsearch/customizations'
42
45
  # @service
43
46
  module Aws::CloudSearch
44
47
 
45
- GEM_VERSION = '1.17.0'
48
+ GEM_VERSION = '1.18.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/query.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:cloudsearch)
31
31
 
32
32
  module Aws::CloudSearch
33
+ # An API client for CloudSearch. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::CloudSearch::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -108,6 +120,12 @@ module Aws::CloudSearch
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::CloudSearch
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -166,15 +188,29 @@ module Aws::CloudSearch
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,26 @@ module Aws::CloudSearch
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ # * `legacy` - The pre-existing retry behavior. This is default value if
233
+ # no retry mode is provided.
234
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
235
+ # This includes support for retry quotas, which limit the number of
236
+ # unsuccessful retries a client can make.
237
+ # * `adaptive` - An experimental retry mode that includes all the
238
+ # functionality of `standard` mode along with automatic client side
239
+ # throttling. This is a provisional mode that may change behavior
240
+ # in the future.
190
241
  #
191
242
  # @option options [String] :secret_access_key
192
243
  #
@@ -209,16 +260,16 @@ module Aws::CloudSearch
209
260
  # requests through. Formatted like 'http://proxy.com:123'.
210
261
  #
211
262
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
263
+ # seconds to wait when opening a HTTP session before raising a
213
264
  # `Timeout::Error`.
214
265
  #
215
266
  # @option options [Integer] :http_read_timeout (60) The default
216
267
  # number of seconds to wait for response data. This value can
217
268
  # safely be set
218
- # per-request on the session yeidled by {#session_for}.
269
+ # per-request on the session yielded by {#session_for}.
219
270
  #
220
271
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
272
+ # seconds a connection is allowed to sit idle before it is
222
273
  # considered stale. Stale connections are closed and removed
223
274
  # from the pool before making a request.
224
275
  #
@@ -227,7 +278,7 @@ module Aws::CloudSearch
227
278
  # request body. This option has no effect unless the request has
228
279
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
280
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
281
+ # request on the session yielded by {#session_for}.
231
282
  #
232
283
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
284
  # HTTP debug output will be sent to the `:logger`.
@@ -1772,7 +1823,7 @@ module Aws::CloudSearch
1772
1823
  params: params,
1773
1824
  config: config)
1774
1825
  context[:gem_name] = 'aws-sdk-cloudsearch'
1775
- context[:gem_version] = '1.17.0'
1826
+ context[:gem_version] = '1.18.0'
1776
1827
  Seahorse::Client::Request.new(handlers, context)
1777
1828
  end
1778
1829
 
@@ -329,6 +329,8 @@ module Aws::CloudSearch
329
329
  DescribeSuggestersResponse.add_member(:suggesters, Shapes::ShapeRef.new(shape: SuggesterStatusList, required: true, location_name: "Suggesters"))
330
330
  DescribeSuggestersResponse.struct_class = Types::DescribeSuggestersResponse
331
331
 
332
+ DisabledOperationException.struct_class = Types::DisabledOperationException
333
+
332
334
  DocumentSuggesterOptions.add_member(:source_field, Shapes::ShapeRef.new(shape: FieldName, required: true, location_name: "SourceField"))
333
335
  DocumentSuggesterOptions.add_member(:fuzzy_matching, Shapes::ShapeRef.new(shape: SuggesterFuzzyMatching, location_name: "FuzzyMatching"))
334
336
  DocumentSuggesterOptions.add_member(:sort_expression, Shapes::ShapeRef.new(shape: String, location_name: "SortExpression"))
@@ -435,6 +437,10 @@ module Aws::CloudSearch
435
437
  IntOptions.add_member(:sort_enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "SortEnabled"))
436
438
  IntOptions.struct_class = Types::IntOptions
437
439
 
440
+ InternalException.struct_class = Types::InternalException
441
+
442
+ InvalidTypeException.struct_class = Types::InvalidTypeException
443
+
438
444
  LatLonOptions.add_member(:default_value, Shapes::ShapeRef.new(shape: FieldValue, location_name: "DefaultValue"))
439
445
  LatLonOptions.add_member(:source_field, Shapes::ShapeRef.new(shape: FieldName, location_name: "SourceField"))
440
446
  LatLonOptions.add_member(:facet_enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "FacetEnabled"))
@@ -443,6 +449,8 @@ module Aws::CloudSearch
443
449
  LatLonOptions.add_member(:sort_enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "SortEnabled"))
444
450
  LatLonOptions.struct_class = Types::LatLonOptions
445
451
 
452
+ LimitExceededException.struct_class = Types::LimitExceededException
453
+
446
454
  Limits.add_member(:maximum_replication_count, Shapes::ShapeRef.new(shape: MaximumReplicationCount, required: true, location_name: "MaximumReplicationCount"))
447
455
  Limits.add_member(:maximum_partition_count, Shapes::ShapeRef.new(shape: MaximumPartitionCount, required: true, location_name: "MaximumPartitionCount"))
448
456
  Limits.struct_class = Types::Limits
@@ -472,6 +480,8 @@ module Aws::CloudSearch
472
480
  OptionStatus.add_member(:pending_deletion, Shapes::ShapeRef.new(shape: Boolean, location_name: "PendingDeletion"))
473
481
  OptionStatus.struct_class = Types::OptionStatus
474
482
 
483
+ ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
484
+
475
485
  ScalingParameters.add_member(:desired_instance_type, Shapes::ShapeRef.new(shape: PartitionInstanceType, location_name: "DesiredInstanceType"))
476
486
  ScalingParameters.add_member(:desired_replication_count, Shapes::ShapeRef.new(shape: UIntValue, location_name: "DesiredReplicationCount"))
477
487
  ScalingParameters.add_member(:desired_partition_count, Shapes::ShapeRef.new(shape: UIntValue, location_name: "DesiredPartitionCount"))
@@ -539,6 +549,8 @@ module Aws::CloudSearch
539
549
  UpdateServiceAccessPoliciesResponse.add_member(:access_policies, Shapes::ShapeRef.new(shape: AccessPoliciesStatus, required: true, location_name: "AccessPolicies"))
540
550
  UpdateServiceAccessPoliciesResponse.struct_class = Types::UpdateServiceAccessPoliciesResponse
541
551
 
552
+ ValidationException.struct_class = Types::ValidationException
553
+
542
554
 
543
555
  # @api private
544
556
  API = Seahorse::Model::Api.new.tap do |api|
@@ -6,6 +6,35 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::CloudSearch
9
+
10
+ # When CloudSearch returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::CloudSearch::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all CloudSearch errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::CloudSearch::Errors::ServiceError
18
+ # # rescues all CloudSearch API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {BaseException}
29
+ # * {DisabledOperationException}
30
+ # * {InternalException}
31
+ # * {InvalidTypeException}
32
+ # * {LimitExceededException}
33
+ # * {ResourceNotFoundException}
34
+ # * {ValidationException}
35
+ #
36
+ # Additionally, error classes are dynamically generated for service errors based on the error code
37
+ # if they are not defined above.
9
38
  module Errors
10
39
 
11
40
  extend Aws::Errors::DynamicErrors
@@ -28,7 +57,66 @@ module Aws::CloudSearch
28
57
  def message
29
58
  @message || @data[:message]
30
59
  end
60
+ end
61
+
62
+ class DisabledOperationException < ServiceError
63
+
64
+ # @param [Seahorse::Client::RequestContext] context
65
+ # @param [String] message
66
+ # @param [Aws::CloudSearch::Types::DisabledOperationException] data
67
+ def initialize(context, message, data = Aws::EmptyStructure.new)
68
+ super(context, message, data)
69
+ end
70
+ end
71
+
72
+ class InternalException < ServiceError
73
+
74
+ # @param [Seahorse::Client::RequestContext] context
75
+ # @param [String] message
76
+ # @param [Aws::CloudSearch::Types::InternalException] data
77
+ def initialize(context, message, data = Aws::EmptyStructure.new)
78
+ super(context, message, data)
79
+ end
80
+ end
81
+
82
+ class InvalidTypeException < ServiceError
83
+
84
+ # @param [Seahorse::Client::RequestContext] context
85
+ # @param [String] message
86
+ # @param [Aws::CloudSearch::Types::InvalidTypeException] data
87
+ def initialize(context, message, data = Aws::EmptyStructure.new)
88
+ super(context, message, data)
89
+ end
90
+ end
91
+
92
+ class LimitExceededException < ServiceError
93
+
94
+ # @param [Seahorse::Client::RequestContext] context
95
+ # @param [String] message
96
+ # @param [Aws::CloudSearch::Types::LimitExceededException] data
97
+ def initialize(context, message, data = Aws::EmptyStructure.new)
98
+ super(context, message, data)
99
+ end
100
+ end
101
+
102
+ class ResourceNotFoundException < ServiceError
103
+
104
+ # @param [Seahorse::Client::RequestContext] context
105
+ # @param [String] message
106
+ # @param [Aws::CloudSearch::Types::ResourceNotFoundException] data
107
+ def initialize(context, message, data = Aws::EmptyStructure.new)
108
+ super(context, message, data)
109
+ end
110
+ end
31
111
 
112
+ class ValidationException < ServiceError
113
+
114
+ # @param [Seahorse::Client::RequestContext] context
115
+ # @param [String] message
116
+ # @param [Aws::CloudSearch::Types::ValidationException] data
117
+ def initialize(context, message, data = Aws::EmptyStructure.new)
118
+ super(context, message, data)
119
+ end
32
120
  end
33
121
 
34
122
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::CloudSearch
9
+ # This class provides a resource oriented interface for CloudSearch.
10
+ # To create a resource object:
11
+ # resource = Aws::CloudSearch::Resource.new(region: 'us-west-2')
12
+ # You can supply a client object with custom configuration that will be used for all resource operations.
13
+ # If you do not pass +:client+, a default client will be constructed.
14
+ # client = Aws::CloudSearch::Client.new(region: 'us-west-2')
15
+ # resource = Aws::CloudSearch::Resource.new(client: client)
9
16
  class Resource
10
17
 
11
18
  # @param options ({})
@@ -1243,6 +1243,11 @@ module Aws::CloudSearch
1243
1243
  include Aws::Structure
1244
1244
  end
1245
1245
 
1246
+ # The request was rejected because it attempted an operation which is
1247
+ # not enabled.
1248
+ #
1249
+ class DisabledOperationException < Aws::EmptyStructure; end
1250
+
1246
1251
  # Options for a search suggester.
1247
1252
  #
1248
1253
  # @note When making an API call, you may pass DocumentSuggesterOptions
@@ -1926,6 +1931,21 @@ module Aws::CloudSearch
1926
1931
  include Aws::Structure
1927
1932
  end
1928
1933
 
1934
+ # An internal error occurred while processing the request. If this
1935
+ # problem persists, report an issue from the [Service Health
1936
+ # Dashboard][1].
1937
+ #
1938
+ #
1939
+ #
1940
+ # [1]: http://status.aws.amazon.com/
1941
+ #
1942
+ class InternalException < Aws::EmptyStructure; end
1943
+
1944
+ # The request was rejected because it specified an invalid type
1945
+ # definition.
1946
+ #
1947
+ class InvalidTypeException < Aws::EmptyStructure; end
1948
+
1929
1949
  # Options for a latlon field. A latlon field contains a location stored
1930
1950
  # as a latitude and longitude value pair. Present if `IndexFieldType`
1931
1951
  # specifies the field is of type `latlon`. All options are enabled by
@@ -1994,6 +2014,11 @@ module Aws::CloudSearch
1994
2014
  include Aws::Structure
1995
2015
  end
1996
2016
 
2017
+ # The request was rejected because a resource limit has already been
2018
+ # met.
2019
+ #
2020
+ class LimitExceededException < Aws::EmptyStructure; end
2021
+
1997
2022
  # @!attribute [rw] maximum_replication_count
1998
2023
  # @return [Integer]
1999
2024
  #
@@ -2173,6 +2198,11 @@ module Aws::CloudSearch
2173
2198
  include Aws::Structure
2174
2199
  end
2175
2200
 
2201
+ # The request was rejected because it attempted to reference a resource
2202
+ # that does not exist.
2203
+ #
2204
+ class ResourceNotFoundException < Aws::EmptyStructure; end
2205
+
2176
2206
  # The desired instance type and desired number of replicas of each index
2177
2207
  # partition.
2178
2208
  #
@@ -2583,5 +2613,9 @@ module Aws::CloudSearch
2583
2613
  include Aws::Structure
2584
2614
  end
2585
2615
 
2616
+ # The request was rejected because it has invalid parameters.
2617
+ #
2618
+ class ValidationException < Aws::EmptyStructure; end
2619
+
2586
2620
  end
2587
2621
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-cloudsearch
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.17.0
4
+ version: 1.18.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: 2019-11-13 00:00:00.000000000 Z
11
+ date: 2020-03-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core