Class: Aws::Account::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Account::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-account/lib/aws-sdk-account/client.rb
Overview
An API client for Account. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Account::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_primary_email_update(params = {}) ⇒ Types::AcceptPrimaryEmailUpdateResponse
Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account.
-
#delete_alternate_contact(params = {}) ⇒ Struct
Deletes the specified alternate contact from an Amazon Web Services account.
-
#disable_region(params = {}) ⇒ Struct
Disables (opts-out) a particular Region for an account.
-
#enable_region(params = {}) ⇒ Struct
Enables (opts-in) a particular Region for an account.
-
#get_account_information(params = {}) ⇒ Types::GetAccountInformationResponse
Retrieves information about the specified account including its account name, account ID, and account creation date and time.
-
#get_alternate_contact(params = {}) ⇒ Types::GetAlternateContactResponse
Retrieves the specified alternate contact attached to an Amazon Web Services account.
-
#get_contact_information(params = {}) ⇒ Types::GetContactInformationResponse
Retrieves the primary contact information of an Amazon Web Services account.
-
#get_primary_email(params = {}) ⇒ Types::GetPrimaryEmailResponse
Retrieves the primary email address for the specified account.
-
#get_region_opt_status(params = {}) ⇒ Types::GetRegionOptStatusResponse
Retrieves the opt-in status of a particular Region.
-
#list_regions(params = {}) ⇒ Types::ListRegionsResponse
Lists all the Regions for a given account and their respective opt-in statuses.
-
#put_account_name(params = {}) ⇒ Struct
Updates the account name of the specified account.
-
#put_alternate_contact(params = {}) ⇒ Struct
Modifies the specified alternate contact attached to an Amazon Web Services account.
-
#put_contact_information(params = {}) ⇒ Struct
Updates the primary contact information of an Amazon Web Services account.
-
#start_primary_email_update(params = {}) ⇒ Types::StartPrimaryEmailUpdateResponse
Starts the process to update the primary email address for the specified account.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
473 474 475 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 473 def initialize(*args) super end |
Instance Method Details
#accept_primary_email_update(params = {}) ⇒ Types::AcceptPrimaryEmailUpdateResponse
Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account.
538 539 540 541 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 538 def accept_primary_email_update(params = {}, = {}) req = build_request(:accept_primary_email_update, params) req.send_request() end |
#delete_alternate_contact(params = {}) ⇒ Struct
Deletes the specified alternate contact from an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.
611 612 613 614 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 611 def delete_alternate_contact(params = {}, = {}) req = build_request(:delete_alternate_contact, params) req.send_request() end |
#disable_region(params = {}) ⇒ Struct
Disables (opts-out) a particular Region for an account.
675 676 677 678 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 675 def disable_region(params = {}, = {}) req = build_request(:disable_region, params) req.send_request() end |
#enable_region(params = {}) ⇒ Struct
Enables (opts-in) a particular Region for an account.
735 736 737 738 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 735 def enable_region(params = {}, = {}) req = build_request(:enable_region, params) req.send_request() end |
#get_account_information(params = {}) ⇒ Types::GetAccountInformationResponse
Retrieves information about the specified account including its
account name, account ID, and account creation date and time. To use
this API, an IAM user or role must have the
account:GetAccountInformation
IAM permission.
800 801 802 803 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 800 def get_account_information(params = {}, = {}) req = build_request(:get_account_information, params) req.send_request() end |
#get_alternate_contact(params = {}) ⇒ Types::GetAlternateContactResponse
Retrieves the specified alternate contact attached to an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.
883 884 885 886 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 883 def get_alternate_contact(params = {}, = {}) req = build_request(:get_alternate_contact, params) req.send_request() end |
#get_contact_information(params = {}) ⇒ Types::GetContactInformationResponse
Retrieves the primary contact information of an Amazon Web Services account.
For complete details about how to use the primary contact operations, see Update the primary and alternate contact information.
958 959 960 961 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 958 def get_contact_information(params = {}, = {}) req = build_request(:get_contact_information, params) req.send_request() end |
#get_primary_email(params = {}) ⇒ Types::GetPrimaryEmailResponse
Retrieves the primary email address for the specified account.
1009 1010 1011 1012 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 1009 def get_primary_email(params = {}, = {}) req = build_request(:get_primary_email, params) req.send_request() end |
#get_region_opt_status(params = {}) ⇒ Types::GetRegionOptStatusResponse
Retrieves the opt-in status of a particular Region.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 1073 def get_region_opt_status(params = {}, = {}) req = build_request(:get_region_opt_status, params) req.send_request() end |
#list_regions(params = {}) ⇒ Types::ListRegionsResponse
Lists all the Regions for a given account and their respective opt-in
statuses. Optionally, this list can be filtered by the
region-opt-status-contains
parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1170 1171 1172 1173 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 1170 def list_regions(params = {}, = {}) req = build_request(:list_regions, params) req.send_request() end |
#put_account_name(params = {}) ⇒ Struct
Updates the account name of the specified account. To use this API,
IAM principals must have the account:PutAccountName
IAM permission.
1227 1228 1229 1230 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 1227 def put_account_name(params = {}, = {}) req = build_request(:put_account_name, params) req.send_request() end |
#put_alternate_contact(params = {}) ⇒ Struct
Modifies the specified alternate contact attached to an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts.
1316 1317 1318 1319 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 1316 def put_alternate_contact(params = {}, = {}) req = build_request(:put_alternate_contact, params) req.send_request() end |
#put_contact_information(params = {}) ⇒ Struct
Updates the primary contact information of an Amazon Web Services account.
For complete details about how to use the primary contact operations, see Update the primary and alternate contact information.
1392 1393 1394 1395 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 1392 def put_contact_information(params = {}, = {}) req = build_request(:put_contact_information, params) req.send_request() end |
#start_primary_email_update(params = {}) ⇒ Types::StartPrimaryEmailUpdateResponse
Starts the process to update the primary email address for the specified account.
1449 1450 1451 1452 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 1449 def start_primary_email_update(params = {}, = {}) req = build_request(:start_primary_email_update, params) req.send_request() end |