aws-sdk-supportauthz 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-supportauthz/client.rb +1029 -0
- data/lib/aws-sdk-supportauthz/client_api.rb +491 -0
- data/lib/aws-sdk-supportauthz/customizations.rb +0 -0
- data/lib/aws-sdk-supportauthz/endpoint_parameters.rb +59 -0
- data/lib/aws-sdk-supportauthz/endpoint_provider.rb +32 -0
- data/lib/aws-sdk-supportauthz/endpoints.rb +20 -0
- data/lib/aws-sdk-supportauthz/errors.rb +217 -0
- data/lib/aws-sdk-supportauthz/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-supportauthz/resource.rb +26 -0
- data/lib/aws-sdk-supportauthz/types.rb +925 -0
- data/lib/aws-sdk-supportauthz/waiters.rb +15 -0
- data/lib/aws-sdk-supportauthz.rb +62 -0
- data/sig/client.rbs +252 -0
- data/sig/errors.rbs +48 -0
- data/sig/resource.rbs +85 -0
- data/sig/types.rbs +302 -0
- data/sig/waiters.rbs +13 -0
- metadata +97 -0
|
@@ -0,0 +1,1029 @@
|
|
|
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'
|
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration'
|
|
12
|
+
require 'aws-sdk-core/plugins/logging'
|
|
13
|
+
require 'aws-sdk-core/plugins/param_converter'
|
|
14
|
+
require 'aws-sdk-core/plugins/param_validator'
|
|
15
|
+
require 'aws-sdk-core/plugins/user_agent'
|
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors'
|
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors'
|
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration'
|
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint'
|
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery'
|
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern'
|
|
22
|
+
require 'aws-sdk-core/plugins/response_paging'
|
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses'
|
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token'
|
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id'
|
|
26
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter'
|
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin'
|
|
28
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin'
|
|
29
|
+
require 'aws-sdk-core/plugins/transfer_encoding'
|
|
30
|
+
require 'aws-sdk-core/plugins/http_checksum'
|
|
31
|
+
require 'aws-sdk-core/plugins/checksum_algorithm'
|
|
32
|
+
require 'aws-sdk-core/plugins/request_compression'
|
|
33
|
+
require 'aws-sdk-core/plugins/defaults_mode'
|
|
34
|
+
require 'aws-sdk-core/plugins/recursion_detection'
|
|
35
|
+
require 'aws-sdk-core/plugins/telemetry'
|
|
36
|
+
require 'aws-sdk-core/plugins/sign'
|
|
37
|
+
require 'aws-sdk-core/plugins/protocols/rest_json'
|
|
38
|
+
|
|
39
|
+
module Aws::SupportAuthZ
|
|
40
|
+
# An API client for SupportAuthZ. To construct a client, you need to configure a `:region` and `:credentials`.
|
|
41
|
+
#
|
|
42
|
+
# client = Aws::SupportAuthZ::Client.new(
|
|
43
|
+
# region: region_name,
|
|
44
|
+
# credentials: credentials,
|
|
45
|
+
# # ...
|
|
46
|
+
# )
|
|
47
|
+
#
|
|
48
|
+
# For details on configuring region and credentials see
|
|
49
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
|
50
|
+
#
|
|
51
|
+
# See {#initialize} for a full list of supported configuration options.
|
|
52
|
+
class Client < Seahorse::Client::Base
|
|
53
|
+
|
|
54
|
+
include Aws::ClientStubs
|
|
55
|
+
|
|
56
|
+
@identifier = :supportauthz
|
|
57
|
+
|
|
58
|
+
set_api(ClientApi::API)
|
|
59
|
+
|
|
60
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
|
61
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
|
62
|
+
add_plugin(Aws::Plugins::Logging)
|
|
63
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
|
64
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
|
65
|
+
add_plugin(Aws::Plugins::UserAgent)
|
|
66
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
|
67
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
|
68
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
|
69
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
|
70
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
|
71
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
|
72
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
|
73
|
+
add_plugin(Aws::Plugins::StubResponses)
|
|
74
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
|
75
|
+
add_plugin(Aws::Plugins::InvocationId)
|
|
76
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
|
77
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
|
78
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
|
79
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
|
80
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
|
81
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
|
82
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
|
83
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
|
84
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
|
85
|
+
add_plugin(Aws::Plugins::Telemetry)
|
|
86
|
+
add_plugin(Aws::Plugins::Sign)
|
|
87
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
|
88
|
+
add_plugin(Aws::SupportAuthZ::Plugins::Endpoints)
|
|
89
|
+
|
|
90
|
+
# @overload initialize(options)
|
|
91
|
+
# @param [Hash] options
|
|
92
|
+
#
|
|
93
|
+
# @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
|
|
94
|
+
# A list of plugins to apply to the client. Each plugin is either a
|
|
95
|
+
# class name or an instance of a plugin class.
|
|
96
|
+
#
|
|
97
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
|
98
|
+
# Your AWS credentials used for authentication. This can be any class that includes and implements
|
|
99
|
+
# `Aws::CredentialProvider`, or instance of any one of the following classes:
|
|
100
|
+
#
|
|
101
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
|
102
|
+
# credentials.
|
|
103
|
+
#
|
|
104
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
|
105
|
+
# shared file, such as `~/.aws/config`.
|
|
106
|
+
#
|
|
107
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
|
108
|
+
#
|
|
109
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
|
110
|
+
# assume a role after providing credentials via the web.
|
|
111
|
+
#
|
|
112
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
|
113
|
+
# access token generated from `aws login`.
|
|
114
|
+
#
|
|
115
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
|
116
|
+
# process that outputs to stdout.
|
|
117
|
+
#
|
|
118
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
|
119
|
+
# from an EC2 IMDS on an EC2 instance.
|
|
120
|
+
#
|
|
121
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
|
122
|
+
# instances running in ECS.
|
|
123
|
+
#
|
|
124
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
|
125
|
+
# from the Cognito Identity service.
|
|
126
|
+
#
|
|
127
|
+
# When `:credentials` are not configured directly, the following locations will be searched for credentials:
|
|
128
|
+
#
|
|
129
|
+
# * `Aws.config[:credentials]`
|
|
130
|
+
#
|
|
131
|
+
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
|
132
|
+
# `:account_id` options.
|
|
133
|
+
#
|
|
134
|
+
# * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
|
|
135
|
+
# `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
|
|
136
|
+
#
|
|
137
|
+
# * `~/.aws/credentials`
|
|
138
|
+
#
|
|
139
|
+
# * `~/.aws/config`
|
|
140
|
+
#
|
|
141
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
|
|
142
|
+
# Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
|
143
|
+
# enable retries and extended timeouts. Instance profile credential fetching can be disabled by
|
|
144
|
+
# setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
|
|
145
|
+
#
|
|
146
|
+
# @option options [required, String] :region
|
|
147
|
+
# The AWS region to connect to. The configured `:region` is
|
|
148
|
+
# used to determine the service `:endpoint`. When not passed,
|
|
149
|
+
# a default `:region` is searched for in the following locations:
|
|
150
|
+
#
|
|
151
|
+
# * `Aws.config[:region]`
|
|
152
|
+
# * `ENV['AWS_REGION']`
|
|
153
|
+
# * `ENV['AMAZON_REGION']`
|
|
154
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
|
155
|
+
# * `~/.aws/credentials`
|
|
156
|
+
# * `~/.aws/config`
|
|
157
|
+
#
|
|
158
|
+
# @option options [String] :access_key_id
|
|
159
|
+
#
|
|
160
|
+
# @option options [String] :account_id
|
|
161
|
+
#
|
|
162
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
|
163
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
|
164
|
+
# the background every 60 secs (default). Defaults to `false`.
|
|
165
|
+
#
|
|
166
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
|
167
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
|
168
|
+
# until there is sufficent client side capacity to retry the request.
|
|
169
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
|
170
|
+
# not retry instead of sleeping.
|
|
171
|
+
#
|
|
172
|
+
# @option options [Array<String>] :auth_scheme_preference
|
|
173
|
+
# A list of preferred authentication schemes to use when making a request. Supported values are:
|
|
174
|
+
# `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
|
|
175
|
+
# shared config as `auth_scheme_preference`, the value should be a comma-separated list.
|
|
176
|
+
#
|
|
177
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
|
178
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
|
179
|
+
# this client.
|
|
180
|
+
#
|
|
181
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
|
182
|
+
# Allows you to provide an identifier for this client which will be attached to
|
|
183
|
+
# all generated client side metrics. Defaults to an empty string.
|
|
184
|
+
#
|
|
185
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
|
186
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
|
187
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
|
188
|
+
#
|
|
189
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
|
190
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
|
191
|
+
# agent is running on, where client metrics will be published via UDP.
|
|
192
|
+
#
|
|
193
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
|
194
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
|
195
|
+
# will use the Client Side Monitoring Agent Publisher.
|
|
196
|
+
#
|
|
197
|
+
# @option options [Boolean] :convert_params (true)
|
|
198
|
+
# When `true`, an attempt is made to coerce request parameters into
|
|
199
|
+
# the required types.
|
|
200
|
+
#
|
|
201
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
|
202
|
+
# Used only in `standard` and `adaptive` retry modes. Specifies whether to apply
|
|
203
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
|
204
|
+
#
|
|
205
|
+
# @option options [String] :defaults_mode ("legacy")
|
|
206
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
|
207
|
+
# accepted modes and the configuration defaults that are included.
|
|
208
|
+
#
|
|
209
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
|
210
|
+
# When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
|
|
211
|
+
#
|
|
212
|
+
# @option options [Boolean] :disable_request_compression (false)
|
|
213
|
+
# When set to 'true' the request body will not be compressed
|
|
214
|
+
# for supported operations.
|
|
215
|
+
#
|
|
216
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
|
217
|
+
# Normally you should not configure the `:endpoint` option
|
|
218
|
+
# directly. This is normally constructed from the `:region`
|
|
219
|
+
# option. Configuring `:endpoint` is normally reserved for
|
|
220
|
+
# connecting to test or custom endpoints. The endpoint should
|
|
221
|
+
# be a URI formatted like:
|
|
222
|
+
#
|
|
223
|
+
# 'http://example.com'
|
|
224
|
+
# 'https://example.com'
|
|
225
|
+
# 'http://example.com:123'
|
|
226
|
+
#
|
|
227
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
|
228
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
|
229
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
|
230
|
+
#
|
|
231
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
|
232
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
|
233
|
+
#
|
|
234
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
|
235
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
|
236
|
+
# Use this option to config the time interval in seconds for making
|
|
237
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
|
238
|
+
#
|
|
239
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
|
240
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
|
241
|
+
#
|
|
242
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
|
243
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
|
244
|
+
# variables and the shared configuration file.
|
|
245
|
+
#
|
|
246
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
247
|
+
# The log formatter.
|
|
248
|
+
#
|
|
249
|
+
# @option options [Symbol] :log_level (:info)
|
|
250
|
+
# The log level to send messages to the `:logger` at.
|
|
251
|
+
#
|
|
252
|
+
# @option options [Logger] :logger
|
|
253
|
+
# The Logger instance to send log messages to. If this option
|
|
254
|
+
# is not set, logging will be disabled.
|
|
255
|
+
#
|
|
256
|
+
# @option options [Integer] :max_attempts (3)
|
|
257
|
+
# An integer representing the maximum number attempts that will be made for
|
|
258
|
+
# a single request, including the initial attempt. For example,
|
|
259
|
+
# setting this value to 5 will result in a request being retried up to
|
|
260
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
|
261
|
+
#
|
|
262
|
+
# @option options [String] :profile ("default")
|
|
263
|
+
# Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
|
|
264
|
+
# When not specified, 'default' is used.
|
|
265
|
+
#
|
|
266
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
|
267
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
|
268
|
+
#
|
|
269
|
+
# * `when_supported` - (default) When set, a checksum will be
|
|
270
|
+
# calculated for all request payloads of operations modeled with the
|
|
271
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
|
272
|
+
# `requestAlgorithmMember` is modeled.
|
|
273
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
|
274
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
|
275
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
|
276
|
+
# is modeled and supplied.
|
|
277
|
+
#
|
|
278
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
|
279
|
+
# The minimum size in bytes that triggers compression for request
|
|
280
|
+
# bodies. The value must be non-negative integer value between 0
|
|
281
|
+
# and 10485780 bytes inclusive.
|
|
282
|
+
#
|
|
283
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
|
284
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
|
285
|
+
#
|
|
286
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
|
287
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
|
288
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
|
289
|
+
# are supported.
|
|
290
|
+
# * `when_required` - When set, checksum validation is not performed on
|
|
291
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
|
292
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
|
293
|
+
#
|
|
294
|
+
# @option options [Proc] :retry_backoff
|
|
295
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
|
296
|
+
# This option is only used in the `legacy` retry mode.
|
|
297
|
+
#
|
|
298
|
+
# @option options [Float] :retry_base_delay (0.3)
|
|
299
|
+
# The base delay in seconds used by the default backoff function. This option
|
|
300
|
+
# is only used in the `legacy` retry mode.
|
|
301
|
+
#
|
|
302
|
+
# @option options [Symbol] :retry_jitter (:none)
|
|
303
|
+
# A delay randomiser function used by the default backoff function.
|
|
304
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
|
305
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
|
306
|
+
# in the `legacy` retry mode.
|
|
307
|
+
#
|
|
308
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
|
309
|
+
#
|
|
310
|
+
# @option options [Integer] :retry_limit (3)
|
|
311
|
+
# The maximum number of times to retry failed requests. Only
|
|
312
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
|
313
|
+
# are retried. Generally, these are throttling errors, data
|
|
314
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
|
315
|
+
# endpoint discovery, and errors from expired credentials.
|
|
316
|
+
# This option is only used in the `legacy` retry mode.
|
|
317
|
+
#
|
|
318
|
+
# @option options [Integer] :retry_max_delay (0)
|
|
319
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
|
320
|
+
# used by the default backoff function. This option is only used in the
|
|
321
|
+
# `legacy` retry mode.
|
|
322
|
+
#
|
|
323
|
+
# @option options [String] :retry_mode ("legacy")
|
|
324
|
+
# Specifies which retry algorithm to use. Values are:
|
|
325
|
+
#
|
|
326
|
+
# * `legacy` - The pre-existing retry behavior. This is the default
|
|
327
|
+
# value if no retry mode is provided.
|
|
328
|
+
#
|
|
329
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
|
330
|
+
# This includes support for retry quotas, which limit the number of
|
|
331
|
+
# unsuccessful retries a client can make.
|
|
332
|
+
#
|
|
333
|
+
# * `adaptive` - A retry mode that includes all the functionality of
|
|
334
|
+
# `standard` mode along with automatic client side throttling.
|
|
335
|
+
#
|
|
336
|
+
# @option options [String] :sdk_ua_app_id
|
|
337
|
+
# A unique and opaque application ID that is appended to the
|
|
338
|
+
# User-Agent header as app/sdk_ua_app_id. It should have a
|
|
339
|
+
# maximum length of 50. This variable is sourced from environment
|
|
340
|
+
# variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
|
|
341
|
+
#
|
|
342
|
+
# @option options [String] :secret_access_key
|
|
343
|
+
#
|
|
344
|
+
# @option options [String] :session_token
|
|
345
|
+
#
|
|
346
|
+
# @option options [Array] :sigv4a_signing_region_set
|
|
347
|
+
# A list of regions that should be signed with SigV4a signing. When
|
|
348
|
+
# not passed, a default `:sigv4a_signing_region_set` is searched for
|
|
349
|
+
# in the following locations:
|
|
350
|
+
#
|
|
351
|
+
# * `Aws.config[:sigv4a_signing_region_set]`
|
|
352
|
+
# * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
|
|
353
|
+
# * `~/.aws/config`
|
|
354
|
+
#
|
|
355
|
+
# @option options [Boolean] :stub_responses (false)
|
|
356
|
+
# Causes the client to return stubbed responses. By default
|
|
357
|
+
# fake responses are generated and returned. You can specify
|
|
358
|
+
# the response data to return or errors to raise by calling
|
|
359
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
|
360
|
+
#
|
|
361
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
362
|
+
# requests are made, and retries are disabled.
|
|
363
|
+
#
|
|
364
|
+
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
|
|
365
|
+
# Allows you to provide a telemetry provider, which is used to
|
|
366
|
+
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
|
|
367
|
+
# will not record or emit any telemetry data. The SDK supports the
|
|
368
|
+
# following telemetry providers:
|
|
369
|
+
#
|
|
370
|
+
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
|
|
371
|
+
# `opentelemetry-sdk` gem and then, pass in an instance of a
|
|
372
|
+
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
|
373
|
+
#
|
|
374
|
+
# @option options [Aws::TokenProvider] :token_provider
|
|
375
|
+
# Your Bearer token used for authentication. This can be any class that includes and implements
|
|
376
|
+
# `Aws::TokenProvider`, or instance of any one of the following classes:
|
|
377
|
+
#
|
|
378
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
|
379
|
+
# tokens.
|
|
380
|
+
#
|
|
381
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
|
382
|
+
# access token generated from `aws login`.
|
|
383
|
+
#
|
|
384
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
|
385
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
|
386
|
+
#
|
|
387
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
|
388
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
|
389
|
+
# will be used if available.
|
|
390
|
+
#
|
|
391
|
+
# @option options [Boolean] :use_fips_endpoint
|
|
392
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
|
393
|
+
# When a `fips` region is used, the region is normalized and this config
|
|
394
|
+
# is set to `true`.
|
|
395
|
+
#
|
|
396
|
+
# @option options [Boolean] :validate_params (true)
|
|
397
|
+
# When `true`, request parameters are validated before
|
|
398
|
+
# sending the request.
|
|
399
|
+
#
|
|
400
|
+
# @option options [Aws::SupportAuthZ::EndpointProvider] :endpoint_provider
|
|
401
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to
|
|
402
|
+
# `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
|
|
403
|
+
# `Aws::SupportAuthZ::EndpointParameters`.
|
|
404
|
+
#
|
|
405
|
+
# @option options [Float] :http_continue_timeout (1)
|
|
406
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
|
407
|
+
# request body. This option has no effect unless the request has "Expect"
|
|
408
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
|
409
|
+
# behaviour. This value can safely be set per request on the session.
|
|
410
|
+
#
|
|
411
|
+
# @option options [Float] :http_idle_timeout (5)
|
|
412
|
+
# The number of seconds a connection is allowed to sit idle before it
|
|
413
|
+
# is considered stale. Stale connections are closed and removed from the
|
|
414
|
+
# pool before making a request.
|
|
415
|
+
#
|
|
416
|
+
# @option options [Float] :http_open_timeout (15)
|
|
417
|
+
# The default number of seconds to wait for response data.
|
|
418
|
+
# This value can safely be set per-request on the session.
|
|
419
|
+
#
|
|
420
|
+
# @option options [URI::HTTP,String] :http_proxy
|
|
421
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
|
422
|
+
#
|
|
423
|
+
# @option options [Float] :http_read_timeout (60)
|
|
424
|
+
# The default number of seconds to wait for response data.
|
|
425
|
+
# This value can safely be set per-request on the session.
|
|
426
|
+
#
|
|
427
|
+
# @option options [Boolean] :http_wire_trace (false)
|
|
428
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
|
429
|
+
#
|
|
430
|
+
# @option options [Proc] :on_chunk_received
|
|
431
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
|
432
|
+
# of the response body is received. It provides three arguments: the chunk,
|
|
433
|
+
# the number of bytes received, and the total number of
|
|
434
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
|
435
|
+
#
|
|
436
|
+
# @option options [Proc] :on_chunk_sent
|
|
437
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
|
438
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
|
439
|
+
# the number of bytes read from the body, and the total number of
|
|
440
|
+
# bytes in the body.
|
|
441
|
+
#
|
|
442
|
+
# @option options [Boolean] :raise_response_errors (true)
|
|
443
|
+
# When `true`, response errors are raised.
|
|
444
|
+
#
|
|
445
|
+
# @option options [String] :ssl_ca_bundle
|
|
446
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
|
447
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
|
448
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
|
449
|
+
#
|
|
450
|
+
# @option options [String] :ssl_ca_directory
|
|
451
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
|
452
|
+
# authority files for verifying peer certificates. If you do
|
|
453
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
|
454
|
+
# default will be used if available.
|
|
455
|
+
#
|
|
456
|
+
# @option options [String] :ssl_ca_store
|
|
457
|
+
# Sets the X509::Store to verify peer certificate.
|
|
458
|
+
#
|
|
459
|
+
# @option options [OpenSSL::X509::Certificate] :ssl_cert
|
|
460
|
+
# Sets a client certificate when creating http connections.
|
|
461
|
+
#
|
|
462
|
+
# @option options [OpenSSL::PKey] :ssl_key
|
|
463
|
+
# Sets a client key when creating http connections.
|
|
464
|
+
#
|
|
465
|
+
# @option options [Float] :ssl_timeout
|
|
466
|
+
# Sets the SSL timeout in seconds
|
|
467
|
+
#
|
|
468
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
|
469
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
|
470
|
+
#
|
|
471
|
+
def initialize(*args)
|
|
472
|
+
super
|
|
473
|
+
end
|
|
474
|
+
|
|
475
|
+
# @!group API Operations
|
|
476
|
+
|
|
477
|
+
# Creates a support permit that authorizes an AWS support operator to
|
|
478
|
+
# perform specified actions on specified resources. The permit is
|
|
479
|
+
# cryptographically signed using a customer-managed AWS KMS key
|
|
480
|
+
# (ECC\_NIST\_P384, SIGN\_VERIFY) to ensure non-repudiation.
|
|
481
|
+
#
|
|
482
|
+
# @option params [required, Types::Permit] :permit
|
|
483
|
+
# The permit definition specifying the actions, resources, and
|
|
484
|
+
# time-window conditions that the support operator is authorized to use.
|
|
485
|
+
#
|
|
486
|
+
# @option params [required, String] :name
|
|
487
|
+
# A customer-chosen name for the support permit. Must be between 1 and
|
|
488
|
+
# 256 alphanumeric characters.
|
|
489
|
+
#
|
|
490
|
+
# @option params [String] :description
|
|
491
|
+
# A human-readable description of why this permit is being created.
|
|
492
|
+
# Maximum length of 1024 characters.
|
|
493
|
+
#
|
|
494
|
+
# @option params [required, Types::SigningKeyInfo] :signing_key_info
|
|
495
|
+
# The signing key information used to sign the permit. Must reference an
|
|
496
|
+
# AWS KMS key with key usage SIGN\_VERIFY and key spec ECC\_NIST\_P384.
|
|
497
|
+
#
|
|
498
|
+
# @option params [String] :support_case_display_id
|
|
499
|
+
# The display identifier of the AWS Support case associated with this
|
|
500
|
+
# permit.
|
|
501
|
+
#
|
|
502
|
+
# @option params [String] :client_token
|
|
503
|
+
# A unique, case-sensitive identifier to ensure that the operation
|
|
504
|
+
# completes no more than one time. If this token matches a previous
|
|
505
|
+
# request, the service returns the existing permit without creating a
|
|
506
|
+
# duplicate.
|
|
507
|
+
#
|
|
508
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
509
|
+
# not need to pass this option.**
|
|
510
|
+
#
|
|
511
|
+
# @option params [Hash<String,String>] :tags
|
|
512
|
+
# The tags to associate with the support permit on creation.
|
|
513
|
+
#
|
|
514
|
+
# @return [Types::CreateSupportPermitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
515
|
+
#
|
|
516
|
+
# * {Types::CreateSupportPermitOutput#name #name} => String
|
|
517
|
+
# * {Types::CreateSupportPermitOutput#arn #arn} => String
|
|
518
|
+
# * {Types::CreateSupportPermitOutput#description #description} => String
|
|
519
|
+
# * {Types::CreateSupportPermitOutput#permit #permit} => Types::Permit
|
|
520
|
+
# * {Types::CreateSupportPermitOutput#status #status} => String
|
|
521
|
+
# * {Types::CreateSupportPermitOutput#signing_key_info #signing_key_info} => Types::SigningKeyInfo
|
|
522
|
+
# * {Types::CreateSupportPermitOutput#created_at #created_at} => Time
|
|
523
|
+
# * {Types::CreateSupportPermitOutput#support_case_display_id #support_case_display_id} => String
|
|
524
|
+
# * {Types::CreateSupportPermitOutput#tags #tags} => Hash<String,String>
|
|
525
|
+
#
|
|
526
|
+
# @example Request syntax with placeholder values
|
|
527
|
+
#
|
|
528
|
+
# resp = client.create_support_permit({
|
|
529
|
+
# permit: { # required
|
|
530
|
+
# actions: { # required
|
|
531
|
+
# all_actions: {
|
|
532
|
+
# },
|
|
533
|
+
# actions: ["Action"],
|
|
534
|
+
# },
|
|
535
|
+
# resources: { # required
|
|
536
|
+
# all_resources_in_region: {
|
|
537
|
+
# },
|
|
538
|
+
# resources: ["Resource"],
|
|
539
|
+
# },
|
|
540
|
+
# conditions: [
|
|
541
|
+
# {
|
|
542
|
+
# allow_after: Time.now,
|
|
543
|
+
# allow_before: Time.now,
|
|
544
|
+
# },
|
|
545
|
+
# ],
|
|
546
|
+
# },
|
|
547
|
+
# name: "Name", # required
|
|
548
|
+
# description: "Description",
|
|
549
|
+
# signing_key_info: { # required
|
|
550
|
+
# kms_key: "KmsKeyArn",
|
|
551
|
+
# },
|
|
552
|
+
# support_case_display_id: "SupportCaseDisplayId",
|
|
553
|
+
# client_token: "ClientToken",
|
|
554
|
+
# tags: {
|
|
555
|
+
# "TagKey" => "TagValue",
|
|
556
|
+
# },
|
|
557
|
+
# })
|
|
558
|
+
#
|
|
559
|
+
# @example Response structure
|
|
560
|
+
#
|
|
561
|
+
# resp.name #=> String
|
|
562
|
+
# resp.arn #=> String
|
|
563
|
+
# resp.description #=> String
|
|
564
|
+
# resp.permit.actions.actions #=> Array
|
|
565
|
+
# resp.permit.actions.actions[0] #=> String
|
|
566
|
+
# resp.permit.resources.resources #=> Array
|
|
567
|
+
# resp.permit.resources.resources[0] #=> String
|
|
568
|
+
# resp.permit.conditions #=> Array
|
|
569
|
+
# resp.permit.conditions[0].allow_after #=> Time
|
|
570
|
+
# resp.permit.conditions[0].allow_before #=> Time
|
|
571
|
+
# resp.status #=> String, one of "ACTIVE", "INACTIVE", "DELETING"
|
|
572
|
+
# resp.signing_key_info.kms_key #=> String
|
|
573
|
+
# resp.created_at #=> Time
|
|
574
|
+
# resp.support_case_display_id #=> String
|
|
575
|
+
# resp.tags #=> Hash
|
|
576
|
+
# resp.tags["TagKey"] #=> String
|
|
577
|
+
#
|
|
578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supportauthz-2026-06-30/CreateSupportPermit AWS API Documentation
|
|
579
|
+
#
|
|
580
|
+
# @overload create_support_permit(params = {})
|
|
581
|
+
# @param [Hash] params ({})
|
|
582
|
+
def create_support_permit(params = {}, options = {})
|
|
583
|
+
req = build_request(:create_support_permit, params)
|
|
584
|
+
req.send_request(options)
|
|
585
|
+
end
|
|
586
|
+
|
|
587
|
+
# Deletes a support permit, revoking the authorization previously
|
|
588
|
+
# granted to the AWS support operator.
|
|
589
|
+
#
|
|
590
|
+
# @option params [required, String] :support_permit_identifier
|
|
591
|
+
# The Amazon Resource Name (ARN) or name of the support permit to
|
|
592
|
+
# delete.
|
|
593
|
+
#
|
|
594
|
+
# @return [Types::DeleteSupportPermitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
595
|
+
#
|
|
596
|
+
# * {Types::DeleteSupportPermitOutput#name #name} => String
|
|
597
|
+
# * {Types::DeleteSupportPermitOutput#arn #arn} => String
|
|
598
|
+
# * {Types::DeleteSupportPermitOutput#description #description} => String
|
|
599
|
+
# * {Types::DeleteSupportPermitOutput#permit #permit} => Types::Permit
|
|
600
|
+
# * {Types::DeleteSupportPermitOutput#status #status} => String
|
|
601
|
+
# * {Types::DeleteSupportPermitOutput#signing_key_info #signing_key_info} => Types::SigningKeyInfo
|
|
602
|
+
# * {Types::DeleteSupportPermitOutput#created_at #created_at} => Time
|
|
603
|
+
# * {Types::DeleteSupportPermitOutput#support_case_display_id #support_case_display_id} => String
|
|
604
|
+
#
|
|
605
|
+
# @example Request syntax with placeholder values
|
|
606
|
+
#
|
|
607
|
+
# resp = client.delete_support_permit({
|
|
608
|
+
# support_permit_identifier: "Arn", # required
|
|
609
|
+
# })
|
|
610
|
+
#
|
|
611
|
+
# @example Response structure
|
|
612
|
+
#
|
|
613
|
+
# resp.name #=> String
|
|
614
|
+
# resp.arn #=> String
|
|
615
|
+
# resp.description #=> String
|
|
616
|
+
# resp.permit.actions.actions #=> Array
|
|
617
|
+
# resp.permit.actions.actions[0] #=> String
|
|
618
|
+
# resp.permit.resources.resources #=> Array
|
|
619
|
+
# resp.permit.resources.resources[0] #=> String
|
|
620
|
+
# resp.permit.conditions #=> Array
|
|
621
|
+
# resp.permit.conditions[0].allow_after #=> Time
|
|
622
|
+
# resp.permit.conditions[0].allow_before #=> Time
|
|
623
|
+
# resp.status #=> String, one of "ACTIVE", "INACTIVE", "DELETING"
|
|
624
|
+
# resp.signing_key_info.kms_key #=> String
|
|
625
|
+
# resp.created_at #=> Time
|
|
626
|
+
# resp.support_case_display_id #=> String
|
|
627
|
+
#
|
|
628
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supportauthz-2026-06-30/DeleteSupportPermit AWS API Documentation
|
|
629
|
+
#
|
|
630
|
+
# @overload delete_support_permit(params = {})
|
|
631
|
+
# @param [Hash] params ({})
|
|
632
|
+
def delete_support_permit(params = {}, options = {})
|
|
633
|
+
req = build_request(:delete_support_permit, params)
|
|
634
|
+
req.send_request(options)
|
|
635
|
+
end
|
|
636
|
+
|
|
637
|
+
# Retrieves the description of a specific support action.
|
|
638
|
+
#
|
|
639
|
+
# @option params [required, String] :action
|
|
640
|
+
# The name of the support action to retrieve.
|
|
641
|
+
#
|
|
642
|
+
# @return [Types::GetActionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
643
|
+
#
|
|
644
|
+
# * {Types::GetActionOutput#action #action} => String
|
|
645
|
+
# * {Types::GetActionOutput#service #service} => String
|
|
646
|
+
# * {Types::GetActionOutput#description #description} => String
|
|
647
|
+
#
|
|
648
|
+
# @example Request syntax with placeholder values
|
|
649
|
+
#
|
|
650
|
+
# resp = client.get_action({
|
|
651
|
+
# action: "Action", # required
|
|
652
|
+
# })
|
|
653
|
+
#
|
|
654
|
+
# @example Response structure
|
|
655
|
+
#
|
|
656
|
+
# resp.action #=> String
|
|
657
|
+
# resp.service #=> String
|
|
658
|
+
# resp.description #=> String
|
|
659
|
+
#
|
|
660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supportauthz-2026-06-30/GetAction AWS API Documentation
|
|
661
|
+
#
|
|
662
|
+
# @overload get_action(params = {})
|
|
663
|
+
# @param [Hash] params ({})
|
|
664
|
+
def get_action(params = {}, options = {})
|
|
665
|
+
req = build_request(:get_action, params)
|
|
666
|
+
req.send_request(options)
|
|
667
|
+
end
|
|
668
|
+
|
|
669
|
+
# Retrieves the details of a support permit by its ARN or name.
|
|
670
|
+
#
|
|
671
|
+
# @option params [required, String] :support_permit_identifier
|
|
672
|
+
# The ARN or name of the support permit to retrieve.
|
|
673
|
+
#
|
|
674
|
+
# @return [Types::GetSupportPermitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
675
|
+
#
|
|
676
|
+
# * {Types::GetSupportPermitOutput#name #name} => String
|
|
677
|
+
# * {Types::GetSupportPermitOutput#arn #arn} => String
|
|
678
|
+
# * {Types::GetSupportPermitOutput#description #description} => String
|
|
679
|
+
# * {Types::GetSupportPermitOutput#permit #permit} => Types::Permit
|
|
680
|
+
# * {Types::GetSupportPermitOutput#status #status} => String
|
|
681
|
+
# * {Types::GetSupportPermitOutput#signing_key_info #signing_key_info} => Types::SigningKeyInfo
|
|
682
|
+
# * {Types::GetSupportPermitOutput#created_at #created_at} => Time
|
|
683
|
+
# * {Types::GetSupportPermitOutput#support_case_display_id #support_case_display_id} => String
|
|
684
|
+
# * {Types::GetSupportPermitOutput#tags #tags} => Hash<String,String>
|
|
685
|
+
#
|
|
686
|
+
# @example Request syntax with placeholder values
|
|
687
|
+
#
|
|
688
|
+
# resp = client.get_support_permit({
|
|
689
|
+
# support_permit_identifier: "SupportPermitIdentifier", # required
|
|
690
|
+
# })
|
|
691
|
+
#
|
|
692
|
+
# @example Response structure
|
|
693
|
+
#
|
|
694
|
+
# resp.name #=> String
|
|
695
|
+
# resp.arn #=> String
|
|
696
|
+
# resp.description #=> String
|
|
697
|
+
# resp.permit.actions.actions #=> Array
|
|
698
|
+
# resp.permit.actions.actions[0] #=> String
|
|
699
|
+
# resp.permit.resources.resources #=> Array
|
|
700
|
+
# resp.permit.resources.resources[0] #=> String
|
|
701
|
+
# resp.permit.conditions #=> Array
|
|
702
|
+
# resp.permit.conditions[0].allow_after #=> Time
|
|
703
|
+
# resp.permit.conditions[0].allow_before #=> Time
|
|
704
|
+
# resp.status #=> String, one of "ACTIVE", "INACTIVE", "DELETING"
|
|
705
|
+
# resp.signing_key_info.kms_key #=> String
|
|
706
|
+
# resp.created_at #=> Time
|
|
707
|
+
# resp.support_case_display_id #=> String
|
|
708
|
+
# resp.tags #=> Hash
|
|
709
|
+
# resp.tags["TagKey"] #=> String
|
|
710
|
+
#
|
|
711
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supportauthz-2026-06-30/GetSupportPermit AWS API Documentation
|
|
712
|
+
#
|
|
713
|
+
# @overload get_support_permit(params = {})
|
|
714
|
+
# @param [Hash] params ({})
|
|
715
|
+
def get_support_permit(params = {}, options = {})
|
|
716
|
+
req = build_request(:get_support_permit, params)
|
|
717
|
+
req.send_request(options)
|
|
718
|
+
end
|
|
719
|
+
|
|
720
|
+
# Lists available support actions for a specified AWS service. Use
|
|
721
|
+
# pagination to ensure that the operation returns quickly and
|
|
722
|
+
# successfully.
|
|
723
|
+
#
|
|
724
|
+
# @option params [String] :next_token
|
|
725
|
+
# The token for the next page of results.
|
|
726
|
+
#
|
|
727
|
+
# @option params [Integer] :max_results
|
|
728
|
+
# The maximum number of results to return in a single call. Valid range
|
|
729
|
+
# is 1 to 100.
|
|
730
|
+
#
|
|
731
|
+
# @option params [required, String] :service
|
|
732
|
+
# The name of the AWS service for which to list available support
|
|
733
|
+
# actions.
|
|
734
|
+
#
|
|
735
|
+
# @return [Types::ListActionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
736
|
+
#
|
|
737
|
+
# * {Types::ListActionsOutput#action_summaries #action_summaries} => Array<Types::ActionSummary>
|
|
738
|
+
# * {Types::ListActionsOutput#next_token #next_token} => String
|
|
739
|
+
#
|
|
740
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
741
|
+
#
|
|
742
|
+
# @example Request syntax with placeholder values
|
|
743
|
+
#
|
|
744
|
+
# resp = client.list_actions({
|
|
745
|
+
# next_token: "NextToken",
|
|
746
|
+
# max_results: 1,
|
|
747
|
+
# service: "Service", # required
|
|
748
|
+
# })
|
|
749
|
+
#
|
|
750
|
+
# @example Response structure
|
|
751
|
+
#
|
|
752
|
+
# resp.action_summaries #=> Array
|
|
753
|
+
# resp.action_summaries[0].action #=> String
|
|
754
|
+
# resp.action_summaries[0].service #=> String
|
|
755
|
+
# resp.action_summaries[0].description #=> String
|
|
756
|
+
# resp.next_token #=> String
|
|
757
|
+
#
|
|
758
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supportauthz-2026-06-30/ListActions AWS API Documentation
|
|
759
|
+
#
|
|
760
|
+
# @overload list_actions(params = {})
|
|
761
|
+
# @param [Hash] params ({})
|
|
762
|
+
def list_actions(params = {}, options = {})
|
|
763
|
+
req = build_request(:list_actions, params)
|
|
764
|
+
req.send_request(options)
|
|
765
|
+
end
|
|
766
|
+
|
|
767
|
+
# Lists permit requests from AWS support operators. Use pagination to
|
|
768
|
+
# ensure that the operation returns quickly and successfully.
|
|
769
|
+
#
|
|
770
|
+
# @option params [String] :next_token
|
|
771
|
+
# The token for the next page of results.
|
|
772
|
+
#
|
|
773
|
+
# @option params [Integer] :max_results
|
|
774
|
+
# The maximum number of results to return in a single call. Valid range
|
|
775
|
+
# is 1 to 100.
|
|
776
|
+
#
|
|
777
|
+
# @option params [String] :support_case_display_id
|
|
778
|
+
# Filters the results by support case display identifier.
|
|
779
|
+
#
|
|
780
|
+
# @return [Types::ListSupportPermitRequestsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
781
|
+
#
|
|
782
|
+
# * {Types::ListSupportPermitRequestsOutput#support_permit_requests #support_permit_requests} => Array<Types::SupportPermitRequest>
|
|
783
|
+
# * {Types::ListSupportPermitRequestsOutput#next_token #next_token} => String
|
|
784
|
+
#
|
|
785
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
786
|
+
#
|
|
787
|
+
# @example Request syntax with placeholder values
|
|
788
|
+
#
|
|
789
|
+
# resp = client.list_support_permit_requests({
|
|
790
|
+
# next_token: "NextToken",
|
|
791
|
+
# max_results: 1,
|
|
792
|
+
# support_case_display_id: "SupportCaseDisplayId",
|
|
793
|
+
# })
|
|
794
|
+
#
|
|
795
|
+
# @example Response structure
|
|
796
|
+
#
|
|
797
|
+
# resp.support_permit_requests #=> Array
|
|
798
|
+
# resp.support_permit_requests[0].request_arn #=> String
|
|
799
|
+
# resp.support_permit_requests[0].permit.actions.actions #=> Array
|
|
800
|
+
# resp.support_permit_requests[0].permit.actions.actions[0] #=> String
|
|
801
|
+
# resp.support_permit_requests[0].permit.resources.resources #=> Array
|
|
802
|
+
# resp.support_permit_requests[0].permit.resources.resources[0] #=> String
|
|
803
|
+
# resp.support_permit_requests[0].permit.conditions #=> Array
|
|
804
|
+
# resp.support_permit_requests[0].permit.conditions[0].allow_after #=> Time
|
|
805
|
+
# resp.support_permit_requests[0].permit.conditions[0].allow_before #=> Time
|
|
806
|
+
# resp.support_permit_requests[0].support_case_display_id #=> String
|
|
807
|
+
# resp.support_permit_requests[0].status #=> String, one of "PENDING", "ACCEPTED", "REJECTED", "CANCELLED"
|
|
808
|
+
# resp.support_permit_requests[0].created_at #=> Time
|
|
809
|
+
# resp.support_permit_requests[0].updated_at #=> Time
|
|
810
|
+
# resp.next_token #=> String
|
|
811
|
+
#
|
|
812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supportauthz-2026-06-30/ListSupportPermitRequests AWS API Documentation
|
|
813
|
+
#
|
|
814
|
+
# @overload list_support_permit_requests(params = {})
|
|
815
|
+
# @param [Hash] params ({})
|
|
816
|
+
def list_support_permit_requests(params = {}, options = {})
|
|
817
|
+
req = build_request(:list_support_permit_requests, params)
|
|
818
|
+
req.send_request(options)
|
|
819
|
+
end
|
|
820
|
+
|
|
821
|
+
# Lists all support permits in the caller's account. Use pagination to
|
|
822
|
+
# ensure that the operation returns quickly and successfully.
|
|
823
|
+
#
|
|
824
|
+
# @option params [String] :next_token
|
|
825
|
+
# The token for the next page of results.
|
|
826
|
+
#
|
|
827
|
+
# @option params [Integer] :max_results
|
|
828
|
+
# The maximum number of results to return in a single call. Valid range
|
|
829
|
+
# is 1 to 100.
|
|
830
|
+
#
|
|
831
|
+
# @option params [Array<String>] :support_permit_statuses
|
|
832
|
+
# Filters the results by support permit status. Valid values: ACTIVE,
|
|
833
|
+
# INACTIVE, DELETING.
|
|
834
|
+
#
|
|
835
|
+
# @return [Types::ListSupportPermitsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
836
|
+
#
|
|
837
|
+
# * {Types::ListSupportPermitsOutput#support_permits #support_permits} => Array<Types::SupportPermitSummary>
|
|
838
|
+
# * {Types::ListSupportPermitsOutput#next_token #next_token} => String
|
|
839
|
+
#
|
|
840
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
841
|
+
#
|
|
842
|
+
# @example Request syntax with placeholder values
|
|
843
|
+
#
|
|
844
|
+
# resp = client.list_support_permits({
|
|
845
|
+
# next_token: "NextToken",
|
|
846
|
+
# max_results: 1,
|
|
847
|
+
# support_permit_statuses: ["ACTIVE"], # accepts ACTIVE, INACTIVE, DELETING
|
|
848
|
+
# })
|
|
849
|
+
#
|
|
850
|
+
# @example Response structure
|
|
851
|
+
#
|
|
852
|
+
# resp.support_permits #=> Array
|
|
853
|
+
# resp.support_permits[0].name #=> String
|
|
854
|
+
# resp.support_permits[0].arn #=> String
|
|
855
|
+
# resp.support_permits[0].permit.actions.actions #=> Array
|
|
856
|
+
# resp.support_permits[0].permit.actions.actions[0] #=> String
|
|
857
|
+
# resp.support_permits[0].permit.resources.resources #=> Array
|
|
858
|
+
# resp.support_permits[0].permit.resources.resources[0] #=> String
|
|
859
|
+
# resp.support_permits[0].permit.conditions #=> Array
|
|
860
|
+
# resp.support_permits[0].permit.conditions[0].allow_after #=> Time
|
|
861
|
+
# resp.support_permits[0].permit.conditions[0].allow_before #=> Time
|
|
862
|
+
# resp.support_permits[0].status #=> String, one of "ACTIVE", "INACTIVE", "DELETING"
|
|
863
|
+
# resp.support_permits[0].signing_key_info.kms_key #=> String
|
|
864
|
+
# resp.support_permits[0].created_at #=> Time
|
|
865
|
+
# resp.support_permits[0].support_case_display_id #=> String
|
|
866
|
+
# resp.next_token #=> String
|
|
867
|
+
#
|
|
868
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supportauthz-2026-06-30/ListSupportPermits AWS API Documentation
|
|
869
|
+
#
|
|
870
|
+
# @overload list_support_permits(params = {})
|
|
871
|
+
# @param [Hash] params ({})
|
|
872
|
+
def list_support_permits(params = {}, options = {})
|
|
873
|
+
req = build_request(:list_support_permits, params)
|
|
874
|
+
req.send_request(options)
|
|
875
|
+
end
|
|
876
|
+
|
|
877
|
+
# Lists the tags associated with a support permit resource.
|
|
878
|
+
#
|
|
879
|
+
# @option params [required, String] :resource_arn
|
|
880
|
+
# The ARN of the resource to list tags for.
|
|
881
|
+
#
|
|
882
|
+
# @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
883
|
+
#
|
|
884
|
+
# * {Types::ListTagsForResourceOutput#tags #tags} => Hash<String,String>
|
|
885
|
+
#
|
|
886
|
+
# @example Request syntax with placeholder values
|
|
887
|
+
#
|
|
888
|
+
# resp = client.list_tags_for_resource({
|
|
889
|
+
# resource_arn: "Arn", # required
|
|
890
|
+
# })
|
|
891
|
+
#
|
|
892
|
+
# @example Response structure
|
|
893
|
+
#
|
|
894
|
+
# resp.tags #=> Hash
|
|
895
|
+
# resp.tags["TagKey"] #=> String
|
|
896
|
+
#
|
|
897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supportauthz-2026-06-30/ListTagsForResource AWS API Documentation
|
|
898
|
+
#
|
|
899
|
+
# @overload list_tags_for_resource(params = {})
|
|
900
|
+
# @param [Hash] params ({})
|
|
901
|
+
def list_tags_for_resource(params = {}, options = {})
|
|
902
|
+
req = build_request(:list_tags_for_resource, params)
|
|
903
|
+
req.send_request(options)
|
|
904
|
+
end
|
|
905
|
+
|
|
906
|
+
# Rejects a permit request from an AWS support operator. The operator
|
|
907
|
+
# cannot proceed with the requested action.
|
|
908
|
+
#
|
|
909
|
+
# @option params [required, String] :request_arn
|
|
910
|
+
# The ARN of the permit request to reject.
|
|
911
|
+
#
|
|
912
|
+
# @return [Types::RejectSupportPermitRequestOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
913
|
+
#
|
|
914
|
+
# * {Types::RejectSupportPermitRequestOutput#request_arn #request_arn} => String
|
|
915
|
+
#
|
|
916
|
+
# @example Request syntax with placeholder values
|
|
917
|
+
#
|
|
918
|
+
# resp = client.reject_support_permit_request({
|
|
919
|
+
# request_arn: "RequestArn", # required
|
|
920
|
+
# })
|
|
921
|
+
#
|
|
922
|
+
# @example Response structure
|
|
923
|
+
#
|
|
924
|
+
# resp.request_arn #=> String
|
|
925
|
+
#
|
|
926
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supportauthz-2026-06-30/RejectSupportPermitRequest AWS API Documentation
|
|
927
|
+
#
|
|
928
|
+
# @overload reject_support_permit_request(params = {})
|
|
929
|
+
# @param [Hash] params ({})
|
|
930
|
+
def reject_support_permit_request(params = {}, options = {})
|
|
931
|
+
req = build_request(:reject_support_permit_request, params)
|
|
932
|
+
req.send_request(options)
|
|
933
|
+
end
|
|
934
|
+
|
|
935
|
+
# Adds or overwrites one or more tags for a support permit resource.
|
|
936
|
+
#
|
|
937
|
+
# @option params [required, String] :resource_arn
|
|
938
|
+
# The ARN of the resource to tag.
|
|
939
|
+
#
|
|
940
|
+
# @option params [required, Hash<String,String>] :tags
|
|
941
|
+
# The tags to add to the resource. Maximum of 50 tags.
|
|
942
|
+
#
|
|
943
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
944
|
+
#
|
|
945
|
+
# @example Request syntax with placeholder values
|
|
946
|
+
#
|
|
947
|
+
# resp = client.tag_resource({
|
|
948
|
+
# resource_arn: "Arn", # required
|
|
949
|
+
# tags: { # required
|
|
950
|
+
# "TagKey" => "TagValue",
|
|
951
|
+
# },
|
|
952
|
+
# })
|
|
953
|
+
#
|
|
954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supportauthz-2026-06-30/TagResource AWS API Documentation
|
|
955
|
+
#
|
|
956
|
+
# @overload tag_resource(params = {})
|
|
957
|
+
# @param [Hash] params ({})
|
|
958
|
+
def tag_resource(params = {}, options = {})
|
|
959
|
+
req = build_request(:tag_resource, params)
|
|
960
|
+
req.send_request(options)
|
|
961
|
+
end
|
|
962
|
+
|
|
963
|
+
# Removes one or more tags from a support permit resource.
|
|
964
|
+
#
|
|
965
|
+
# @option params [required, String] :resource_arn
|
|
966
|
+
# The ARN of the resource to untag.
|
|
967
|
+
#
|
|
968
|
+
# @option params [required, Array<String>] :tag_keys
|
|
969
|
+
# The tag keys to remove from the resource.
|
|
970
|
+
#
|
|
971
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
972
|
+
#
|
|
973
|
+
# @example Request syntax with placeholder values
|
|
974
|
+
#
|
|
975
|
+
# resp = client.untag_resource({
|
|
976
|
+
# resource_arn: "Arn", # required
|
|
977
|
+
# tag_keys: ["TagKey"], # required
|
|
978
|
+
# })
|
|
979
|
+
#
|
|
980
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/supportauthz-2026-06-30/UntagResource AWS API Documentation
|
|
981
|
+
#
|
|
982
|
+
# @overload untag_resource(params = {})
|
|
983
|
+
# @param [Hash] params ({})
|
|
984
|
+
def untag_resource(params = {}, options = {})
|
|
985
|
+
req = build_request(:untag_resource, params)
|
|
986
|
+
req.send_request(options)
|
|
987
|
+
end
|
|
988
|
+
|
|
989
|
+
# @!endgroup
|
|
990
|
+
|
|
991
|
+
# @param params ({})
|
|
992
|
+
# @api private
|
|
993
|
+
def build_request(operation_name, params = {})
|
|
994
|
+
handlers = @handlers.for(operation_name)
|
|
995
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
|
996
|
+
Aws::Telemetry.module_to_tracer_name('Aws::SupportAuthZ')
|
|
997
|
+
)
|
|
998
|
+
context = Seahorse::Client::RequestContext.new(
|
|
999
|
+
operation_name: operation_name,
|
|
1000
|
+
operation: config.api.operation(operation_name),
|
|
1001
|
+
client: self,
|
|
1002
|
+
params: params,
|
|
1003
|
+
config: config,
|
|
1004
|
+
tracer: tracer
|
|
1005
|
+
)
|
|
1006
|
+
context[:gem_name] = 'aws-sdk-supportauthz'
|
|
1007
|
+
context[:gem_version] = '1.0.0'
|
|
1008
|
+
Seahorse::Client::Request.new(handlers, context)
|
|
1009
|
+
end
|
|
1010
|
+
|
|
1011
|
+
# @api private
|
|
1012
|
+
# @deprecated
|
|
1013
|
+
def waiter_names
|
|
1014
|
+
[]
|
|
1015
|
+
end
|
|
1016
|
+
|
|
1017
|
+
class << self
|
|
1018
|
+
|
|
1019
|
+
# @api private
|
|
1020
|
+
attr_reader :identifier
|
|
1021
|
+
|
|
1022
|
+
# @api private
|
|
1023
|
+
def errors_module
|
|
1024
|
+
Errors
|
|
1025
|
+
end
|
|
1026
|
+
|
|
1027
|
+
end
|
|
1028
|
+
end
|
|
1029
|
+
end
|