aws-sdk-account 1.3.0 → 1.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +77 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-account/client.rb +512 -4
- data/lib/aws-sdk-account/client_api.rb +183 -1
- data/lib/aws-sdk-account/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-account/endpoint_provider.rb +60 -0
- data/lib/aws-sdk-account/endpoints.rb +142 -0
- data/lib/aws-sdk-account/errors.rb +26 -0
- data/lib/aws-sdk-account/plugins/endpoints.rb +86 -0
- data/lib/aws-sdk-account/types.rb +505 -25
- data/lib/aws-sdk-account.rb +5 -1
- metadata +8 -4
@@ -27,7 +27,11 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
-
require 'aws-sdk-core/plugins/
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/request_compression.rb'
|
32
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
33
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
34
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
31
35
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
36
|
|
33
37
|
Aws::Plugins::GlobalConfiguration.add_identifier(:account)
|
@@ -73,8 +77,13 @@ module Aws::Account
|
|
73
77
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
78
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
79
|
add_plugin(Aws::Plugins::HttpChecksum)
|
76
|
-
add_plugin(Aws::Plugins::
|
80
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
81
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
82
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
83
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
84
|
+
add_plugin(Aws::Plugins::Sign)
|
77
85
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
86
|
+
add_plugin(Aws::Account::Plugins::Endpoints)
|
78
87
|
|
79
88
|
# @overload initialize(options)
|
80
89
|
# @param [Hash] options
|
@@ -175,10 +184,18 @@ module Aws::Account
|
|
175
184
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
176
185
|
# a clock skew correction and retry requests with skewed client clocks.
|
177
186
|
#
|
187
|
+
# @option options [String] :defaults_mode ("legacy")
|
188
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
189
|
+
# accepted modes and the configuration defaults that are included.
|
190
|
+
#
|
178
191
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
179
192
|
# Set to true to disable SDK automatically adding host prefix
|
180
193
|
# to default service endpoint when available.
|
181
194
|
#
|
195
|
+
# @option options [Boolean] :disable_request_compression (false)
|
196
|
+
# When set to 'true' the request body will not be compressed
|
197
|
+
# for supported operations.
|
198
|
+
#
|
182
199
|
# @option options [String] :endpoint
|
183
200
|
# The client endpoint is normally constructed from the `:region`
|
184
201
|
# option. You should only configure an `:endpoint` when connecting
|
@@ -199,6 +216,10 @@ module Aws::Account
|
|
199
216
|
# @option options [Boolean] :endpoint_discovery (false)
|
200
217
|
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
201
218
|
#
|
219
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
220
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
221
|
+
# variables and the shared configuration file.
|
222
|
+
#
|
202
223
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
203
224
|
# The log formatter.
|
204
225
|
#
|
@@ -219,6 +240,11 @@ module Aws::Account
|
|
219
240
|
# Used when loading credentials from the shared credentials file
|
220
241
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
221
242
|
#
|
243
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
244
|
+
# The minimum size in bytes that triggers compression for request
|
245
|
+
# bodies. The value must be non-negative integer value between 0
|
246
|
+
# and 10485780 bytes inclusive.
|
247
|
+
#
|
222
248
|
# @option options [Proc] :retry_backoff
|
223
249
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
224
250
|
# This option is only used in the `legacy` retry mode.
|
@@ -264,6 +290,11 @@ module Aws::Account
|
|
264
290
|
# in the future.
|
265
291
|
#
|
266
292
|
#
|
293
|
+
# @option options [String] :sdk_ua_app_id
|
294
|
+
# A unique and opaque application ID that is appended to the
|
295
|
+
# User-Agent header as app/<sdk_ua_app_id>. It should have a
|
296
|
+
# maximum length of 50.
|
297
|
+
#
|
267
298
|
# @option options [String] :secret_access_key
|
268
299
|
#
|
269
300
|
# @option options [String] :session_token
|
@@ -277,6 +308,19 @@ module Aws::Account
|
|
277
308
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
278
309
|
# requests are made, and retries are disabled.
|
279
310
|
#
|
311
|
+
# @option options [Aws::TokenProvider] :token_provider
|
312
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
313
|
+
# following classes:
|
314
|
+
#
|
315
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
316
|
+
# tokens.
|
317
|
+
#
|
318
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
319
|
+
# access token generated from `aws login`.
|
320
|
+
#
|
321
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
322
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
323
|
+
#
|
280
324
|
# @option options [Boolean] :use_dualstack_endpoint
|
281
325
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
282
326
|
# will be used if available.
|
@@ -290,6 +334,9 @@ module Aws::Account
|
|
290
334
|
# When `true`, request parameters are validated before
|
291
335
|
# sending the request.
|
292
336
|
#
|
337
|
+
# @option options [Aws::Account::EndpointProvider] :endpoint_provider
|
338
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Account::EndpointParameters`
|
339
|
+
#
|
293
340
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
294
341
|
# requests through. Formatted like 'http://proxy.com:123'.
|
295
342
|
#
|
@@ -297,7 +344,7 @@ module Aws::Account
|
|
297
344
|
# seconds to wait when opening a HTTP session before raising a
|
298
345
|
# `Timeout::Error`.
|
299
346
|
#
|
300
|
-
# @option options [
|
347
|
+
# @option options [Float] :http_read_timeout (60) The default
|
301
348
|
# number of seconds to wait for response data. This value can
|
302
349
|
# safely be set per-request on the session.
|
303
350
|
#
|
@@ -313,6 +360,9 @@ module Aws::Account
|
|
313
360
|
# disables this behaviour. This value can safely be set per
|
314
361
|
# request on the session.
|
315
362
|
#
|
363
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
364
|
+
# in seconds.
|
365
|
+
#
|
316
366
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
317
367
|
# HTTP debug output will be sent to the `:logger`.
|
318
368
|
#
|
@@ -344,9 +394,18 @@ module Aws::Account
|
|
344
394
|
# For complete details about how to use the alternate contact
|
345
395
|
# operations, see [Access or updating the alternate contacts][1].
|
346
396
|
#
|
397
|
+
# <note markdown="1"> Before you can update the alternate contact information for an Amazon
|
398
|
+
# Web Services account that is managed by Organizations, you must first
|
399
|
+
# enable integration between Amazon Web Services Account Management and
|
400
|
+
# Organizations. For more information, see [Enabling trusted access for
|
401
|
+
# Amazon Web Services Account Management][2].
|
402
|
+
#
|
403
|
+
# </note>
|
404
|
+
#
|
347
405
|
#
|
348
406
|
#
|
349
407
|
# [1]: https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html
|
408
|
+
# [2]: https://docs.aws.amazon.com/accounts/latest/reference/using-orgs-trusted-access.html
|
350
409
|
#
|
351
410
|
# @option params [String] :account_id
|
352
411
|
# Specifies the 12 digit account ID number of the Amazon Web Services
|
@@ -402,15 +461,143 @@ module Aws::Account
|
|
402
461
|
req.send_request(options)
|
403
462
|
end
|
404
463
|
|
464
|
+
# Disables (opts-out) a particular Region for an account.
|
465
|
+
#
|
466
|
+
# @option params [String] :account_id
|
467
|
+
# Specifies the 12-digit account ID number of the Amazon Web Services
|
468
|
+
# account that you want to access or modify with this operation. If you
|
469
|
+
# don't specify this parameter, it defaults to the Amazon Web Services
|
470
|
+
# account of the identity used to call the operation. To use this
|
471
|
+
# parameter, the caller must be an identity in the [organization's
|
472
|
+
# management account][1] or a delegated administrator account. The
|
473
|
+
# specified account ID must also be a member account in the same
|
474
|
+
# organization. The organization must have [all features enabled][2],
|
475
|
+
# and the organization must have [trusted access][3] enabled for the
|
476
|
+
# Account Management service, and optionally a [delegated admin][4]
|
477
|
+
# account assigned.
|
478
|
+
#
|
479
|
+
# <note markdown="1"> The management account can't specify its own `AccountId`. It must
|
480
|
+
# call the operation in standalone context by not including the
|
481
|
+
# `AccountId` parameter.
|
482
|
+
#
|
483
|
+
# </note>
|
484
|
+
#
|
485
|
+
# To call this operation on an account that is not a member of an
|
486
|
+
# organization, don't specify this parameter. Instead, call the
|
487
|
+
# operation using an identity belonging to the account whose contacts
|
488
|
+
# you wish to retrieve or modify.
|
489
|
+
#
|
490
|
+
#
|
491
|
+
#
|
492
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account
|
493
|
+
# [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html
|
494
|
+
# [3]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html
|
495
|
+
# [4]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html
|
496
|
+
#
|
497
|
+
# @option params [required, String] :region_name
|
498
|
+
# Specifies the Region-code for a given Region name (for example,
|
499
|
+
# `af-south-1`). When you disable a Region, Amazon Web Services performs
|
500
|
+
# actions to deactivate that Region in your account, such as destroying
|
501
|
+
# IAM resources in the Region. This process takes a few minutes for most
|
502
|
+
# accounts, but this can take several hours. You cannot enable the
|
503
|
+
# Region until the disabling process is fully completed.
|
504
|
+
#
|
505
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
506
|
+
#
|
507
|
+
# @example Request syntax with placeholder values
|
508
|
+
#
|
509
|
+
# resp = client.disable_region({
|
510
|
+
# account_id: "AccountId",
|
511
|
+
# region_name: "RegionName", # required
|
512
|
+
# })
|
513
|
+
#
|
514
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/DisableRegion AWS API Documentation
|
515
|
+
#
|
516
|
+
# @overload disable_region(params = {})
|
517
|
+
# @param [Hash] params ({})
|
518
|
+
def disable_region(params = {}, options = {})
|
519
|
+
req = build_request(:disable_region, params)
|
520
|
+
req.send_request(options)
|
521
|
+
end
|
522
|
+
|
523
|
+
# Enables (opts-in) a particular Region for an account.
|
524
|
+
#
|
525
|
+
# @option params [String] :account_id
|
526
|
+
# Specifies the 12-digit account ID number of the Amazon Web Services
|
527
|
+
# account that you want to access or modify with this operation. If you
|
528
|
+
# don't specify this parameter, it defaults to the Amazon Web Services
|
529
|
+
# account of the identity used to call the operation. To use this
|
530
|
+
# parameter, the caller must be an identity in the [organization's
|
531
|
+
# management account][1] or a delegated administrator account. The
|
532
|
+
# specified account ID must also be a member account in the same
|
533
|
+
# organization. The organization must have [all features enabled][2],
|
534
|
+
# and the organization must have [trusted access][3] enabled for the
|
535
|
+
# Account Management service, and optionally a [delegated admin][4]
|
536
|
+
# account assigned.
|
537
|
+
#
|
538
|
+
# <note markdown="1"> The management account can't specify its own `AccountId`. It must
|
539
|
+
# call the operation in standalone context by not including the
|
540
|
+
# `AccountId` parameter.
|
541
|
+
#
|
542
|
+
# </note>
|
543
|
+
#
|
544
|
+
# To call this operation on an account that is not a member of an
|
545
|
+
# organization, don't specify this parameter. Instead, call the
|
546
|
+
# operation using an identity belonging to the account whose contacts
|
547
|
+
# you wish to retrieve or modify.
|
548
|
+
#
|
549
|
+
#
|
550
|
+
#
|
551
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account
|
552
|
+
# [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html
|
553
|
+
# [3]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html
|
554
|
+
# [4]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html
|
555
|
+
#
|
556
|
+
# @option params [required, String] :region_name
|
557
|
+
# Specifies the Region-code for a given Region name (for example,
|
558
|
+
# `af-south-1`). When you enable a Region, Amazon Web Services performs
|
559
|
+
# actions to prepare your account in that Region, such as distributing
|
560
|
+
# your IAM resources to the Region. This process takes a few minutes for
|
561
|
+
# most accounts, but it can take several hours. You cannot use the
|
562
|
+
# Region until this process is complete. Furthermore, you cannot disable
|
563
|
+
# the Region until the enabling process is fully completed.
|
564
|
+
#
|
565
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
566
|
+
#
|
567
|
+
# @example Request syntax with placeholder values
|
568
|
+
#
|
569
|
+
# resp = client.enable_region({
|
570
|
+
# account_id: "AccountId",
|
571
|
+
# region_name: "RegionName", # required
|
572
|
+
# })
|
573
|
+
#
|
574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/EnableRegion AWS API Documentation
|
575
|
+
#
|
576
|
+
# @overload enable_region(params = {})
|
577
|
+
# @param [Hash] params ({})
|
578
|
+
def enable_region(params = {}, options = {})
|
579
|
+
req = build_request(:enable_region, params)
|
580
|
+
req.send_request(options)
|
581
|
+
end
|
582
|
+
|
405
583
|
# Retrieves the specified alternate contact attached to an Amazon Web
|
406
584
|
# Services account.
|
407
585
|
#
|
408
586
|
# For complete details about how to use the alternate contact
|
409
587
|
# operations, see [Access or updating the alternate contacts][1].
|
410
588
|
#
|
589
|
+
# <note markdown="1"> Before you can update the alternate contact information for an Amazon
|
590
|
+
# Web Services account that is managed by Organizations, you must first
|
591
|
+
# enable integration between Amazon Web Services Account Management and
|
592
|
+
# Organizations. For more information, see [Enabling trusted access for
|
593
|
+
# Amazon Web Services Account Management][2].
|
594
|
+
#
|
595
|
+
# </note>
|
596
|
+
#
|
411
597
|
#
|
412
598
|
#
|
413
599
|
# [1]: https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html
|
600
|
+
# [2]: https://docs.aws.amazon.com/accounts/latest/reference/using-orgs-trusted-access.html
|
414
601
|
#
|
415
602
|
# @option params [String] :account_id
|
416
603
|
# Specifies the 12 digit account ID number of the Amazon Web Services
|
@@ -476,15 +663,260 @@ module Aws::Account
|
|
476
663
|
req.send_request(options)
|
477
664
|
end
|
478
665
|
|
666
|
+
# Retrieves the primary contact information of an Amazon Web Services
|
667
|
+
# account.
|
668
|
+
#
|
669
|
+
# For complete details about how to use the primary contact operations,
|
670
|
+
# see [Update the primary and alternate contact information][1].
|
671
|
+
#
|
672
|
+
#
|
673
|
+
#
|
674
|
+
# [1]: https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html
|
675
|
+
#
|
676
|
+
# @option params [String] :account_id
|
677
|
+
# Specifies the 12-digit account ID number of the Amazon Web Services
|
678
|
+
# account that you want to access or modify with this operation. If you
|
679
|
+
# don't specify this parameter, it defaults to the Amazon Web Services
|
680
|
+
# account of the identity used to call the operation. To use this
|
681
|
+
# parameter, the caller must be an identity in the [organization's
|
682
|
+
# management account][1] or a delegated administrator account. The
|
683
|
+
# specified account ID must also be a member account in the same
|
684
|
+
# organization. The organization must have [all features enabled][2],
|
685
|
+
# and the organization must have [trusted access][3] enabled for the
|
686
|
+
# Account Management service, and optionally a [delegated admin][4]
|
687
|
+
# account assigned.
|
688
|
+
#
|
689
|
+
# <note markdown="1"> The management account can't specify its own `AccountId`. It must
|
690
|
+
# call the operation in standalone context by not including the
|
691
|
+
# `AccountId` parameter.
|
692
|
+
#
|
693
|
+
# </note>
|
694
|
+
#
|
695
|
+
# To call this operation on an account that is not a member of an
|
696
|
+
# organization, don't specify this parameter. Instead, call the
|
697
|
+
# operation using an identity belonging to the account whose contacts
|
698
|
+
# you wish to retrieve or modify.
|
699
|
+
#
|
700
|
+
#
|
701
|
+
#
|
702
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account
|
703
|
+
# [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html
|
704
|
+
# [3]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html
|
705
|
+
# [4]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html
|
706
|
+
#
|
707
|
+
# @return [Types::GetContactInformationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
708
|
+
#
|
709
|
+
# * {Types::GetContactInformationResponse#contact_information #contact_information} => Types::ContactInformation
|
710
|
+
#
|
711
|
+
# @example Request syntax with placeholder values
|
712
|
+
#
|
713
|
+
# resp = client.get_contact_information({
|
714
|
+
# account_id: "AccountId",
|
715
|
+
# })
|
716
|
+
#
|
717
|
+
# @example Response structure
|
718
|
+
#
|
719
|
+
# resp.contact_information.address_line_1 #=> String
|
720
|
+
# resp.contact_information.address_line_2 #=> String
|
721
|
+
# resp.contact_information.address_line_3 #=> String
|
722
|
+
# resp.contact_information.city #=> String
|
723
|
+
# resp.contact_information.company_name #=> String
|
724
|
+
# resp.contact_information.country_code #=> String
|
725
|
+
# resp.contact_information.district_or_county #=> String
|
726
|
+
# resp.contact_information.full_name #=> String
|
727
|
+
# resp.contact_information.phone_number #=> String
|
728
|
+
# resp.contact_information.postal_code #=> String
|
729
|
+
# resp.contact_information.state_or_region #=> String
|
730
|
+
# resp.contact_information.website_url #=> String
|
731
|
+
#
|
732
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/GetContactInformation AWS API Documentation
|
733
|
+
#
|
734
|
+
# @overload get_contact_information(params = {})
|
735
|
+
# @param [Hash] params ({})
|
736
|
+
def get_contact_information(params = {}, options = {})
|
737
|
+
req = build_request(:get_contact_information, params)
|
738
|
+
req.send_request(options)
|
739
|
+
end
|
740
|
+
|
741
|
+
# Retrieves the opt-in status of a particular Region.
|
742
|
+
#
|
743
|
+
# @option params [String] :account_id
|
744
|
+
# Specifies the 12-digit account ID number of the Amazon Web Services
|
745
|
+
# account that you want to access or modify with this operation. If you
|
746
|
+
# don't specify this parameter, it defaults to the Amazon Web Services
|
747
|
+
# account of the identity used to call the operation. To use this
|
748
|
+
# parameter, the caller must be an identity in the [organization's
|
749
|
+
# management account][1] or a delegated administrator account. The
|
750
|
+
# specified account ID must also be a member account in the same
|
751
|
+
# organization. The organization must have [all features enabled][2],
|
752
|
+
# and the organization must have [trusted access][3] enabled for the
|
753
|
+
# Account Management service, and optionally a [delegated admin][4]
|
754
|
+
# account assigned.
|
755
|
+
#
|
756
|
+
# <note markdown="1"> The management account can't specify its own `AccountId`. It must
|
757
|
+
# call the operation in standalone context by not including the
|
758
|
+
# `AccountId` parameter.
|
759
|
+
#
|
760
|
+
# </note>
|
761
|
+
#
|
762
|
+
# To call this operation on an account that is not a member of an
|
763
|
+
# organization, don't specify this parameter. Instead, call the
|
764
|
+
# operation using an identity belonging to the account whose contacts
|
765
|
+
# you wish to retrieve or modify.
|
766
|
+
#
|
767
|
+
#
|
768
|
+
#
|
769
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account
|
770
|
+
# [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html
|
771
|
+
# [3]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html
|
772
|
+
# [4]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html
|
773
|
+
#
|
774
|
+
# @option params [required, String] :region_name
|
775
|
+
# Specifies the Region-code for a given Region name (for example,
|
776
|
+
# `af-south-1`). This function will return the status of whatever Region
|
777
|
+
# you pass into this parameter.
|
778
|
+
#
|
779
|
+
# @return [Types::GetRegionOptStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
780
|
+
#
|
781
|
+
# * {Types::GetRegionOptStatusResponse#region_name #region_name} => String
|
782
|
+
# * {Types::GetRegionOptStatusResponse#region_opt_status #region_opt_status} => String
|
783
|
+
#
|
784
|
+
# @example Request syntax with placeholder values
|
785
|
+
#
|
786
|
+
# resp = client.get_region_opt_status({
|
787
|
+
# account_id: "AccountId",
|
788
|
+
# region_name: "RegionName", # required
|
789
|
+
# })
|
790
|
+
#
|
791
|
+
# @example Response structure
|
792
|
+
#
|
793
|
+
# resp.region_name #=> String
|
794
|
+
# resp.region_opt_status #=> String, one of "ENABLED", "ENABLING", "DISABLING", "DISABLED", "ENABLED_BY_DEFAULT"
|
795
|
+
#
|
796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/GetRegionOptStatus AWS API Documentation
|
797
|
+
#
|
798
|
+
# @overload get_region_opt_status(params = {})
|
799
|
+
# @param [Hash] params ({})
|
800
|
+
def get_region_opt_status(params = {}, options = {})
|
801
|
+
req = build_request(:get_region_opt_status, params)
|
802
|
+
req.send_request(options)
|
803
|
+
end
|
804
|
+
|
805
|
+
# Lists all the Regions for a given account and their respective opt-in
|
806
|
+
# statuses. Optionally, this list can be filtered by the
|
807
|
+
# `region-opt-status-contains` parameter.
|
808
|
+
#
|
809
|
+
# @option params [String] :account_id
|
810
|
+
# Specifies the 12-digit account ID number of the Amazon Web Services
|
811
|
+
# account that you want to access or modify with this operation. If you
|
812
|
+
# don't specify this parameter, it defaults to the Amazon Web Services
|
813
|
+
# account of the identity used to call the operation. To use this
|
814
|
+
# parameter, the caller must be an identity in the [organization's
|
815
|
+
# management account][1] or a delegated administrator account. The
|
816
|
+
# specified account ID must also be a member account in the same
|
817
|
+
# organization. The organization must have [all features enabled][2],
|
818
|
+
# and the organization must have [trusted access][3] enabled for the
|
819
|
+
# Account Management service, and optionally a [delegated admin][4]
|
820
|
+
# account assigned.
|
821
|
+
#
|
822
|
+
# <note markdown="1"> The management account can't specify its own `AccountId`. It must
|
823
|
+
# call the operation in standalone context by not including the
|
824
|
+
# `AccountId` parameter.
|
825
|
+
#
|
826
|
+
# </note>
|
827
|
+
#
|
828
|
+
# To call this operation on an account that is not a member of an
|
829
|
+
# organization, don't specify this parameter. Instead, call the
|
830
|
+
# operation using an identity belonging to the account whose contacts
|
831
|
+
# you wish to retrieve or modify.
|
832
|
+
#
|
833
|
+
#
|
834
|
+
#
|
835
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account
|
836
|
+
# [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html
|
837
|
+
# [3]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html
|
838
|
+
# [4]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html
|
839
|
+
#
|
840
|
+
# @option params [Integer] :max_results
|
841
|
+
# The total number of items to return in the command’s output. If the
|
842
|
+
# total number of items available is more than the value specified, a
|
843
|
+
# `NextToken` is provided in the command’s output. To resume pagination,
|
844
|
+
# provide the `NextToken` value in the `starting-token` argument of a
|
845
|
+
# subsequent command. Do not use the `NextToken` response element
|
846
|
+
# directly outside of the Amazon Web Services CLI. For usage examples,
|
847
|
+
# see [Pagination][1] in the *Amazon Web Services Command Line Interface
|
848
|
+
# User Guide*.
|
849
|
+
#
|
850
|
+
#
|
851
|
+
#
|
852
|
+
# [1]: http://docs.aws.amazon.com/cli/latest/userguide/pagination.html
|
853
|
+
#
|
854
|
+
# @option params [String] :next_token
|
855
|
+
# A token used to specify where to start paginating. This is the
|
856
|
+
# `NextToken` from a previously truncated response. For usage examples,
|
857
|
+
# see [Pagination][1] in the *Amazon Web Services Command Line Interface
|
858
|
+
# User Guide*.
|
859
|
+
#
|
860
|
+
#
|
861
|
+
#
|
862
|
+
# [1]: http://docs.aws.amazon.com/cli/latest/userguide/pagination.html
|
863
|
+
#
|
864
|
+
# @option params [Array<String>] :region_opt_status_contains
|
865
|
+
# A list of Region statuses (Enabling, Enabled, Disabling, Disabled,
|
866
|
+
# Enabled\_by\_default) to use to filter the list of Regions for a given
|
867
|
+
# account. For example, passing in a value of ENABLING will only return
|
868
|
+
# a list of Regions with a Region status of ENABLING.
|
869
|
+
#
|
870
|
+
# @return [Types::ListRegionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
871
|
+
#
|
872
|
+
# * {Types::ListRegionsResponse#next_token #next_token} => String
|
873
|
+
# * {Types::ListRegionsResponse#regions #regions} => Array<Types::Region>
|
874
|
+
#
|
875
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
876
|
+
#
|
877
|
+
# @example Request syntax with placeholder values
|
878
|
+
#
|
879
|
+
# resp = client.list_regions({
|
880
|
+
# account_id: "AccountId",
|
881
|
+
# max_results: 1,
|
882
|
+
# next_token: "ListRegionsRequestNextTokenString",
|
883
|
+
# region_opt_status_contains: ["ENABLED"], # accepts ENABLED, ENABLING, DISABLING, DISABLED, ENABLED_BY_DEFAULT
|
884
|
+
# })
|
885
|
+
#
|
886
|
+
# @example Response structure
|
887
|
+
#
|
888
|
+
# resp.next_token #=> String
|
889
|
+
# resp.regions #=> Array
|
890
|
+
# resp.regions[0].region_name #=> String
|
891
|
+
# resp.regions[0].region_opt_status #=> String, one of "ENABLED", "ENABLING", "DISABLING", "DISABLED", "ENABLED_BY_DEFAULT"
|
892
|
+
#
|
893
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/ListRegions AWS API Documentation
|
894
|
+
#
|
895
|
+
# @overload list_regions(params = {})
|
896
|
+
# @param [Hash] params ({})
|
897
|
+
def list_regions(params = {}, options = {})
|
898
|
+
req = build_request(:list_regions, params)
|
899
|
+
req.send_request(options)
|
900
|
+
end
|
901
|
+
|
479
902
|
# Modifies the specified alternate contact attached to an Amazon Web
|
480
903
|
# Services account.
|
481
904
|
#
|
482
905
|
# For complete details about how to use the alternate contact
|
483
906
|
# operations, see [Access or updating the alternate contacts][1].
|
484
907
|
#
|
908
|
+
# <note markdown="1"> Before you can update the alternate contact information for an Amazon
|
909
|
+
# Web Services account that is managed by Organizations, you must first
|
910
|
+
# enable integration between Amazon Web Services Account Management and
|
911
|
+
# Organizations. For more information, see [Enabling trusted access for
|
912
|
+
# Amazon Web Services Account Management][2].
|
913
|
+
#
|
914
|
+
# </note>
|
915
|
+
#
|
485
916
|
#
|
486
917
|
#
|
487
918
|
# [1]: https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html
|
919
|
+
# [2]: https://docs.aws.amazon.com/accounts/latest/reference/using-orgs-trusted-access.html
|
488
920
|
#
|
489
921
|
# @option params [String] :account_id
|
490
922
|
# Specifies the 12 digit account ID number of the Amazon Web Services
|
@@ -556,6 +988,82 @@ module Aws::Account
|
|
556
988
|
req.send_request(options)
|
557
989
|
end
|
558
990
|
|
991
|
+
# Updates the primary contact information of an Amazon Web Services
|
992
|
+
# account.
|
993
|
+
#
|
994
|
+
# For complete details about how to use the primary contact operations,
|
995
|
+
# see [Update the primary and alternate contact information][1].
|
996
|
+
#
|
997
|
+
#
|
998
|
+
#
|
999
|
+
# [1]: https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html
|
1000
|
+
#
|
1001
|
+
# @option params [String] :account_id
|
1002
|
+
# Specifies the 12-digit account ID number of the Amazon Web Services
|
1003
|
+
# account that you want to access or modify with this operation. If you
|
1004
|
+
# don't specify this parameter, it defaults to the Amazon Web Services
|
1005
|
+
# account of the identity used to call the operation. To use this
|
1006
|
+
# parameter, the caller must be an identity in the [organization's
|
1007
|
+
# management account][1] or a delegated administrator account. The
|
1008
|
+
# specified account ID must also be a member account in the same
|
1009
|
+
# organization. The organization must have [all features enabled][2],
|
1010
|
+
# and the organization must have [trusted access][3] enabled for the
|
1011
|
+
# Account Management service, and optionally a [delegated admin][4]
|
1012
|
+
# account assigned.
|
1013
|
+
#
|
1014
|
+
# <note markdown="1"> The management account can't specify its own `AccountId`. It must
|
1015
|
+
# call the operation in standalone context by not including the
|
1016
|
+
# `AccountId` parameter.
|
1017
|
+
#
|
1018
|
+
# </note>
|
1019
|
+
#
|
1020
|
+
# To call this operation on an account that is not a member of an
|
1021
|
+
# organization, don't specify this parameter. Instead, call the
|
1022
|
+
# operation using an identity belonging to the account whose contacts
|
1023
|
+
# you wish to retrieve or modify.
|
1024
|
+
#
|
1025
|
+
#
|
1026
|
+
#
|
1027
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account
|
1028
|
+
# [2]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html
|
1029
|
+
# [3]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html
|
1030
|
+
# [4]: https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html
|
1031
|
+
#
|
1032
|
+
# @option params [required, Types::ContactInformation] :contact_information
|
1033
|
+
# Contains the details of the primary contact information associated
|
1034
|
+
# with an Amazon Web Services account.
|
1035
|
+
#
|
1036
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1037
|
+
#
|
1038
|
+
# @example Request syntax with placeholder values
|
1039
|
+
#
|
1040
|
+
# resp = client.put_contact_information({
|
1041
|
+
# account_id: "AccountId",
|
1042
|
+
# contact_information: { # required
|
1043
|
+
# address_line_1: "AddressLine", # required
|
1044
|
+
# address_line_2: "AddressLine",
|
1045
|
+
# address_line_3: "AddressLine",
|
1046
|
+
# city: "City", # required
|
1047
|
+
# company_name: "CompanyName",
|
1048
|
+
# country_code: "CountryCode", # required
|
1049
|
+
# district_or_county: "DistrictOrCounty",
|
1050
|
+
# full_name: "FullName", # required
|
1051
|
+
# phone_number: "ContactInformationPhoneNumber", # required
|
1052
|
+
# postal_code: "PostalCode", # required
|
1053
|
+
# state_or_region: "StateOrRegion",
|
1054
|
+
# website_url: "WebsiteUrl",
|
1055
|
+
# },
|
1056
|
+
# })
|
1057
|
+
#
|
1058
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/PutContactInformation AWS API Documentation
|
1059
|
+
#
|
1060
|
+
# @overload put_contact_information(params = {})
|
1061
|
+
# @param [Hash] params ({})
|
1062
|
+
def put_contact_information(params = {}, options = {})
|
1063
|
+
req = build_request(:put_contact_information, params)
|
1064
|
+
req.send_request(options)
|
1065
|
+
end
|
1066
|
+
|
559
1067
|
# @!endgroup
|
560
1068
|
|
561
1069
|
# @param params ({})
|
@@ -569,7 +1077,7 @@ module Aws::Account
|
|
569
1077
|
params: params,
|
570
1078
|
config: config)
|
571
1079
|
context[:gem_name] = 'aws-sdk-account'
|
572
|
-
context[:gem_version] = '1.
|
1080
|
+
context[:gem_version] = '1.18.0'
|
573
1081
|
Seahorse::Client::Request.new(handlers, context)
|
574
1082
|
end
|
575
1083
|
|