aws-sdk-elasticsearchservice 1.30.0 → 1.35.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 +5 -5
- data/lib/aws-sdk-elasticsearchservice.rb +7 -4
- data/lib/aws-sdk-elasticsearchservice/client.rb +397 -14
- data/lib/aws-sdk-elasticsearchservice/client_api.rb +267 -0
- data/lib/aws-sdk-elasticsearchservice/errors.rb +121 -0
- data/lib/aws-sdk-elasticsearchservice/resource.rb +1 -0
- data/lib/aws-sdk-elasticsearchservice/types.rb +513 -1
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 9cd2277d9b70813460ecaf2b5043979dc45116f422b952ecbef6ed57d2f2e125
|
4
|
+
data.tar.gz: 1ffeef5345a23be3387e5667923c668db12b4be7a6847b90090661aece408e79
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0c40710d284111afdc5ba7837b4b26d87c3032c6fab99a7f277c00f07cd1d13ec9d580cde305b6aaba42afedeef3c4fb2f401540f7f73414262ae1a77e75634f
|
7
|
+
data.tar.gz: e7c1789ba4e9f5f0e4045219c2063004ad41b527e956bb718522bd3a38d75332b3df8fdebe0b4f61bf1ae6ca66928b1f3d6f8ec466d6d8a8634b222d6d8723c0
|
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-elasticsearchservice/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# elasticsearch_service = Aws::ElasticsearchService::Client.new
|
28
|
+
# resp = elasticsearch_service.add_tags(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from Amazon Elasticsearch Service
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from Amazon Elasticsearch Service 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::ElasticsearchService::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all Amazon Elasticsearch Service API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-elasticsearchservice/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::ElasticsearchService
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.35.0'
|
46
49
|
|
47
50
|
end
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:elasticsearchservice)
|
31
31
|
|
32
32
|
module Aws::ElasticsearchService
|
33
|
+
# An API client for ElasticsearchService. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::ElasticsearchService::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
|
@@ -93,7 +105,7 @@ module Aws::ElasticsearchService
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::ElasticsearchService
|
|
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::ElasticsearchService
|
|
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.
|
@@ -139,7 +161,7 @@ module Aws::ElasticsearchService
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::ElasticsearchService
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::ElasticsearchService
|
|
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.
|
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,30 @@ module Aws::ElasticsearchService
|
|
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
|
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)
|
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
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -209,16 +264,15 @@ module Aws::ElasticsearchService
|
|
209
264
|
# requests through. Formatted like 'http://proxy.com:123'.
|
210
265
|
#
|
211
266
|
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
-
# seconds to wait when opening a HTTP session before
|
267
|
+
# seconds to wait when opening a HTTP session before raising a
|
213
268
|
# `Timeout::Error`.
|
214
269
|
#
|
215
270
|
# @option options [Integer] :http_read_timeout (60) The default
|
216
271
|
# number of seconds to wait for response data. This value can
|
217
|
-
# safely be set
|
218
|
-
# per-request on the session yeidled by {#session_for}.
|
272
|
+
# safely be set per-request on the session.
|
219
273
|
#
|
220
274
|
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
-
# seconds a connection is allowed to sit
|
275
|
+
# seconds a connection is allowed to sit idle before it is
|
222
276
|
# considered stale. Stale connections are closed and removed
|
223
277
|
# from the pool before making a request.
|
224
278
|
#
|
@@ -227,7 +281,7 @@ module Aws::ElasticsearchService
|
|
227
281
|
# request body. This option has no effect unless the request has
|
228
282
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
283
|
# disables this behaviour. This value can safely be set per
|
230
|
-
# request on the session
|
284
|
+
# request on the session.
|
231
285
|
#
|
232
286
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
287
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -290,6 +344,45 @@ module Aws::ElasticsearchService
|
|
290
344
|
req.send_request(options)
|
291
345
|
end
|
292
346
|
|
347
|
+
# Associates a package with an Amazon ES domain.
|
348
|
+
#
|
349
|
+
# @option params [required, String] :package_id
|
350
|
+
# Internal ID of the package that you want to associate with a domain.
|
351
|
+
# Use `DescribePackages` to find this value.
|
352
|
+
#
|
353
|
+
# @option params [required, String] :domain_name
|
354
|
+
# Name of the domain that you want to associate the package with.
|
355
|
+
#
|
356
|
+
# @return [Types::AssociatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
357
|
+
#
|
358
|
+
# * {Types::AssociatePackageResponse#domain_package_details #domain_package_details} => Types::DomainPackageDetails
|
359
|
+
#
|
360
|
+
# @example Request syntax with placeholder values
|
361
|
+
#
|
362
|
+
# resp = client.associate_package({
|
363
|
+
# package_id: "PackageID", # required
|
364
|
+
# domain_name: "DomainName", # required
|
365
|
+
# })
|
366
|
+
#
|
367
|
+
# @example Response structure
|
368
|
+
#
|
369
|
+
# resp.domain_package_details.package_id #=> String
|
370
|
+
# resp.domain_package_details.package_name #=> String
|
371
|
+
# resp.domain_package_details.package_type #=> String, one of "TXT-DICTIONARY"
|
372
|
+
# resp.domain_package_details.last_updated #=> Time
|
373
|
+
# resp.domain_package_details.domain_name #=> String
|
374
|
+
# resp.domain_package_details.domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
|
375
|
+
# resp.domain_package_details.reference_path #=> String
|
376
|
+
# resp.domain_package_details.error_details.error_type #=> String
|
377
|
+
# resp.domain_package_details.error_details.error_message #=> String
|
378
|
+
#
|
379
|
+
# @overload associate_package(params = {})
|
380
|
+
# @param [Hash] params ({})
|
381
|
+
def associate_package(params = {}, options = {})
|
382
|
+
req = build_request(:associate_package, params)
|
383
|
+
req.send_request(options)
|
384
|
+
end
|
385
|
+
|
293
386
|
# Cancels a scheduled service software update for an Amazon ES domain.
|
294
387
|
# You can only perform this operation before the `AutomatedUpdateDate`
|
295
388
|
# and when the `UpdateStatus` is in the `PENDING_UPDATE` state.
|
@@ -317,6 +410,7 @@ module Aws::ElasticsearchService
|
|
317
410
|
# resp.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
|
318
411
|
# resp.service_software_options.description #=> String
|
319
412
|
# resp.service_software_options.automated_update_date #=> Time
|
413
|
+
# resp.service_software_options.optional_deployment #=> Boolean
|
320
414
|
#
|
321
415
|
# @overload cancel_elasticsearch_service_software_update(params = {})
|
322
416
|
# @param [Hash] params ({})
|
@@ -539,6 +633,7 @@ module Aws::ElasticsearchService
|
|
539
633
|
# resp.domain_status.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
|
540
634
|
# resp.domain_status.service_software_options.description #=> String
|
541
635
|
# resp.domain_status.service_software_options.automated_update_date #=> Time
|
636
|
+
# resp.domain_status.service_software_options.optional_deployment #=> Boolean
|
542
637
|
# resp.domain_status.domain_endpoint_options.enforce_https #=> Boolean
|
543
638
|
# resp.domain_status.domain_endpoint_options.tls_security_policy #=> String, one of "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07"
|
544
639
|
# resp.domain_status.advanced_security_options.enabled #=> Boolean
|
@@ -551,6 +646,54 @@ module Aws::ElasticsearchService
|
|
551
646
|
req.send_request(options)
|
552
647
|
end
|
553
648
|
|
649
|
+
# Create a package for use with Amazon ES domains.
|
650
|
+
#
|
651
|
+
# @option params [required, String] :package_name
|
652
|
+
# Unique identifier for the package.
|
653
|
+
#
|
654
|
+
# @option params [required, String] :package_type
|
655
|
+
# Type of package. Currently supports only TXT-DICTIONARY.
|
656
|
+
#
|
657
|
+
# @option params [String] :package_description
|
658
|
+
# Description of the package.
|
659
|
+
#
|
660
|
+
# @option params [required, Types::PackageSource] :package_source
|
661
|
+
# The customer S3 location `PackageSource` for importing the package.
|
662
|
+
#
|
663
|
+
# @return [Types::CreatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
664
|
+
#
|
665
|
+
# * {Types::CreatePackageResponse#package_details #package_details} => Types::PackageDetails
|
666
|
+
#
|
667
|
+
# @example Request syntax with placeholder values
|
668
|
+
#
|
669
|
+
# resp = client.create_package({
|
670
|
+
# package_name: "PackageName", # required
|
671
|
+
# package_type: "TXT-DICTIONARY", # required, accepts TXT-DICTIONARY
|
672
|
+
# package_description: "PackageDescription",
|
673
|
+
# package_source: { # required
|
674
|
+
# s3_bucket_name: "S3BucketName",
|
675
|
+
# s3_key: "S3Key",
|
676
|
+
# },
|
677
|
+
# })
|
678
|
+
#
|
679
|
+
# @example Response structure
|
680
|
+
#
|
681
|
+
# resp.package_details.package_id #=> String
|
682
|
+
# resp.package_details.package_name #=> String
|
683
|
+
# resp.package_details.package_type #=> String, one of "TXT-DICTIONARY"
|
684
|
+
# resp.package_details.package_description #=> String
|
685
|
+
# resp.package_details.package_status #=> String, one of "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED"
|
686
|
+
# resp.package_details.created_at #=> Time
|
687
|
+
# resp.package_details.error_details.error_type #=> String
|
688
|
+
# resp.package_details.error_details.error_message #=> String
|
689
|
+
#
|
690
|
+
# @overload create_package(params = {})
|
691
|
+
# @param [Hash] params ({})
|
692
|
+
def create_package(params = {}, options = {})
|
693
|
+
req = build_request(:create_package, params)
|
694
|
+
req.send_request(options)
|
695
|
+
end
|
696
|
+
|
554
697
|
# Permanently deletes the specified Elasticsearch domain and all of its
|
555
698
|
# data. Once a domain is deleted, it cannot be recovered.
|
556
699
|
#
|
@@ -623,6 +766,7 @@ module Aws::ElasticsearchService
|
|
623
766
|
# resp.domain_status.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
|
624
767
|
# resp.domain_status.service_software_options.description #=> String
|
625
768
|
# resp.domain_status.service_software_options.automated_update_date #=> Time
|
769
|
+
# resp.domain_status.service_software_options.optional_deployment #=> Boolean
|
626
770
|
# resp.domain_status.domain_endpoint_options.enforce_https #=> Boolean
|
627
771
|
# resp.domain_status.domain_endpoint_options.tls_security_policy #=> String, one of "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07"
|
628
772
|
# resp.domain_status.advanced_security_options.enabled #=> Boolean
|
@@ -655,6 +799,40 @@ module Aws::ElasticsearchService
|
|
655
799
|
req.send_request(options)
|
656
800
|
end
|
657
801
|
|
802
|
+
# Delete the package.
|
803
|
+
#
|
804
|
+
# @option params [required, String] :package_id
|
805
|
+
# Internal ID of the package that you want to delete. Use
|
806
|
+
# `DescribePackages` to find this value.
|
807
|
+
#
|
808
|
+
# @return [Types::DeletePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
809
|
+
#
|
810
|
+
# * {Types::DeletePackageResponse#package_details #package_details} => Types::PackageDetails
|
811
|
+
#
|
812
|
+
# @example Request syntax with placeholder values
|
813
|
+
#
|
814
|
+
# resp = client.delete_package({
|
815
|
+
# package_id: "PackageID", # required
|
816
|
+
# })
|
817
|
+
#
|
818
|
+
# @example Response structure
|
819
|
+
#
|
820
|
+
# resp.package_details.package_id #=> String
|
821
|
+
# resp.package_details.package_name #=> String
|
822
|
+
# resp.package_details.package_type #=> String, one of "TXT-DICTIONARY"
|
823
|
+
# resp.package_details.package_description #=> String
|
824
|
+
# resp.package_details.package_status #=> String, one of "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED"
|
825
|
+
# resp.package_details.created_at #=> Time
|
826
|
+
# resp.package_details.error_details.error_type #=> String
|
827
|
+
# resp.package_details.error_details.error_message #=> String
|
828
|
+
#
|
829
|
+
# @overload delete_package(params = {})
|
830
|
+
# @param [Hash] params ({})
|
831
|
+
def delete_package(params = {}, options = {})
|
832
|
+
req = build_request(:delete_package, params)
|
833
|
+
req.send_request(options)
|
834
|
+
end
|
835
|
+
|
658
836
|
# Returns domain configuration information about the specified
|
659
837
|
# Elasticsearch domain, including the domain ID, domain endpoint, and
|
660
838
|
# domain ARN.
|
@@ -727,6 +905,7 @@ module Aws::ElasticsearchService
|
|
727
905
|
# resp.domain_status.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
|
728
906
|
# resp.domain_status.service_software_options.description #=> String
|
729
907
|
# resp.domain_status.service_software_options.automated_update_date #=> Time
|
908
|
+
# resp.domain_status.service_software_options.optional_deployment #=> Boolean
|
730
909
|
# resp.domain_status.domain_endpoint_options.enforce_https #=> Boolean
|
731
910
|
# resp.domain_status.domain_endpoint_options.tls_security_policy #=> String, one of "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07"
|
732
911
|
# resp.domain_status.advanced_security_options.enabled #=> Boolean
|
@@ -944,6 +1123,7 @@ module Aws::ElasticsearchService
|
|
944
1123
|
# resp.domain_status_list[0].service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
|
945
1124
|
# resp.domain_status_list[0].service_software_options.description #=> String
|
946
1125
|
# resp.domain_status_list[0].service_software_options.automated_update_date #=> Time
|
1126
|
+
# resp.domain_status_list[0].service_software_options.optional_deployment #=> Boolean
|
947
1127
|
# resp.domain_status_list[0].domain_endpoint_options.enforce_https #=> Boolean
|
948
1128
|
# resp.domain_status_list[0].domain_endpoint_options.tls_security_policy #=> String, one of "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07"
|
949
1129
|
# resp.domain_status_list[0].advanced_security_options.enabled #=> Boolean
|
@@ -1008,6 +1188,61 @@ module Aws::ElasticsearchService
|
|
1008
1188
|
req.send_request(options)
|
1009
1189
|
end
|
1010
1190
|
|
1191
|
+
# Describes all packages available to Amazon ES. Includes options for
|
1192
|
+
# filtering, limiting the number of results, and pagination.
|
1193
|
+
#
|
1194
|
+
# @option params [Array<Types::DescribePackagesFilter>] :filters
|
1195
|
+
# Only returns packages that match the `DescribePackagesFilterList`
|
1196
|
+
# values.
|
1197
|
+
#
|
1198
|
+
# @option params [Integer] :max_results
|
1199
|
+
# Limits results to a maximum number of packages.
|
1200
|
+
#
|
1201
|
+
# @option params [String] :next_token
|
1202
|
+
# Used for pagination. Only necessary if a previous API call includes a
|
1203
|
+
# non-null NextToken value. If provided, returns results for the next
|
1204
|
+
# page.
|
1205
|
+
#
|
1206
|
+
# @return [Types::DescribePackagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1207
|
+
#
|
1208
|
+
# * {Types::DescribePackagesResponse#package_details_list #package_details_list} => Array<Types::PackageDetails>
|
1209
|
+
# * {Types::DescribePackagesResponse#next_token #next_token} => String
|
1210
|
+
#
|
1211
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1212
|
+
#
|
1213
|
+
# @example Request syntax with placeholder values
|
1214
|
+
#
|
1215
|
+
# resp = client.describe_packages({
|
1216
|
+
# filters: [
|
1217
|
+
# {
|
1218
|
+
# name: "PackageID", # accepts PackageID, PackageName, PackageStatus
|
1219
|
+
# value: ["DescribePackagesFilterValue"],
|
1220
|
+
# },
|
1221
|
+
# ],
|
1222
|
+
# max_results: 1,
|
1223
|
+
# next_token: "NextToken",
|
1224
|
+
# })
|
1225
|
+
#
|
1226
|
+
# @example Response structure
|
1227
|
+
#
|
1228
|
+
# resp.package_details_list #=> Array
|
1229
|
+
# resp.package_details_list[0].package_id #=> String
|
1230
|
+
# resp.package_details_list[0].package_name #=> String
|
1231
|
+
# resp.package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY"
|
1232
|
+
# resp.package_details_list[0].package_description #=> String
|
1233
|
+
# resp.package_details_list[0].package_status #=> String, one of "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED"
|
1234
|
+
# resp.package_details_list[0].created_at #=> Time
|
1235
|
+
# resp.package_details_list[0].error_details.error_type #=> String
|
1236
|
+
# resp.package_details_list[0].error_details.error_message #=> String
|
1237
|
+
# resp.next_token #=> String
|
1238
|
+
#
|
1239
|
+
# @overload describe_packages(params = {})
|
1240
|
+
# @param [Hash] params ({})
|
1241
|
+
def describe_packages(params = {}, options = {})
|
1242
|
+
req = build_request(:describe_packages, params)
|
1243
|
+
req.send_request(options)
|
1244
|
+
end
|
1245
|
+
|
1011
1246
|
# Lists available reserved Elasticsearch instance offerings.
|
1012
1247
|
#
|
1013
1248
|
# @option params [String] :reserved_elasticsearch_instance_offering_id
|
@@ -1028,6 +1263,8 @@ module Aws::ElasticsearchService
|
|
1028
1263
|
# * {Types::DescribeReservedElasticsearchInstanceOfferingsResponse#next_token #next_token} => String
|
1029
1264
|
# * {Types::DescribeReservedElasticsearchInstanceOfferingsResponse#reserved_elasticsearch_instance_offerings #reserved_elasticsearch_instance_offerings} => Array<Types::ReservedElasticsearchInstanceOffering>
|
1030
1265
|
#
|
1266
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1267
|
+
#
|
1031
1268
|
# @example Request syntax with placeholder values
|
1032
1269
|
#
|
1033
1270
|
# resp = client.describe_reserved_elasticsearch_instance_offerings({
|
@@ -1079,6 +1316,8 @@ module Aws::ElasticsearchService
|
|
1079
1316
|
# * {Types::DescribeReservedElasticsearchInstancesResponse#next_token #next_token} => String
|
1080
1317
|
# * {Types::DescribeReservedElasticsearchInstancesResponse#reserved_elasticsearch_instances #reserved_elasticsearch_instances} => Array<Types::ReservedElasticsearchInstance>
|
1081
1318
|
#
|
1319
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1320
|
+
#
|
1082
1321
|
# @example Request syntax with placeholder values
|
1083
1322
|
#
|
1084
1323
|
# resp = client.describe_reserved_elasticsearch_instances({
|
@@ -1114,6 +1353,45 @@ module Aws::ElasticsearchService
|
|
1114
1353
|
req.send_request(options)
|
1115
1354
|
end
|
1116
1355
|
|
1356
|
+
# Dissociates a package from the Amazon ES domain.
|
1357
|
+
#
|
1358
|
+
# @option params [required, String] :package_id
|
1359
|
+
# Internal ID of the package that you want to associate with a domain.
|
1360
|
+
# Use `DescribePackages` to find this value.
|
1361
|
+
#
|
1362
|
+
# @option params [required, String] :domain_name
|
1363
|
+
# Name of the domain that you want to associate the package with.
|
1364
|
+
#
|
1365
|
+
# @return [Types::DissociatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1366
|
+
#
|
1367
|
+
# * {Types::DissociatePackageResponse#domain_package_details #domain_package_details} => Types::DomainPackageDetails
|
1368
|
+
#
|
1369
|
+
# @example Request syntax with placeholder values
|
1370
|
+
#
|
1371
|
+
# resp = client.dissociate_package({
|
1372
|
+
# package_id: "PackageID", # required
|
1373
|
+
# domain_name: "DomainName", # required
|
1374
|
+
# })
|
1375
|
+
#
|
1376
|
+
# @example Response structure
|
1377
|
+
#
|
1378
|
+
# resp.domain_package_details.package_id #=> String
|
1379
|
+
# resp.domain_package_details.package_name #=> String
|
1380
|
+
# resp.domain_package_details.package_type #=> String, one of "TXT-DICTIONARY"
|
1381
|
+
# resp.domain_package_details.last_updated #=> Time
|
1382
|
+
# resp.domain_package_details.domain_name #=> String
|
1383
|
+
# resp.domain_package_details.domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
|
1384
|
+
# resp.domain_package_details.reference_path #=> String
|
1385
|
+
# resp.domain_package_details.error_details.error_type #=> String
|
1386
|
+
# resp.domain_package_details.error_details.error_message #=> String
|
1387
|
+
#
|
1388
|
+
# @overload dissociate_package(params = {})
|
1389
|
+
# @param [Hash] params ({})
|
1390
|
+
def dissociate_package(params = {}, options = {})
|
1391
|
+
req = build_request(:dissociate_package, params)
|
1392
|
+
req.send_request(options)
|
1393
|
+
end
|
1394
|
+
|
1117
1395
|
# Returns a list of upgrade compatible Elastisearch versions. You can
|
1118
1396
|
# optionally pass a ` DomainName ` to get all upgrade compatible
|
1119
1397
|
# Elasticsearch versions for that specific domain.
|
@@ -1170,6 +1448,8 @@ module Aws::ElasticsearchService
|
|
1170
1448
|
# * {Types::GetUpgradeHistoryResponse#upgrade_histories #upgrade_histories} => Array<Types::UpgradeHistory>
|
1171
1449
|
# * {Types::GetUpgradeHistoryResponse#next_token #next_token} => String
|
1172
1450
|
#
|
1451
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1452
|
+
#
|
1173
1453
|
# @example Request syntax with placeholder values
|
1174
1454
|
#
|
1175
1455
|
# resp = client.get_upgrade_history({
|
@@ -1252,6 +1532,55 @@ module Aws::ElasticsearchService
|
|
1252
1532
|
req.send_request(options)
|
1253
1533
|
end
|
1254
1534
|
|
1535
|
+
# Lists all Amazon ES domains associated with the package.
|
1536
|
+
#
|
1537
|
+
# @option params [required, String] :package_id
|
1538
|
+
# The package for which to list domains.
|
1539
|
+
#
|
1540
|
+
# @option params [Integer] :max_results
|
1541
|
+
# Limits results to a maximum number of domains.
|
1542
|
+
#
|
1543
|
+
# @option params [String] :next_token
|
1544
|
+
# Used for pagination. Only necessary if a previous API call includes a
|
1545
|
+
# non-null NextToken value. If provided, returns results for the next
|
1546
|
+
# page.
|
1547
|
+
#
|
1548
|
+
# @return [Types::ListDomainsForPackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1549
|
+
#
|
1550
|
+
# * {Types::ListDomainsForPackageResponse#domain_package_details_list #domain_package_details_list} => Array<Types::DomainPackageDetails>
|
1551
|
+
# * {Types::ListDomainsForPackageResponse#next_token #next_token} => String
|
1552
|
+
#
|
1553
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1554
|
+
#
|
1555
|
+
# @example Request syntax with placeholder values
|
1556
|
+
#
|
1557
|
+
# resp = client.list_domains_for_package({
|
1558
|
+
# package_id: "PackageID", # required
|
1559
|
+
# max_results: 1,
|
1560
|
+
# next_token: "NextToken",
|
1561
|
+
# })
|
1562
|
+
#
|
1563
|
+
# @example Response structure
|
1564
|
+
#
|
1565
|
+
# resp.domain_package_details_list #=> Array
|
1566
|
+
# resp.domain_package_details_list[0].package_id #=> String
|
1567
|
+
# resp.domain_package_details_list[0].package_name #=> String
|
1568
|
+
# resp.domain_package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY"
|
1569
|
+
# resp.domain_package_details_list[0].last_updated #=> Time
|
1570
|
+
# resp.domain_package_details_list[0].domain_name #=> String
|
1571
|
+
# resp.domain_package_details_list[0].domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
|
1572
|
+
# resp.domain_package_details_list[0].reference_path #=> String
|
1573
|
+
# resp.domain_package_details_list[0].error_details.error_type #=> String
|
1574
|
+
# resp.domain_package_details_list[0].error_details.error_message #=> String
|
1575
|
+
# resp.next_token #=> String
|
1576
|
+
#
|
1577
|
+
# @overload list_domains_for_package(params = {})
|
1578
|
+
# @param [Hash] params ({})
|
1579
|
+
def list_domains_for_package(params = {}, options = {})
|
1580
|
+
req = build_request(:list_domains_for_package, params)
|
1581
|
+
req.send_request(options)
|
1582
|
+
end
|
1583
|
+
|
1255
1584
|
# List all Elasticsearch instance types that are supported for given
|
1256
1585
|
# ElasticsearchVersion
|
1257
1586
|
#
|
@@ -1277,6 +1606,8 @@ module Aws::ElasticsearchService
|
|
1277
1606
|
# * {Types::ListElasticsearchInstanceTypesResponse#elasticsearch_instance_types #elasticsearch_instance_types} => Array<String>
|
1278
1607
|
# * {Types::ListElasticsearchInstanceTypesResponse#next_token #next_token} => String
|
1279
1608
|
#
|
1609
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1610
|
+
#
|
1280
1611
|
# @example Request syntax with placeholder values
|
1281
1612
|
#
|
1282
1613
|
# resp = client.list_elasticsearch_instance_types({
|
@@ -1315,6 +1646,8 @@ module Aws::ElasticsearchService
|
|
1315
1646
|
# * {Types::ListElasticsearchVersionsResponse#elasticsearch_versions #elasticsearch_versions} => Array<String>
|
1316
1647
|
# * {Types::ListElasticsearchVersionsResponse#next_token #next_token} => String
|
1317
1648
|
#
|
1649
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1650
|
+
#
|
1318
1651
|
# @example Request syntax with placeholder values
|
1319
1652
|
#
|
1320
1653
|
# resp = client.list_elasticsearch_versions({
|
@@ -1335,6 +1668,55 @@ module Aws::ElasticsearchService
|
|
1335
1668
|
req.send_request(options)
|
1336
1669
|
end
|
1337
1670
|
|
1671
|
+
# Lists all packages associated with the Amazon ES domain.
|
1672
|
+
#
|
1673
|
+
# @option params [required, String] :domain_name
|
1674
|
+
# The name of the domain for which you want to list associated packages.
|
1675
|
+
#
|
1676
|
+
# @option params [Integer] :max_results
|
1677
|
+
# Limits results to a maximum number of packages.
|
1678
|
+
#
|
1679
|
+
# @option params [String] :next_token
|
1680
|
+
# Used for pagination. Only necessary if a previous API call includes a
|
1681
|
+
# non-null NextToken value. If provided, returns results for the next
|
1682
|
+
# page.
|
1683
|
+
#
|
1684
|
+
# @return [Types::ListPackagesForDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1685
|
+
#
|
1686
|
+
# * {Types::ListPackagesForDomainResponse#domain_package_details_list #domain_package_details_list} => Array<Types::DomainPackageDetails>
|
1687
|
+
# * {Types::ListPackagesForDomainResponse#next_token #next_token} => String
|
1688
|
+
#
|
1689
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1690
|
+
#
|
1691
|
+
# @example Request syntax with placeholder values
|
1692
|
+
#
|
1693
|
+
# resp = client.list_packages_for_domain({
|
1694
|
+
# domain_name: "DomainName", # required
|
1695
|
+
# max_results: 1,
|
1696
|
+
# next_token: "NextToken",
|
1697
|
+
# })
|
1698
|
+
#
|
1699
|
+
# @example Response structure
|
1700
|
+
#
|
1701
|
+
# resp.domain_package_details_list #=> Array
|
1702
|
+
# resp.domain_package_details_list[0].package_id #=> String
|
1703
|
+
# resp.domain_package_details_list[0].package_name #=> String
|
1704
|
+
# resp.domain_package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY"
|
1705
|
+
# resp.domain_package_details_list[0].last_updated #=> Time
|
1706
|
+
# resp.domain_package_details_list[0].domain_name #=> String
|
1707
|
+
# resp.domain_package_details_list[0].domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
|
1708
|
+
# resp.domain_package_details_list[0].reference_path #=> String
|
1709
|
+
# resp.domain_package_details_list[0].error_details.error_type #=> String
|
1710
|
+
# resp.domain_package_details_list[0].error_details.error_message #=> String
|
1711
|
+
# resp.next_token #=> String
|
1712
|
+
#
|
1713
|
+
# @overload list_packages_for_domain(params = {})
|
1714
|
+
# @param [Hash] params ({})
|
1715
|
+
def list_packages_for_domain(params = {}, options = {})
|
1716
|
+
req = build_request(:list_packages_for_domain, params)
|
1717
|
+
req.send_request(options)
|
1718
|
+
end
|
1719
|
+
|
1338
1720
|
# Returns all tags for the given Elasticsearch domain.
|
1339
1721
|
#
|
1340
1722
|
# @option params [required, String] :arn
|
@@ -1452,6 +1834,7 @@ module Aws::ElasticsearchService
|
|
1452
1834
|
# resp.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
|
1453
1835
|
# resp.service_software_options.description #=> String
|
1454
1836
|
# resp.service_software_options.automated_update_date #=> Time
|
1837
|
+
# resp.service_software_options.optional_deployment #=> Boolean
|
1455
1838
|
#
|
1456
1839
|
# @overload start_elasticsearch_service_software_update(params = {})
|
1457
1840
|
# @param [Hash] params ({})
|
@@ -1758,7 +2141,7 @@ module Aws::ElasticsearchService
|
|
1758
2141
|
params: params,
|
1759
2142
|
config: config)
|
1760
2143
|
context[:gem_name] = 'aws-sdk-elasticsearchservice'
|
1761
|
-
context[:gem_version] = '1.
|
2144
|
+
context[:gem_version] = '1.35.0'
|
1762
2145
|
Seahorse::Client::Request.new(handlers, context)
|
1763
2146
|
end
|
1764
2147
|
|