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
-
#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_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_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_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.
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.
385 386 387 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#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.
459 460 461 462 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 459 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.
518 519 520 521 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 518 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.
578 579 580 581 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 578 def enable_region(params = {}, = {}) req = build_request(:enable_region, 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.
661 662 663 664 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 661 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.
736 737 738 739 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 736 def get_contact_information(params = {}, = {}) req = build_request(:get_contact_information, params) req.send_request() end |
#get_region_opt_status(params = {}) ⇒ Types::GetRegionOptStatusResponse
Retrieves the opt-in status of a particular Region.
800 801 802 803 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 800 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.
897 898 899 900 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 897 def list_regions(params = {}, = {}) req = build_request(:list_regions, 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.
986 987 988 989 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 986 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.
1062 1063 1064 1065 |
# File 'gems/aws-sdk-account/lib/aws-sdk-account/client.rb', line 1062 def put_contact_information(params = {}, = {}) req = build_request(:put_contact_information, params) req.send_request() end |