aws-sdk-globalaccelerator 1.13.0 → 1.18.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 45620f6e2062dfa419f7f3bb4a878a11b6d0b515
4
- data.tar.gz: 31c9474693f38eed9300a44609bdf1353e3a61e0
2
+ SHA256:
3
+ metadata.gz: 6be95881c7b4cdffc6a5379b79f26de5cf8b9d5a866e55c26d8fb5d66b129b89
4
+ data.tar.gz: 0cf0ba2f2b96807bc4a785472b23e599f7dc393c9299e63a758fe464b70536f5
5
5
  SHA512:
6
- metadata.gz: c80d559b90382009950d173f290be3c65370fef3accc758d39875894459154bd88f67a554703d3dfc696f289b32d3ed7f98b8a528680991620ffe05cfd321bd3
7
- data.tar.gz: 468e693b6f37e39f4332b21d189bb43ab2894539bddae555ed54e714a84f1537ee58c1d76018bdee090b8c6061408d5ed9aef3ae869bd2f3e20582544d2ea580
6
+ metadata.gz: 03cb40728d0c29c16617939136536a52773027dc699dba4f07a9154886b423b9feac3cee6acedc40ef03a10ec4b24f2488e0f619c4ad787ba7e67a8652a884be
7
+ data.tar.gz: 6aff279147706bdda4e5ec7db73470c83c1d74b484056532a81e8ba046ee315934eda6feddd63eed1596e9264ca3d8bfb718ee9f5f20382d26d17a0dba83cf2d
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-globalaccelerator/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # global_accelerator = Aws::GlobalAccelerator::Client.new
28
+ # resp = global_accelerator.advertise_byoip_cidr(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS Global Accelerator all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS Global Accelerator are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::GlobalAccelerator::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS Global Accelerator API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-globalaccelerator/customizations'
42
45
  # @service
43
46
  module Aws::GlobalAccelerator
44
47
 
45
- GEM_VERSION = '1.13.0'
48
+ GEM_VERSION = '1.18.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:globalaccelerator)
31
31
 
32
32
  module Aws::GlobalAccelerator
33
+ # An API client for GlobalAccelerator. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::GlobalAccelerator::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::GlobalAccelerator
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::GlobalAccelerator
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::GlobalAccelerator
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::GlobalAccelerator
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::GlobalAccelerator
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::GlobalAccelerator
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::GlobalAccelerator
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -219,16 +274,15 @@ module Aws::GlobalAccelerator
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
282
+ # safely be set per-request on the session.
229
283
  #
230
284
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
285
+ # seconds a connection is allowed to sit idle before it is
232
286
  # considered stale. Stale connections are closed and removed
233
287
  # from the pool before making a request.
234
288
  #
@@ -237,7 +291,7 @@ module Aws::GlobalAccelerator
237
291
  # request body. This option has no effect unless the request has
238
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
293
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
294
+ # request on the session.
241
295
  #
242
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
297
  # HTTP debug output will be sent to the `:logger`.
@@ -264,13 +318,67 @@ module Aws::GlobalAccelerator
264
318
 
265
319
  # @!group API Operations
266
320
 
321
+ # Advertises an IPv4 address range that is provisioned for use with your
322
+ # AWS resources through bring your own IP addresses (BYOIP). It can take
323
+ # a few minutes before traffic to the specified addresses starts routing
324
+ # to AWS because of propagation delays. To see an AWS CLI example of
325
+ # advertising an address range, scroll down to **Example**.
326
+ #
327
+ # To stop advertising the BYOIP address range, use [
328
+ # WithdrawByoipCidr][1].
329
+ #
330
+ # For more information, see [Bring Your Own IP Addresses (BYOIP)][2] in
331
+ # the *AWS Global Accelerator Developer Guide*.
332
+ #
333
+ #
334
+ #
335
+ # [1]: https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html
336
+ # [2]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html
337
+ #
338
+ # @option params [required, String] :cidr
339
+ # The address range, in CIDR notation. This must be the exact range that
340
+ # you provisioned. You can't advertise only a portion of the
341
+ # provisioned range.
342
+ #
343
+ # @return [Types::AdvertiseByoipCidrResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
344
+ #
345
+ # * {Types::AdvertiseByoipCidrResponse#byoip_cidr #byoip_cidr} => Types::ByoipCidr
346
+ #
347
+ # @example Request syntax with placeholder values
348
+ #
349
+ # resp = client.advertise_byoip_cidr({
350
+ # cidr: "GenericString", # required
351
+ # })
352
+ #
353
+ # @example Response structure
354
+ #
355
+ # resp.byoip_cidr.cidr #=> String
356
+ # resp.byoip_cidr.state #=> String, one of "PENDING_PROVISIONING", "READY", "PENDING_ADVERTISING", "ADVERTISING", "PENDING_WITHDRAWING", "PENDING_DEPROVISIONING", "DEPROVISIONED", "FAILED_PROVISION", "FAILED_ADVERTISING", "FAILED_WITHDRAW", "FAILED_DEPROVISION"
357
+ # resp.byoip_cidr.events #=> Array
358
+ # resp.byoip_cidr.events[0].message #=> String
359
+ # resp.byoip_cidr.events[0].timestamp #=> Time
360
+ #
361
+ # @see http://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/AdvertiseByoipCidr AWS API Documentation
362
+ #
363
+ # @overload advertise_byoip_cidr(params = {})
364
+ # @param [Hash] params ({})
365
+ def advertise_byoip_cidr(params = {}, options = {})
366
+ req = build_request(:advertise_byoip_cidr, params)
367
+ req.send_request(options)
368
+ end
369
+
267
370
  # Create an accelerator. An accelerator includes one or more listeners
268
371
  # that process inbound connections and direct traffic to one or more
269
372
  # endpoint groups, each of which includes endpoints, such as Network
270
373
  # Load Balancers. To see an AWS CLI example of creating an accelerator,
271
374
  # scroll down to **Example**.
272
375
  #
273
- # You must specify the US-West-2 (Oregon) Region to create or update
376
+ # If you bring your own IP address ranges to AWS Global Accelerator
377
+ # (BYOIP), you can assign IP addresses from your own pool to your
378
+ # accelerator as the static IP address entry points. Only one IP address
379
+ # from each of your IP address ranges can be used for each accelerator.
380
+ #
381
+ # You must specify the US West (Oregon) Region to create or update
274
382
  # accelerators.
275
383
  #
276
384
  # @option params [required, String] :name
@@ -281,6 +389,23 @@ module Aws::GlobalAccelerator
281
389
  # @option params [String] :ip_address_type
282
390
  # The value for the address type must be IPv4.
283
391
  #
392
+ # @option params [Array<String>] :ip_addresses
393
+ # Optionally, if you've added your own IP address pool to Global
394
+ # Accelerator, you can choose IP addresses from your own pool to use for
395
+ # the accelerator's static IP addresses. You can specify one or two
396
+ # addresses, separated by a comma. Do not include the /32 suffix.
397
+ #
398
+ # If you specify only one IP address from your IP address range, Global
399
+ # Accelerator assigns a second static IP address for the accelerator
400
+ # from the AWS IP address pool.
401
+ #
402
+ # For more information, see [Bring Your Own IP Addresses (BYOIP)][1] in
403
+ # the *AWS Global Accelerator Developer Guide*.
404
+ #
405
+ #
406
+ #
407
+ # [1]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html
408
+ #
284
409
  # @option params [Boolean] :enabled
285
410
  # Indicates whether an accelerator is enabled. The value is true or
286
411
  # false. The default value is true.
@@ -292,6 +417,19 @@ module Aws::GlobalAccelerator
292
417
  # A unique, case-sensitive identifier that you provide to ensure the
293
418
  # idempotency—that is, the uniqueness—of an accelerator.
294
419
  #
420
+ # **A suitable default value is auto-generated.** You should normally
421
+ # not need to pass this option.**
422
+ #
423
+ # @option params [Array<Types::Tag>] :tags
424
+ # Create tags for an accelerator.
425
+ #
426
+ # For more information, see [Tagging in AWS Global Accelerator][1] in
427
+ # the *AWS Global Accelerator Developer Guide*.
428
+ #
429
+ #
430
+ #
431
+ # [1]: https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html
432
+ #
295
433
  # @return [Types::CreateAcceleratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
296
434
  #
297
435
  # * {Types::CreateAcceleratorResponse#accelerator #accelerator} => Types::Accelerator
@@ -301,8 +439,15 @@ module Aws::GlobalAccelerator
301
439
  # resp = client.create_accelerator({
302
440
  # name: "GenericString", # required
303
441
  # ip_address_type: "IPV4", # accepts IPV4
442
+ # ip_addresses: ["IpAddress"],
304
443
  # enabled: false,
305
444
  # idempotency_token: "IdempotencyToken", # required
445
+ # tags: [
446
+ # {
447
+ # key: "TagKey", # required
448
+ # value: "TagValue", # required
449
+ # },
450
+ # ],
306
451
  # })
307
452
  #
308
453
  # @example Response structure
@@ -383,6 +528,9 @@ module Aws::GlobalAccelerator
383
528
  # A unique, case-sensitive identifier that you provide to ensure the
384
529
  # idempotency—that is, the uniqueness—of the request.
385
530
  #
531
+ # **A suitable default value is auto-generated.** You should normally
532
+ # not need to pass this option.**
533
+ #
386
534
  # @return [Types::CreateEndpointGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
387
535
  #
388
536
  # * {Types::CreateEndpointGroupResponse#endpoint_group #endpoint_group} => Types::EndpointGroup
@@ -478,6 +626,9 @@ module Aws::GlobalAccelerator
478
626
  # A unique, case-sensitive identifier that you provide to ensure the
479
627
  # idempotency—that is, the uniqueness—of the request.
480
628
  #
629
+ # **A suitable default value is auto-generated.** You should normally
630
+ # not need to pass this option.**
631
+ #
481
632
  # @return [Types::CreateListenerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
482
633
  #
483
634
  # * {Types::CreateListenerResponse#listener #listener} => Types::Listener
@@ -515,9 +666,30 @@ module Aws::GlobalAccelerator
515
666
  req.send_request(options)
516
667
  end
517
668
 
518
- # Delete an accelerator. Note: before you can delete an accelerator, you
519
- # must disable it and remove all dependent resources (listeners and
520
- # endpoint groups).
669
+ # Delete an accelerator. Before you can delete an accelerator, you must
670
+ # disable it and remove all dependent resources (listeners and endpoint
671
+ # groups). To disable the accelerator, update the accelerator to set
672
+ # `Enabled` to false.
673
+ #
674
+ # When you create an accelerator, by default, Global Accelerator
675
+ # provides you with a set of two static IP addresses. Alternatively, you
676
+ # can bring your own IP address ranges to Global Accelerator and assign
677
+ # IP addresses from those ranges.
678
+ #
679
+ # The IP addresses are assigned to your accelerator for as long as it
680
+ # exists, even if you disable the accelerator and it no longer accepts
681
+ # or routes traffic. However, when you *delete* an accelerator, you lose
682
+ # the static IP addresses that are assigned to the accelerator, so you
683
+ # can no longer route traffic by using them. As a best practice, ensure
684
+ # that you have permissions in place to avoid inadvertently deleting
685
+ # accelerators. You can use IAM policies with Global Accelerator to
686
+ # limit the users who have permissions to delete an accelerator. For
687
+ # more information, see [Authentication and Access Control][1] in the
688
+ # *AWS Global Accelerator Developer Guide*.
689
+ #
690
+ #
691
+ #
692
+ # [1]: https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html
521
693
  #
522
694
  # @option params [required, String] :accelerator_arn
523
695
  # The Amazon Resource Name (ARN) of an accelerator.
@@ -583,6 +755,54 @@ module Aws::GlobalAccelerator
583
755
  req.send_request(options)
584
756
  end
585
757
 
758
+ # Releases the specified address range that you provisioned to use with
759
+ # your AWS resources through bring your own IP addresses (BYOIP) and
760
+ # deletes the corresponding address pool. To see an AWS CLI example of
761
+ # deprovisioning an address range, scroll down to **Example**.
762
+ #
763
+ # Before you can release an address range, you must stop advertising it
764
+ # by using [WithdrawByoipCidr][1] and you must not have any accelerators
765
+ # that are using static IP addresses allocated from its address range.
766
+ #
767
+ # For more information, see [Bring Your Own IP Addresses (BYOIP)][2] in
768
+ # the *AWS Global Accelerator Developer Guide*.
769
+ #
770
+ #
771
+ #
772
+ # [1]: https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html
773
+ # [2]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html
774
+ #
775
+ # @option params [required, String] :cidr
776
+ # The address range, in CIDR notation. The prefix must be the same
777
+ # prefix that you specified when you provisioned the address range.
778
+ #
779
+ # @return [Types::DeprovisionByoipCidrResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
780
+ #
781
+ # * {Types::DeprovisionByoipCidrResponse#byoip_cidr #byoip_cidr} => Types::ByoipCidr
782
+ #
783
+ # @example Request syntax with placeholder values
784
+ #
785
+ # resp = client.deprovision_byoip_cidr({
786
+ # cidr: "GenericString", # required
787
+ # })
788
+ #
789
+ # @example Response structure
790
+ #
791
+ # resp.byoip_cidr.cidr #=> String
792
+ # resp.byoip_cidr.state #=> String, one of "PENDING_PROVISIONING", "READY", "PENDING_ADVERTISING", "ADVERTISING", "PENDING_WITHDRAWING", "PENDING_DEPROVISIONING", "DEPROVISIONED", "FAILED_PROVISION", "FAILED_ADVERTISING", "FAILED_WITHDRAW", "FAILED_DEPROVISION"
793
+ # resp.byoip_cidr.events #=> Array
794
+ # resp.byoip_cidr.events[0].message #=> String
795
+ # resp.byoip_cidr.events[0].timestamp #=> Time
796
+ #
797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeprovisionByoipCidr AWS API Documentation
798
+ #
799
+ # @overload deprovision_byoip_cidr(params = {})
800
+ # @param [Hash] params ({})
801
+ def deprovision_byoip_cidr(params = {}, options = {})
802
+ req = build_request(:deprovision_byoip_cidr, params)
803
+ req.send_request(options)
804
+ end
805
+
586
806
  # Describe an accelerator. To see an AWS CLI example of describing an
587
807
  # accelerator, scroll down to **Example**.
588
808
  #
@@ -623,7 +843,9 @@ module Aws::GlobalAccelerator
623
843
  req.send_request(options)
624
844
  end
625
845
 
626
- # Describe the attributes of an accelerator.
846
+ # Describe the attributes of an accelerator. To see an AWS CLI example
847
+ # of describing the attributes of an accelerator, scroll down to
848
+ # **Example**.
627
849
  #
628
850
  # @option params [required, String] :accelerator_arn
629
851
  # The Amazon Resource Name (ARN) of the accelerator with the attributes
@@ -654,7 +876,8 @@ module Aws::GlobalAccelerator
654
876
  req.send_request(options)
655
877
  end
656
878
 
657
- # Describe an endpoint group.
879
+ # Describe an endpoint group. To see an AWS CLI example of describing an
880
+ # endpoint group, scroll down to **Example**.
658
881
  #
659
882
  # @option params [required, String] :endpoint_group_arn
660
883
  # The Amazon Resource Name (ARN) of the endpoint group to describe.
@@ -695,7 +918,8 @@ module Aws::GlobalAccelerator
695
918
  req.send_request(options)
696
919
  end
697
920
 
698
- # Describe a listener.
921
+ # Describe a listener. To see an AWS CLI example of describing a
922
+ # listener, scroll down to **Example**.
699
923
  #
700
924
  # @option params [required, String] :listener_arn
701
925
  # The Amazon Resource Name (ARN) of the listener to describe.
@@ -728,7 +952,9 @@ module Aws::GlobalAccelerator
728
952
  req.send_request(options)
729
953
  end
730
954
 
731
- # List the accelerators for an AWS account.
955
+ # List the accelerators for an AWS account. To see an AWS CLI example of
956
+ # listing the accelerators for an AWS account, scroll down to
957
+ # **Example**.
732
958
  #
733
959
  # @option params [Integer] :max_results
734
960
  # The number of Global Accelerator objects that you want to return with
@@ -776,7 +1002,59 @@ module Aws::GlobalAccelerator
776
1002
  req.send_request(options)
777
1003
  end
778
1004
 
779
- # List the endpoint groups that are associated with a listener.
1005
+ # Lists the IP address ranges that were specified in calls to
1006
+ # [ProvisionByoipCidr][1], including the current state and a history of
1007
+ # state changes.
1008
+ #
1009
+ # To see an AWS CLI example of listing BYOIP CIDR addresses, scroll down
1010
+ # to **Example**.
1011
+ #
1012
+ #
1013
+ #
1014
+ # [1]: https://docs.aws.amazon.com/global-accelerator/latest/api/ProvisionByoipCidr.html
1015
+ #
1016
+ # @option params [Integer] :max_results
1017
+ # The maximum number of results to return with a single call. To
1018
+ # retrieve the remaining results, make another call with the returned
1019
+ # `nextToken` value.
1020
+ #
1021
+ # @option params [String] :next_token
1022
+ # The token for the next page of results.
1023
+ #
1024
+ # @return [Types::ListByoipCidrsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1025
+ #
1026
+ # * {Types::ListByoipCidrsResponse#byoip_cidrs #byoip_cidrs} => Array&lt;Types::ByoipCidr&gt;
1027
+ # * {Types::ListByoipCidrsResponse#next_token #next_token} => String
1028
+ #
1029
+ # @example Request syntax with placeholder values
1030
+ #
1031
+ # resp = client.list_byoip_cidrs({
1032
+ # max_results: 1,
1033
+ # next_token: "GenericString",
1034
+ # })
1035
+ #
1036
+ # @example Response structure
1037
+ #
1038
+ # resp.byoip_cidrs #=> Array
1039
+ # resp.byoip_cidrs[0].cidr #=> String
1040
+ # resp.byoip_cidrs[0].state #=> String, one of "PENDING_PROVISIONING", "READY", "PENDING_ADVERTISING", "ADVERTISING", "PENDING_WITHDRAWING", "PENDING_DEPROVISIONING", "DEPROVISIONED", "FAILED_PROVISION", "FAILED_ADVERTISING", "FAILED_WITHDRAW", "FAILED_DEPROVISION"
1041
+ # resp.byoip_cidrs[0].events #=> Array
1042
+ # resp.byoip_cidrs[0].events[0].message #=> String
1043
+ # resp.byoip_cidrs[0].events[0].timestamp #=> Time
1044
+ # resp.next_token #=> String
1045
+ #
1046
+ # @see http://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListByoipCidrs AWS API Documentation
1047
+ #
1048
+ # @overload list_byoip_cidrs(params = {})
1049
+ # @param [Hash] params ({})
1050
+ def list_byoip_cidrs(params = {}, options = {})
1051
+ req = build_request(:list_byoip_cidrs, params)
1052
+ req.send_request(options)
1053
+ end
1054
+
1055
+ # List the endpoint groups that are associated with a listener. To see
1056
+ # an AWS CLI example of listing the endpoint groups for listener, scroll
1057
+ # down to **Example**.
780
1058
  #
781
1059
  # @option params [required, String] :listener_arn
782
1060
  # The Amazon Resource Name (ARN) of the listener.
@@ -830,7 +1108,8 @@ module Aws::GlobalAccelerator
830
1108
  req.send_request(options)
831
1109
  end
832
1110
 
833
- # List the listeners for an accelerator.
1111
+ # List the listeners for an accelerator. To see an AWS CLI example of
1112
+ # listing the listeners for an accelerator, scroll down to **Example**.
834
1113
  #
835
1114
  # @option params [required, String] :accelerator_arn
836
1115
  # The Amazon Resource Name (ARN) of the accelerator for which you want
@@ -877,10 +1156,186 @@ module Aws::GlobalAccelerator
877
1156
  req.send_request(options)
878
1157
  end
879
1158
 
1159
+ # List all tags for an accelerator. To see an AWS CLI example of listing
1160
+ # tags for an accelerator, scroll down to **Example**.
1161
+ #
1162
+ # For more information, see [Tagging in AWS Global Accelerator][1] in
1163
+ # the *AWS Global Accelerator Developer Guide*.
1164
+ #
1165
+ #
1166
+ #
1167
+ # [1]: https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html
1168
+ #
1169
+ # @option params [required, String] :resource_arn
1170
+ # The Amazon Resource Name (ARN) of the accelerator to list tags for. An
1171
+ # ARN uniquely identifies an accelerator.
1172
+ #
1173
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1174
+ #
1175
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt;
1176
+ #
1177
+ # @example Request syntax with placeholder values
1178
+ #
1179
+ # resp = client.list_tags_for_resource({
1180
+ # resource_arn: "ResourceArn", # required
1181
+ # })
1182
+ #
1183
+ # @example Response structure
1184
+ #
1185
+ # resp.tags #=> Array
1186
+ # resp.tags[0].key #=> String
1187
+ # resp.tags[0].value #=> String
1188
+ #
1189
+ # @see http://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListTagsForResource AWS API Documentation
1190
+ #
1191
+ # @overload list_tags_for_resource(params = {})
1192
+ # @param [Hash] params ({})
1193
+ def list_tags_for_resource(params = {}, options = {})
1194
+ req = build_request(:list_tags_for_resource, params)
1195
+ req.send_request(options)
1196
+ end
1197
+
1198
+ # Provisions an IP address range to use with your AWS resources through
1199
+ # bring your own IP addresses (BYOIP) and creates a corresponding
1200
+ # address pool. After the address range is provisioned, it is ready to
1201
+ # be advertised using [ AdvertiseByoipCidr][1].
1202
+ #
1203
+ # To see an AWS CLI example of provisioning an address range for BYOIP,
1204
+ # scroll down to **Example**.
1205
+ #
1206
+ # For more information, see [Bring Your Own IP Addresses (BYOIP)][2] in
1207
+ # the *AWS Global Accelerator Developer Guide*.
1208
+ #
1209
+ #
1210
+ #
1211
+ # [1]: https://docs.aws.amazon.com/global-accelerator/latest/api/AdvertiseByoipCidr.html
1212
+ # [2]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html
1213
+ #
1214
+ # @option params [required, String] :cidr
1215
+ # The public IPv4 address range, in CIDR notation. The most specific IP
1216
+ # prefix that you can specify is /24. The address range cannot overlap
1217
+ # with another address range that you've brought to this or another
1218
+ # Region.
1219
+ #
1220
+ # @option params [required, Types::CidrAuthorizationContext] :cidr_authorization_context
1221
+ # A signed document that proves that you are authorized to bring the
1222
+ # specified IP address range to Amazon using BYOIP.
1223
+ #
1224
+ # @return [Types::ProvisionByoipCidrResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1225
+ #
1226
+ # * {Types::ProvisionByoipCidrResponse#byoip_cidr #byoip_cidr} => Types::ByoipCidr
1227
+ #
1228
+ # @example Request syntax with placeholder values
1229
+ #
1230
+ # resp = client.provision_byoip_cidr({
1231
+ # cidr: "GenericString", # required
1232
+ # cidr_authorization_context: { # required
1233
+ # message: "GenericString", # required
1234
+ # signature: "GenericString", # required
1235
+ # },
1236
+ # })
1237
+ #
1238
+ # @example Response structure
1239
+ #
1240
+ # resp.byoip_cidr.cidr #=> String
1241
+ # resp.byoip_cidr.state #=> String, one of "PENDING_PROVISIONING", "READY", "PENDING_ADVERTISING", "ADVERTISING", "PENDING_WITHDRAWING", "PENDING_DEPROVISIONING", "DEPROVISIONED", "FAILED_PROVISION", "FAILED_ADVERTISING", "FAILED_WITHDRAW", "FAILED_DEPROVISION"
1242
+ # resp.byoip_cidr.events #=> Array
1243
+ # resp.byoip_cidr.events[0].message #=> String
1244
+ # resp.byoip_cidr.events[0].timestamp #=> Time
1245
+ #
1246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ProvisionByoipCidr AWS API Documentation
1247
+ #
1248
+ # @overload provision_byoip_cidr(params = {})
1249
+ # @param [Hash] params ({})
1250
+ def provision_byoip_cidr(params = {}, options = {})
1251
+ req = build_request(:provision_byoip_cidr, params)
1252
+ req.send_request(options)
1253
+ end
1254
+
1255
+ # Add tags to an accelerator resource. To see an AWS CLI example of
1256
+ # adding tags to an accelerator, scroll down to **Example**.
1257
+ #
1258
+ # For more information, see [Tagging in AWS Global Accelerator][1] in
1259
+ # the *AWS Global Accelerator Developer Guide*.
1260
+ #
1261
+ #
1262
+ #
1263
+ # [1]: https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html
1264
+ #
1265
+ # @option params [required, String] :resource_arn
1266
+ # The Amazon Resource Name (ARN) of the Global Accelerator resource to
1267
+ # add tags to. An ARN uniquely identifies a resource.
1268
+ #
1269
+ # @option params [required, Array<Types::Tag>] :tags
1270
+ # The tags to add to a resource. A tag consists of a key and a value
1271
+ # that you define.
1272
+ #
1273
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1274
+ #
1275
+ # @example Request syntax with placeholder values
1276
+ #
1277
+ # resp = client.tag_resource({
1278
+ # resource_arn: "ResourceArn", # required
1279
+ # tags: [ # required
1280
+ # {
1281
+ # key: "TagKey", # required
1282
+ # value: "TagValue", # required
1283
+ # },
1284
+ # ],
1285
+ # })
1286
+ #
1287
+ # @see http://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/TagResource AWS API Documentation
1288
+ #
1289
+ # @overload tag_resource(params = {})
1290
+ # @param [Hash] params ({})
1291
+ def tag_resource(params = {}, options = {})
1292
+ req = build_request(:tag_resource, params)
1293
+ req.send_request(options)
1294
+ end
1295
+
1296
+ # Remove tags from a Global Accelerator resource. When you specify a tag
1297
+ # key, the action removes both that key and its associated value. To see
1298
+ # an AWS CLI example of removing tags from an accelerator, scroll down
1299
+ # to **Example**. The operation succeeds even if you attempt to remove
1300
+ # tags from an accelerator that was already removed.
1301
+ #
1302
+ # For more information, see [Tagging in AWS Global Accelerator][1] in
1303
+ # the *AWS Global Accelerator Developer Guide*.
1304
+ #
1305
+ #
1306
+ #
1307
+ # [1]: https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html
1308
+ #
1309
+ # @option params [required, String] :resource_arn
1310
+ # The Amazon Resource Name (ARN) of the Global Accelerator resource to
1311
+ # remove tags from. An ARN uniquely identifies a resource.
1312
+ #
1313
+ # @option params [required, Array<String>] :tag_keys
1314
+ # The tag key pairs that you want to remove from the specified
1315
+ # resources.
1316
+ #
1317
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1318
+ #
1319
+ # @example Request syntax with placeholder values
1320
+ #
1321
+ # resp = client.untag_resource({
1322
+ # resource_arn: "ResourceArn", # required
1323
+ # tag_keys: ["TagKey"], # required
1324
+ # })
1325
+ #
1326
+ # @see http://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UntagResource AWS API Documentation
1327
+ #
1328
+ # @overload untag_resource(params = {})
1329
+ # @param [Hash] params ({})
1330
+ def untag_resource(params = {}, options = {})
1331
+ req = build_request(:untag_resource, params)
1332
+ req.send_request(options)
1333
+ end
1334
+
880
1335
  # Update an accelerator. To see an AWS CLI example of updating an
881
1336
  # accelerator, scroll down to **Example**.
882
1337
  #
883
- # You must specify the US-West-2 (Oregon) Region to create or update
1338
+ # You must specify the US West (Oregon) Region to create or update
884
1339
  # accelerators.
885
1340
  #
886
1341
  # @option params [required, String] :accelerator_arn
@@ -966,9 +1421,14 @@ module Aws::GlobalAccelerator
966
1421
  #
967
1422
  # @option params [String] :flow_logs_s3_prefix
968
1423
  # Update the prefix for the location in the Amazon S3 bucket for the
969
- # flow logs. Attribute is required if `FlowLogsEnabled` is `true`. If
970
- # you don’t specify a prefix, the flow logs are stored in the root of
971
- # the bucket.
1424
+ # flow logs. Attribute is required if `FlowLogsEnabled` is `true`.
1425
+ #
1426
+ # If you don’t specify a prefix, the flow logs are stored in the root of
1427
+ # the bucket. If you specify slash (/) for the S3 bucket prefix, the log
1428
+ # file bucket folder structure will include a double slash (//), like
1429
+ # the following:
1430
+ #
1431
+ # s3-bucket\_name//AWSLogs/aws\_account\_id
972
1432
  #
973
1433
  # @return [Types::UpdateAcceleratorAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
974
1434
  #
@@ -1092,7 +1552,8 @@ module Aws::GlobalAccelerator
1092
1552
  req.send_request(options)
1093
1553
  end
1094
1554
 
1095
- # Update a listener.
1555
+ # Update a listener. To see an AWS CLI example of updating listener,
1556
+ # scroll down to **Example**.
1096
1557
  #
1097
1558
  # @option params [required, String] :listener_arn
1098
1559
  # The Amazon Resource Name (ARN) of the listener to update.
@@ -1166,6 +1627,52 @@ module Aws::GlobalAccelerator
1166
1627
  req.send_request(options)
1167
1628
  end
1168
1629
 
1630
+ # Stops advertising an address range that is provisioned as an address
1631
+ # pool. You can perform this operation at most once every 10 seconds,
1632
+ # even if you specify different address ranges each time. To see an AWS
1633
+ # CLI example of withdrawing an address range for BYOIP so it will no
1634
+ # longer be advertised by AWS, scroll down to **Example**.
1635
+ #
1636
+ # It can take a few minutes before traffic to the specified addresses
1637
+ # stops routing to AWS because of propagation delays.
1638
+ #
1639
+ # For more information, see [Bring Your Own IP Addresses (BYOIP)][1] in
1640
+ # the *AWS Global Accelerator Developer Guide*.
1641
+ #
1642
+ #
1643
+ #
1644
+ # [1]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html
1645
+ #
1646
+ # @option params [required, String] :cidr
1647
+ # The address range, in CIDR notation.
1648
+ #
1649
+ # @return [Types::WithdrawByoipCidrResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1650
+ #
1651
+ # * {Types::WithdrawByoipCidrResponse#byoip_cidr #byoip_cidr} => Types::ByoipCidr
1652
+ #
1653
+ # @example Request syntax with placeholder values
1654
+ #
1655
+ # resp = client.withdraw_byoip_cidr({
1656
+ # cidr: "GenericString", # required
1657
+ # })
1658
+ #
1659
+ # @example Response structure
1660
+ #
1661
+ # resp.byoip_cidr.cidr #=> String
1662
+ # resp.byoip_cidr.state #=> String, one of "PENDING_PROVISIONING", "READY", "PENDING_ADVERTISING", "ADVERTISING", "PENDING_WITHDRAWING", "PENDING_DEPROVISIONING", "DEPROVISIONED", "FAILED_PROVISION", "FAILED_ADVERTISING", "FAILED_WITHDRAW", "FAILED_DEPROVISION"
1663
+ # resp.byoip_cidr.events #=> Array
1664
+ # resp.byoip_cidr.events[0].message #=> String
1665
+ # resp.byoip_cidr.events[0].timestamp #=> Time
1666
+ #
1667
+ # @see http://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/WithdrawByoipCidr AWS API Documentation
1668
+ #
1669
+ # @overload withdraw_byoip_cidr(params = {})
1670
+ # @param [Hash] params ({})
1671
+ def withdraw_byoip_cidr(params = {}, options = {})
1672
+ req = build_request(:withdraw_byoip_cidr, params)
1673
+ req.send_request(options)
1674
+ end
1675
+
1169
1676
  # @!endgroup
1170
1677
 
1171
1678
  # @param params ({})
@@ -1179,7 +1686,7 @@ module Aws::GlobalAccelerator
1179
1686
  params: params,
1180
1687
  config: config)
1181
1688
  context[:gem_name] = 'aws-sdk-globalaccelerator'
1182
- context[:gem_version] = '1.13.0'
1689
+ context[:gem_version] = '1.18.0'
1183
1690
  Seahorse::Client::Request.new(handlers, context)
1184
1691
  end
1185
1692