Class: Aws::MigrationHubConfig::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MigrationHubConfig::Client
- Includes:
- ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
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` and `HomeRegion` fields.
-
#get_home_region(params = {}) ⇒ Types::GetHomeRegionResult
Returns the calling account’s home region, if configured.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
451 452 453 |
# File 'lib/aws-sdk-migrationhubconfig/client.rb', line 451 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
644 645 646 |
# File 'lib/aws-sdk-migrationhubconfig/client.rb', line 644 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
647 648 649 |
# File 'lib/aws-sdk-migrationhubconfig/client.rb', line 647 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 |
# File 'lib/aws-sdk-migrationhubconfig/client.rb', line 617 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::MigrationHubConfig') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-migrationhubconfig' context[:gem_version] = '1.47.0' Seahorse::Client::Request.new(handlers, context) end |
#create_home_region_control(params = {}) ⇒ Types::CreateHomeRegionControlResult
This API sets up the home region for the calling account only.
497 498 499 500 |
# File 'lib/aws-sdk-migrationhubconfig/client.rb', line 497 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.
523 524 525 526 |
# File 'lib/aws-sdk-migrationhubconfig/client.rb', line 523 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.
584 585 586 587 |
# File 'lib/aws-sdk-migrationhubconfig/client.rb', line 584 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.
608 609 610 611 |
# File 'lib/aws-sdk-migrationhubconfig/client.rb', line 608 def get_home_region(params = {}, = {}) req = build_request(:get_home_region, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
637 638 639 |
# File 'lib/aws-sdk-migrationhubconfig/client.rb', line 637 def waiter_names [] end |