Class: Aws::MigrationHubConfig::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MigrationHubConfig::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-migrationhubconfig/lib/aws-sdk-migrationhubconfig/client.rb
Overview
An API client for MigrationHubConfig. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MigrationHubConfig::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
-
#create_home_region_control(params = {}) ⇒ Types::CreateHomeRegionControlResult
This API sets up the home region for the calling account only.
-
#delete_home_region_control(params = {}) ⇒ Struct
This operation deletes the home region configuration for the calling account.
-
#describe_home_region_controls(params = {}) ⇒ Types::DescribeHomeRegionControlsResult
This API permits filtering on the
ControlId
andHomeRegion
fields. -
#get_home_region(params = {}) ⇒ Types::GetHomeRegionResult
Returns the calling account’s home region, if configured.
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.
420 421 422 |
# File 'gems/aws-sdk-migrationhubconfig/lib/aws-sdk-migrationhubconfig/client.rb', line 420 def initialize(*args) super end |
Instance Method Details
#create_home_region_control(params = {}) ⇒ Types::CreateHomeRegionControlResult
This API sets up the home region for the calling account only.
466 467 468 469 |
# File 'gems/aws-sdk-migrationhubconfig/lib/aws-sdk-migrationhubconfig/client.rb', line 466 def create_home_region_control(params = {}, = {}) req = build_request(:create_home_region_control, params) req.send_request() end |
#delete_home_region_control(params = {}) ⇒ Struct
This operation deletes the home region configuration for the calling account. The operation does not delete discovery or migration tracking data in the home region.
492 493 494 495 |
# File 'gems/aws-sdk-migrationhubconfig/lib/aws-sdk-migrationhubconfig/client.rb', line 492 def delete_home_region_control(params = {}, = {}) req = build_request(:delete_home_region_control, params) req.send_request() end |
#describe_home_region_controls(params = {}) ⇒ Types::DescribeHomeRegionControlsResult
This API permits filtering on the ControlId
and HomeRegion
fields.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
553 554 555 556 |
# File 'gems/aws-sdk-migrationhubconfig/lib/aws-sdk-migrationhubconfig/client.rb', line 553 def describe_home_region_controls(params = {}, = {}) req = build_request(:describe_home_region_controls, params) req.send_request() end |
#get_home_region(params = {}) ⇒ Types::GetHomeRegionResult
Returns the calling account’s home region, if configured. This API is
used by other AWS services to determine the regional endpoint for
calling AWS Application Discovery Service and Migration Hub. You must
call GetHomeRegion
at least once before you call any other AWS
Application Discovery Service and AWS Migration Hub APIs, to obtain
the account's Migration Hub home region.
577 578 579 580 |
# File 'gems/aws-sdk-migrationhubconfig/lib/aws-sdk-migrationhubconfig/client.rb', line 577 def get_home_region(params = {}, = {}) req = build_request(:get_home_region, params) req.send_request() end |