aws-sdk-arczonalshift 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.
@@ -0,0 +1,779 @@
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/checksum_algorithm.rb'
31
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
32
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
33
+ require 'aws-sdk-core/plugins/sign.rb'
34
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
35
+
36
+ Aws::Plugins::GlobalConfiguration.add_identifier(:arczonalshift)
37
+
38
+ module Aws::ARCZonalShift
39
+ # An API client for ARCZonalShift. To construct a client, you need to configure a `:region` and `:credentials`.
40
+ #
41
+ # client = Aws::ARCZonalShift::Client.new(
42
+ # region: region_name,
43
+ # credentials: credentials,
44
+ # # ...
45
+ # )
46
+ #
47
+ # For details on configuring region and credentials see
48
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
49
+ #
50
+ # See {#initialize} for a full list of supported configuration options.
51
+ class Client < Seahorse::Client::Base
52
+
53
+ include Aws::ClientStubs
54
+
55
+ @identifier = :arczonalshift
56
+
57
+ set_api(ClientApi::API)
58
+
59
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
60
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
61
+ add_plugin(Aws::Plugins::Logging)
62
+ add_plugin(Aws::Plugins::ParamConverter)
63
+ add_plugin(Aws::Plugins::ParamValidator)
64
+ add_plugin(Aws::Plugins::UserAgent)
65
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
66
+ add_plugin(Aws::Plugins::RetryErrors)
67
+ add_plugin(Aws::Plugins::GlobalConfiguration)
68
+ add_plugin(Aws::Plugins::RegionalEndpoint)
69
+ add_plugin(Aws::Plugins::EndpointDiscovery)
70
+ add_plugin(Aws::Plugins::EndpointPattern)
71
+ add_plugin(Aws::Plugins::ResponsePaging)
72
+ add_plugin(Aws::Plugins::StubResponses)
73
+ add_plugin(Aws::Plugins::IdempotencyToken)
74
+ add_plugin(Aws::Plugins::JsonvalueConverter)
75
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
76
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
77
+ add_plugin(Aws::Plugins::TransferEncoding)
78
+ add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
+ add_plugin(Aws::Plugins::DefaultsMode)
81
+ add_plugin(Aws::Plugins::RecursionDetection)
82
+ add_plugin(Aws::Plugins::Sign)
83
+ add_plugin(Aws::Plugins::Protocols::RestJson)
84
+ add_plugin(Aws::ARCZonalShift::Plugins::Endpoints)
85
+
86
+ # @overload initialize(options)
87
+ # @param [Hash] options
88
+ # @option options [required, Aws::CredentialProvider] :credentials
89
+ # Your AWS credentials. This can be an instance of any one of the
90
+ # following classes:
91
+ #
92
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
93
+ # credentials.
94
+ #
95
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
96
+ # shared file, such as `~/.aws/config`.
97
+ #
98
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
99
+ #
100
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
101
+ # assume a role after providing credentials via the web.
102
+ #
103
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
104
+ # access token generated from `aws login`.
105
+ #
106
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
107
+ # process that outputs to stdout.
108
+ #
109
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
110
+ # from an EC2 IMDS on an EC2 instance.
111
+ #
112
+ # * `Aws::ECSCredentials` - Used for loading credentials from
113
+ # instances running in ECS.
114
+ #
115
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
116
+ # from the Cognito Identity service.
117
+ #
118
+ # When `:credentials` are not configured directly, the following
119
+ # locations will be searched for credentials:
120
+ #
121
+ # * `Aws.config[:credentials]`
122
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
123
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
124
+ # * `~/.aws/credentials`
125
+ # * `~/.aws/config`
126
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
127
+ # are very aggressive. Construct and pass an instance of
128
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
129
+ # enable retries and extended timeouts. Instance profile credential
130
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
131
+ # to true.
132
+ #
133
+ # @option options [required, String] :region
134
+ # The AWS region to connect to. The configured `:region` is
135
+ # used to determine the service `:endpoint`. When not passed,
136
+ # a default `:region` is searched for in the following locations:
137
+ #
138
+ # * `Aws.config[:region]`
139
+ # * `ENV['AWS_REGION']`
140
+ # * `ENV['AMAZON_REGION']`
141
+ # * `ENV['AWS_DEFAULT_REGION']`
142
+ # * `~/.aws/credentials`
143
+ # * `~/.aws/config`
144
+ #
145
+ # @option options [String] :access_key_id
146
+ #
147
+ # @option options [Boolean] :active_endpoint_cache (false)
148
+ # When set to `true`, a thread polling for endpoints will be running in
149
+ # the background every 60 secs (default). Defaults to `false`.
150
+ #
151
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
152
+ # Used only in `adaptive` retry mode. When true, the request will sleep
153
+ # until there is sufficent client side capacity to retry the request.
154
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
155
+ # not retry instead of sleeping.
156
+ #
157
+ # @option options [Boolean] :client_side_monitoring (false)
158
+ # When `true`, client-side metrics will be collected for all API requests from
159
+ # this client.
160
+ #
161
+ # @option options [String] :client_side_monitoring_client_id ("")
162
+ # Allows you to provide an identifier for this client which will be attached to
163
+ # all generated client side metrics. Defaults to an empty string.
164
+ #
165
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
166
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
167
+ # side monitoring agent is running on, where client metrics will be published via UDP.
168
+ #
169
+ # @option options [Integer] :client_side_monitoring_port (31000)
170
+ # Required for publishing client metrics. The port that the client side monitoring
171
+ # agent is running on, where client metrics will be published via UDP.
172
+ #
173
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
174
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
175
+ # will use the Client Side Monitoring Agent Publisher.
176
+ #
177
+ # @option options [Boolean] :convert_params (true)
178
+ # When `true`, an attempt is made to coerce request parameters into
179
+ # the required types.
180
+ #
181
+ # @option options [Boolean] :correct_clock_skew (true)
182
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
183
+ # a clock skew correction and retry requests with skewed client clocks.
184
+ #
185
+ # @option options [String] :defaults_mode ("legacy")
186
+ # See {Aws::DefaultsModeConfiguration} for a list of the
187
+ # accepted modes and the configuration defaults that are included.
188
+ #
189
+ # @option options [Boolean] :disable_host_prefix_injection (false)
190
+ # Set to true to disable SDK automatically adding host prefix
191
+ # to default service endpoint when available.
192
+ #
193
+ # @option options [String] :endpoint
194
+ # The client endpoint is normally constructed from the `:region`
195
+ # option. You should only configure an `:endpoint` when connecting
196
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
197
+ #
198
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
199
+ # Used for the maximum size limit of the LRU cache storing endpoints data
200
+ # for endpoint discovery enabled operations. Defaults to 1000.
201
+ #
202
+ # @option options [Integer] :endpoint_cache_max_threads (10)
203
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
204
+ #
205
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
206
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
207
+ # Use this option to config the time interval in seconds for making
208
+ # requests fetching endpoints information. Defaults to 60 sec.
209
+ #
210
+ # @option options [Boolean] :endpoint_discovery (false)
211
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
212
+ #
213
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
214
+ # The log formatter.
215
+ #
216
+ # @option options [Symbol] :log_level (:info)
217
+ # The log level to send messages to the `:logger` at.
218
+ #
219
+ # @option options [Logger] :logger
220
+ # The Logger instance to send log messages to. If this option
221
+ # is not set, logging will be disabled.
222
+ #
223
+ # @option options [Integer] :max_attempts (3)
224
+ # An integer representing the maximum number attempts that will be made for
225
+ # a single request, including the initial attempt. For example,
226
+ # setting this value to 5 will result in a request being retried up to
227
+ # 4 times. Used in `standard` and `adaptive` retry modes.
228
+ #
229
+ # @option options [String] :profile ("default")
230
+ # Used when loading credentials from the shared credentials file
231
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
232
+ #
233
+ # @option options [Proc] :retry_backoff
234
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
235
+ # This option is only used in the `legacy` retry mode.
236
+ #
237
+ # @option options [Float] :retry_base_delay (0.3)
238
+ # The base delay in seconds used by the default backoff function. This option
239
+ # is only used in the `legacy` retry mode.
240
+ #
241
+ # @option options [Symbol] :retry_jitter (:none)
242
+ # A delay randomiser function used by the default backoff function.
243
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
244
+ # otherwise a Proc that takes and returns a number. This option is only used
245
+ # in the `legacy` retry mode.
246
+ #
247
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
248
+ #
249
+ # @option options [Integer] :retry_limit (3)
250
+ # The maximum number of times to retry failed requests. Only
251
+ # ~ 500 level server errors and certain ~ 400 level client errors
252
+ # are retried. Generally, these are throttling errors, data
253
+ # checksum errors, networking errors, timeout errors, auth errors,
254
+ # endpoint discovery, and errors from expired credentials.
255
+ # This option is only used in the `legacy` retry mode.
256
+ #
257
+ # @option options [Integer] :retry_max_delay (0)
258
+ # The maximum number of seconds to delay between retries (0 for no limit)
259
+ # used by the default backoff function. This option is only used in the
260
+ # `legacy` retry mode.
261
+ #
262
+ # @option options [String] :retry_mode ("legacy")
263
+ # Specifies which retry algorithm to use. Values are:
264
+ #
265
+ # * `legacy` - The pre-existing retry behavior. This is default value if
266
+ # no retry mode is provided.
267
+ #
268
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
269
+ # This includes support for retry quotas, which limit the number of
270
+ # unsuccessful retries a client can make.
271
+ #
272
+ # * `adaptive` - An experimental retry mode that includes all the
273
+ # functionality of `standard` mode along with automatic client side
274
+ # throttling. This is a provisional mode that may change behavior
275
+ # in the future.
276
+ #
277
+ #
278
+ # @option options [String] :secret_access_key
279
+ #
280
+ # @option options [String] :session_token
281
+ #
282
+ # @option options [Boolean] :stub_responses (false)
283
+ # Causes the client to return stubbed responses. By default
284
+ # fake responses are generated and returned. You can specify
285
+ # the response data to return or errors to raise by calling
286
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
287
+ #
288
+ # ** Please note ** When response stubbing is enabled, no HTTP
289
+ # requests are made, and retries are disabled.
290
+ #
291
+ # @option options [Aws::TokenProvider] :token_provider
292
+ # A Bearer Token Provider. This can be an instance of any one of the
293
+ # following classes:
294
+ #
295
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
296
+ # tokens.
297
+ #
298
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
299
+ # access token generated from `aws login`.
300
+ #
301
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
302
+ # will be used to search for tokens configured for your profile in shared configuration files.
303
+ #
304
+ # @option options [Boolean] :use_dualstack_endpoint
305
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
306
+ # will be used if available.
307
+ #
308
+ # @option options [Boolean] :use_fips_endpoint
309
+ # When set to `true`, fips compatible endpoints will be used if available.
310
+ # When a `fips` region is used, the region is normalized and this config
311
+ # is set to `true`.
312
+ #
313
+ # @option options [Boolean] :validate_params (true)
314
+ # When `true`, request parameters are validated before
315
+ # sending the request.
316
+ #
317
+ # @option options [Aws::ARCZonalShift::EndpointProvider] :endpoint_provider
318
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ARCZonalShift::EndpointParameters`
319
+ #
320
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
321
+ # requests through. Formatted like 'http://proxy.com:123'.
322
+ #
323
+ # @option options [Float] :http_open_timeout (15) The number of
324
+ # seconds to wait when opening a HTTP session before raising a
325
+ # `Timeout::Error`.
326
+ #
327
+ # @option options [Float] :http_read_timeout (60) The default
328
+ # number of seconds to wait for response data. This value can
329
+ # safely be set per-request on the session.
330
+ #
331
+ # @option options [Float] :http_idle_timeout (5) The number of
332
+ # seconds a connection is allowed to sit idle before it is
333
+ # considered stale. Stale connections are closed and removed
334
+ # from the pool before making a request.
335
+ #
336
+ # @option options [Float] :http_continue_timeout (1) The number of
337
+ # seconds to wait for a 100-continue response before sending the
338
+ # request body. This option has no effect unless the request has
339
+ # "Expect" header set to "100-continue". Defaults to `nil` which
340
+ # disables this behaviour. This value can safely be set per
341
+ # request on the session.
342
+ #
343
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
344
+ # in seconds.
345
+ #
346
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
347
+ # HTTP debug output will be sent to the `:logger`.
348
+ #
349
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
350
+ # SSL peer certificates are verified when establishing a
351
+ # connection.
352
+ #
353
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
354
+ # certificate authority bundle file that should be used when
355
+ # verifying peer certificates. If you do not pass
356
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
357
+ # will be used if available.
358
+ #
359
+ # @option options [String] :ssl_ca_directory Full path of the
360
+ # directory that contains the unbundled SSL certificate
361
+ # authority files for verifying peer certificates. If you do
362
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
363
+ # system default will be used if available.
364
+ #
365
+ def initialize(*args)
366
+ super
367
+ end
368
+
369
+ # @!group API Operations
370
+
371
+ # Cancel a zonal shift in Amazon Route 53 Application Recovery
372
+ # Controller that you've started for a resource in your AWS account in
373
+ # an AWS Region.
374
+ #
375
+ # @option params [required, String] :zonal_shift_id
376
+ # The internally-generated identifier of a zonal shift.
377
+ #
378
+ # @return [Types::ZonalShift] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
379
+ #
380
+ # * {Types::ZonalShift#away_from #away_from} => String
381
+ # * {Types::ZonalShift#comment #comment} => String
382
+ # * {Types::ZonalShift#expiry_time #expiry_time} => Time
383
+ # * {Types::ZonalShift#resource_identifier #resource_identifier} => String
384
+ # * {Types::ZonalShift#start_time #start_time} => Time
385
+ # * {Types::ZonalShift#status #status} => String
386
+ # * {Types::ZonalShift#zonal_shift_id #zonal_shift_id} => String
387
+ #
388
+ # @example Request syntax with placeholder values
389
+ #
390
+ # resp = client.cancel_zonal_shift({
391
+ # zonal_shift_id: "ZonalShiftId", # required
392
+ # })
393
+ #
394
+ # @example Response structure
395
+ #
396
+ # resp.away_from #=> String
397
+ # resp.comment #=> String
398
+ # resp.expiry_time #=> Time
399
+ # resp.resource_identifier #=> String
400
+ # resp.start_time #=> Time
401
+ # resp.status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
402
+ # resp.zonal_shift_id #=> String
403
+ #
404
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/CancelZonalShift AWS API Documentation
405
+ #
406
+ # @overload cancel_zonal_shift(params = {})
407
+ # @param [Hash] params ({})
408
+ def cancel_zonal_shift(params = {}, options = {})
409
+ req = build_request(:cancel_zonal_shift, params)
410
+ req.send_request(options)
411
+ end
412
+
413
+ # Get information about a resource that's been registered for zonal
414
+ # shifts with Amazon Route 53 Application Recovery Controller in this
415
+ # AWS Region. Resources that are registered for zonal shifts are managed
416
+ # resources in Route 53 ARC.
417
+ #
418
+ # At this time, you can only start a zonal shift for Network Load
419
+ # Balancers and Application Load Balancers with cross-zone load
420
+ # balancing turned off.
421
+ #
422
+ # @option params [required, String] :resource_identifier
423
+ # The identifier for the resource to include in a zonal shift. The
424
+ # identifier is the Amazon Resource Name (ARN) for the resource.
425
+ #
426
+ # At this time, you can only start a zonal shift for Network Load
427
+ # Balancers and Application Load Balancers with cross-zone load
428
+ # balancing turned off.
429
+ #
430
+ # @return [Types::GetManagedResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
431
+ #
432
+ # * {Types::GetManagedResourceResponse#applied_weights #applied_weights} => Hash&lt;String,Float&gt;
433
+ # * {Types::GetManagedResourceResponse#arn #arn} => String
434
+ # * {Types::GetManagedResourceResponse#name #name} => String
435
+ # * {Types::GetManagedResourceResponse#zonal_shifts #zonal_shifts} => Array&lt;Types::ZonalShiftInResource&gt;
436
+ #
437
+ # @example Request syntax with placeholder values
438
+ #
439
+ # resp = client.get_managed_resource({
440
+ # resource_identifier: "ResourceIdentifier", # required
441
+ # })
442
+ #
443
+ # @example Response structure
444
+ #
445
+ # resp.applied_weights #=> Hash
446
+ # resp.applied_weights["AvailabilityZone"] #=> Float
447
+ # resp.arn #=> String
448
+ # resp.name #=> String
449
+ # resp.zonal_shifts #=> Array
450
+ # resp.zonal_shifts[0].applied_status #=> String, one of "APPLIED", "NOT_APPLIED"
451
+ # resp.zonal_shifts[0].away_from #=> String
452
+ # resp.zonal_shifts[0].comment #=> String
453
+ # resp.zonal_shifts[0].expiry_time #=> Time
454
+ # resp.zonal_shifts[0].resource_identifier #=> String
455
+ # resp.zonal_shifts[0].start_time #=> Time
456
+ # resp.zonal_shifts[0].zonal_shift_id #=> String
457
+ #
458
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/GetManagedResource AWS API Documentation
459
+ #
460
+ # @overload get_managed_resource(params = {})
461
+ # @param [Hash] params ({})
462
+ def get_managed_resource(params = {}, options = {})
463
+ req = build_request(:get_managed_resource, params)
464
+ req.send_request(options)
465
+ end
466
+
467
+ # Lists all the resources in your AWS account in this AWS Region that
468
+ # are managed for zonal shifts in Amazon Route 53 Application Recovery
469
+ # Controller, and information about them. The information includes their
470
+ # Amazon Resource Names (ARNs), the Availability Zones the resources are
471
+ # deployed in, and the resource name.
472
+ #
473
+ # @option params [Integer] :max_results
474
+ # The number of objects that you want to return with this call.
475
+ #
476
+ # @option params [String] :next_token
477
+ # Specifies that you want to receive the next page of results. Valid
478
+ # only if you received a `NextToken` response in the previous request.
479
+ # If you did, it indicates that more output is available. Set this
480
+ # parameter to the value provided by the previous call's `NextToken`
481
+ # response to request the next page of results.
482
+ #
483
+ # @return [Types::ListManagedResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
484
+ #
485
+ # * {Types::ListManagedResourcesResponse#items #items} => Array&lt;Types::ManagedResourceSummary&gt;
486
+ # * {Types::ListManagedResourcesResponse#next_token #next_token} => String
487
+ #
488
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
489
+ #
490
+ # @example Request syntax with placeholder values
491
+ #
492
+ # resp = client.list_managed_resources({
493
+ # max_results: 1,
494
+ # next_token: "String",
495
+ # })
496
+ #
497
+ # @example Response structure
498
+ #
499
+ # resp.items #=> Array
500
+ # resp.items[0].arn #=> String
501
+ # resp.items[0].availability_zones #=> Array
502
+ # resp.items[0].availability_zones[0] #=> String
503
+ # resp.items[0].name #=> String
504
+ # resp.next_token #=> String
505
+ #
506
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListManagedResources AWS API Documentation
507
+ #
508
+ # @overload list_managed_resources(params = {})
509
+ # @param [Hash] params ({})
510
+ def list_managed_resources(params = {}, options = {})
511
+ req = build_request(:list_managed_resources, params)
512
+ req.send_request(options)
513
+ end
514
+
515
+ # Lists all the active zonal shifts in Amazon Route 53 Application
516
+ # Recovery Controller in your AWS account in this AWS Region.
517
+ #
518
+ # @option params [Integer] :max_results
519
+ # The number of objects that you want to return with this call.
520
+ #
521
+ # @option params [String] :next_token
522
+ # Specifies that you want to receive the next page of results. Valid
523
+ # only if you received a `NextToken` response in the previous request.
524
+ # If you did, it indicates that more output is available. Set this
525
+ # parameter to the value provided by the previous call's `NextToken`
526
+ # response to request the next page of results.
527
+ #
528
+ # @option params [String] :status
529
+ # A status for a zonal shift.
530
+ #
531
+ # The `Status` for a zonal shift can have one of the following values:
532
+ #
533
+ # * **ACTIVE**\: The zonal shift is started and active.
534
+ #
535
+ # * **EXPIRED**\: The zonal shift has expired (the expiry time was
536
+ # exceeded).
537
+ #
538
+ # * **CANCELED**\: The zonal shift was canceled.
539
+ #
540
+ # @return [Types::ListZonalShiftsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
541
+ #
542
+ # * {Types::ListZonalShiftsResponse#items #items} => Array&lt;Types::ZonalShiftSummary&gt;
543
+ # * {Types::ListZonalShiftsResponse#next_token #next_token} => String
544
+ #
545
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
546
+ #
547
+ # @example Request syntax with placeholder values
548
+ #
549
+ # resp = client.list_zonal_shifts({
550
+ # max_results: 1,
551
+ # next_token: "String",
552
+ # status: "ACTIVE", # accepts ACTIVE, EXPIRED, CANCELED
553
+ # })
554
+ #
555
+ # @example Response structure
556
+ #
557
+ # resp.items #=> Array
558
+ # resp.items[0].away_from #=> String
559
+ # resp.items[0].comment #=> String
560
+ # resp.items[0].expiry_time #=> Time
561
+ # resp.items[0].resource_identifier #=> String
562
+ # resp.items[0].start_time #=> Time
563
+ # resp.items[0].status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
564
+ # resp.items[0].zonal_shift_id #=> String
565
+ # resp.next_token #=> String
566
+ #
567
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/ListZonalShifts AWS API Documentation
568
+ #
569
+ # @overload list_zonal_shifts(params = {})
570
+ # @param [Hash] params ({})
571
+ def list_zonal_shifts(params = {}, options = {})
572
+ req = build_request(:list_zonal_shifts, params)
573
+ req.send_request(options)
574
+ end
575
+
576
+ # You start a zonal shift to temporarily move load balancer traffic away
577
+ # from an Availability Zone in a AWS Region, to help your application
578
+ # recover immediately, for example, from a developer's bad code
579
+ # deployment or from an AWS infrastructure failure in a single
580
+ # Availability Zone. You can start a zonal shift in Route 53 ARC only
581
+ # for managed resources in your account in an AWS Region. Resources are
582
+ # automatically registered with Route 53 ARC by AWS services.
583
+ #
584
+ # At this time, you can only start a zonal shift for Network Load
585
+ # Balancers and Application Load Balancers with cross-zone load
586
+ # balancing turned off.
587
+ #
588
+ # When you start a zonal shift, traffic for the resource is no longer
589
+ # routed to the Availability Zone. The zonal shift is created
590
+ # immediately in Route 53 ARC. However, it can take a short time,
591
+ # typically up to a few minutes, for existing, in-progress connections
592
+ # in the Availability Zone to complete.
593
+ #
594
+ # For more information, see [Zonal shift][1] in the Amazon Route 53
595
+ # Application Recovery Controller Developer Guide.
596
+ #
597
+ #
598
+ #
599
+ # [1]: https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.html
600
+ #
601
+ # @option params [required, String] :away_from
602
+ # The Availability Zone that traffic is moved away from for a resource
603
+ # when you start a zonal shift. Until the zonal shift expires or you
604
+ # cancel it, traffic for the resource is instead moved to other
605
+ # Availability Zones in the AWS Region.
606
+ #
607
+ # @option params [required, String] :comment
608
+ # A comment that you enter about the zonal shift. Only the latest
609
+ # comment is retained; no comment history is maintained. A new comment
610
+ # overwrites any existing comment string.
611
+ #
612
+ # @option params [required, String] :expires_in
613
+ # The length of time that you want a zonal shift to be active, which
614
+ # Route 53 ARC converts to an expiry time (expiration time). Zonal
615
+ # shifts are temporary. You can set a zonal shift to be active initially
616
+ # for up to three days (72 hours).
617
+ #
618
+ # If you want to still keep traffic away from an Availability Zone, you
619
+ # can update the zonal shift and set a new expiration. You can also
620
+ # cancel a zonal shift, before it expires, for example, if you're ready
621
+ # to restore traffic to the Availability Zone.
622
+ #
623
+ # To set a length of time for a zonal shift to be active, specify a
624
+ # whole number, and then one of the following, with no space:
625
+ #
626
+ # <ul> <li> <p> <b>A lowercase letter m:</b> To specify that the value is in minutes.</p> </li> <li> <p> <b>A lowercase letter h:</b> To specify that the value is in hours.</p> </li> </ul> <p>For example: <code>20h</code> means the zonal shift expires in 20 hours. <code>120m</code> means the zonal shift expires in 120 minutes (2 hours).</p>
627
+ #
628
+ # @option params [required, String] :resource_identifier
629
+ # The identifier for the resource to include in a zonal shift. The
630
+ # identifier is the Amazon Resource Name (ARN) for the resource.
631
+ #
632
+ # At this time, you can only start a zonal shift for Network Load
633
+ # Balancers and Application Load Balancers with cross-zone load
634
+ # balancing turned off.
635
+ #
636
+ # @return [Types::ZonalShift] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
637
+ #
638
+ # * {Types::ZonalShift#away_from #away_from} => String
639
+ # * {Types::ZonalShift#comment #comment} => String
640
+ # * {Types::ZonalShift#expiry_time #expiry_time} => Time
641
+ # * {Types::ZonalShift#resource_identifier #resource_identifier} => String
642
+ # * {Types::ZonalShift#start_time #start_time} => Time
643
+ # * {Types::ZonalShift#status #status} => String
644
+ # * {Types::ZonalShift#zonal_shift_id #zonal_shift_id} => String
645
+ #
646
+ # @example Request syntax with placeholder values
647
+ #
648
+ # resp = client.start_zonal_shift({
649
+ # away_from: "AvailabilityZone", # required
650
+ # comment: "ZonalShiftComment", # required
651
+ # expires_in: "ExpiresIn", # required
652
+ # resource_identifier: "ResourceIdentifier", # required
653
+ # })
654
+ #
655
+ # @example Response structure
656
+ #
657
+ # resp.away_from #=> String
658
+ # resp.comment #=> String
659
+ # resp.expiry_time #=> Time
660
+ # resp.resource_identifier #=> String
661
+ # resp.start_time #=> Time
662
+ # resp.status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
663
+ # resp.zonal_shift_id #=> String
664
+ #
665
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/StartZonalShift AWS API Documentation
666
+ #
667
+ # @overload start_zonal_shift(params = {})
668
+ # @param [Hash] params ({})
669
+ def start_zonal_shift(params = {}, options = {})
670
+ req = build_request(:start_zonal_shift, params)
671
+ req.send_request(options)
672
+ end
673
+
674
+ # Update an active zonal shift in Amazon Route 53 Application Recovery
675
+ # Controller in your AWS account. You can update a zonal shift to set a
676
+ # new expiration, or edit or replace the comment for the zonal shift.
677
+ #
678
+ # @option params [String] :comment
679
+ # A comment that you enter about the zonal shift. Only the latest
680
+ # comment is retained; no comment history is maintained. A new comment
681
+ # overwrites any existing comment string.
682
+ #
683
+ # @option params [String] :expires_in
684
+ # The length of time that you want a zonal shift to be active, which
685
+ # Route 53 ARC converts to an expiry time (expiration time). Zonal
686
+ # shifts are temporary. You can set a zonal shift to be active initially
687
+ # for up to three days (72 hours).
688
+ #
689
+ # If you want to still keep traffic away from an Availability Zone, you
690
+ # can update the zonal shift and set a new expiration. You can also
691
+ # cancel a zonal shift, before it expires, for example, if you're ready
692
+ # to restore traffic to the Availability Zone.
693
+ #
694
+ # To set a length of time for a zonal shift to be active, specify a
695
+ # whole number, and then one of the following, with no space:
696
+ #
697
+ # * **A lowercase letter m:** To specify that the value is in minutes.
698
+ #
699
+ # * **A lowercase letter h:** To specify that the value is in hours.
700
+ #
701
+ # For example: `20h` means the zonal shift expires in 20 hours. `120m`
702
+ # means the zonal shift expires in 120 minutes (2 hours).
703
+ #
704
+ # @option params [required, String] :zonal_shift_id
705
+ # The identifier of a zonal shift.
706
+ #
707
+ # @return [Types::ZonalShift] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
708
+ #
709
+ # * {Types::ZonalShift#away_from #away_from} => String
710
+ # * {Types::ZonalShift#comment #comment} => String
711
+ # * {Types::ZonalShift#expiry_time #expiry_time} => Time
712
+ # * {Types::ZonalShift#resource_identifier #resource_identifier} => String
713
+ # * {Types::ZonalShift#start_time #start_time} => Time
714
+ # * {Types::ZonalShift#status #status} => String
715
+ # * {Types::ZonalShift#zonal_shift_id #zonal_shift_id} => String
716
+ #
717
+ # @example Request syntax with placeholder values
718
+ #
719
+ # resp = client.update_zonal_shift({
720
+ # comment: "ZonalShiftComment",
721
+ # expires_in: "ExpiresIn",
722
+ # zonal_shift_id: "ZonalShiftId", # required
723
+ # })
724
+ #
725
+ # @example Response structure
726
+ #
727
+ # resp.away_from #=> String
728
+ # resp.comment #=> String
729
+ # resp.expiry_time #=> Time
730
+ # resp.resource_identifier #=> String
731
+ # resp.start_time #=> Time
732
+ # resp.status #=> String, one of "ACTIVE", "EXPIRED", "CANCELED"
733
+ # resp.zonal_shift_id #=> String
734
+ #
735
+ # @see http://docs.aws.amazon.com/goto/WebAPI/arc-zonal-shift-2022-10-30/UpdateZonalShift AWS API Documentation
736
+ #
737
+ # @overload update_zonal_shift(params = {})
738
+ # @param [Hash] params ({})
739
+ def update_zonal_shift(params = {}, options = {})
740
+ req = build_request(:update_zonal_shift, params)
741
+ req.send_request(options)
742
+ end
743
+
744
+ # @!endgroup
745
+
746
+ # @param params ({})
747
+ # @api private
748
+ def build_request(operation_name, params = {})
749
+ handlers = @handlers.for(operation_name)
750
+ context = Seahorse::Client::RequestContext.new(
751
+ operation_name: operation_name,
752
+ operation: config.api.operation(operation_name),
753
+ client: self,
754
+ params: params,
755
+ config: config)
756
+ context[:gem_name] = 'aws-sdk-arczonalshift'
757
+ context[:gem_version] = '1.0.0'
758
+ Seahorse::Client::Request.new(handlers, context)
759
+ end
760
+
761
+ # @api private
762
+ # @deprecated
763
+ def waiter_names
764
+ []
765
+ end
766
+
767
+ class << self
768
+
769
+ # @api private
770
+ attr_reader :identifier
771
+
772
+ # @api private
773
+ def errors_module
774
+ Errors
775
+ end
776
+
777
+ end
778
+ end
779
+ end