aws-sdk-opensearchservice 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 8be8785ba9f304b323dd7a00b2ec37c3ea2d7980374fd56f38151aedff541776
4
+ data.tar.gz: 1675763d2da662060814ee6e27769d8d9772edd44277b586f57ddc5ac00cc620
5
+ SHA512:
6
+ metadata.gz: 68175a4d9d9702cfad2150cfce3d3af0c2a748cfff5522c42cd45b91c6d3793066d1aa0b9ecb5bc504e7a2a67cd5718be7408fba2fb3005fa264f9eb17b367d4
7
+ data.tar.gz: 01f29bb05c611e67352720608c4b7811dbbba1d3ce5477bb83634e8d0eab9cfb4c5cf2f19af0864ef23804dace498a7cddfe6cf0f054b5c64f29a89e99398ca2
data/CHANGELOG.md ADDED
@@ -0,0 +1,8 @@
1
+ Unreleased Changes
2
+ ------------------
3
+
4
+ 1.0.0 (2021-09-08)
5
+ ------------------
6
+
7
+ * Feature - Initial release of `aws-sdk-opensearchservice`.
8
+
data/LICENSE.txt ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.0.0
@@ -0,0 +1,2930 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:opensearchservice)
34
+
35
+ module Aws::OpenSearchService
36
+ # An API client for OpenSearchService. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::OpenSearchService::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :opensearchservice
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::RestJson)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
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
+ #
102
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
103
+ # from an EC2 IMDS on an EC2 instance.
104
+ #
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
107
+ #
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
110
+ #
111
+ # When `:credentials` are not configured directly, the following
112
+ # locations will be searched for credentials:
113
+ #
114
+ # * `Aws.config[:credentials]`
115
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
116
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
117
+ # * `~/.aws/credentials`
118
+ # * `~/.aws/config`
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.
123
+ #
124
+ # @option options [required, String] :region
125
+ # The AWS region to connect to. The configured `:region` is
126
+ # used to determine the service `:endpoint`. When not passed,
127
+ # a default `:region` is searched for in the following locations:
128
+ #
129
+ # * `Aws.config[:region]`
130
+ # * `ENV['AWS_REGION']`
131
+ # * `ENV['AMAZON_REGION']`
132
+ # * `ENV['AWS_DEFAULT_REGION']`
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ #
136
+ # @option options [String] :access_key_id
137
+ #
138
+ # @option options [Boolean] :active_endpoint_cache (false)
139
+ # When set to `true`, a thread polling for endpoints will be running in
140
+ # the background every 60 secs (default). Defaults to `false`.
141
+ #
142
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
143
+ # Used only in `adaptive` retry mode. When true, the request will sleep
144
+ # until there is sufficent client side capacity to retry the request.
145
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
146
+ # not retry instead of sleeping.
147
+ #
148
+ # @option options [Boolean] :client_side_monitoring (false)
149
+ # When `true`, client-side metrics will be collected for all API requests from
150
+ # this client.
151
+ #
152
+ # @option options [String] :client_side_monitoring_client_id ("")
153
+ # Allows you to provide an identifier for this client which will be attached to
154
+ # all generated client side metrics. Defaults to an empty string.
155
+ #
156
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
157
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
158
+ # side monitoring agent is running on, where client metrics will be published via UDP.
159
+ #
160
+ # @option options [Integer] :client_side_monitoring_port (31000)
161
+ # Required for publishing client metrics. The port that the client side monitoring
162
+ # agent is running on, where client metrics will be published via UDP.
163
+ #
164
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
165
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
166
+ # will use the Client Side Monitoring Agent Publisher.
167
+ #
168
+ # @option options [Boolean] :convert_params (true)
169
+ # When `true`, an attempt is made to coerce request parameters into
170
+ # the required types.
171
+ #
172
+ # @option options [Boolean] :correct_clock_skew (true)
173
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
+ # a clock skew correction and retry requests with skewed client clocks.
175
+ #
176
+ # @option options [Boolean] :disable_host_prefix_injection (false)
177
+ # Set to true to disable SDK automatically adding host prefix
178
+ # to default service endpoint when available.
179
+ #
180
+ # @option options [String] :endpoint
181
+ # The client endpoint is normally constructed from the `:region`
182
+ # option. You should only configure an `:endpoint` when connecting
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
184
+ #
185
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
186
+ # Used for the maximum size limit of the LRU cache storing endpoints data
187
+ # for endpoint discovery enabled operations. Defaults to 1000.
188
+ #
189
+ # @option options [Integer] :endpoint_cache_max_threads (10)
190
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
191
+ #
192
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
193
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
194
+ # Use this option to config the time interval in seconds for making
195
+ # requests fetching endpoints information. Defaults to 60 sec.
196
+ #
197
+ # @option options [Boolean] :endpoint_discovery (false)
198
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
199
+ #
200
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
201
+ # The log formatter.
202
+ #
203
+ # @option options [Symbol] :log_level (:info)
204
+ # The log level to send messages to the `:logger` at.
205
+ #
206
+ # @option options [Logger] :logger
207
+ # The Logger instance to send log messages to. If this option
208
+ # is not set, logging will be disabled.
209
+ #
210
+ # @option options [Integer] :max_attempts (3)
211
+ # An integer representing the maximum number attempts that will be made for
212
+ # a single request, including the initial attempt. For example,
213
+ # setting this value to 5 will result in a request being retried up to
214
+ # 4 times. Used in `standard` and `adaptive` retry modes.
215
+ #
216
+ # @option options [String] :profile ("default")
217
+ # Used when loading credentials from the shared credentials file
218
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
219
+ #
220
+ # @option options [Proc] :retry_backoff
221
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
222
+ # This option is only used in the `legacy` retry mode.
223
+ #
224
+ # @option options [Float] :retry_base_delay (0.3)
225
+ # The base delay in seconds used by the default backoff function. This option
226
+ # is only used in the `legacy` retry mode.
227
+ #
228
+ # @option options [Symbol] :retry_jitter (:none)
229
+ # A delay randomiser function used by the default backoff function.
230
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
231
+ # otherwise a Proc that takes and returns a number. This option is only used
232
+ # in the `legacy` retry mode.
233
+ #
234
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
235
+ #
236
+ # @option options [Integer] :retry_limit (3)
237
+ # The maximum number of times to retry failed requests. Only
238
+ # ~ 500 level server errors and certain ~ 400 level client errors
239
+ # are retried. Generally, these are throttling errors, data
240
+ # checksum errors, networking errors, timeout errors, auth errors,
241
+ # endpoint discovery, and errors from expired credentials.
242
+ # This option is only used in the `legacy` retry mode.
243
+ #
244
+ # @option options [Integer] :retry_max_delay (0)
245
+ # The maximum number of seconds to delay between retries (0 for no limit)
246
+ # used by the default backoff function. This option is only used in the
247
+ # `legacy` retry mode.
248
+ #
249
+ # @option options [String] :retry_mode ("legacy")
250
+ # Specifies which retry algorithm to use. Values are:
251
+ #
252
+ # * `legacy` - The pre-existing retry behavior. This is default value if
253
+ # no retry mode is provided.
254
+ #
255
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
256
+ # This includes support for retry quotas, which limit the number of
257
+ # unsuccessful retries a client can make.
258
+ #
259
+ # * `adaptive` - An experimental retry mode that includes all the
260
+ # functionality of `standard` mode along with automatic client side
261
+ # throttling. This is a provisional mode that may change behavior
262
+ # in the future.
263
+ #
264
+ #
265
+ # @option options [String] :secret_access_key
266
+ #
267
+ # @option options [String] :session_token
268
+ #
269
+ # @option options [Boolean] :stub_responses (false)
270
+ # Causes the client to return stubbed responses. By default
271
+ # fake responses are generated and returned. You can specify
272
+ # the response data to return or errors to raise by calling
273
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
274
+ #
275
+ # ** Please note ** When response stubbing is enabled, no HTTP
276
+ # requests are made, and retries are disabled.
277
+ #
278
+ # @option options [Boolean] :validate_params (true)
279
+ # When `true`, request parameters are validated before
280
+ # sending the request.
281
+ #
282
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
283
+ # requests through. Formatted like 'http://proxy.com:123'.
284
+ #
285
+ # @option options [Float] :http_open_timeout (15) The number of
286
+ # seconds to wait when opening a HTTP session before raising a
287
+ # `Timeout::Error`.
288
+ #
289
+ # @option options [Integer] :http_read_timeout (60) The default
290
+ # number of seconds to wait for response data. This value can
291
+ # safely be set per-request on the session.
292
+ #
293
+ # @option options [Float] :http_idle_timeout (5) The number of
294
+ # seconds a connection is allowed to sit idle before it is
295
+ # considered stale. Stale connections are closed and removed
296
+ # from the pool before making a request.
297
+ #
298
+ # @option options [Float] :http_continue_timeout (1) The number of
299
+ # seconds to wait for a 100-continue response before sending the
300
+ # request body. This option has no effect unless the request has
301
+ # "Expect" header set to "100-continue". Defaults to `nil` which
302
+ # disables this behaviour. This value can safely be set per
303
+ # request on the session.
304
+ #
305
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
306
+ # HTTP debug output will be sent to the `:logger`.
307
+ #
308
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
309
+ # SSL peer certificates are verified when establishing a
310
+ # connection.
311
+ #
312
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
313
+ # certificate authority bundle file that should be used when
314
+ # verifying peer certificates. If you do not pass
315
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
316
+ # will be used if available.
317
+ #
318
+ # @option options [String] :ssl_ca_directory Full path of the
319
+ # directory that contains the unbundled SSL certificate
320
+ # authority files for verifying peer certificates. If you do
321
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
322
+ # system default will be used if available.
323
+ #
324
+ def initialize(*args)
325
+ super
326
+ end
327
+
328
+ # @!group API Operations
329
+
330
+ # Allows the remote domain owner to accept an inbound cross-cluster
331
+ # connection request.
332
+ #
333
+ # @option params [required, String] :connection_id
334
+ # The ID of the inbound connection you want to accept.
335
+ #
336
+ # @return [Types::AcceptInboundConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
337
+ #
338
+ # * {Types::AcceptInboundConnectionResponse#connection #connection} => Types::InboundConnection
339
+ #
340
+ # @example Request syntax with placeholder values
341
+ #
342
+ # resp = client.accept_inbound_connection({
343
+ # connection_id: "ConnectionId", # required
344
+ # })
345
+ #
346
+ # @example Response structure
347
+ #
348
+ # resp.connection.local_domain_info.aws_domain_information.owner_id #=> String
349
+ # resp.connection.local_domain_info.aws_domain_information.domain_name #=> String
350
+ # resp.connection.local_domain_info.aws_domain_information.region #=> String
351
+ # resp.connection.remote_domain_info.aws_domain_information.owner_id #=> String
352
+ # resp.connection.remote_domain_info.aws_domain_information.domain_name #=> String
353
+ # resp.connection.remote_domain_info.aws_domain_information.region #=> String
354
+ # resp.connection.connection_id #=> String
355
+ # resp.connection.connection_status.status_code #=> String, one of "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED"
356
+ # resp.connection.connection_status.message #=> String
357
+ #
358
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AcceptInboundConnection AWS API Documentation
359
+ #
360
+ # @overload accept_inbound_connection(params = {})
361
+ # @param [Hash] params ({})
362
+ def accept_inbound_connection(params = {}, options = {})
363
+ req = build_request(:accept_inbound_connection, params)
364
+ req.send_request(options)
365
+ end
366
+
367
+ # Attaches tags to an existing domain. Tags are a set of case-sensitive
368
+ # key value pairs. An domain can have up to 10 tags. See [ Tagging
369
+ # Amazon OpenSearch Service domains][1] for more information.
370
+ #
371
+ #
372
+ #
373
+ # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging
374
+ #
375
+ # @option params [required, String] :arn
376
+ # Specify the `ARN` of the domain you want to add tags to.
377
+ #
378
+ # @option params [required, Array<Types::Tag>] :tag_list
379
+ # List of `Tag` to add to the domain.
380
+ #
381
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
382
+ #
383
+ # @example Request syntax with placeholder values
384
+ #
385
+ # resp = client.add_tags({
386
+ # arn: "ARN", # required
387
+ # tag_list: [ # required
388
+ # {
389
+ # key: "TagKey", # required
390
+ # value: "TagValue", # required
391
+ # },
392
+ # ],
393
+ # })
394
+ #
395
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddTags AWS API Documentation
396
+ #
397
+ # @overload add_tags(params = {})
398
+ # @param [Hash] params ({})
399
+ def add_tags(params = {}, options = {})
400
+ req = build_request(:add_tags, params)
401
+ req.send_request(options)
402
+ end
403
+
404
+ # Associates a package with an Amazon OpenSearch Service domain.
405
+ #
406
+ # @option params [required, String] :package_id
407
+ # Internal ID of the package to associate with a domain. Use
408
+ # `DescribePackages` to find this value.
409
+ #
410
+ # @option params [required, String] :domain_name
411
+ # The name of the domain to associate the package with.
412
+ #
413
+ # @return [Types::AssociatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
414
+ #
415
+ # * {Types::AssociatePackageResponse#domain_package_details #domain_package_details} => Types::DomainPackageDetails
416
+ #
417
+ # @example Request syntax with placeholder values
418
+ #
419
+ # resp = client.associate_package({
420
+ # package_id: "PackageID", # required
421
+ # domain_name: "DomainName", # required
422
+ # })
423
+ #
424
+ # @example Response structure
425
+ #
426
+ # resp.domain_package_details.package_id #=> String
427
+ # resp.domain_package_details.package_name #=> String
428
+ # resp.domain_package_details.package_type #=> String, one of "TXT-DICTIONARY"
429
+ # resp.domain_package_details.last_updated #=> Time
430
+ # resp.domain_package_details.domain_name #=> String
431
+ # resp.domain_package_details.domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
432
+ # resp.domain_package_details.package_version #=> String
433
+ # resp.domain_package_details.reference_path #=> String
434
+ # resp.domain_package_details.error_details.error_type #=> String
435
+ # resp.domain_package_details.error_details.error_message #=> String
436
+ #
437
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AssociatePackage AWS API Documentation
438
+ #
439
+ # @overload associate_package(params = {})
440
+ # @param [Hash] params ({})
441
+ def associate_package(params = {}, options = {})
442
+ req = build_request(:associate_package, params)
443
+ req.send_request(options)
444
+ end
445
+
446
+ # Cancels a scheduled service software update for an Amazon OpenSearch
447
+ # Service domain. You can only perform this operation before the
448
+ # `AutomatedUpdateDate` and when the `UpdateStatus` is in the
449
+ # `PENDING_UPDATE` state.
450
+ #
451
+ # @option params [required, String] :domain_name
452
+ # The name of the domain that you want to stop the latest service
453
+ # software update on.
454
+ #
455
+ # @return [Types::CancelServiceSoftwareUpdateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
456
+ #
457
+ # * {Types::CancelServiceSoftwareUpdateResponse#service_software_options #service_software_options} => Types::ServiceSoftwareOptions
458
+ #
459
+ # @example Request syntax with placeholder values
460
+ #
461
+ # resp = client.cancel_service_software_update({
462
+ # domain_name: "DomainName", # required
463
+ # })
464
+ #
465
+ # @example Response structure
466
+ #
467
+ # resp.service_software_options.current_version #=> String
468
+ # resp.service_software_options.new_version #=> String
469
+ # resp.service_software_options.update_available #=> Boolean
470
+ # resp.service_software_options.cancellable #=> Boolean
471
+ # resp.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
472
+ # resp.service_software_options.description #=> String
473
+ # resp.service_software_options.automated_update_date #=> Time
474
+ # resp.service_software_options.optional_deployment #=> Boolean
475
+ #
476
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelServiceSoftwareUpdate AWS API Documentation
477
+ #
478
+ # @overload cancel_service_software_update(params = {})
479
+ # @param [Hash] params ({})
480
+ def cancel_service_software_update(params = {}, options = {})
481
+ req = build_request(:cancel_service_software_update, params)
482
+ req.send_request(options)
483
+ end
484
+
485
+ # Creates a new Amazon OpenSearch Service domain. For more information,
486
+ # see [Creating and managing Amazon OpenSearch Service domains ][1] in
487
+ # the *Amazon OpenSearch Service Developer Guide*.
488
+ #
489
+ #
490
+ #
491
+ # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html
492
+ #
493
+ # @option params [required, String] :domain_name
494
+ # The name of the Amazon OpenSearch Service domain you're creating.
495
+ # Domain names are unique across the domains owned by an account within
496
+ # an AWS region. Domain names must start with a lowercase letter and can
497
+ # contain the following characters: a-z (lowercase), 0-9, and -
498
+ # (hyphen).
499
+ #
500
+ # @option params [String] :engine_version
501
+ # String of format Elasticsearch\_X.Y or OpenSearch\_X.Y to specify the
502
+ # engine version for the Amazon OpenSearch Service domain. For example,
503
+ # "OpenSearch\_1.0" or "Elasticsearch\_7.9". For more information,
504
+ # see [Creating and managing Amazon OpenSearch Service domains ][1].
505
+ #
506
+ #
507
+ #
508
+ # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains
509
+ #
510
+ # @option params [Types::ClusterConfig] :cluster_config
511
+ # Configuration options for a domain. Specifies the instance type and
512
+ # number of instances in the domain.
513
+ #
514
+ # @option params [Types::EBSOptions] :ebs_options
515
+ # Options to enable, disable, and specify the type and size of EBS
516
+ # storage volumes.
517
+ #
518
+ # @option params [String] :access_policies
519
+ # IAM access policy as a JSON-formatted string.
520
+ #
521
+ # @option params [Types::SnapshotOptions] :snapshot_options
522
+ # Option to set time, in UTC format, of the daily automated snapshot.
523
+ # Default value is 0 hours.
524
+ #
525
+ # @option params [Types::VPCOptions] :vpc_options
526
+ # Options to specify the subnets and security groups for a VPC endpoint.
527
+ # For more information, see [Launching your Amazon OpenSearch Service
528
+ # domains using a VPC ][1].
529
+ #
530
+ #
531
+ #
532
+ # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html
533
+ #
534
+ # @option params [Types::CognitoOptions] :cognito_options
535
+ # Options to specify the Cognito user and identity pools for OpenSearch
536
+ # Dashboards authentication. For more information, see [Configuring
537
+ # Amazon Cognito authentication for OpenSearch Dashboards][1].
538
+ #
539
+ #
540
+ #
541
+ # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html
542
+ #
543
+ # @option params [Types::EncryptionAtRestOptions] :encryption_at_rest_options
544
+ # Options for encryption of data at rest.
545
+ #
546
+ # @option params [Types::NodeToNodeEncryptionOptions] :node_to_node_encryption_options
547
+ # Node-to-node encryption options.
548
+ #
549
+ # @option params [Hash<String,String>] :advanced_options
550
+ # Option to allow references to indices in an HTTP request body. Must be
551
+ # `false` when configuring access to individual sub-resources. By
552
+ # default, the value is `true`. See [Advanced cluster parameters ][1]
553
+ # for more information.
554
+ #
555
+ #
556
+ #
557
+ # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
558
+ #
559
+ # @option params [Hash<String,Types::LogPublishingOption>] :log_publishing_options
560
+ # Map of `LogType` and `LogPublishingOption`, each containing options to
561
+ # publish a given type of OpenSearch log.
562
+ #
563
+ # @option params [Types::DomainEndpointOptions] :domain_endpoint_options
564
+ # Options to specify configurations that will be applied to the domain
565
+ # endpoint.
566
+ #
567
+ # @option params [Types::AdvancedSecurityOptionsInput] :advanced_security_options
568
+ # Specifies advanced security options.
569
+ #
570
+ # @option params [Array<Types::Tag>] :tag_list
571
+ # A list of `Tag` added during domain creation.
572
+ #
573
+ # @option params [Types::AutoTuneOptionsInput] :auto_tune_options
574
+ # Specifies Auto-Tune options.
575
+ #
576
+ # @return [Types::CreateDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
577
+ #
578
+ # * {Types::CreateDomainResponse#domain_status #domain_status} => Types::DomainStatus
579
+ #
580
+ # @example Request syntax with placeholder values
581
+ #
582
+ # resp = client.create_domain({
583
+ # domain_name: "DomainName", # required
584
+ # engine_version: "VersionString",
585
+ # cluster_config: {
586
+ # instance_type: "m3.medium.search", # accepts m3.medium.search, m3.large.search, m3.xlarge.search, m3.2xlarge.search, m4.large.search, m4.xlarge.search, m4.2xlarge.search, m4.4xlarge.search, m4.10xlarge.search, m5.large.search, m5.xlarge.search, m5.2xlarge.search, m5.4xlarge.search, m5.12xlarge.search, m5.24xlarge.search, r5.large.search, r5.xlarge.search, r5.2xlarge.search, r5.4xlarge.search, r5.12xlarge.search, r5.24xlarge.search, c5.large.search, c5.xlarge.search, c5.2xlarge.search, c5.4xlarge.search, c5.9xlarge.search, c5.18xlarge.search, t3.nano.search, t3.micro.search, t3.small.search, t3.medium.search, t3.large.search, t3.xlarge.search, t3.2xlarge.search, ultrawarm1.medium.search, ultrawarm1.large.search, ultrawarm1.xlarge.search, t2.micro.search, t2.small.search, t2.medium.search, r3.large.search, r3.xlarge.search, r3.2xlarge.search, r3.4xlarge.search, r3.8xlarge.search, i2.xlarge.search, i2.2xlarge.search, d2.xlarge.search, d2.2xlarge.search, d2.4xlarge.search, d2.8xlarge.search, c4.large.search, c4.xlarge.search, c4.2xlarge.search, c4.4xlarge.search, c4.8xlarge.search, r4.large.search, r4.xlarge.search, r4.2xlarge.search, r4.4xlarge.search, r4.8xlarge.search, r4.16xlarge.search, i3.large.search, i3.xlarge.search, i3.2xlarge.search, i3.4xlarge.search, i3.8xlarge.search, i3.16xlarge.search, r6g.large.search, r6g.xlarge.search, r6g.2xlarge.search, r6g.4xlarge.search, r6g.8xlarge.search, r6g.12xlarge.search, m6g.large.search, m6g.xlarge.search, m6g.2xlarge.search, m6g.4xlarge.search, m6g.8xlarge.search, m6g.12xlarge.search, c6g.large.search, c6g.xlarge.search, c6g.2xlarge.search, c6g.4xlarge.search, c6g.8xlarge.search, c6g.12xlarge.search, r6gd.large.search, r6gd.xlarge.search, r6gd.2xlarge.search, r6gd.4xlarge.search, r6gd.8xlarge.search, r6gd.12xlarge.search, r6gd.16xlarge.search, t4g.small.search, t4g.medium.search
587
+ # instance_count: 1,
588
+ # dedicated_master_enabled: false,
589
+ # zone_awareness_enabled: false,
590
+ # zone_awareness_config: {
591
+ # availability_zone_count: 1,
592
+ # },
593
+ # dedicated_master_type: "m3.medium.search", # accepts m3.medium.search, m3.large.search, m3.xlarge.search, m3.2xlarge.search, m4.large.search, m4.xlarge.search, m4.2xlarge.search, m4.4xlarge.search, m4.10xlarge.search, m5.large.search, m5.xlarge.search, m5.2xlarge.search, m5.4xlarge.search, m5.12xlarge.search, m5.24xlarge.search, r5.large.search, r5.xlarge.search, r5.2xlarge.search, r5.4xlarge.search, r5.12xlarge.search, r5.24xlarge.search, c5.large.search, c5.xlarge.search, c5.2xlarge.search, c5.4xlarge.search, c5.9xlarge.search, c5.18xlarge.search, t3.nano.search, t3.micro.search, t3.small.search, t3.medium.search, t3.large.search, t3.xlarge.search, t3.2xlarge.search, ultrawarm1.medium.search, ultrawarm1.large.search, ultrawarm1.xlarge.search, t2.micro.search, t2.small.search, t2.medium.search, r3.large.search, r3.xlarge.search, r3.2xlarge.search, r3.4xlarge.search, r3.8xlarge.search, i2.xlarge.search, i2.2xlarge.search, d2.xlarge.search, d2.2xlarge.search, d2.4xlarge.search, d2.8xlarge.search, c4.large.search, c4.xlarge.search, c4.2xlarge.search, c4.4xlarge.search, c4.8xlarge.search, r4.large.search, r4.xlarge.search, r4.2xlarge.search, r4.4xlarge.search, r4.8xlarge.search, r4.16xlarge.search, i3.large.search, i3.xlarge.search, i3.2xlarge.search, i3.4xlarge.search, i3.8xlarge.search, i3.16xlarge.search, r6g.large.search, r6g.xlarge.search, r6g.2xlarge.search, r6g.4xlarge.search, r6g.8xlarge.search, r6g.12xlarge.search, m6g.large.search, m6g.xlarge.search, m6g.2xlarge.search, m6g.4xlarge.search, m6g.8xlarge.search, m6g.12xlarge.search, c6g.large.search, c6g.xlarge.search, c6g.2xlarge.search, c6g.4xlarge.search, c6g.8xlarge.search, c6g.12xlarge.search, r6gd.large.search, r6gd.xlarge.search, r6gd.2xlarge.search, r6gd.4xlarge.search, r6gd.8xlarge.search, r6gd.12xlarge.search, r6gd.16xlarge.search, t4g.small.search, t4g.medium.search
594
+ # dedicated_master_count: 1,
595
+ # warm_enabled: false,
596
+ # warm_type: "ultrawarm1.medium.search", # accepts ultrawarm1.medium.search, ultrawarm1.large.search, ultrawarm1.xlarge.search
597
+ # warm_count: 1,
598
+ # cold_storage_options: {
599
+ # enabled: false, # required
600
+ # },
601
+ # },
602
+ # ebs_options: {
603
+ # ebs_enabled: false,
604
+ # volume_type: "standard", # accepts standard, gp2, io1
605
+ # volume_size: 1,
606
+ # iops: 1,
607
+ # },
608
+ # access_policies: "PolicyDocument",
609
+ # snapshot_options: {
610
+ # automated_snapshot_start_hour: 1,
611
+ # },
612
+ # vpc_options: {
613
+ # subnet_ids: ["String"],
614
+ # security_group_ids: ["String"],
615
+ # },
616
+ # cognito_options: {
617
+ # enabled: false,
618
+ # user_pool_id: "UserPoolId",
619
+ # identity_pool_id: "IdentityPoolId",
620
+ # role_arn: "RoleArn",
621
+ # },
622
+ # encryption_at_rest_options: {
623
+ # enabled: false,
624
+ # kms_key_id: "KmsKeyId",
625
+ # },
626
+ # node_to_node_encryption_options: {
627
+ # enabled: false,
628
+ # },
629
+ # advanced_options: {
630
+ # "String" => "String",
631
+ # },
632
+ # log_publishing_options: {
633
+ # "INDEX_SLOW_LOGS" => {
634
+ # cloud_watch_logs_log_group_arn: "CloudWatchLogsLogGroupArn",
635
+ # enabled: false,
636
+ # },
637
+ # },
638
+ # domain_endpoint_options: {
639
+ # enforce_https: false,
640
+ # tls_security_policy: "Policy-Min-TLS-1-0-2019-07", # accepts Policy-Min-TLS-1-0-2019-07, Policy-Min-TLS-1-2-2019-07
641
+ # custom_endpoint_enabled: false,
642
+ # custom_endpoint: "DomainNameFqdn",
643
+ # custom_endpoint_certificate_arn: "ARN",
644
+ # },
645
+ # advanced_security_options: {
646
+ # enabled: false,
647
+ # internal_user_database_enabled: false,
648
+ # master_user_options: {
649
+ # master_user_arn: "ARN",
650
+ # master_user_name: "Username",
651
+ # master_user_password: "Password",
652
+ # },
653
+ # saml_options: {
654
+ # enabled: false,
655
+ # idp: {
656
+ # metadata_content: "SAMLMetadata", # required
657
+ # entity_id: "SAMLEntityId", # required
658
+ # },
659
+ # master_user_name: "Username",
660
+ # master_backend_role: "BackendRole",
661
+ # subject_key: "String",
662
+ # roles_key: "String",
663
+ # session_timeout_minutes: 1,
664
+ # },
665
+ # },
666
+ # tag_list: [
667
+ # {
668
+ # key: "TagKey", # required
669
+ # value: "TagValue", # required
670
+ # },
671
+ # ],
672
+ # auto_tune_options: {
673
+ # desired_state: "ENABLED", # accepts ENABLED, DISABLED
674
+ # maintenance_schedules: [
675
+ # {
676
+ # start_at: Time.now,
677
+ # duration: {
678
+ # value: 1,
679
+ # unit: "HOURS", # accepts HOURS
680
+ # },
681
+ # cron_expression_for_recurrence: "String",
682
+ # },
683
+ # ],
684
+ # },
685
+ # })
686
+ #
687
+ # @example Response structure
688
+ #
689
+ # resp.domain_status.domain_id #=> String
690
+ # resp.domain_status.domain_name #=> String
691
+ # resp.domain_status.arn #=> String
692
+ # resp.domain_status.created #=> Boolean
693
+ # resp.domain_status.deleted #=> Boolean
694
+ # resp.domain_status.endpoint #=> String
695
+ # resp.domain_status.endpoints #=> Hash
696
+ # resp.domain_status.endpoints["String"] #=> String
697
+ # resp.domain_status.processing #=> Boolean
698
+ # resp.domain_status.upgrade_processing #=> Boolean
699
+ # resp.domain_status.engine_version #=> String
700
+ # resp.domain_status.cluster_config.instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
701
+ # resp.domain_status.cluster_config.instance_count #=> Integer
702
+ # resp.domain_status.cluster_config.dedicated_master_enabled #=> Boolean
703
+ # resp.domain_status.cluster_config.zone_awareness_enabled #=> Boolean
704
+ # resp.domain_status.cluster_config.zone_awareness_config.availability_zone_count #=> Integer
705
+ # resp.domain_status.cluster_config.dedicated_master_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
706
+ # resp.domain_status.cluster_config.dedicated_master_count #=> Integer
707
+ # resp.domain_status.cluster_config.warm_enabled #=> Boolean
708
+ # resp.domain_status.cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
709
+ # resp.domain_status.cluster_config.warm_count #=> Integer
710
+ # resp.domain_status.cluster_config.cold_storage_options.enabled #=> Boolean
711
+ # resp.domain_status.ebs_options.ebs_enabled #=> Boolean
712
+ # resp.domain_status.ebs_options.volume_type #=> String, one of "standard", "gp2", "io1"
713
+ # resp.domain_status.ebs_options.volume_size #=> Integer
714
+ # resp.domain_status.ebs_options.iops #=> Integer
715
+ # resp.domain_status.access_policies #=> String
716
+ # resp.domain_status.snapshot_options.automated_snapshot_start_hour #=> Integer
717
+ # resp.domain_status.vpc_options.vpc_id #=> String
718
+ # resp.domain_status.vpc_options.subnet_ids #=> Array
719
+ # resp.domain_status.vpc_options.subnet_ids[0] #=> String
720
+ # resp.domain_status.vpc_options.availability_zones #=> Array
721
+ # resp.domain_status.vpc_options.availability_zones[0] #=> String
722
+ # resp.domain_status.vpc_options.security_group_ids #=> Array
723
+ # resp.domain_status.vpc_options.security_group_ids[0] #=> String
724
+ # resp.domain_status.cognito_options.enabled #=> Boolean
725
+ # resp.domain_status.cognito_options.user_pool_id #=> String
726
+ # resp.domain_status.cognito_options.identity_pool_id #=> String
727
+ # resp.domain_status.cognito_options.role_arn #=> String
728
+ # resp.domain_status.encryption_at_rest_options.enabled #=> Boolean
729
+ # resp.domain_status.encryption_at_rest_options.kms_key_id #=> String
730
+ # resp.domain_status.node_to_node_encryption_options.enabled #=> Boolean
731
+ # resp.domain_status.advanced_options #=> Hash
732
+ # resp.domain_status.advanced_options["String"] #=> String
733
+ # resp.domain_status.log_publishing_options #=> Hash
734
+ # resp.domain_status.log_publishing_options["LogType"].cloud_watch_logs_log_group_arn #=> String
735
+ # resp.domain_status.log_publishing_options["LogType"].enabled #=> Boolean
736
+ # resp.domain_status.service_software_options.current_version #=> String
737
+ # resp.domain_status.service_software_options.new_version #=> String
738
+ # resp.domain_status.service_software_options.update_available #=> Boolean
739
+ # resp.domain_status.service_software_options.cancellable #=> Boolean
740
+ # resp.domain_status.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
741
+ # resp.domain_status.service_software_options.description #=> String
742
+ # resp.domain_status.service_software_options.automated_update_date #=> Time
743
+ # resp.domain_status.service_software_options.optional_deployment #=> Boolean
744
+ # resp.domain_status.domain_endpoint_options.enforce_https #=> Boolean
745
+ # 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"
746
+ # resp.domain_status.domain_endpoint_options.custom_endpoint_enabled #=> Boolean
747
+ # resp.domain_status.domain_endpoint_options.custom_endpoint #=> String
748
+ # resp.domain_status.domain_endpoint_options.custom_endpoint_certificate_arn #=> String
749
+ # resp.domain_status.advanced_security_options.enabled #=> Boolean
750
+ # resp.domain_status.advanced_security_options.internal_user_database_enabled #=> Boolean
751
+ # resp.domain_status.advanced_security_options.saml_options.enabled #=> Boolean
752
+ # resp.domain_status.advanced_security_options.saml_options.idp.metadata_content #=> String
753
+ # resp.domain_status.advanced_security_options.saml_options.idp.entity_id #=> String
754
+ # resp.domain_status.advanced_security_options.saml_options.subject_key #=> String
755
+ # resp.domain_status.advanced_security_options.saml_options.roles_key #=> String
756
+ # resp.domain_status.advanced_security_options.saml_options.session_timeout_minutes #=> Integer
757
+ # resp.domain_status.auto_tune_options.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
758
+ # resp.domain_status.auto_tune_options.error_message #=> String
759
+ #
760
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateDomain AWS API Documentation
761
+ #
762
+ # @overload create_domain(params = {})
763
+ # @param [Hash] params ({})
764
+ def create_domain(params = {}, options = {})
765
+ req = build_request(:create_domain, params)
766
+ req.send_request(options)
767
+ end
768
+
769
+ # Creates a new cross-cluster connection from a local OpenSearch domain
770
+ # to a remote OpenSearch domain.
771
+ #
772
+ # @option params [required, Types::DomainInformationContainer] :local_domain_info
773
+ # The ` AWSDomainInformation ` for the local OpenSearch domain.
774
+ #
775
+ # @option params [required, Types::DomainInformationContainer] :remote_domain_info
776
+ # The ` AWSDomainInformation ` for the remote OpenSearch domain.
777
+ #
778
+ # @option params [required, String] :connection_alias
779
+ # The connection alias used used by the customer for this cross-cluster
780
+ # connection.
781
+ #
782
+ # @return [Types::CreateOutboundConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
783
+ #
784
+ # * {Types::CreateOutboundConnectionResponse#local_domain_info #local_domain_info} => Types::DomainInformationContainer
785
+ # * {Types::CreateOutboundConnectionResponse#remote_domain_info #remote_domain_info} => Types::DomainInformationContainer
786
+ # * {Types::CreateOutboundConnectionResponse#connection_alias #connection_alias} => String
787
+ # * {Types::CreateOutboundConnectionResponse#connection_status #connection_status} => Types::OutboundConnectionStatus
788
+ # * {Types::CreateOutboundConnectionResponse#connection_id #connection_id} => String
789
+ #
790
+ # @example Request syntax with placeholder values
791
+ #
792
+ # resp = client.create_outbound_connection({
793
+ # local_domain_info: { # required
794
+ # aws_domain_information: {
795
+ # owner_id: "OwnerId",
796
+ # domain_name: "DomainName", # required
797
+ # region: "Region",
798
+ # },
799
+ # },
800
+ # remote_domain_info: { # required
801
+ # aws_domain_information: {
802
+ # owner_id: "OwnerId",
803
+ # domain_name: "DomainName", # required
804
+ # region: "Region",
805
+ # },
806
+ # },
807
+ # connection_alias: "ConnectionAlias", # required
808
+ # })
809
+ #
810
+ # @example Response structure
811
+ #
812
+ # resp.local_domain_info.aws_domain_information.owner_id #=> String
813
+ # resp.local_domain_info.aws_domain_information.domain_name #=> String
814
+ # resp.local_domain_info.aws_domain_information.region #=> String
815
+ # resp.remote_domain_info.aws_domain_information.owner_id #=> String
816
+ # resp.remote_domain_info.aws_domain_information.domain_name #=> String
817
+ # resp.remote_domain_info.aws_domain_information.region #=> String
818
+ # resp.connection_alias #=> String
819
+ # resp.connection_status.status_code #=> String, one of "VALIDATING", "VALIDATION_FAILED", "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED"
820
+ # resp.connection_status.message #=> String
821
+ # resp.connection_id #=> String
822
+ #
823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateOutboundConnection AWS API Documentation
824
+ #
825
+ # @overload create_outbound_connection(params = {})
826
+ # @param [Hash] params ({})
827
+ def create_outbound_connection(params = {}, options = {})
828
+ req = build_request(:create_outbound_connection, params)
829
+ req.send_request(options)
830
+ end
831
+
832
+ # Create a package for use with Amazon OpenSearch Service domains.
833
+ #
834
+ # @option params [required, String] :package_name
835
+ # Unique identifier for the package.
836
+ #
837
+ # @option params [required, String] :package_type
838
+ # Type of package. Currently supports only TXT-DICTIONARY.
839
+ #
840
+ # @option params [String] :package_description
841
+ # Description of the package.
842
+ #
843
+ # @option params [required, Types::PackageSource] :package_source
844
+ # The Amazon S3 location from which to import the package.
845
+ #
846
+ # @return [Types::CreatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
847
+ #
848
+ # * {Types::CreatePackageResponse#package_details #package_details} => Types::PackageDetails
849
+ #
850
+ # @example Request syntax with placeholder values
851
+ #
852
+ # resp = client.create_package({
853
+ # package_name: "PackageName", # required
854
+ # package_type: "TXT-DICTIONARY", # required, accepts TXT-DICTIONARY
855
+ # package_description: "PackageDescription",
856
+ # package_source: { # required
857
+ # s3_bucket_name: "S3BucketName",
858
+ # s3_key: "S3Key",
859
+ # },
860
+ # })
861
+ #
862
+ # @example Response structure
863
+ #
864
+ # resp.package_details.package_id #=> String
865
+ # resp.package_details.package_name #=> String
866
+ # resp.package_details.package_type #=> String, one of "TXT-DICTIONARY"
867
+ # resp.package_details.package_description #=> String
868
+ # resp.package_details.package_status #=> String, one of "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED"
869
+ # resp.package_details.created_at #=> Time
870
+ # resp.package_details.last_updated_at #=> Time
871
+ # resp.package_details.available_package_version #=> String
872
+ # resp.package_details.error_details.error_type #=> String
873
+ # resp.package_details.error_details.error_message #=> String
874
+ #
875
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreatePackage AWS API Documentation
876
+ #
877
+ # @overload create_package(params = {})
878
+ # @param [Hash] params ({})
879
+ def create_package(params = {}, options = {})
880
+ req = build_request(:create_package, params)
881
+ req.send_request(options)
882
+ end
883
+
884
+ # Permanently deletes the specified domain and all of its data. Once a
885
+ # domain is deleted, it cannot be recovered.
886
+ #
887
+ # @option params [required, String] :domain_name
888
+ # The name of the domain you want to permanently delete.
889
+ #
890
+ # @return [Types::DeleteDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
891
+ #
892
+ # * {Types::DeleteDomainResponse#domain_status #domain_status} => Types::DomainStatus
893
+ #
894
+ # @example Request syntax with placeholder values
895
+ #
896
+ # resp = client.delete_domain({
897
+ # domain_name: "DomainName", # required
898
+ # })
899
+ #
900
+ # @example Response structure
901
+ #
902
+ # resp.domain_status.domain_id #=> String
903
+ # resp.domain_status.domain_name #=> String
904
+ # resp.domain_status.arn #=> String
905
+ # resp.domain_status.created #=> Boolean
906
+ # resp.domain_status.deleted #=> Boolean
907
+ # resp.domain_status.endpoint #=> String
908
+ # resp.domain_status.endpoints #=> Hash
909
+ # resp.domain_status.endpoints["String"] #=> String
910
+ # resp.domain_status.processing #=> Boolean
911
+ # resp.domain_status.upgrade_processing #=> Boolean
912
+ # resp.domain_status.engine_version #=> String
913
+ # resp.domain_status.cluster_config.instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
914
+ # resp.domain_status.cluster_config.instance_count #=> Integer
915
+ # resp.domain_status.cluster_config.dedicated_master_enabled #=> Boolean
916
+ # resp.domain_status.cluster_config.zone_awareness_enabled #=> Boolean
917
+ # resp.domain_status.cluster_config.zone_awareness_config.availability_zone_count #=> Integer
918
+ # resp.domain_status.cluster_config.dedicated_master_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
919
+ # resp.domain_status.cluster_config.dedicated_master_count #=> Integer
920
+ # resp.domain_status.cluster_config.warm_enabled #=> Boolean
921
+ # resp.domain_status.cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
922
+ # resp.domain_status.cluster_config.warm_count #=> Integer
923
+ # resp.domain_status.cluster_config.cold_storage_options.enabled #=> Boolean
924
+ # resp.domain_status.ebs_options.ebs_enabled #=> Boolean
925
+ # resp.domain_status.ebs_options.volume_type #=> String, one of "standard", "gp2", "io1"
926
+ # resp.domain_status.ebs_options.volume_size #=> Integer
927
+ # resp.domain_status.ebs_options.iops #=> Integer
928
+ # resp.domain_status.access_policies #=> String
929
+ # resp.domain_status.snapshot_options.automated_snapshot_start_hour #=> Integer
930
+ # resp.domain_status.vpc_options.vpc_id #=> String
931
+ # resp.domain_status.vpc_options.subnet_ids #=> Array
932
+ # resp.domain_status.vpc_options.subnet_ids[0] #=> String
933
+ # resp.domain_status.vpc_options.availability_zones #=> Array
934
+ # resp.domain_status.vpc_options.availability_zones[0] #=> String
935
+ # resp.domain_status.vpc_options.security_group_ids #=> Array
936
+ # resp.domain_status.vpc_options.security_group_ids[0] #=> String
937
+ # resp.domain_status.cognito_options.enabled #=> Boolean
938
+ # resp.domain_status.cognito_options.user_pool_id #=> String
939
+ # resp.domain_status.cognito_options.identity_pool_id #=> String
940
+ # resp.domain_status.cognito_options.role_arn #=> String
941
+ # resp.domain_status.encryption_at_rest_options.enabled #=> Boolean
942
+ # resp.domain_status.encryption_at_rest_options.kms_key_id #=> String
943
+ # resp.domain_status.node_to_node_encryption_options.enabled #=> Boolean
944
+ # resp.domain_status.advanced_options #=> Hash
945
+ # resp.domain_status.advanced_options["String"] #=> String
946
+ # resp.domain_status.log_publishing_options #=> Hash
947
+ # resp.domain_status.log_publishing_options["LogType"].cloud_watch_logs_log_group_arn #=> String
948
+ # resp.domain_status.log_publishing_options["LogType"].enabled #=> Boolean
949
+ # resp.domain_status.service_software_options.current_version #=> String
950
+ # resp.domain_status.service_software_options.new_version #=> String
951
+ # resp.domain_status.service_software_options.update_available #=> Boolean
952
+ # resp.domain_status.service_software_options.cancellable #=> Boolean
953
+ # resp.domain_status.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
954
+ # resp.domain_status.service_software_options.description #=> String
955
+ # resp.domain_status.service_software_options.automated_update_date #=> Time
956
+ # resp.domain_status.service_software_options.optional_deployment #=> Boolean
957
+ # resp.domain_status.domain_endpoint_options.enforce_https #=> Boolean
958
+ # 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"
959
+ # resp.domain_status.domain_endpoint_options.custom_endpoint_enabled #=> Boolean
960
+ # resp.domain_status.domain_endpoint_options.custom_endpoint #=> String
961
+ # resp.domain_status.domain_endpoint_options.custom_endpoint_certificate_arn #=> String
962
+ # resp.domain_status.advanced_security_options.enabled #=> Boolean
963
+ # resp.domain_status.advanced_security_options.internal_user_database_enabled #=> Boolean
964
+ # resp.domain_status.advanced_security_options.saml_options.enabled #=> Boolean
965
+ # resp.domain_status.advanced_security_options.saml_options.idp.metadata_content #=> String
966
+ # resp.domain_status.advanced_security_options.saml_options.idp.entity_id #=> String
967
+ # resp.domain_status.advanced_security_options.saml_options.subject_key #=> String
968
+ # resp.domain_status.advanced_security_options.saml_options.roles_key #=> String
969
+ # resp.domain_status.advanced_security_options.saml_options.session_timeout_minutes #=> Integer
970
+ # resp.domain_status.auto_tune_options.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
971
+ # resp.domain_status.auto_tune_options.error_message #=> String
972
+ #
973
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDomain AWS API Documentation
974
+ #
975
+ # @overload delete_domain(params = {})
976
+ # @param [Hash] params ({})
977
+ def delete_domain(params = {}, options = {})
978
+ req = build_request(:delete_domain, params)
979
+ req.send_request(options)
980
+ end
981
+
982
+ # Allows the remote domain owner to delete an existing inbound
983
+ # cross-cluster connection.
984
+ #
985
+ # @option params [required, String] :connection_id
986
+ # The ID of the inbound connection to permanently delete.
987
+ #
988
+ # @return [Types::DeleteInboundConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
989
+ #
990
+ # * {Types::DeleteInboundConnectionResponse#connection #connection} => Types::InboundConnection
991
+ #
992
+ # @example Request syntax with placeholder values
993
+ #
994
+ # resp = client.delete_inbound_connection({
995
+ # connection_id: "ConnectionId", # required
996
+ # })
997
+ #
998
+ # @example Response structure
999
+ #
1000
+ # resp.connection.local_domain_info.aws_domain_information.owner_id #=> String
1001
+ # resp.connection.local_domain_info.aws_domain_information.domain_name #=> String
1002
+ # resp.connection.local_domain_info.aws_domain_information.region #=> String
1003
+ # resp.connection.remote_domain_info.aws_domain_information.owner_id #=> String
1004
+ # resp.connection.remote_domain_info.aws_domain_information.domain_name #=> String
1005
+ # resp.connection.remote_domain_info.aws_domain_information.region #=> String
1006
+ # resp.connection.connection_id #=> String
1007
+ # resp.connection.connection_status.status_code #=> String, one of "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED"
1008
+ # resp.connection.connection_status.message #=> String
1009
+ #
1010
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteInboundConnection AWS API Documentation
1011
+ #
1012
+ # @overload delete_inbound_connection(params = {})
1013
+ # @param [Hash] params ({})
1014
+ def delete_inbound_connection(params = {}, options = {})
1015
+ req = build_request(:delete_inbound_connection, params)
1016
+ req.send_request(options)
1017
+ end
1018
+
1019
+ # Allows the local domain owner to delete an existing outbound
1020
+ # cross-cluster connection.
1021
+ #
1022
+ # @option params [required, String] :connection_id
1023
+ # The ID of the outbound connection you want to permanently delete.
1024
+ #
1025
+ # @return [Types::DeleteOutboundConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1026
+ #
1027
+ # * {Types::DeleteOutboundConnectionResponse#connection #connection} => Types::OutboundConnection
1028
+ #
1029
+ # @example Request syntax with placeholder values
1030
+ #
1031
+ # resp = client.delete_outbound_connection({
1032
+ # connection_id: "ConnectionId", # required
1033
+ # })
1034
+ #
1035
+ # @example Response structure
1036
+ #
1037
+ # resp.connection.local_domain_info.aws_domain_information.owner_id #=> String
1038
+ # resp.connection.local_domain_info.aws_domain_information.domain_name #=> String
1039
+ # resp.connection.local_domain_info.aws_domain_information.region #=> String
1040
+ # resp.connection.remote_domain_info.aws_domain_information.owner_id #=> String
1041
+ # resp.connection.remote_domain_info.aws_domain_information.domain_name #=> String
1042
+ # resp.connection.remote_domain_info.aws_domain_information.region #=> String
1043
+ # resp.connection.connection_id #=> String
1044
+ # resp.connection.connection_alias #=> String
1045
+ # resp.connection.connection_status.status_code #=> String, one of "VALIDATING", "VALIDATION_FAILED", "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED"
1046
+ # resp.connection.connection_status.message #=> String
1047
+ #
1048
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteOutboundConnection AWS API Documentation
1049
+ #
1050
+ # @overload delete_outbound_connection(params = {})
1051
+ # @param [Hash] params ({})
1052
+ def delete_outbound_connection(params = {}, options = {})
1053
+ req = build_request(:delete_outbound_connection, params)
1054
+ req.send_request(options)
1055
+ end
1056
+
1057
+ # Deletes the package.
1058
+ #
1059
+ # @option params [required, String] :package_id
1060
+ # The internal ID of the package you want to delete. Use
1061
+ # `DescribePackages` to find this value.
1062
+ #
1063
+ # @return [Types::DeletePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1064
+ #
1065
+ # * {Types::DeletePackageResponse#package_details #package_details} => Types::PackageDetails
1066
+ #
1067
+ # @example Request syntax with placeholder values
1068
+ #
1069
+ # resp = client.delete_package({
1070
+ # package_id: "PackageID", # required
1071
+ # })
1072
+ #
1073
+ # @example Response structure
1074
+ #
1075
+ # resp.package_details.package_id #=> String
1076
+ # resp.package_details.package_name #=> String
1077
+ # resp.package_details.package_type #=> String, one of "TXT-DICTIONARY"
1078
+ # resp.package_details.package_description #=> String
1079
+ # resp.package_details.package_status #=> String, one of "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED"
1080
+ # resp.package_details.created_at #=> Time
1081
+ # resp.package_details.last_updated_at #=> Time
1082
+ # resp.package_details.available_package_version #=> String
1083
+ # resp.package_details.error_details.error_type #=> String
1084
+ # resp.package_details.error_details.error_message #=> String
1085
+ #
1086
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeletePackage AWS API Documentation
1087
+ #
1088
+ # @overload delete_package(params = {})
1089
+ # @param [Hash] params ({})
1090
+ def delete_package(params = {}, options = {})
1091
+ req = build_request(:delete_package, params)
1092
+ req.send_request(options)
1093
+ end
1094
+
1095
+ # Returns domain configuration information about the specified domain,
1096
+ # including the domain ID, domain endpoint, and domain ARN.
1097
+ #
1098
+ # @option params [required, String] :domain_name
1099
+ # The name of the domain for which you want information.
1100
+ #
1101
+ # @return [Types::DescribeDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1102
+ #
1103
+ # * {Types::DescribeDomainResponse#domain_status #domain_status} => Types::DomainStatus
1104
+ #
1105
+ # @example Request syntax with placeholder values
1106
+ #
1107
+ # resp = client.describe_domain({
1108
+ # domain_name: "DomainName", # required
1109
+ # })
1110
+ #
1111
+ # @example Response structure
1112
+ #
1113
+ # resp.domain_status.domain_id #=> String
1114
+ # resp.domain_status.domain_name #=> String
1115
+ # resp.domain_status.arn #=> String
1116
+ # resp.domain_status.created #=> Boolean
1117
+ # resp.domain_status.deleted #=> Boolean
1118
+ # resp.domain_status.endpoint #=> String
1119
+ # resp.domain_status.endpoints #=> Hash
1120
+ # resp.domain_status.endpoints["String"] #=> String
1121
+ # resp.domain_status.processing #=> Boolean
1122
+ # resp.domain_status.upgrade_processing #=> Boolean
1123
+ # resp.domain_status.engine_version #=> String
1124
+ # resp.domain_status.cluster_config.instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
1125
+ # resp.domain_status.cluster_config.instance_count #=> Integer
1126
+ # resp.domain_status.cluster_config.dedicated_master_enabled #=> Boolean
1127
+ # resp.domain_status.cluster_config.zone_awareness_enabled #=> Boolean
1128
+ # resp.domain_status.cluster_config.zone_awareness_config.availability_zone_count #=> Integer
1129
+ # resp.domain_status.cluster_config.dedicated_master_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
1130
+ # resp.domain_status.cluster_config.dedicated_master_count #=> Integer
1131
+ # resp.domain_status.cluster_config.warm_enabled #=> Boolean
1132
+ # resp.domain_status.cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
1133
+ # resp.domain_status.cluster_config.warm_count #=> Integer
1134
+ # resp.domain_status.cluster_config.cold_storage_options.enabled #=> Boolean
1135
+ # resp.domain_status.ebs_options.ebs_enabled #=> Boolean
1136
+ # resp.domain_status.ebs_options.volume_type #=> String, one of "standard", "gp2", "io1"
1137
+ # resp.domain_status.ebs_options.volume_size #=> Integer
1138
+ # resp.domain_status.ebs_options.iops #=> Integer
1139
+ # resp.domain_status.access_policies #=> String
1140
+ # resp.domain_status.snapshot_options.automated_snapshot_start_hour #=> Integer
1141
+ # resp.domain_status.vpc_options.vpc_id #=> String
1142
+ # resp.domain_status.vpc_options.subnet_ids #=> Array
1143
+ # resp.domain_status.vpc_options.subnet_ids[0] #=> String
1144
+ # resp.domain_status.vpc_options.availability_zones #=> Array
1145
+ # resp.domain_status.vpc_options.availability_zones[0] #=> String
1146
+ # resp.domain_status.vpc_options.security_group_ids #=> Array
1147
+ # resp.domain_status.vpc_options.security_group_ids[0] #=> String
1148
+ # resp.domain_status.cognito_options.enabled #=> Boolean
1149
+ # resp.domain_status.cognito_options.user_pool_id #=> String
1150
+ # resp.domain_status.cognito_options.identity_pool_id #=> String
1151
+ # resp.domain_status.cognito_options.role_arn #=> String
1152
+ # resp.domain_status.encryption_at_rest_options.enabled #=> Boolean
1153
+ # resp.domain_status.encryption_at_rest_options.kms_key_id #=> String
1154
+ # resp.domain_status.node_to_node_encryption_options.enabled #=> Boolean
1155
+ # resp.domain_status.advanced_options #=> Hash
1156
+ # resp.domain_status.advanced_options["String"] #=> String
1157
+ # resp.domain_status.log_publishing_options #=> Hash
1158
+ # resp.domain_status.log_publishing_options["LogType"].cloud_watch_logs_log_group_arn #=> String
1159
+ # resp.domain_status.log_publishing_options["LogType"].enabled #=> Boolean
1160
+ # resp.domain_status.service_software_options.current_version #=> String
1161
+ # resp.domain_status.service_software_options.new_version #=> String
1162
+ # resp.domain_status.service_software_options.update_available #=> Boolean
1163
+ # resp.domain_status.service_software_options.cancellable #=> Boolean
1164
+ # resp.domain_status.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
1165
+ # resp.domain_status.service_software_options.description #=> String
1166
+ # resp.domain_status.service_software_options.automated_update_date #=> Time
1167
+ # resp.domain_status.service_software_options.optional_deployment #=> Boolean
1168
+ # resp.domain_status.domain_endpoint_options.enforce_https #=> Boolean
1169
+ # 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"
1170
+ # resp.domain_status.domain_endpoint_options.custom_endpoint_enabled #=> Boolean
1171
+ # resp.domain_status.domain_endpoint_options.custom_endpoint #=> String
1172
+ # resp.domain_status.domain_endpoint_options.custom_endpoint_certificate_arn #=> String
1173
+ # resp.domain_status.advanced_security_options.enabled #=> Boolean
1174
+ # resp.domain_status.advanced_security_options.internal_user_database_enabled #=> Boolean
1175
+ # resp.domain_status.advanced_security_options.saml_options.enabled #=> Boolean
1176
+ # resp.domain_status.advanced_security_options.saml_options.idp.metadata_content #=> String
1177
+ # resp.domain_status.advanced_security_options.saml_options.idp.entity_id #=> String
1178
+ # resp.domain_status.advanced_security_options.saml_options.subject_key #=> String
1179
+ # resp.domain_status.advanced_security_options.saml_options.roles_key #=> String
1180
+ # resp.domain_status.advanced_security_options.saml_options.session_timeout_minutes #=> Integer
1181
+ # resp.domain_status.auto_tune_options.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
1182
+ # resp.domain_status.auto_tune_options.error_message #=> String
1183
+ #
1184
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomain AWS API Documentation
1185
+ #
1186
+ # @overload describe_domain(params = {})
1187
+ # @param [Hash] params ({})
1188
+ def describe_domain(params = {}, options = {})
1189
+ req = build_request(:describe_domain, params)
1190
+ req.send_request(options)
1191
+ end
1192
+
1193
+ # Provides scheduled Auto-Tune action details for the domain, such as
1194
+ # Auto-Tune action type, description, severity, and scheduled date.
1195
+ #
1196
+ # @option params [required, String] :domain_name
1197
+ # The domain name for which you want Auto-Tune action details.
1198
+ #
1199
+ # @option params [Integer] :max_results
1200
+ # Set this value to limit the number of results returned. If not
1201
+ # specified, defaults to 100.
1202
+ #
1203
+ # @option params [String] :next_token
1204
+ # NextToken is sent in case the earlier API call results contain the
1205
+ # NextToken. Used for pagination.
1206
+ #
1207
+ # @return [Types::DescribeDomainAutoTunesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1208
+ #
1209
+ # * {Types::DescribeDomainAutoTunesResponse#auto_tunes #auto_tunes} => Array&lt;Types::AutoTune&gt;
1210
+ # * {Types::DescribeDomainAutoTunesResponse#next_token #next_token} => String
1211
+ #
1212
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1213
+ #
1214
+ # @example Request syntax with placeholder values
1215
+ #
1216
+ # resp = client.describe_domain_auto_tunes({
1217
+ # domain_name: "DomainName", # required
1218
+ # max_results: 1,
1219
+ # next_token: "NextToken",
1220
+ # })
1221
+ #
1222
+ # @example Response structure
1223
+ #
1224
+ # resp.auto_tunes #=> Array
1225
+ # resp.auto_tunes[0].auto_tune_type #=> String, one of "SCHEDULED_ACTION"
1226
+ # resp.auto_tunes[0].auto_tune_details.scheduled_auto_tune_details.date #=> Time
1227
+ # resp.auto_tunes[0].auto_tune_details.scheduled_auto_tune_details.action_type #=> String, one of "JVM_HEAP_SIZE_TUNING", "JVM_YOUNG_GEN_TUNING"
1228
+ # resp.auto_tunes[0].auto_tune_details.scheduled_auto_tune_details.action #=> String
1229
+ # resp.auto_tunes[0].auto_tune_details.scheduled_auto_tune_details.severity #=> String, one of "LOW", "MEDIUM", "HIGH"
1230
+ # resp.next_token #=> String
1231
+ #
1232
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainAutoTunes AWS API Documentation
1233
+ #
1234
+ # @overload describe_domain_auto_tunes(params = {})
1235
+ # @param [Hash] params ({})
1236
+ def describe_domain_auto_tunes(params = {}, options = {})
1237
+ req = build_request(:describe_domain_auto_tunes, params)
1238
+ req.send_request(options)
1239
+ end
1240
+
1241
+ # Provides cluster configuration information about the specified domain,
1242
+ # such as the state, creation date, update version, and update date for
1243
+ # cluster options.
1244
+ #
1245
+ # @option params [required, String] :domain_name
1246
+ # The domain you want to get information about.
1247
+ #
1248
+ # @return [Types::DescribeDomainConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1249
+ #
1250
+ # * {Types::DescribeDomainConfigResponse#domain_config #domain_config} => Types::DomainConfig
1251
+ #
1252
+ # @example Request syntax with placeholder values
1253
+ #
1254
+ # resp = client.describe_domain_config({
1255
+ # domain_name: "DomainName", # required
1256
+ # })
1257
+ #
1258
+ # @example Response structure
1259
+ #
1260
+ # resp.domain_config.engine_version.options #=> String
1261
+ # resp.domain_config.engine_version.status.creation_date #=> Time
1262
+ # resp.domain_config.engine_version.status.update_date #=> Time
1263
+ # resp.domain_config.engine_version.status.update_version #=> Integer
1264
+ # resp.domain_config.engine_version.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
1265
+ # resp.domain_config.engine_version.status.pending_deletion #=> Boolean
1266
+ # resp.domain_config.cluster_config.options.instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
1267
+ # resp.domain_config.cluster_config.options.instance_count #=> Integer
1268
+ # resp.domain_config.cluster_config.options.dedicated_master_enabled #=> Boolean
1269
+ # resp.domain_config.cluster_config.options.zone_awareness_enabled #=> Boolean
1270
+ # resp.domain_config.cluster_config.options.zone_awareness_config.availability_zone_count #=> Integer
1271
+ # resp.domain_config.cluster_config.options.dedicated_master_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
1272
+ # resp.domain_config.cluster_config.options.dedicated_master_count #=> Integer
1273
+ # resp.domain_config.cluster_config.options.warm_enabled #=> Boolean
1274
+ # resp.domain_config.cluster_config.options.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
1275
+ # resp.domain_config.cluster_config.options.warm_count #=> Integer
1276
+ # resp.domain_config.cluster_config.options.cold_storage_options.enabled #=> Boolean
1277
+ # resp.domain_config.cluster_config.status.creation_date #=> Time
1278
+ # resp.domain_config.cluster_config.status.update_date #=> Time
1279
+ # resp.domain_config.cluster_config.status.update_version #=> Integer
1280
+ # resp.domain_config.cluster_config.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
1281
+ # resp.domain_config.cluster_config.status.pending_deletion #=> Boolean
1282
+ # resp.domain_config.ebs_options.options.ebs_enabled #=> Boolean
1283
+ # resp.domain_config.ebs_options.options.volume_type #=> String, one of "standard", "gp2", "io1"
1284
+ # resp.domain_config.ebs_options.options.volume_size #=> Integer
1285
+ # resp.domain_config.ebs_options.options.iops #=> Integer
1286
+ # resp.domain_config.ebs_options.status.creation_date #=> Time
1287
+ # resp.domain_config.ebs_options.status.update_date #=> Time
1288
+ # resp.domain_config.ebs_options.status.update_version #=> Integer
1289
+ # resp.domain_config.ebs_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
1290
+ # resp.domain_config.ebs_options.status.pending_deletion #=> Boolean
1291
+ # resp.domain_config.access_policies.options #=> String
1292
+ # resp.domain_config.access_policies.status.creation_date #=> Time
1293
+ # resp.domain_config.access_policies.status.update_date #=> Time
1294
+ # resp.domain_config.access_policies.status.update_version #=> Integer
1295
+ # resp.domain_config.access_policies.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
1296
+ # resp.domain_config.access_policies.status.pending_deletion #=> Boolean
1297
+ # resp.domain_config.snapshot_options.options.automated_snapshot_start_hour #=> Integer
1298
+ # resp.domain_config.snapshot_options.status.creation_date #=> Time
1299
+ # resp.domain_config.snapshot_options.status.update_date #=> Time
1300
+ # resp.domain_config.snapshot_options.status.update_version #=> Integer
1301
+ # resp.domain_config.snapshot_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
1302
+ # resp.domain_config.snapshot_options.status.pending_deletion #=> Boolean
1303
+ # resp.domain_config.vpc_options.options.vpc_id #=> String
1304
+ # resp.domain_config.vpc_options.options.subnet_ids #=> Array
1305
+ # resp.domain_config.vpc_options.options.subnet_ids[0] #=> String
1306
+ # resp.domain_config.vpc_options.options.availability_zones #=> Array
1307
+ # resp.domain_config.vpc_options.options.availability_zones[0] #=> String
1308
+ # resp.domain_config.vpc_options.options.security_group_ids #=> Array
1309
+ # resp.domain_config.vpc_options.options.security_group_ids[0] #=> String
1310
+ # resp.domain_config.vpc_options.status.creation_date #=> Time
1311
+ # resp.domain_config.vpc_options.status.update_date #=> Time
1312
+ # resp.domain_config.vpc_options.status.update_version #=> Integer
1313
+ # resp.domain_config.vpc_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
1314
+ # resp.domain_config.vpc_options.status.pending_deletion #=> Boolean
1315
+ # resp.domain_config.cognito_options.options.enabled #=> Boolean
1316
+ # resp.domain_config.cognito_options.options.user_pool_id #=> String
1317
+ # resp.domain_config.cognito_options.options.identity_pool_id #=> String
1318
+ # resp.domain_config.cognito_options.options.role_arn #=> String
1319
+ # resp.domain_config.cognito_options.status.creation_date #=> Time
1320
+ # resp.domain_config.cognito_options.status.update_date #=> Time
1321
+ # resp.domain_config.cognito_options.status.update_version #=> Integer
1322
+ # resp.domain_config.cognito_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
1323
+ # resp.domain_config.cognito_options.status.pending_deletion #=> Boolean
1324
+ # resp.domain_config.encryption_at_rest_options.options.enabled #=> Boolean
1325
+ # resp.domain_config.encryption_at_rest_options.options.kms_key_id #=> String
1326
+ # resp.domain_config.encryption_at_rest_options.status.creation_date #=> Time
1327
+ # resp.domain_config.encryption_at_rest_options.status.update_date #=> Time
1328
+ # resp.domain_config.encryption_at_rest_options.status.update_version #=> Integer
1329
+ # resp.domain_config.encryption_at_rest_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
1330
+ # resp.domain_config.encryption_at_rest_options.status.pending_deletion #=> Boolean
1331
+ # resp.domain_config.node_to_node_encryption_options.options.enabled #=> Boolean
1332
+ # resp.domain_config.node_to_node_encryption_options.status.creation_date #=> Time
1333
+ # resp.domain_config.node_to_node_encryption_options.status.update_date #=> Time
1334
+ # resp.domain_config.node_to_node_encryption_options.status.update_version #=> Integer
1335
+ # resp.domain_config.node_to_node_encryption_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
1336
+ # resp.domain_config.node_to_node_encryption_options.status.pending_deletion #=> Boolean
1337
+ # resp.domain_config.advanced_options.options #=> Hash
1338
+ # resp.domain_config.advanced_options.options["String"] #=> String
1339
+ # resp.domain_config.advanced_options.status.creation_date #=> Time
1340
+ # resp.domain_config.advanced_options.status.update_date #=> Time
1341
+ # resp.domain_config.advanced_options.status.update_version #=> Integer
1342
+ # resp.domain_config.advanced_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
1343
+ # resp.domain_config.advanced_options.status.pending_deletion #=> Boolean
1344
+ # resp.domain_config.log_publishing_options.options #=> Hash
1345
+ # resp.domain_config.log_publishing_options.options["LogType"].cloud_watch_logs_log_group_arn #=> String
1346
+ # resp.domain_config.log_publishing_options.options["LogType"].enabled #=> Boolean
1347
+ # resp.domain_config.log_publishing_options.status.creation_date #=> Time
1348
+ # resp.domain_config.log_publishing_options.status.update_date #=> Time
1349
+ # resp.domain_config.log_publishing_options.status.update_version #=> Integer
1350
+ # resp.domain_config.log_publishing_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
1351
+ # resp.domain_config.log_publishing_options.status.pending_deletion #=> Boolean
1352
+ # resp.domain_config.domain_endpoint_options.options.enforce_https #=> Boolean
1353
+ # resp.domain_config.domain_endpoint_options.options.tls_security_policy #=> String, one of "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07"
1354
+ # resp.domain_config.domain_endpoint_options.options.custom_endpoint_enabled #=> Boolean
1355
+ # resp.domain_config.domain_endpoint_options.options.custom_endpoint #=> String
1356
+ # resp.domain_config.domain_endpoint_options.options.custom_endpoint_certificate_arn #=> String
1357
+ # resp.domain_config.domain_endpoint_options.status.creation_date #=> Time
1358
+ # resp.domain_config.domain_endpoint_options.status.update_date #=> Time
1359
+ # resp.domain_config.domain_endpoint_options.status.update_version #=> Integer
1360
+ # resp.domain_config.domain_endpoint_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
1361
+ # resp.domain_config.domain_endpoint_options.status.pending_deletion #=> Boolean
1362
+ # resp.domain_config.advanced_security_options.options.enabled #=> Boolean
1363
+ # resp.domain_config.advanced_security_options.options.internal_user_database_enabled #=> Boolean
1364
+ # resp.domain_config.advanced_security_options.options.saml_options.enabled #=> Boolean
1365
+ # resp.domain_config.advanced_security_options.options.saml_options.idp.metadata_content #=> String
1366
+ # resp.domain_config.advanced_security_options.options.saml_options.idp.entity_id #=> String
1367
+ # resp.domain_config.advanced_security_options.options.saml_options.subject_key #=> String
1368
+ # resp.domain_config.advanced_security_options.options.saml_options.roles_key #=> String
1369
+ # resp.domain_config.advanced_security_options.options.saml_options.session_timeout_minutes #=> Integer
1370
+ # resp.domain_config.advanced_security_options.status.creation_date #=> Time
1371
+ # resp.domain_config.advanced_security_options.status.update_date #=> Time
1372
+ # resp.domain_config.advanced_security_options.status.update_version #=> Integer
1373
+ # resp.domain_config.advanced_security_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
1374
+ # resp.domain_config.advanced_security_options.status.pending_deletion #=> Boolean
1375
+ # resp.domain_config.auto_tune_options.options.desired_state #=> String, one of "ENABLED", "DISABLED"
1376
+ # resp.domain_config.auto_tune_options.options.rollback_on_disable #=> String, one of "NO_ROLLBACK", "DEFAULT_ROLLBACK"
1377
+ # resp.domain_config.auto_tune_options.options.maintenance_schedules #=> Array
1378
+ # resp.domain_config.auto_tune_options.options.maintenance_schedules[0].start_at #=> Time
1379
+ # resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.value #=> Integer
1380
+ # resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.unit #=> String, one of "HOURS"
1381
+ # resp.domain_config.auto_tune_options.options.maintenance_schedules[0].cron_expression_for_recurrence #=> String
1382
+ # resp.domain_config.auto_tune_options.status.creation_date #=> Time
1383
+ # resp.domain_config.auto_tune_options.status.update_date #=> Time
1384
+ # resp.domain_config.auto_tune_options.status.update_version #=> Integer
1385
+ # resp.domain_config.auto_tune_options.status.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
1386
+ # resp.domain_config.auto_tune_options.status.error_message #=> String
1387
+ # resp.domain_config.auto_tune_options.status.pending_deletion #=> Boolean
1388
+ #
1389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainConfig AWS API Documentation
1390
+ #
1391
+ # @overload describe_domain_config(params = {})
1392
+ # @param [Hash] params ({})
1393
+ def describe_domain_config(params = {}, options = {})
1394
+ req = build_request(:describe_domain_config, params)
1395
+ req.send_request(options)
1396
+ end
1397
+
1398
+ # Returns domain configuration information about the specified domains,
1399
+ # including the domain ID, domain endpoint, and domain ARN.
1400
+ #
1401
+ # @option params [required, Array<String>] :domain_names
1402
+ # The domains for which you want information.
1403
+ #
1404
+ # @return [Types::DescribeDomainsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1405
+ #
1406
+ # * {Types::DescribeDomainsResponse#domain_status_list #domain_status_list} => Array&lt;Types::DomainStatus&gt;
1407
+ #
1408
+ # @example Request syntax with placeholder values
1409
+ #
1410
+ # resp = client.describe_domains({
1411
+ # domain_names: ["DomainName"], # required
1412
+ # })
1413
+ #
1414
+ # @example Response structure
1415
+ #
1416
+ # resp.domain_status_list #=> Array
1417
+ # resp.domain_status_list[0].domain_id #=> String
1418
+ # resp.domain_status_list[0].domain_name #=> String
1419
+ # resp.domain_status_list[0].arn #=> String
1420
+ # resp.domain_status_list[0].created #=> Boolean
1421
+ # resp.domain_status_list[0].deleted #=> Boolean
1422
+ # resp.domain_status_list[0].endpoint #=> String
1423
+ # resp.domain_status_list[0].endpoints #=> Hash
1424
+ # resp.domain_status_list[0].endpoints["String"] #=> String
1425
+ # resp.domain_status_list[0].processing #=> Boolean
1426
+ # resp.domain_status_list[0].upgrade_processing #=> Boolean
1427
+ # resp.domain_status_list[0].engine_version #=> String
1428
+ # resp.domain_status_list[0].cluster_config.instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
1429
+ # resp.domain_status_list[0].cluster_config.instance_count #=> Integer
1430
+ # resp.domain_status_list[0].cluster_config.dedicated_master_enabled #=> Boolean
1431
+ # resp.domain_status_list[0].cluster_config.zone_awareness_enabled #=> Boolean
1432
+ # resp.domain_status_list[0].cluster_config.zone_awareness_config.availability_zone_count #=> Integer
1433
+ # resp.domain_status_list[0].cluster_config.dedicated_master_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
1434
+ # resp.domain_status_list[0].cluster_config.dedicated_master_count #=> Integer
1435
+ # resp.domain_status_list[0].cluster_config.warm_enabled #=> Boolean
1436
+ # resp.domain_status_list[0].cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
1437
+ # resp.domain_status_list[0].cluster_config.warm_count #=> Integer
1438
+ # resp.domain_status_list[0].cluster_config.cold_storage_options.enabled #=> Boolean
1439
+ # resp.domain_status_list[0].ebs_options.ebs_enabled #=> Boolean
1440
+ # resp.domain_status_list[0].ebs_options.volume_type #=> String, one of "standard", "gp2", "io1"
1441
+ # resp.domain_status_list[0].ebs_options.volume_size #=> Integer
1442
+ # resp.domain_status_list[0].ebs_options.iops #=> Integer
1443
+ # resp.domain_status_list[0].access_policies #=> String
1444
+ # resp.domain_status_list[0].snapshot_options.automated_snapshot_start_hour #=> Integer
1445
+ # resp.domain_status_list[0].vpc_options.vpc_id #=> String
1446
+ # resp.domain_status_list[0].vpc_options.subnet_ids #=> Array
1447
+ # resp.domain_status_list[0].vpc_options.subnet_ids[0] #=> String
1448
+ # resp.domain_status_list[0].vpc_options.availability_zones #=> Array
1449
+ # resp.domain_status_list[0].vpc_options.availability_zones[0] #=> String
1450
+ # resp.domain_status_list[0].vpc_options.security_group_ids #=> Array
1451
+ # resp.domain_status_list[0].vpc_options.security_group_ids[0] #=> String
1452
+ # resp.domain_status_list[0].cognito_options.enabled #=> Boolean
1453
+ # resp.domain_status_list[0].cognito_options.user_pool_id #=> String
1454
+ # resp.domain_status_list[0].cognito_options.identity_pool_id #=> String
1455
+ # resp.domain_status_list[0].cognito_options.role_arn #=> String
1456
+ # resp.domain_status_list[0].encryption_at_rest_options.enabled #=> Boolean
1457
+ # resp.domain_status_list[0].encryption_at_rest_options.kms_key_id #=> String
1458
+ # resp.domain_status_list[0].node_to_node_encryption_options.enabled #=> Boolean
1459
+ # resp.domain_status_list[0].advanced_options #=> Hash
1460
+ # resp.domain_status_list[0].advanced_options["String"] #=> String
1461
+ # resp.domain_status_list[0].log_publishing_options #=> Hash
1462
+ # resp.domain_status_list[0].log_publishing_options["LogType"].cloud_watch_logs_log_group_arn #=> String
1463
+ # resp.domain_status_list[0].log_publishing_options["LogType"].enabled #=> Boolean
1464
+ # resp.domain_status_list[0].service_software_options.current_version #=> String
1465
+ # resp.domain_status_list[0].service_software_options.new_version #=> String
1466
+ # resp.domain_status_list[0].service_software_options.update_available #=> Boolean
1467
+ # resp.domain_status_list[0].service_software_options.cancellable #=> Boolean
1468
+ # resp.domain_status_list[0].service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
1469
+ # resp.domain_status_list[0].service_software_options.description #=> String
1470
+ # resp.domain_status_list[0].service_software_options.automated_update_date #=> Time
1471
+ # resp.domain_status_list[0].service_software_options.optional_deployment #=> Boolean
1472
+ # resp.domain_status_list[0].domain_endpoint_options.enforce_https #=> Boolean
1473
+ # 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"
1474
+ # resp.domain_status_list[0].domain_endpoint_options.custom_endpoint_enabled #=> Boolean
1475
+ # resp.domain_status_list[0].domain_endpoint_options.custom_endpoint #=> String
1476
+ # resp.domain_status_list[0].domain_endpoint_options.custom_endpoint_certificate_arn #=> String
1477
+ # resp.domain_status_list[0].advanced_security_options.enabled #=> Boolean
1478
+ # resp.domain_status_list[0].advanced_security_options.internal_user_database_enabled #=> Boolean
1479
+ # resp.domain_status_list[0].advanced_security_options.saml_options.enabled #=> Boolean
1480
+ # resp.domain_status_list[0].advanced_security_options.saml_options.idp.metadata_content #=> String
1481
+ # resp.domain_status_list[0].advanced_security_options.saml_options.idp.entity_id #=> String
1482
+ # resp.domain_status_list[0].advanced_security_options.saml_options.subject_key #=> String
1483
+ # resp.domain_status_list[0].advanced_security_options.saml_options.roles_key #=> String
1484
+ # resp.domain_status_list[0].advanced_security_options.saml_options.session_timeout_minutes #=> Integer
1485
+ # resp.domain_status_list[0].auto_tune_options.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
1486
+ # resp.domain_status_list[0].auto_tune_options.error_message #=> String
1487
+ #
1488
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomains AWS API Documentation
1489
+ #
1490
+ # @overload describe_domains(params = {})
1491
+ # @param [Hash] params ({})
1492
+ def describe_domains(params = {}, options = {})
1493
+ req = build_request(:describe_domains, params)
1494
+ req.send_request(options)
1495
+ end
1496
+
1497
+ # Lists all the inbound cross-cluster connections for a remote domain.
1498
+ #
1499
+ # @option params [Array<Types::Filter>] :filters
1500
+ # A list of filters used to match properties for inbound cross-cluster
1501
+ # connections. Available ` Filter ` values are: * connection-id
1502
+ # * local-domain-info.domain-name
1503
+ # * local-domain-info.owner-id
1504
+ # * local-domain-info.region
1505
+ # * remote-domain-info.domain-name
1506
+ #
1507
+ # @option params [Integer] :max_results
1508
+ # Set this value to limit the number of results returned. If not
1509
+ # specified, defaults to 100.
1510
+ #
1511
+ # @option params [String] :next_token
1512
+ # If more results are available and NextToken is present, make the next
1513
+ # request to the same API with the received NextToken to paginate the
1514
+ # remaining results.
1515
+ #
1516
+ # @return [Types::DescribeInboundConnectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1517
+ #
1518
+ # * {Types::DescribeInboundConnectionsResponse#connections #connections} => Array&lt;Types::InboundConnection&gt;
1519
+ # * {Types::DescribeInboundConnectionsResponse#next_token #next_token} => String
1520
+ #
1521
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1522
+ #
1523
+ # @example Request syntax with placeholder values
1524
+ #
1525
+ # resp = client.describe_inbound_connections({
1526
+ # filters: [
1527
+ # {
1528
+ # name: "NonEmptyString",
1529
+ # values: ["NonEmptyString"],
1530
+ # },
1531
+ # ],
1532
+ # max_results: 1,
1533
+ # next_token: "NextToken",
1534
+ # })
1535
+ #
1536
+ # @example Response structure
1537
+ #
1538
+ # resp.connections #=> Array
1539
+ # resp.connections[0].local_domain_info.aws_domain_information.owner_id #=> String
1540
+ # resp.connections[0].local_domain_info.aws_domain_information.domain_name #=> String
1541
+ # resp.connections[0].local_domain_info.aws_domain_information.region #=> String
1542
+ # resp.connections[0].remote_domain_info.aws_domain_information.owner_id #=> String
1543
+ # resp.connections[0].remote_domain_info.aws_domain_information.domain_name #=> String
1544
+ # resp.connections[0].remote_domain_info.aws_domain_information.region #=> String
1545
+ # resp.connections[0].connection_id #=> String
1546
+ # resp.connections[0].connection_status.status_code #=> String, one of "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED"
1547
+ # resp.connections[0].connection_status.message #=> String
1548
+ # resp.next_token #=> String
1549
+ #
1550
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInboundConnections AWS API Documentation
1551
+ #
1552
+ # @overload describe_inbound_connections(params = {})
1553
+ # @param [Hash] params ({})
1554
+ def describe_inbound_connections(params = {}, options = {})
1555
+ req = build_request(:describe_inbound_connections, params)
1556
+ req.send_request(options)
1557
+ end
1558
+
1559
+ # Describe the limits for a given instance type and OpenSearch or
1560
+ # Elasticsearch version. When modifying an existing domain, specify the
1561
+ # ` DomainName ` to see which limits you can modify.
1562
+ #
1563
+ # @option params [String] :domain_name
1564
+ # The name of the domain you want to modify. Only include this value if
1565
+ # you're querying OpenSearch ` Limits ` for an existing domain.
1566
+ #
1567
+ # @option params [required, String] :instance_type
1568
+ # The instance type for an OpenSearch cluster for which OpenSearch `
1569
+ # Limits ` are needed.
1570
+ #
1571
+ # @option params [required, String] :engine_version
1572
+ # Version of OpenSearch for which ` Limits ` are needed.
1573
+ #
1574
+ # @return [Types::DescribeInstanceTypeLimitsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1575
+ #
1576
+ # * {Types::DescribeInstanceTypeLimitsResponse#limits_by_role #limits_by_role} => Hash&lt;String,Types::Limits&gt;
1577
+ #
1578
+ # @example Request syntax with placeholder values
1579
+ #
1580
+ # resp = client.describe_instance_type_limits({
1581
+ # domain_name: "DomainName",
1582
+ # instance_type: "m3.medium.search", # required, accepts m3.medium.search, m3.large.search, m3.xlarge.search, m3.2xlarge.search, m4.large.search, m4.xlarge.search, m4.2xlarge.search, m4.4xlarge.search, m4.10xlarge.search, m5.large.search, m5.xlarge.search, m5.2xlarge.search, m5.4xlarge.search, m5.12xlarge.search, m5.24xlarge.search, r5.large.search, r5.xlarge.search, r5.2xlarge.search, r5.4xlarge.search, r5.12xlarge.search, r5.24xlarge.search, c5.large.search, c5.xlarge.search, c5.2xlarge.search, c5.4xlarge.search, c5.9xlarge.search, c5.18xlarge.search, t3.nano.search, t3.micro.search, t3.small.search, t3.medium.search, t3.large.search, t3.xlarge.search, t3.2xlarge.search, ultrawarm1.medium.search, ultrawarm1.large.search, ultrawarm1.xlarge.search, t2.micro.search, t2.small.search, t2.medium.search, r3.large.search, r3.xlarge.search, r3.2xlarge.search, r3.4xlarge.search, r3.8xlarge.search, i2.xlarge.search, i2.2xlarge.search, d2.xlarge.search, d2.2xlarge.search, d2.4xlarge.search, d2.8xlarge.search, c4.large.search, c4.xlarge.search, c4.2xlarge.search, c4.4xlarge.search, c4.8xlarge.search, r4.large.search, r4.xlarge.search, r4.2xlarge.search, r4.4xlarge.search, r4.8xlarge.search, r4.16xlarge.search, i3.large.search, i3.xlarge.search, i3.2xlarge.search, i3.4xlarge.search, i3.8xlarge.search, i3.16xlarge.search, r6g.large.search, r6g.xlarge.search, r6g.2xlarge.search, r6g.4xlarge.search, r6g.8xlarge.search, r6g.12xlarge.search, m6g.large.search, m6g.xlarge.search, m6g.2xlarge.search, m6g.4xlarge.search, m6g.8xlarge.search, m6g.12xlarge.search, c6g.large.search, c6g.xlarge.search, c6g.2xlarge.search, c6g.4xlarge.search, c6g.8xlarge.search, c6g.12xlarge.search, r6gd.large.search, r6gd.xlarge.search, r6gd.2xlarge.search, r6gd.4xlarge.search, r6gd.8xlarge.search, r6gd.12xlarge.search, r6gd.16xlarge.search, t4g.small.search, t4g.medium.search
1583
+ # engine_version: "VersionString", # required
1584
+ # })
1585
+ #
1586
+ # @example Response structure
1587
+ #
1588
+ # resp.limits_by_role #=> Hash
1589
+ # resp.limits_by_role["InstanceRole"].storage_types #=> Array
1590
+ # resp.limits_by_role["InstanceRole"].storage_types[0].storage_type_name #=> String
1591
+ # resp.limits_by_role["InstanceRole"].storage_types[0].storage_sub_type_name #=> String
1592
+ # resp.limits_by_role["InstanceRole"].storage_types[0].storage_type_limits #=> Array
1593
+ # resp.limits_by_role["InstanceRole"].storage_types[0].storage_type_limits[0].limit_name #=> String
1594
+ # resp.limits_by_role["InstanceRole"].storage_types[0].storage_type_limits[0].limit_values #=> Array
1595
+ # resp.limits_by_role["InstanceRole"].storage_types[0].storage_type_limits[0].limit_values[0] #=> String
1596
+ # resp.limits_by_role["InstanceRole"].instance_limits.instance_count_limits.minimum_instance_count #=> Integer
1597
+ # resp.limits_by_role["InstanceRole"].instance_limits.instance_count_limits.maximum_instance_count #=> Integer
1598
+ # resp.limits_by_role["InstanceRole"].additional_limits #=> Array
1599
+ # resp.limits_by_role["InstanceRole"].additional_limits[0].limit_name #=> String
1600
+ # resp.limits_by_role["InstanceRole"].additional_limits[0].limit_values #=> Array
1601
+ # resp.limits_by_role["InstanceRole"].additional_limits[0].limit_values[0] #=> String
1602
+ #
1603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInstanceTypeLimits AWS API Documentation
1604
+ #
1605
+ # @overload describe_instance_type_limits(params = {})
1606
+ # @param [Hash] params ({})
1607
+ def describe_instance_type_limits(params = {}, options = {})
1608
+ req = build_request(:describe_instance_type_limits, params)
1609
+ req.send_request(options)
1610
+ end
1611
+
1612
+ # Lists all the outbound cross-cluster connections for a local domain.
1613
+ #
1614
+ # @option params [Array<Types::Filter>] :filters
1615
+ # A list of filters used to match properties for outbound cross-cluster
1616
+ # connections. Available ` Filter ` names for this operation are: *
1617
+ # connection-id
1618
+ # * remote-domain-info.domain-name
1619
+ # * remote-domain-info.owner-id
1620
+ # * remote-domain-info.region
1621
+ # * local-domain-info.domain-name
1622
+ #
1623
+ # @option params [Integer] :max_results
1624
+ # Set this value to limit the number of results returned. If not
1625
+ # specified, defaults to 100.
1626
+ #
1627
+ # @option params [String] :next_token
1628
+ # NextToken is sent in case the earlier API call results contain the
1629
+ # NextToken parameter. Used for pagination.
1630
+ #
1631
+ # @return [Types::DescribeOutboundConnectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1632
+ #
1633
+ # * {Types::DescribeOutboundConnectionsResponse#connections #connections} => Array&lt;Types::OutboundConnection&gt;
1634
+ # * {Types::DescribeOutboundConnectionsResponse#next_token #next_token} => String
1635
+ #
1636
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1637
+ #
1638
+ # @example Request syntax with placeholder values
1639
+ #
1640
+ # resp = client.describe_outbound_connections({
1641
+ # filters: [
1642
+ # {
1643
+ # name: "NonEmptyString",
1644
+ # values: ["NonEmptyString"],
1645
+ # },
1646
+ # ],
1647
+ # max_results: 1,
1648
+ # next_token: "NextToken",
1649
+ # })
1650
+ #
1651
+ # @example Response structure
1652
+ #
1653
+ # resp.connections #=> Array
1654
+ # resp.connections[0].local_domain_info.aws_domain_information.owner_id #=> String
1655
+ # resp.connections[0].local_domain_info.aws_domain_information.domain_name #=> String
1656
+ # resp.connections[0].local_domain_info.aws_domain_information.region #=> String
1657
+ # resp.connections[0].remote_domain_info.aws_domain_information.owner_id #=> String
1658
+ # resp.connections[0].remote_domain_info.aws_domain_information.domain_name #=> String
1659
+ # resp.connections[0].remote_domain_info.aws_domain_information.region #=> String
1660
+ # resp.connections[0].connection_id #=> String
1661
+ # resp.connections[0].connection_alias #=> String
1662
+ # resp.connections[0].connection_status.status_code #=> String, one of "VALIDATING", "VALIDATION_FAILED", "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED"
1663
+ # resp.connections[0].connection_status.message #=> String
1664
+ # resp.next_token #=> String
1665
+ #
1666
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeOutboundConnections AWS API Documentation
1667
+ #
1668
+ # @overload describe_outbound_connections(params = {})
1669
+ # @param [Hash] params ({})
1670
+ def describe_outbound_connections(params = {}, options = {})
1671
+ req = build_request(:describe_outbound_connections, params)
1672
+ req.send_request(options)
1673
+ end
1674
+
1675
+ # Describes all packages available to Amazon OpenSearch Service domains.
1676
+ # Includes options for filtering, limiting the number of results, and
1677
+ # pagination.
1678
+ #
1679
+ # @option params [Array<Types::DescribePackagesFilter>] :filters
1680
+ # Only returns packages that match the `DescribePackagesFilterList`
1681
+ # values.
1682
+ #
1683
+ # @option params [Integer] :max_results
1684
+ # Limits results to a maximum number of packages.
1685
+ #
1686
+ # @option params [String] :next_token
1687
+ # Used for pagination. Only necessary if a previous API call includes a
1688
+ # non-null NextToken value. If provided, returns results for the next
1689
+ # page.
1690
+ #
1691
+ # @return [Types::DescribePackagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1692
+ #
1693
+ # * {Types::DescribePackagesResponse#package_details_list #package_details_list} => Array&lt;Types::PackageDetails&gt;
1694
+ # * {Types::DescribePackagesResponse#next_token #next_token} => String
1695
+ #
1696
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1697
+ #
1698
+ # @example Request syntax with placeholder values
1699
+ #
1700
+ # resp = client.describe_packages({
1701
+ # filters: [
1702
+ # {
1703
+ # name: "PackageID", # accepts PackageID, PackageName, PackageStatus
1704
+ # value: ["DescribePackagesFilterValue"],
1705
+ # },
1706
+ # ],
1707
+ # max_results: 1,
1708
+ # next_token: "NextToken",
1709
+ # })
1710
+ #
1711
+ # @example Response structure
1712
+ #
1713
+ # resp.package_details_list #=> Array
1714
+ # resp.package_details_list[0].package_id #=> String
1715
+ # resp.package_details_list[0].package_name #=> String
1716
+ # resp.package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY"
1717
+ # resp.package_details_list[0].package_description #=> String
1718
+ # resp.package_details_list[0].package_status #=> String, one of "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED"
1719
+ # resp.package_details_list[0].created_at #=> Time
1720
+ # resp.package_details_list[0].last_updated_at #=> Time
1721
+ # resp.package_details_list[0].available_package_version #=> String
1722
+ # resp.package_details_list[0].error_details.error_type #=> String
1723
+ # resp.package_details_list[0].error_details.error_message #=> String
1724
+ # resp.next_token #=> String
1725
+ #
1726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribePackages AWS API Documentation
1727
+ #
1728
+ # @overload describe_packages(params = {})
1729
+ # @param [Hash] params ({})
1730
+ def describe_packages(params = {}, options = {})
1731
+ req = build_request(:describe_packages, params)
1732
+ req.send_request(options)
1733
+ end
1734
+
1735
+ # Lists available reserved OpenSearch instance offerings.
1736
+ #
1737
+ # @option params [String] :reserved_instance_offering_id
1738
+ # The offering identifier filter value. Use this parameter to show only
1739
+ # the available offering that matches the specified reservation
1740
+ # identifier.
1741
+ #
1742
+ # @option params [Integer] :max_results
1743
+ # Set this value to limit the number of results returned. If not
1744
+ # specified, defaults to 100.
1745
+ #
1746
+ # @option params [String] :next_token
1747
+ # Provides an identifier to allow retrieval of paginated results.
1748
+ #
1749
+ # @return [Types::DescribeReservedInstanceOfferingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1750
+ #
1751
+ # * {Types::DescribeReservedInstanceOfferingsResponse#next_token #next_token} => String
1752
+ # * {Types::DescribeReservedInstanceOfferingsResponse#reserved_instance_offerings #reserved_instance_offerings} => Array&lt;Types::ReservedInstanceOffering&gt;
1753
+ #
1754
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1755
+ #
1756
+ # @example Request syntax with placeholder values
1757
+ #
1758
+ # resp = client.describe_reserved_instance_offerings({
1759
+ # reserved_instance_offering_id: "GUID",
1760
+ # max_results: 1,
1761
+ # next_token: "NextToken",
1762
+ # })
1763
+ #
1764
+ # @example Response structure
1765
+ #
1766
+ # resp.next_token #=> String
1767
+ # resp.reserved_instance_offerings #=> Array
1768
+ # resp.reserved_instance_offerings[0].reserved_instance_offering_id #=> String
1769
+ # resp.reserved_instance_offerings[0].instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
1770
+ # resp.reserved_instance_offerings[0].duration #=> Integer
1771
+ # resp.reserved_instance_offerings[0].fixed_price #=> Float
1772
+ # resp.reserved_instance_offerings[0].usage_price #=> Float
1773
+ # resp.reserved_instance_offerings[0].currency_code #=> String
1774
+ # resp.reserved_instance_offerings[0].payment_option #=> String, one of "ALL_UPFRONT", "PARTIAL_UPFRONT", "NO_UPFRONT"
1775
+ # resp.reserved_instance_offerings[0].recurring_charges #=> Array
1776
+ # resp.reserved_instance_offerings[0].recurring_charges[0].recurring_charge_amount #=> Float
1777
+ # resp.reserved_instance_offerings[0].recurring_charges[0].recurring_charge_frequency #=> String
1778
+ #
1779
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeReservedInstanceOfferings AWS API Documentation
1780
+ #
1781
+ # @overload describe_reserved_instance_offerings(params = {})
1782
+ # @param [Hash] params ({})
1783
+ def describe_reserved_instance_offerings(params = {}, options = {})
1784
+ req = build_request(:describe_reserved_instance_offerings, params)
1785
+ req.send_request(options)
1786
+ end
1787
+
1788
+ # Returns information about reserved OpenSearch instances for this
1789
+ # account.
1790
+ #
1791
+ # @option params [String] :reserved_instance_id
1792
+ # The reserved instance identifier filter value. Use this parameter to
1793
+ # show only the reservation that matches the specified reserved
1794
+ # OpenSearch instance ID.
1795
+ #
1796
+ # @option params [Integer] :max_results
1797
+ # Set this value to limit the number of results returned. If not
1798
+ # specified, defaults to 100.
1799
+ #
1800
+ # @option params [String] :next_token
1801
+ # Provides an identifier to allow retrieval of paginated results.
1802
+ #
1803
+ # @return [Types::DescribeReservedInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1804
+ #
1805
+ # * {Types::DescribeReservedInstancesResponse#next_token #next_token} => String
1806
+ # * {Types::DescribeReservedInstancesResponse#reserved_instances #reserved_instances} => Array&lt;Types::ReservedInstance&gt;
1807
+ #
1808
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1809
+ #
1810
+ # @example Request syntax with placeholder values
1811
+ #
1812
+ # resp = client.describe_reserved_instances({
1813
+ # reserved_instance_id: "GUID",
1814
+ # max_results: 1,
1815
+ # next_token: "NextToken",
1816
+ # })
1817
+ #
1818
+ # @example Response structure
1819
+ #
1820
+ # resp.next_token #=> String
1821
+ # resp.reserved_instances #=> Array
1822
+ # resp.reserved_instances[0].reservation_name #=> String
1823
+ # resp.reserved_instances[0].reserved_instance_id #=> String
1824
+ # resp.reserved_instances[0].billing_subscription_id #=> Integer
1825
+ # resp.reserved_instances[0].reserved_instance_offering_id #=> String
1826
+ # resp.reserved_instances[0].instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
1827
+ # resp.reserved_instances[0].start_time #=> Time
1828
+ # resp.reserved_instances[0].duration #=> Integer
1829
+ # resp.reserved_instances[0].fixed_price #=> Float
1830
+ # resp.reserved_instances[0].usage_price #=> Float
1831
+ # resp.reserved_instances[0].currency_code #=> String
1832
+ # resp.reserved_instances[0].instance_count #=> Integer
1833
+ # resp.reserved_instances[0].state #=> String
1834
+ # resp.reserved_instances[0].payment_option #=> String, one of "ALL_UPFRONT", "PARTIAL_UPFRONT", "NO_UPFRONT"
1835
+ # resp.reserved_instances[0].recurring_charges #=> Array
1836
+ # resp.reserved_instances[0].recurring_charges[0].recurring_charge_amount #=> Float
1837
+ # resp.reserved_instances[0].recurring_charges[0].recurring_charge_frequency #=> String
1838
+ #
1839
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeReservedInstances AWS API Documentation
1840
+ #
1841
+ # @overload describe_reserved_instances(params = {})
1842
+ # @param [Hash] params ({})
1843
+ def describe_reserved_instances(params = {}, options = {})
1844
+ req = build_request(:describe_reserved_instances, params)
1845
+ req.send_request(options)
1846
+ end
1847
+
1848
+ # Dissociates a package from the Amazon OpenSearch Service domain.
1849
+ #
1850
+ # @option params [required, String] :package_id
1851
+ # The internal ID of the package to associate with a domain. Use
1852
+ # `DescribePackages` to find this value.
1853
+ #
1854
+ # @option params [required, String] :domain_name
1855
+ # The name of the domain to associate the package with.
1856
+ #
1857
+ # @return [Types::DissociatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1858
+ #
1859
+ # * {Types::DissociatePackageResponse#domain_package_details #domain_package_details} => Types::DomainPackageDetails
1860
+ #
1861
+ # @example Request syntax with placeholder values
1862
+ #
1863
+ # resp = client.dissociate_package({
1864
+ # package_id: "PackageID", # required
1865
+ # domain_name: "DomainName", # required
1866
+ # })
1867
+ #
1868
+ # @example Response structure
1869
+ #
1870
+ # resp.domain_package_details.package_id #=> String
1871
+ # resp.domain_package_details.package_name #=> String
1872
+ # resp.domain_package_details.package_type #=> String, one of "TXT-DICTIONARY"
1873
+ # resp.domain_package_details.last_updated #=> Time
1874
+ # resp.domain_package_details.domain_name #=> String
1875
+ # resp.domain_package_details.domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
1876
+ # resp.domain_package_details.package_version #=> String
1877
+ # resp.domain_package_details.reference_path #=> String
1878
+ # resp.domain_package_details.error_details.error_type #=> String
1879
+ # resp.domain_package_details.error_details.error_message #=> String
1880
+ #
1881
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DissociatePackage AWS API Documentation
1882
+ #
1883
+ # @overload dissociate_package(params = {})
1884
+ # @param [Hash] params ({})
1885
+ def dissociate_package(params = {}, options = {})
1886
+ req = build_request(:dissociate_package, params)
1887
+ req.send_request(options)
1888
+ end
1889
+
1890
+ # Returns a list of upgrade-compatible versions of
1891
+ # OpenSearch/Elasticsearch. You can optionally pass a ` DomainName ` to
1892
+ # get all upgrade-compatible versions of OpenSearch/Elasticsearch for
1893
+ # that specific domain.
1894
+ #
1895
+ # @option params [String] :domain_name
1896
+ # The name of an domain. Domain names are unique across the domains
1897
+ # owned by an account within an AWS region. Domain names start with a
1898
+ # letter or number and can contain the following characters: a-z
1899
+ # (lowercase), 0-9, and - (hyphen).
1900
+ #
1901
+ # @return [Types::GetCompatibleVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1902
+ #
1903
+ # * {Types::GetCompatibleVersionsResponse#compatible_versions #compatible_versions} => Array&lt;Types::CompatibleVersionsMap&gt;
1904
+ #
1905
+ # @example Request syntax with placeholder values
1906
+ #
1907
+ # resp = client.get_compatible_versions({
1908
+ # domain_name: "DomainName",
1909
+ # })
1910
+ #
1911
+ # @example Response structure
1912
+ #
1913
+ # resp.compatible_versions #=> Array
1914
+ # resp.compatible_versions[0].source_version #=> String
1915
+ # resp.compatible_versions[0].target_versions #=> Array
1916
+ # resp.compatible_versions[0].target_versions[0] #=> String
1917
+ #
1918
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetCompatibleVersions AWS API Documentation
1919
+ #
1920
+ # @overload get_compatible_versions(params = {})
1921
+ # @param [Hash] params ({})
1922
+ def get_compatible_versions(params = {}, options = {})
1923
+ req = build_request(:get_compatible_versions, params)
1924
+ req.send_request(options)
1925
+ end
1926
+
1927
+ # Returns a list of package versions, along with their creation time and
1928
+ # commit message.
1929
+ #
1930
+ # @option params [required, String] :package_id
1931
+ # Returns an audit history of package versions.
1932
+ #
1933
+ # @option params [Integer] :max_results
1934
+ # Limits results to a maximum number of package versions.
1935
+ #
1936
+ # @option params [String] :next_token
1937
+ # Used for pagination. Only necessary if a previous API call includes a
1938
+ # non-null NextToken value. If provided, returns results for the next
1939
+ # page.
1940
+ #
1941
+ # @return [Types::GetPackageVersionHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1942
+ #
1943
+ # * {Types::GetPackageVersionHistoryResponse#package_id #package_id} => String
1944
+ # * {Types::GetPackageVersionHistoryResponse#package_version_history_list #package_version_history_list} => Array&lt;Types::PackageVersionHistory&gt;
1945
+ # * {Types::GetPackageVersionHistoryResponse#next_token #next_token} => String
1946
+ #
1947
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1948
+ #
1949
+ # @example Request syntax with placeholder values
1950
+ #
1951
+ # resp = client.get_package_version_history({
1952
+ # package_id: "PackageID", # required
1953
+ # max_results: 1,
1954
+ # next_token: "NextToken",
1955
+ # })
1956
+ #
1957
+ # @example Response structure
1958
+ #
1959
+ # resp.package_id #=> String
1960
+ # resp.package_version_history_list #=> Array
1961
+ # resp.package_version_history_list[0].package_version #=> String
1962
+ # resp.package_version_history_list[0].commit_message #=> String
1963
+ # resp.package_version_history_list[0].created_at #=> Time
1964
+ # resp.next_token #=> String
1965
+ #
1966
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetPackageVersionHistory AWS API Documentation
1967
+ #
1968
+ # @overload get_package_version_history(params = {})
1969
+ # @param [Hash] params ({})
1970
+ def get_package_version_history(params = {}, options = {})
1971
+ req = build_request(:get_package_version_history, params)
1972
+ req.send_request(options)
1973
+ end
1974
+
1975
+ # Retrieves the complete history of the last 10 upgrades performed on
1976
+ # the domain.
1977
+ #
1978
+ # @option params [required, String] :domain_name
1979
+ # The name of an domain. Domain names are unique across the domains
1980
+ # owned by an account within an AWS region. Domain names start with a
1981
+ # letter or number and can contain the following characters: a-z
1982
+ # (lowercase), 0-9, and - (hyphen).
1983
+ #
1984
+ # @option params [Integer] :max_results
1985
+ # Set this value to limit the number of results returned.
1986
+ #
1987
+ # @option params [String] :next_token
1988
+ # Paginated APIs accept the NextToken input to return the next page of
1989
+ # results and provide a NextToken output in the response, which you can
1990
+ # use to retrieve more results.
1991
+ #
1992
+ # @return [Types::GetUpgradeHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1993
+ #
1994
+ # * {Types::GetUpgradeHistoryResponse#upgrade_histories #upgrade_histories} => Array&lt;Types::UpgradeHistory&gt;
1995
+ # * {Types::GetUpgradeHistoryResponse#next_token #next_token} => String
1996
+ #
1997
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1998
+ #
1999
+ # @example Request syntax with placeholder values
2000
+ #
2001
+ # resp = client.get_upgrade_history({
2002
+ # domain_name: "DomainName", # required
2003
+ # max_results: 1,
2004
+ # next_token: "NextToken",
2005
+ # })
2006
+ #
2007
+ # @example Response structure
2008
+ #
2009
+ # resp.upgrade_histories #=> Array
2010
+ # resp.upgrade_histories[0].upgrade_name #=> String
2011
+ # resp.upgrade_histories[0].start_timestamp #=> Time
2012
+ # resp.upgrade_histories[0].upgrade_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "SUCCEEDED_WITH_ISSUES", "FAILED"
2013
+ # resp.upgrade_histories[0].steps_list #=> Array
2014
+ # resp.upgrade_histories[0].steps_list[0].upgrade_step #=> String, one of "PRE_UPGRADE_CHECK", "SNAPSHOT", "UPGRADE"
2015
+ # resp.upgrade_histories[0].steps_list[0].upgrade_step_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "SUCCEEDED_WITH_ISSUES", "FAILED"
2016
+ # resp.upgrade_histories[0].steps_list[0].issues #=> Array
2017
+ # resp.upgrade_histories[0].steps_list[0].issues[0] #=> String
2018
+ # resp.upgrade_histories[0].steps_list[0].progress_percent #=> Float
2019
+ # resp.next_token #=> String
2020
+ #
2021
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetUpgradeHistory AWS API Documentation
2022
+ #
2023
+ # @overload get_upgrade_history(params = {})
2024
+ # @param [Hash] params ({})
2025
+ def get_upgrade_history(params = {}, options = {})
2026
+ req = build_request(:get_upgrade_history, params)
2027
+ req.send_request(options)
2028
+ end
2029
+
2030
+ # Retrieves the latest status of the last upgrade or upgrade eligibility
2031
+ # check performed on the domain.
2032
+ #
2033
+ # @option params [required, String] :domain_name
2034
+ # The name of an domain. Domain names are unique across the domains
2035
+ # owned by an account within an AWS region. Domain names start with a
2036
+ # letter or number and can contain the following characters: a-z
2037
+ # (lowercase), 0-9, and - (hyphen).
2038
+ #
2039
+ # @return [Types::GetUpgradeStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2040
+ #
2041
+ # * {Types::GetUpgradeStatusResponse#upgrade_step #upgrade_step} => String
2042
+ # * {Types::GetUpgradeStatusResponse#step_status #step_status} => String
2043
+ # * {Types::GetUpgradeStatusResponse#upgrade_name #upgrade_name} => String
2044
+ #
2045
+ # @example Request syntax with placeholder values
2046
+ #
2047
+ # resp = client.get_upgrade_status({
2048
+ # domain_name: "DomainName", # required
2049
+ # })
2050
+ #
2051
+ # @example Response structure
2052
+ #
2053
+ # resp.upgrade_step #=> String, one of "PRE_UPGRADE_CHECK", "SNAPSHOT", "UPGRADE"
2054
+ # resp.step_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "SUCCEEDED_WITH_ISSUES", "FAILED"
2055
+ # resp.upgrade_name #=> String
2056
+ #
2057
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetUpgradeStatus AWS API Documentation
2058
+ #
2059
+ # @overload get_upgrade_status(params = {})
2060
+ # @param [Hash] params ({})
2061
+ def get_upgrade_status(params = {}, options = {})
2062
+ req = build_request(:get_upgrade_status, params)
2063
+ req.send_request(options)
2064
+ end
2065
+
2066
+ # Returns the names of all domains owned by the current user's account.
2067
+ #
2068
+ # @return [Types::ListDomainNamesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2069
+ #
2070
+ # * {Types::ListDomainNamesResponse#domain_names #domain_names} => Array&lt;Types::DomainInfo&gt;
2071
+ #
2072
+ # @example Response structure
2073
+ #
2074
+ # resp.domain_names #=> Array
2075
+ # resp.domain_names[0].domain_name #=> String
2076
+ #
2077
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainNames AWS API Documentation
2078
+ #
2079
+ # @overload list_domain_names(params = {})
2080
+ # @param [Hash] params ({})
2081
+ def list_domain_names(params = {}, options = {})
2082
+ req = build_request(:list_domain_names, params)
2083
+ req.send_request(options)
2084
+ end
2085
+
2086
+ # Lists all Amazon OpenSearch Service domains associated with the
2087
+ # package.
2088
+ #
2089
+ # @option params [required, String] :package_id
2090
+ # The package for which to list associated domains.
2091
+ #
2092
+ # @option params [Integer] :max_results
2093
+ # Limits the results to a maximum number of domains.
2094
+ #
2095
+ # @option params [String] :next_token
2096
+ # Used for pagination. Only necessary if a previous API call includes a
2097
+ # non-null NextToken value. If provided, returns results for the next
2098
+ # page.
2099
+ #
2100
+ # @return [Types::ListDomainsForPackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2101
+ #
2102
+ # * {Types::ListDomainsForPackageResponse#domain_package_details_list #domain_package_details_list} => Array&lt;Types::DomainPackageDetails&gt;
2103
+ # * {Types::ListDomainsForPackageResponse#next_token #next_token} => String
2104
+ #
2105
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2106
+ #
2107
+ # @example Request syntax with placeholder values
2108
+ #
2109
+ # resp = client.list_domains_for_package({
2110
+ # package_id: "PackageID", # required
2111
+ # max_results: 1,
2112
+ # next_token: "NextToken",
2113
+ # })
2114
+ #
2115
+ # @example Response structure
2116
+ #
2117
+ # resp.domain_package_details_list #=> Array
2118
+ # resp.domain_package_details_list[0].package_id #=> String
2119
+ # resp.domain_package_details_list[0].package_name #=> String
2120
+ # resp.domain_package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY"
2121
+ # resp.domain_package_details_list[0].last_updated #=> Time
2122
+ # resp.domain_package_details_list[0].domain_name #=> String
2123
+ # resp.domain_package_details_list[0].domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
2124
+ # resp.domain_package_details_list[0].package_version #=> String
2125
+ # resp.domain_package_details_list[0].reference_path #=> String
2126
+ # resp.domain_package_details_list[0].error_details.error_type #=> String
2127
+ # resp.domain_package_details_list[0].error_details.error_message #=> String
2128
+ # resp.next_token #=> String
2129
+ #
2130
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainsForPackage AWS API Documentation
2131
+ #
2132
+ # @overload list_domains_for_package(params = {})
2133
+ # @param [Hash] params ({})
2134
+ def list_domains_for_package(params = {}, options = {})
2135
+ req = build_request(:list_domains_for_package, params)
2136
+ req.send_request(options)
2137
+ end
2138
+
2139
+ # @option params [required, String] :engine_version
2140
+ #
2141
+ # @option params [String] :domain_name
2142
+ # The name of an domain. Domain names are unique across the domains
2143
+ # owned by an account within an AWS region. Domain names start with a
2144
+ # letter or number and can contain the following characters: a-z
2145
+ # (lowercase), 0-9, and - (hyphen).
2146
+ #
2147
+ # @option params [Integer] :max_results
2148
+ # Set this value to limit the number of results returned.
2149
+ #
2150
+ # @option params [String] :next_token
2151
+ # Paginated APIs accept the NextToken input to return the next page of
2152
+ # results and provide a NextToken output in the response, which you can
2153
+ # use to retrieve more results.
2154
+ #
2155
+ # @return [Types::ListInstanceTypeDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2156
+ #
2157
+ # * {Types::ListInstanceTypeDetailsResponse#instance_type_details #instance_type_details} => Array&lt;Types::InstanceTypeDetails&gt;
2158
+ # * {Types::ListInstanceTypeDetailsResponse#next_token #next_token} => String
2159
+ #
2160
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2161
+ #
2162
+ # @example Request syntax with placeholder values
2163
+ #
2164
+ # resp = client.list_instance_type_details({
2165
+ # engine_version: "VersionString", # required
2166
+ # domain_name: "DomainName",
2167
+ # max_results: 1,
2168
+ # next_token: "NextToken",
2169
+ # })
2170
+ #
2171
+ # @example Response structure
2172
+ #
2173
+ # resp.instance_type_details #=> Array
2174
+ # resp.instance_type_details[0].instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
2175
+ # resp.instance_type_details[0].encryption_enabled #=> Boolean
2176
+ # resp.instance_type_details[0].cognito_enabled #=> Boolean
2177
+ # resp.instance_type_details[0].app_logs_enabled #=> Boolean
2178
+ # resp.instance_type_details[0].advanced_security_enabled #=> Boolean
2179
+ # resp.instance_type_details[0].warm_enabled #=> Boolean
2180
+ # resp.instance_type_details[0].instance_role #=> Array
2181
+ # resp.instance_type_details[0].instance_role[0] #=> String
2182
+ # resp.next_token #=> String
2183
+ #
2184
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListInstanceTypeDetails AWS API Documentation
2185
+ #
2186
+ # @overload list_instance_type_details(params = {})
2187
+ # @param [Hash] params ({})
2188
+ def list_instance_type_details(params = {}, options = {})
2189
+ req = build_request(:list_instance_type_details, params)
2190
+ req.send_request(options)
2191
+ end
2192
+
2193
+ # Lists all packages associated with the Amazon OpenSearch Service
2194
+ # domain.
2195
+ #
2196
+ # @option params [required, String] :domain_name
2197
+ # The name of the domain for which you want to list associated packages.
2198
+ #
2199
+ # @option params [Integer] :max_results
2200
+ # Limits results to a maximum number of packages.
2201
+ #
2202
+ # @option params [String] :next_token
2203
+ # Used for pagination. Only necessary if a previous API call includes a
2204
+ # non-null NextToken value. If provided, returns results for the next
2205
+ # page.
2206
+ #
2207
+ # @return [Types::ListPackagesForDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2208
+ #
2209
+ # * {Types::ListPackagesForDomainResponse#domain_package_details_list #domain_package_details_list} => Array&lt;Types::DomainPackageDetails&gt;
2210
+ # * {Types::ListPackagesForDomainResponse#next_token #next_token} => String
2211
+ #
2212
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2213
+ #
2214
+ # @example Request syntax with placeholder values
2215
+ #
2216
+ # resp = client.list_packages_for_domain({
2217
+ # domain_name: "DomainName", # required
2218
+ # max_results: 1,
2219
+ # next_token: "NextToken",
2220
+ # })
2221
+ #
2222
+ # @example Response structure
2223
+ #
2224
+ # resp.domain_package_details_list #=> Array
2225
+ # resp.domain_package_details_list[0].package_id #=> String
2226
+ # resp.domain_package_details_list[0].package_name #=> String
2227
+ # resp.domain_package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY"
2228
+ # resp.domain_package_details_list[0].last_updated #=> Time
2229
+ # resp.domain_package_details_list[0].domain_name #=> String
2230
+ # resp.domain_package_details_list[0].domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
2231
+ # resp.domain_package_details_list[0].package_version #=> String
2232
+ # resp.domain_package_details_list[0].reference_path #=> String
2233
+ # resp.domain_package_details_list[0].error_details.error_type #=> String
2234
+ # resp.domain_package_details_list[0].error_details.error_message #=> String
2235
+ # resp.next_token #=> String
2236
+ #
2237
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListPackagesForDomain AWS API Documentation
2238
+ #
2239
+ # @overload list_packages_for_domain(params = {})
2240
+ # @param [Hash] params ({})
2241
+ def list_packages_for_domain(params = {}, options = {})
2242
+ req = build_request(:list_packages_for_domain, params)
2243
+ req.send_request(options)
2244
+ end
2245
+
2246
+ # Returns all tags for the given domain.
2247
+ #
2248
+ # @option params [required, String] :arn
2249
+ # Specify the `ARN` of the domain that the tags you want to view are
2250
+ # attached to.
2251
+ #
2252
+ # @return [Types::ListTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2253
+ #
2254
+ # * {Types::ListTagsResponse#tag_list #tag_list} => Array&lt;Types::Tag&gt;
2255
+ #
2256
+ # @example Request syntax with placeholder values
2257
+ #
2258
+ # resp = client.list_tags({
2259
+ # arn: "ARN", # required
2260
+ # })
2261
+ #
2262
+ # @example Response structure
2263
+ #
2264
+ # resp.tag_list #=> Array
2265
+ # resp.tag_list[0].key #=> String
2266
+ # resp.tag_list[0].value #=> String
2267
+ #
2268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListTags AWS API Documentation
2269
+ #
2270
+ # @overload list_tags(params = {})
2271
+ # @param [Hash] params ({})
2272
+ def list_tags(params = {}, options = {})
2273
+ req = build_request(:list_tags, params)
2274
+ req.send_request(options)
2275
+ end
2276
+
2277
+ # List all supported versions of OpenSearch and Elasticsearch.
2278
+ #
2279
+ # @option params [Integer] :max_results
2280
+ # Set this value to limit the number of results returned. Value must be
2281
+ # greater than 10 or it won't be honored.
2282
+ #
2283
+ # @option params [String] :next_token
2284
+ # Paginated APIs accept the NextToken input to return the next page of
2285
+ # results and provide a NextToken output in the response, which you can
2286
+ # use to retrieve more results.
2287
+ #
2288
+ # @return [Types::ListVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2289
+ #
2290
+ # * {Types::ListVersionsResponse#versions #versions} => Array&lt;String&gt;
2291
+ # * {Types::ListVersionsResponse#next_token #next_token} => String
2292
+ #
2293
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2294
+ #
2295
+ # @example Request syntax with placeholder values
2296
+ #
2297
+ # resp = client.list_versions({
2298
+ # max_results: 1,
2299
+ # next_token: "NextToken",
2300
+ # })
2301
+ #
2302
+ # @example Response structure
2303
+ #
2304
+ # resp.versions #=> Array
2305
+ # resp.versions[0] #=> String
2306
+ # resp.next_token #=> String
2307
+ #
2308
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListVersions AWS API Documentation
2309
+ #
2310
+ # @overload list_versions(params = {})
2311
+ # @param [Hash] params ({})
2312
+ def list_versions(params = {}, options = {})
2313
+ req = build_request(:list_versions, params)
2314
+ req.send_request(options)
2315
+ end
2316
+
2317
+ # Allows you to purchase reserved OpenSearch instances.
2318
+ #
2319
+ # @option params [required, String] :reserved_instance_offering_id
2320
+ # The ID of the reserved OpenSearch instance offering to purchase.
2321
+ #
2322
+ # @option params [required, String] :reservation_name
2323
+ # A customer-specified identifier to track this reservation.
2324
+ #
2325
+ # @option params [Integer] :instance_count
2326
+ # The number of OpenSearch instances to reserve.
2327
+ #
2328
+ # @return [Types::PurchaseReservedInstanceOfferingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2329
+ #
2330
+ # * {Types::PurchaseReservedInstanceOfferingResponse#reserved_instance_id #reserved_instance_id} => String
2331
+ # * {Types::PurchaseReservedInstanceOfferingResponse#reservation_name #reservation_name} => String
2332
+ #
2333
+ # @example Request syntax with placeholder values
2334
+ #
2335
+ # resp = client.purchase_reserved_instance_offering({
2336
+ # reserved_instance_offering_id: "GUID", # required
2337
+ # reservation_name: "ReservationToken", # required
2338
+ # instance_count: 1,
2339
+ # })
2340
+ #
2341
+ # @example Response structure
2342
+ #
2343
+ # resp.reserved_instance_id #=> String
2344
+ # resp.reservation_name #=> String
2345
+ #
2346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PurchaseReservedInstanceOffering AWS API Documentation
2347
+ #
2348
+ # @overload purchase_reserved_instance_offering(params = {})
2349
+ # @param [Hash] params ({})
2350
+ def purchase_reserved_instance_offering(params = {}, options = {})
2351
+ req = build_request(:purchase_reserved_instance_offering, params)
2352
+ req.send_request(options)
2353
+ end
2354
+
2355
+ # Allows the remote domain owner to reject an inbound cross-cluster
2356
+ # connection request.
2357
+ #
2358
+ # @option params [required, String] :connection_id
2359
+ # The ID of the inbound connection to reject.
2360
+ #
2361
+ # @return [Types::RejectInboundConnectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2362
+ #
2363
+ # * {Types::RejectInboundConnectionResponse#connection #connection} => Types::InboundConnection
2364
+ #
2365
+ # @example Request syntax with placeholder values
2366
+ #
2367
+ # resp = client.reject_inbound_connection({
2368
+ # connection_id: "ConnectionId", # required
2369
+ # })
2370
+ #
2371
+ # @example Response structure
2372
+ #
2373
+ # resp.connection.local_domain_info.aws_domain_information.owner_id #=> String
2374
+ # resp.connection.local_domain_info.aws_domain_information.domain_name #=> String
2375
+ # resp.connection.local_domain_info.aws_domain_information.region #=> String
2376
+ # resp.connection.remote_domain_info.aws_domain_information.owner_id #=> String
2377
+ # resp.connection.remote_domain_info.aws_domain_information.domain_name #=> String
2378
+ # resp.connection.remote_domain_info.aws_domain_information.region #=> String
2379
+ # resp.connection.connection_id #=> String
2380
+ # resp.connection.connection_status.status_code #=> String, one of "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED"
2381
+ # resp.connection.connection_status.message #=> String
2382
+ #
2383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RejectInboundConnection AWS API Documentation
2384
+ #
2385
+ # @overload reject_inbound_connection(params = {})
2386
+ # @param [Hash] params ({})
2387
+ def reject_inbound_connection(params = {}, options = {})
2388
+ req = build_request(:reject_inbound_connection, params)
2389
+ req.send_request(options)
2390
+ end
2391
+
2392
+ # Removes the specified set of tags from the given domain.
2393
+ #
2394
+ # @option params [required, String] :arn
2395
+ # The `ARN` of the domain from which you want to delete the specified
2396
+ # tags.
2397
+ #
2398
+ # @option params [required, Array<String>] :tag_keys
2399
+ # The `TagKey` list you want to remove from the domain.
2400
+ #
2401
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2402
+ #
2403
+ # @example Request syntax with placeholder values
2404
+ #
2405
+ # resp = client.remove_tags({
2406
+ # arn: "ARN", # required
2407
+ # tag_keys: ["String"], # required
2408
+ # })
2409
+ #
2410
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RemoveTags AWS API Documentation
2411
+ #
2412
+ # @overload remove_tags(params = {})
2413
+ # @param [Hash] params ({})
2414
+ def remove_tags(params = {}, options = {})
2415
+ req = build_request(:remove_tags, params)
2416
+ req.send_request(options)
2417
+ end
2418
+
2419
+ # Schedules a service software update for an Amazon OpenSearch Service
2420
+ # domain.
2421
+ #
2422
+ # @option params [required, String] :domain_name
2423
+ # The name of the domain that you want to update to the latest service
2424
+ # software.
2425
+ #
2426
+ # @return [Types::StartServiceSoftwareUpdateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2427
+ #
2428
+ # * {Types::StartServiceSoftwareUpdateResponse#service_software_options #service_software_options} => Types::ServiceSoftwareOptions
2429
+ #
2430
+ # @example Request syntax with placeholder values
2431
+ #
2432
+ # resp = client.start_service_software_update({
2433
+ # domain_name: "DomainName", # required
2434
+ # })
2435
+ #
2436
+ # @example Response structure
2437
+ #
2438
+ # resp.service_software_options.current_version #=> String
2439
+ # resp.service_software_options.new_version #=> String
2440
+ # resp.service_software_options.update_available #=> Boolean
2441
+ # resp.service_software_options.cancellable #=> Boolean
2442
+ # resp.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
2443
+ # resp.service_software_options.description #=> String
2444
+ # resp.service_software_options.automated_update_date #=> Time
2445
+ # resp.service_software_options.optional_deployment #=> Boolean
2446
+ #
2447
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StartServiceSoftwareUpdate AWS API Documentation
2448
+ #
2449
+ # @overload start_service_software_update(params = {})
2450
+ # @param [Hash] params ({})
2451
+ def start_service_software_update(params = {}, options = {})
2452
+ req = build_request(:start_service_software_update, params)
2453
+ req.send_request(options)
2454
+ end
2455
+
2456
+ # Modifies the cluster configuration of the specified domain, such as
2457
+ # setting the instance type and the number of instances.
2458
+ #
2459
+ # @option params [required, String] :domain_name
2460
+ # The name of the domain you're updating.
2461
+ #
2462
+ # @option params [Types::ClusterConfig] :cluster_config
2463
+ # The type and number of instances to instantiate for the domain
2464
+ # cluster.
2465
+ #
2466
+ # @option params [Types::EBSOptions] :ebs_options
2467
+ # Specify the type and size of the EBS volume to use.
2468
+ #
2469
+ # @option params [Types::SnapshotOptions] :snapshot_options
2470
+ # Option to set the time, in UTC format, for the daily automated
2471
+ # snapshot. Default value is `0` hours.
2472
+ #
2473
+ # @option params [Types::VPCOptions] :vpc_options
2474
+ # Options to specify the subnets and security groups for the VPC
2475
+ # endpoint. For more information, see [Launching your Amazon OpenSearch
2476
+ # Service domains using a VPC ][1].
2477
+ #
2478
+ #
2479
+ #
2480
+ # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html
2481
+ #
2482
+ # @option params [Types::CognitoOptions] :cognito_options
2483
+ # Options to specify the Cognito user and identity pools for OpenSearch
2484
+ # Dashboards authentication. For more information, see [Configuring
2485
+ # Amazon Cognito authentication for OpenSearch Dashboards][1].
2486
+ #
2487
+ #
2488
+ #
2489
+ # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html
2490
+ #
2491
+ # @option params [Hash<String,String>] :advanced_options
2492
+ # Modifies the advanced option to allow references to indices in an HTTP
2493
+ # request body. Must be `false` when configuring access to individual
2494
+ # sub-resources. By default, the value is `true`. See [Advanced options
2495
+ # ][1] for more information.
2496
+ #
2497
+ #
2498
+ #
2499
+ # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
2500
+ #
2501
+ # @option params [String] :access_policies
2502
+ # IAM access policy as a JSON-formatted string.
2503
+ #
2504
+ # @option params [Hash<String,Types::LogPublishingOption>] :log_publishing_options
2505
+ # Map of `LogType` and `LogPublishingOption`, each containing options to
2506
+ # publish a given type of OpenSearch log.
2507
+ #
2508
+ # @option params [Types::EncryptionAtRestOptions] :encryption_at_rest_options
2509
+ # Specifies encryption of data at rest options.
2510
+ #
2511
+ # @option params [Types::DomainEndpointOptions] :domain_endpoint_options
2512
+ # Options to specify configuration that will be applied to the domain
2513
+ # endpoint.
2514
+ #
2515
+ # @option params [Types::NodeToNodeEncryptionOptions] :node_to_node_encryption_options
2516
+ # Specifies node-to-node encryption options.
2517
+ #
2518
+ # @option params [Types::AdvancedSecurityOptionsInput] :advanced_security_options
2519
+ # Specifies advanced security options.
2520
+ #
2521
+ # @option params [Types::AutoTuneOptions] :auto_tune_options
2522
+ # Specifies Auto-Tune options.
2523
+ #
2524
+ # @return [Types::UpdateDomainConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2525
+ #
2526
+ # * {Types::UpdateDomainConfigResponse#domain_config #domain_config} => Types::DomainConfig
2527
+ #
2528
+ # @example Request syntax with placeholder values
2529
+ #
2530
+ # resp = client.update_domain_config({
2531
+ # domain_name: "DomainName", # required
2532
+ # cluster_config: {
2533
+ # instance_type: "m3.medium.search", # accepts m3.medium.search, m3.large.search, m3.xlarge.search, m3.2xlarge.search, m4.large.search, m4.xlarge.search, m4.2xlarge.search, m4.4xlarge.search, m4.10xlarge.search, m5.large.search, m5.xlarge.search, m5.2xlarge.search, m5.4xlarge.search, m5.12xlarge.search, m5.24xlarge.search, r5.large.search, r5.xlarge.search, r5.2xlarge.search, r5.4xlarge.search, r5.12xlarge.search, r5.24xlarge.search, c5.large.search, c5.xlarge.search, c5.2xlarge.search, c5.4xlarge.search, c5.9xlarge.search, c5.18xlarge.search, t3.nano.search, t3.micro.search, t3.small.search, t3.medium.search, t3.large.search, t3.xlarge.search, t3.2xlarge.search, ultrawarm1.medium.search, ultrawarm1.large.search, ultrawarm1.xlarge.search, t2.micro.search, t2.small.search, t2.medium.search, r3.large.search, r3.xlarge.search, r3.2xlarge.search, r3.4xlarge.search, r3.8xlarge.search, i2.xlarge.search, i2.2xlarge.search, d2.xlarge.search, d2.2xlarge.search, d2.4xlarge.search, d2.8xlarge.search, c4.large.search, c4.xlarge.search, c4.2xlarge.search, c4.4xlarge.search, c4.8xlarge.search, r4.large.search, r4.xlarge.search, r4.2xlarge.search, r4.4xlarge.search, r4.8xlarge.search, r4.16xlarge.search, i3.large.search, i3.xlarge.search, i3.2xlarge.search, i3.4xlarge.search, i3.8xlarge.search, i3.16xlarge.search, r6g.large.search, r6g.xlarge.search, r6g.2xlarge.search, r6g.4xlarge.search, r6g.8xlarge.search, r6g.12xlarge.search, m6g.large.search, m6g.xlarge.search, m6g.2xlarge.search, m6g.4xlarge.search, m6g.8xlarge.search, m6g.12xlarge.search, c6g.large.search, c6g.xlarge.search, c6g.2xlarge.search, c6g.4xlarge.search, c6g.8xlarge.search, c6g.12xlarge.search, r6gd.large.search, r6gd.xlarge.search, r6gd.2xlarge.search, r6gd.4xlarge.search, r6gd.8xlarge.search, r6gd.12xlarge.search, r6gd.16xlarge.search, t4g.small.search, t4g.medium.search
2534
+ # instance_count: 1,
2535
+ # dedicated_master_enabled: false,
2536
+ # zone_awareness_enabled: false,
2537
+ # zone_awareness_config: {
2538
+ # availability_zone_count: 1,
2539
+ # },
2540
+ # dedicated_master_type: "m3.medium.search", # accepts m3.medium.search, m3.large.search, m3.xlarge.search, m3.2xlarge.search, m4.large.search, m4.xlarge.search, m4.2xlarge.search, m4.4xlarge.search, m4.10xlarge.search, m5.large.search, m5.xlarge.search, m5.2xlarge.search, m5.4xlarge.search, m5.12xlarge.search, m5.24xlarge.search, r5.large.search, r5.xlarge.search, r5.2xlarge.search, r5.4xlarge.search, r5.12xlarge.search, r5.24xlarge.search, c5.large.search, c5.xlarge.search, c5.2xlarge.search, c5.4xlarge.search, c5.9xlarge.search, c5.18xlarge.search, t3.nano.search, t3.micro.search, t3.small.search, t3.medium.search, t3.large.search, t3.xlarge.search, t3.2xlarge.search, ultrawarm1.medium.search, ultrawarm1.large.search, ultrawarm1.xlarge.search, t2.micro.search, t2.small.search, t2.medium.search, r3.large.search, r3.xlarge.search, r3.2xlarge.search, r3.4xlarge.search, r3.8xlarge.search, i2.xlarge.search, i2.2xlarge.search, d2.xlarge.search, d2.2xlarge.search, d2.4xlarge.search, d2.8xlarge.search, c4.large.search, c4.xlarge.search, c4.2xlarge.search, c4.4xlarge.search, c4.8xlarge.search, r4.large.search, r4.xlarge.search, r4.2xlarge.search, r4.4xlarge.search, r4.8xlarge.search, r4.16xlarge.search, i3.large.search, i3.xlarge.search, i3.2xlarge.search, i3.4xlarge.search, i3.8xlarge.search, i3.16xlarge.search, r6g.large.search, r6g.xlarge.search, r6g.2xlarge.search, r6g.4xlarge.search, r6g.8xlarge.search, r6g.12xlarge.search, m6g.large.search, m6g.xlarge.search, m6g.2xlarge.search, m6g.4xlarge.search, m6g.8xlarge.search, m6g.12xlarge.search, c6g.large.search, c6g.xlarge.search, c6g.2xlarge.search, c6g.4xlarge.search, c6g.8xlarge.search, c6g.12xlarge.search, r6gd.large.search, r6gd.xlarge.search, r6gd.2xlarge.search, r6gd.4xlarge.search, r6gd.8xlarge.search, r6gd.12xlarge.search, r6gd.16xlarge.search, t4g.small.search, t4g.medium.search
2541
+ # dedicated_master_count: 1,
2542
+ # warm_enabled: false,
2543
+ # warm_type: "ultrawarm1.medium.search", # accepts ultrawarm1.medium.search, ultrawarm1.large.search, ultrawarm1.xlarge.search
2544
+ # warm_count: 1,
2545
+ # cold_storage_options: {
2546
+ # enabled: false, # required
2547
+ # },
2548
+ # },
2549
+ # ebs_options: {
2550
+ # ebs_enabled: false,
2551
+ # volume_type: "standard", # accepts standard, gp2, io1
2552
+ # volume_size: 1,
2553
+ # iops: 1,
2554
+ # },
2555
+ # snapshot_options: {
2556
+ # automated_snapshot_start_hour: 1,
2557
+ # },
2558
+ # vpc_options: {
2559
+ # subnet_ids: ["String"],
2560
+ # security_group_ids: ["String"],
2561
+ # },
2562
+ # cognito_options: {
2563
+ # enabled: false,
2564
+ # user_pool_id: "UserPoolId",
2565
+ # identity_pool_id: "IdentityPoolId",
2566
+ # role_arn: "RoleArn",
2567
+ # },
2568
+ # advanced_options: {
2569
+ # "String" => "String",
2570
+ # },
2571
+ # access_policies: "PolicyDocument",
2572
+ # log_publishing_options: {
2573
+ # "INDEX_SLOW_LOGS" => {
2574
+ # cloud_watch_logs_log_group_arn: "CloudWatchLogsLogGroupArn",
2575
+ # enabled: false,
2576
+ # },
2577
+ # },
2578
+ # encryption_at_rest_options: {
2579
+ # enabled: false,
2580
+ # kms_key_id: "KmsKeyId",
2581
+ # },
2582
+ # domain_endpoint_options: {
2583
+ # enforce_https: false,
2584
+ # tls_security_policy: "Policy-Min-TLS-1-0-2019-07", # accepts Policy-Min-TLS-1-0-2019-07, Policy-Min-TLS-1-2-2019-07
2585
+ # custom_endpoint_enabled: false,
2586
+ # custom_endpoint: "DomainNameFqdn",
2587
+ # custom_endpoint_certificate_arn: "ARN",
2588
+ # },
2589
+ # node_to_node_encryption_options: {
2590
+ # enabled: false,
2591
+ # },
2592
+ # advanced_security_options: {
2593
+ # enabled: false,
2594
+ # internal_user_database_enabled: false,
2595
+ # master_user_options: {
2596
+ # master_user_arn: "ARN",
2597
+ # master_user_name: "Username",
2598
+ # master_user_password: "Password",
2599
+ # },
2600
+ # saml_options: {
2601
+ # enabled: false,
2602
+ # idp: {
2603
+ # metadata_content: "SAMLMetadata", # required
2604
+ # entity_id: "SAMLEntityId", # required
2605
+ # },
2606
+ # master_user_name: "Username",
2607
+ # master_backend_role: "BackendRole",
2608
+ # subject_key: "String",
2609
+ # roles_key: "String",
2610
+ # session_timeout_minutes: 1,
2611
+ # },
2612
+ # },
2613
+ # auto_tune_options: {
2614
+ # desired_state: "ENABLED", # accepts ENABLED, DISABLED
2615
+ # rollback_on_disable: "NO_ROLLBACK", # accepts NO_ROLLBACK, DEFAULT_ROLLBACK
2616
+ # maintenance_schedules: [
2617
+ # {
2618
+ # start_at: Time.now,
2619
+ # duration: {
2620
+ # value: 1,
2621
+ # unit: "HOURS", # accepts HOURS
2622
+ # },
2623
+ # cron_expression_for_recurrence: "String",
2624
+ # },
2625
+ # ],
2626
+ # },
2627
+ # })
2628
+ #
2629
+ # @example Response structure
2630
+ #
2631
+ # resp.domain_config.engine_version.options #=> String
2632
+ # resp.domain_config.engine_version.status.creation_date #=> Time
2633
+ # resp.domain_config.engine_version.status.update_date #=> Time
2634
+ # resp.domain_config.engine_version.status.update_version #=> Integer
2635
+ # resp.domain_config.engine_version.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
2636
+ # resp.domain_config.engine_version.status.pending_deletion #=> Boolean
2637
+ # resp.domain_config.cluster_config.options.instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
2638
+ # resp.domain_config.cluster_config.options.instance_count #=> Integer
2639
+ # resp.domain_config.cluster_config.options.dedicated_master_enabled #=> Boolean
2640
+ # resp.domain_config.cluster_config.options.zone_awareness_enabled #=> Boolean
2641
+ # resp.domain_config.cluster_config.options.zone_awareness_config.availability_zone_count #=> Integer
2642
+ # resp.domain_config.cluster_config.options.dedicated_master_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
2643
+ # resp.domain_config.cluster_config.options.dedicated_master_count #=> Integer
2644
+ # resp.domain_config.cluster_config.options.warm_enabled #=> Boolean
2645
+ # resp.domain_config.cluster_config.options.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
2646
+ # resp.domain_config.cluster_config.options.warm_count #=> Integer
2647
+ # resp.domain_config.cluster_config.options.cold_storage_options.enabled #=> Boolean
2648
+ # resp.domain_config.cluster_config.status.creation_date #=> Time
2649
+ # resp.domain_config.cluster_config.status.update_date #=> Time
2650
+ # resp.domain_config.cluster_config.status.update_version #=> Integer
2651
+ # resp.domain_config.cluster_config.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
2652
+ # resp.domain_config.cluster_config.status.pending_deletion #=> Boolean
2653
+ # resp.domain_config.ebs_options.options.ebs_enabled #=> Boolean
2654
+ # resp.domain_config.ebs_options.options.volume_type #=> String, one of "standard", "gp2", "io1"
2655
+ # resp.domain_config.ebs_options.options.volume_size #=> Integer
2656
+ # resp.domain_config.ebs_options.options.iops #=> Integer
2657
+ # resp.domain_config.ebs_options.status.creation_date #=> Time
2658
+ # resp.domain_config.ebs_options.status.update_date #=> Time
2659
+ # resp.domain_config.ebs_options.status.update_version #=> Integer
2660
+ # resp.domain_config.ebs_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
2661
+ # resp.domain_config.ebs_options.status.pending_deletion #=> Boolean
2662
+ # resp.domain_config.access_policies.options #=> String
2663
+ # resp.domain_config.access_policies.status.creation_date #=> Time
2664
+ # resp.domain_config.access_policies.status.update_date #=> Time
2665
+ # resp.domain_config.access_policies.status.update_version #=> Integer
2666
+ # resp.domain_config.access_policies.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
2667
+ # resp.domain_config.access_policies.status.pending_deletion #=> Boolean
2668
+ # resp.domain_config.snapshot_options.options.automated_snapshot_start_hour #=> Integer
2669
+ # resp.domain_config.snapshot_options.status.creation_date #=> Time
2670
+ # resp.domain_config.snapshot_options.status.update_date #=> Time
2671
+ # resp.domain_config.snapshot_options.status.update_version #=> Integer
2672
+ # resp.domain_config.snapshot_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
2673
+ # resp.domain_config.snapshot_options.status.pending_deletion #=> Boolean
2674
+ # resp.domain_config.vpc_options.options.vpc_id #=> String
2675
+ # resp.domain_config.vpc_options.options.subnet_ids #=> Array
2676
+ # resp.domain_config.vpc_options.options.subnet_ids[0] #=> String
2677
+ # resp.domain_config.vpc_options.options.availability_zones #=> Array
2678
+ # resp.domain_config.vpc_options.options.availability_zones[0] #=> String
2679
+ # resp.domain_config.vpc_options.options.security_group_ids #=> Array
2680
+ # resp.domain_config.vpc_options.options.security_group_ids[0] #=> String
2681
+ # resp.domain_config.vpc_options.status.creation_date #=> Time
2682
+ # resp.domain_config.vpc_options.status.update_date #=> Time
2683
+ # resp.domain_config.vpc_options.status.update_version #=> Integer
2684
+ # resp.domain_config.vpc_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
2685
+ # resp.domain_config.vpc_options.status.pending_deletion #=> Boolean
2686
+ # resp.domain_config.cognito_options.options.enabled #=> Boolean
2687
+ # resp.domain_config.cognito_options.options.user_pool_id #=> String
2688
+ # resp.domain_config.cognito_options.options.identity_pool_id #=> String
2689
+ # resp.domain_config.cognito_options.options.role_arn #=> String
2690
+ # resp.domain_config.cognito_options.status.creation_date #=> Time
2691
+ # resp.domain_config.cognito_options.status.update_date #=> Time
2692
+ # resp.domain_config.cognito_options.status.update_version #=> Integer
2693
+ # resp.domain_config.cognito_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
2694
+ # resp.domain_config.cognito_options.status.pending_deletion #=> Boolean
2695
+ # resp.domain_config.encryption_at_rest_options.options.enabled #=> Boolean
2696
+ # resp.domain_config.encryption_at_rest_options.options.kms_key_id #=> String
2697
+ # resp.domain_config.encryption_at_rest_options.status.creation_date #=> Time
2698
+ # resp.domain_config.encryption_at_rest_options.status.update_date #=> Time
2699
+ # resp.domain_config.encryption_at_rest_options.status.update_version #=> Integer
2700
+ # resp.domain_config.encryption_at_rest_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
2701
+ # resp.domain_config.encryption_at_rest_options.status.pending_deletion #=> Boolean
2702
+ # resp.domain_config.node_to_node_encryption_options.options.enabled #=> Boolean
2703
+ # resp.domain_config.node_to_node_encryption_options.status.creation_date #=> Time
2704
+ # resp.domain_config.node_to_node_encryption_options.status.update_date #=> Time
2705
+ # resp.domain_config.node_to_node_encryption_options.status.update_version #=> Integer
2706
+ # resp.domain_config.node_to_node_encryption_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
2707
+ # resp.domain_config.node_to_node_encryption_options.status.pending_deletion #=> Boolean
2708
+ # resp.domain_config.advanced_options.options #=> Hash
2709
+ # resp.domain_config.advanced_options.options["String"] #=> String
2710
+ # resp.domain_config.advanced_options.status.creation_date #=> Time
2711
+ # resp.domain_config.advanced_options.status.update_date #=> Time
2712
+ # resp.domain_config.advanced_options.status.update_version #=> Integer
2713
+ # resp.domain_config.advanced_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
2714
+ # resp.domain_config.advanced_options.status.pending_deletion #=> Boolean
2715
+ # resp.domain_config.log_publishing_options.options #=> Hash
2716
+ # resp.domain_config.log_publishing_options.options["LogType"].cloud_watch_logs_log_group_arn #=> String
2717
+ # resp.domain_config.log_publishing_options.options["LogType"].enabled #=> Boolean
2718
+ # resp.domain_config.log_publishing_options.status.creation_date #=> Time
2719
+ # resp.domain_config.log_publishing_options.status.update_date #=> Time
2720
+ # resp.domain_config.log_publishing_options.status.update_version #=> Integer
2721
+ # resp.domain_config.log_publishing_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
2722
+ # resp.domain_config.log_publishing_options.status.pending_deletion #=> Boolean
2723
+ # resp.domain_config.domain_endpoint_options.options.enforce_https #=> Boolean
2724
+ # resp.domain_config.domain_endpoint_options.options.tls_security_policy #=> String, one of "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07"
2725
+ # resp.domain_config.domain_endpoint_options.options.custom_endpoint_enabled #=> Boolean
2726
+ # resp.domain_config.domain_endpoint_options.options.custom_endpoint #=> String
2727
+ # resp.domain_config.domain_endpoint_options.options.custom_endpoint_certificate_arn #=> String
2728
+ # resp.domain_config.domain_endpoint_options.status.creation_date #=> Time
2729
+ # resp.domain_config.domain_endpoint_options.status.update_date #=> Time
2730
+ # resp.domain_config.domain_endpoint_options.status.update_version #=> Integer
2731
+ # resp.domain_config.domain_endpoint_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
2732
+ # resp.domain_config.domain_endpoint_options.status.pending_deletion #=> Boolean
2733
+ # resp.domain_config.advanced_security_options.options.enabled #=> Boolean
2734
+ # resp.domain_config.advanced_security_options.options.internal_user_database_enabled #=> Boolean
2735
+ # resp.domain_config.advanced_security_options.options.saml_options.enabled #=> Boolean
2736
+ # resp.domain_config.advanced_security_options.options.saml_options.idp.metadata_content #=> String
2737
+ # resp.domain_config.advanced_security_options.options.saml_options.idp.entity_id #=> String
2738
+ # resp.domain_config.advanced_security_options.options.saml_options.subject_key #=> String
2739
+ # resp.domain_config.advanced_security_options.options.saml_options.roles_key #=> String
2740
+ # resp.domain_config.advanced_security_options.options.saml_options.session_timeout_minutes #=> Integer
2741
+ # resp.domain_config.advanced_security_options.status.creation_date #=> Time
2742
+ # resp.domain_config.advanced_security_options.status.update_date #=> Time
2743
+ # resp.domain_config.advanced_security_options.status.update_version #=> Integer
2744
+ # resp.domain_config.advanced_security_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
2745
+ # resp.domain_config.advanced_security_options.status.pending_deletion #=> Boolean
2746
+ # resp.domain_config.auto_tune_options.options.desired_state #=> String, one of "ENABLED", "DISABLED"
2747
+ # resp.domain_config.auto_tune_options.options.rollback_on_disable #=> String, one of "NO_ROLLBACK", "DEFAULT_ROLLBACK"
2748
+ # resp.domain_config.auto_tune_options.options.maintenance_schedules #=> Array
2749
+ # resp.domain_config.auto_tune_options.options.maintenance_schedules[0].start_at #=> Time
2750
+ # resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.value #=> Integer
2751
+ # resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.unit #=> String, one of "HOURS"
2752
+ # resp.domain_config.auto_tune_options.options.maintenance_schedules[0].cron_expression_for_recurrence #=> String
2753
+ # resp.domain_config.auto_tune_options.status.creation_date #=> Time
2754
+ # resp.domain_config.auto_tune_options.status.update_date #=> Time
2755
+ # resp.domain_config.auto_tune_options.status.update_version #=> Integer
2756
+ # resp.domain_config.auto_tune_options.status.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
2757
+ # resp.domain_config.auto_tune_options.status.error_message #=> String
2758
+ # resp.domain_config.auto_tune_options.status.pending_deletion #=> Boolean
2759
+ #
2760
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDomainConfig AWS API Documentation
2761
+ #
2762
+ # @overload update_domain_config(params = {})
2763
+ # @param [Hash] params ({})
2764
+ def update_domain_config(params = {}, options = {})
2765
+ req = build_request(:update_domain_config, params)
2766
+ req.send_request(options)
2767
+ end
2768
+
2769
+ # Updates a package for use with Amazon OpenSearch Service domains.
2770
+ #
2771
+ # @option params [required, String] :package_id
2772
+ # The unique identifier for the package.
2773
+ #
2774
+ # @option params [required, Types::PackageSource] :package_source
2775
+ # The Amazon S3 location for importing the package specified as
2776
+ # `S3BucketName` and `S3Key`
2777
+ #
2778
+ # @option params [String] :package_description
2779
+ # A new description of the package.
2780
+ #
2781
+ # @option params [String] :commit_message
2782
+ # A commit message for the new version which is shown as part of
2783
+ # `GetPackageVersionHistoryResponse`.
2784
+ #
2785
+ # @return [Types::UpdatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2786
+ #
2787
+ # * {Types::UpdatePackageResponse#package_details #package_details} => Types::PackageDetails
2788
+ #
2789
+ # @example Request syntax with placeholder values
2790
+ #
2791
+ # resp = client.update_package({
2792
+ # package_id: "PackageID", # required
2793
+ # package_source: { # required
2794
+ # s3_bucket_name: "S3BucketName",
2795
+ # s3_key: "S3Key",
2796
+ # },
2797
+ # package_description: "PackageDescription",
2798
+ # commit_message: "CommitMessage",
2799
+ # })
2800
+ #
2801
+ # @example Response structure
2802
+ #
2803
+ # resp.package_details.package_id #=> String
2804
+ # resp.package_details.package_name #=> String
2805
+ # resp.package_details.package_type #=> String, one of "TXT-DICTIONARY"
2806
+ # resp.package_details.package_description #=> String
2807
+ # resp.package_details.package_status #=> String, one of "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED"
2808
+ # resp.package_details.created_at #=> Time
2809
+ # resp.package_details.last_updated_at #=> Time
2810
+ # resp.package_details.available_package_version #=> String
2811
+ # resp.package_details.error_details.error_type #=> String
2812
+ # resp.package_details.error_details.error_message #=> String
2813
+ #
2814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdatePackage AWS API Documentation
2815
+ #
2816
+ # @overload update_package(params = {})
2817
+ # @param [Hash] params ({})
2818
+ def update_package(params = {}, options = {})
2819
+ req = build_request(:update_package, params)
2820
+ req.send_request(options)
2821
+ end
2822
+
2823
+ # Allows you to either upgrade your domain or perform an upgrade
2824
+ # eligibility check to a compatible version of OpenSearch or
2825
+ # Elasticsearch.
2826
+ #
2827
+ # @option params [required, String] :domain_name
2828
+ # The name of an domain. Domain names are unique across the domains
2829
+ # owned by an account within an AWS region. Domain names start with a
2830
+ # letter or number and can contain the following characters: a-z
2831
+ # (lowercase), 0-9, and - (hyphen).
2832
+ #
2833
+ # @option params [required, String] :target_version
2834
+ # The version of OpenSearch you intend to upgrade the domain to.
2835
+ #
2836
+ # @option params [Boolean] :perform_check_only
2837
+ # When true, indicates that an upgrade eligibility check needs to be
2838
+ # performed. Does not actually perform the upgrade.
2839
+ #
2840
+ # @option params [Hash<String,String>] :advanced_options
2841
+ # Exposes select native OpenSearch configuration values from
2842
+ # `opensearch.yml`. Currently, the following advanced options are
2843
+ # available:
2844
+ #
2845
+ # * Option to allow references to indices in an HTTP request body. Must
2846
+ # be `false` when configuring access to individual sub-resources. By
2847
+ # default, the value is `true`. See [Advanced cluster parameters ][1]
2848
+ # for more information.
2849
+ # * Option to specify the percentage of heap space allocated to field
2850
+ # data. By default, this setting is unbounded.
2851
+ #
2852
+ # For more information, see [ Advanced cluster parameters][1].
2853
+ #
2854
+ #
2855
+ #
2856
+ # [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
2857
+ #
2858
+ # @return [Types::UpgradeDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2859
+ #
2860
+ # * {Types::UpgradeDomainResponse#upgrade_id #upgrade_id} => String
2861
+ # * {Types::UpgradeDomainResponse#domain_name #domain_name} => String
2862
+ # * {Types::UpgradeDomainResponse#target_version #target_version} => String
2863
+ # * {Types::UpgradeDomainResponse#perform_check_only #perform_check_only} => Boolean
2864
+ # * {Types::UpgradeDomainResponse#advanced_options #advanced_options} => Hash&lt;String,String&gt;
2865
+ #
2866
+ # @example Request syntax with placeholder values
2867
+ #
2868
+ # resp = client.upgrade_domain({
2869
+ # domain_name: "DomainName", # required
2870
+ # target_version: "VersionString", # required
2871
+ # perform_check_only: false,
2872
+ # advanced_options: {
2873
+ # "String" => "String",
2874
+ # },
2875
+ # })
2876
+ #
2877
+ # @example Response structure
2878
+ #
2879
+ # resp.upgrade_id #=> String
2880
+ # resp.domain_name #=> String
2881
+ # resp.target_version #=> String
2882
+ # resp.perform_check_only #=> Boolean
2883
+ # resp.advanced_options #=> Hash
2884
+ # resp.advanced_options["String"] #=> String
2885
+ #
2886
+ # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpgradeDomain AWS API Documentation
2887
+ #
2888
+ # @overload upgrade_domain(params = {})
2889
+ # @param [Hash] params ({})
2890
+ def upgrade_domain(params = {}, options = {})
2891
+ req = build_request(:upgrade_domain, params)
2892
+ req.send_request(options)
2893
+ end
2894
+
2895
+ # @!endgroup
2896
+
2897
+ # @param params ({})
2898
+ # @api private
2899
+ def build_request(operation_name, params = {})
2900
+ handlers = @handlers.for(operation_name)
2901
+ context = Seahorse::Client::RequestContext.new(
2902
+ operation_name: operation_name,
2903
+ operation: config.api.operation(operation_name),
2904
+ client: self,
2905
+ params: params,
2906
+ config: config)
2907
+ context[:gem_name] = 'aws-sdk-opensearchservice'
2908
+ context[:gem_version] = '1.0.0'
2909
+ Seahorse::Client::Request.new(handlers, context)
2910
+ end
2911
+
2912
+ # @api private
2913
+ # @deprecated
2914
+ def waiter_names
2915
+ []
2916
+ end
2917
+
2918
+ class << self
2919
+
2920
+ # @api private
2921
+ attr_reader :identifier
2922
+
2923
+ # @api private
2924
+ def errors_module
2925
+ Errors
2926
+ end
2927
+
2928
+ end
2929
+ end
2930
+ end