MigrationHubConfig class
The AWS Migration Hub home region APIs are available specifically for working with your Migration Hub home region. You can use these APIs to determine a home region, as well as to create and work with controls that describe the home region.
-
You must make API calls for write actions (create, notify, associate,
disassociate, import, or put) while in your home region, or a
HomeRegionNotSetException
error is returned. - API calls for read actions (list, describe, stop, and delete) are permitted outside of your home region.
-
If you call a write API outside the home region, an
InvalidInputException
is returned. -
You can call
GetHomeRegion
action to obtain the account's Migration Hub home region.
Constructors
- MigrationHubConfig({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createHomeRegionControl(
{required String homeRegion, required Target target, bool? dryRun}) → Future< CreateHomeRegionControlResult> - This API sets up the home region for the calling account only.
-
describeHomeRegionControls(
{String? controlId, String? homeRegion, int? maxResults, String? nextToken, Target? target}) → Future< DescribeHomeRegionControlsResult> -
This API permits filtering on the
ControlId
andHomeRegion
fields. -
getHomeRegion(
) → Future< 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. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited