Interface MigrationHubConfigClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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.
For specific API usage, see the sections that follow in this AWS Migration Hub Home Region API reference.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aMigrationHubConfigClient
.static MigrationHubConfigClient
create()
Create aMigrationHubConfigClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateHomeRegionControlResponse
createHomeRegionControl
(Consumer<CreateHomeRegionControlRequest.Builder> createHomeRegionControlRequest) This API sets up the home region for the calling account only.default CreateHomeRegionControlResponse
createHomeRegionControl
(CreateHomeRegionControlRequest createHomeRegionControlRequest) This API sets up the home region for the calling account only.default DeleteHomeRegionControlResponse
deleteHomeRegionControl
(Consumer<DeleteHomeRegionControlRequest.Builder> deleteHomeRegionControlRequest) This operation deletes the home region configuration for the calling account.default DeleteHomeRegionControlResponse
deleteHomeRegionControl
(DeleteHomeRegionControlRequest deleteHomeRegionControlRequest) This operation deletes the home region configuration for the calling account.describeHomeRegionControls
(Consumer<DescribeHomeRegionControlsRequest.Builder> describeHomeRegionControlsRequest) This API permits filtering on theControlId
andHomeRegion
fields.describeHomeRegionControls
(DescribeHomeRegionControlsRequest describeHomeRegionControlsRequest) This API permits filtering on theControlId
andHomeRegion
fields.describeHomeRegionControlsPaginator
(Consumer<DescribeHomeRegionControlsRequest.Builder> describeHomeRegionControlsRequest) This is a variant ofdescribeHomeRegionControls(software.amazon.awssdk.services.migrationhubconfig.model.DescribeHomeRegionControlsRequest)
operation.describeHomeRegionControlsPaginator
(DescribeHomeRegionControlsRequest describeHomeRegionControlsRequest) This is a variant ofdescribeHomeRegionControls(software.amazon.awssdk.services.migrationhubconfig.model.DescribeHomeRegionControlsRequest)
operation.default GetHomeRegionResponse
getHomeRegion
(Consumer<GetHomeRegionRequest.Builder> getHomeRegionRequest) Returns the calling account’s home region, if configured.default GetHomeRegionResponse
getHomeRegion
(GetHomeRegionRequest getHomeRegionRequest) Returns the calling account’s home region, if configured.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createHomeRegionControl
default CreateHomeRegionControlResponse createHomeRegionControl(CreateHomeRegionControlRequest createHomeRegionControlRequest) throws InternalServerErrorException, ServiceUnavailableException, AccessDeniedException, ThrottlingException, DryRunOperationException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubConfigException This API sets up the home region for the calling account only.
- Parameters:
createHomeRegionControlRequest
-- Returns:
- Result of the CreateHomeRegionControl operation returned by the service.
- See Also:
-
createHomeRegionControl
default CreateHomeRegionControlResponse createHomeRegionControl(Consumer<CreateHomeRegionControlRequest.Builder> createHomeRegionControlRequest) throws InternalServerErrorException, ServiceUnavailableException, AccessDeniedException, ThrottlingException, DryRunOperationException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubConfigException This API sets up the home region for the calling account only.
This is a convenience which creates an instance of the
CreateHomeRegionControlRequest.Builder
avoiding the need to create one manually viaCreateHomeRegionControlRequest.builder()
- Parameters:
createHomeRegionControlRequest
- AConsumer
that will call methods onCreateHomeRegionControlRequest.Builder
to create a request.- Returns:
- Result of the CreateHomeRegionControl operation returned by the service.
- See Also:
-
deleteHomeRegionControl
default DeleteHomeRegionControlResponse deleteHomeRegionControl(DeleteHomeRegionControlRequest deleteHomeRegionControlRequest) throws InternalServerErrorException, ServiceUnavailableException, AccessDeniedException, ThrottlingException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubConfigException 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.
- Parameters:
deleteHomeRegionControlRequest
-- Returns:
- Result of the DeleteHomeRegionControl operation returned by the service.
- See Also:
-
deleteHomeRegionControl
default DeleteHomeRegionControlResponse deleteHomeRegionControl(Consumer<DeleteHomeRegionControlRequest.Builder> deleteHomeRegionControlRequest) throws InternalServerErrorException, ServiceUnavailableException, AccessDeniedException, ThrottlingException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubConfigException 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.
This is a convenience which creates an instance of the
DeleteHomeRegionControlRequest.Builder
avoiding the need to create one manually viaDeleteHomeRegionControlRequest.builder()
- Parameters:
deleteHomeRegionControlRequest
- AConsumer
that will call methods onDeleteHomeRegionControlRequest.Builder
to create a request.- Returns:
- Result of the DeleteHomeRegionControl operation returned by the service.
- See Also:
-
describeHomeRegionControls
default DescribeHomeRegionControlsResponse describeHomeRegionControls(DescribeHomeRegionControlsRequest describeHomeRegionControlsRequest) throws InternalServerErrorException, ServiceUnavailableException, AccessDeniedException, ThrottlingException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubConfigException This API permits filtering on the
ControlId
andHomeRegion
fields.- Parameters:
describeHomeRegionControlsRequest
-- Returns:
- Result of the DescribeHomeRegionControls operation returned by the service.
- See Also:
-
describeHomeRegionControls
default DescribeHomeRegionControlsResponse describeHomeRegionControls(Consumer<DescribeHomeRegionControlsRequest.Builder> describeHomeRegionControlsRequest) throws InternalServerErrorException, ServiceUnavailableException, AccessDeniedException, ThrottlingException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubConfigException This API permits filtering on the
ControlId
andHomeRegion
fields.
This is a convenience which creates an instance of the
DescribeHomeRegionControlsRequest.Builder
avoiding the need to create one manually viaDescribeHomeRegionControlsRequest.builder()
- Parameters:
describeHomeRegionControlsRequest
- AConsumer
that will call methods onDescribeHomeRegionControlsRequest.Builder
to create a request.- Returns:
- Result of the DescribeHomeRegionControls operation returned by the service.
- See Also:
-
describeHomeRegionControlsPaginator
default DescribeHomeRegionControlsIterable describeHomeRegionControlsPaginator(DescribeHomeRegionControlsRequest describeHomeRegionControlsRequest) throws InternalServerErrorException, ServiceUnavailableException, AccessDeniedException, ThrottlingException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubConfigException This is a variant of
describeHomeRegionControls(software.amazon.awssdk.services.migrationhubconfig.model.DescribeHomeRegionControlsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.migrationhubconfig.paginators.DescribeHomeRegionControlsIterable responses = client.describeHomeRegionControlsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.migrationhubconfig.paginators.DescribeHomeRegionControlsIterable responses = client .describeHomeRegionControlsPaginator(request); for (software.amazon.awssdk.services.migrationhubconfig.model.DescribeHomeRegionControlsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.migrationhubconfig.paginators.DescribeHomeRegionControlsIterable responses = client.describeHomeRegionControlsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeHomeRegionControls(software.amazon.awssdk.services.migrationhubconfig.model.DescribeHomeRegionControlsRequest)
operation.- Parameters:
describeHomeRegionControlsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeHomeRegionControlsPaginator
default DescribeHomeRegionControlsIterable describeHomeRegionControlsPaginator(Consumer<DescribeHomeRegionControlsRequest.Builder> describeHomeRegionControlsRequest) throws InternalServerErrorException, ServiceUnavailableException, AccessDeniedException, ThrottlingException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubConfigException This is a variant of
describeHomeRegionControls(software.amazon.awssdk.services.migrationhubconfig.model.DescribeHomeRegionControlsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.migrationhubconfig.paginators.DescribeHomeRegionControlsIterable responses = client.describeHomeRegionControlsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.migrationhubconfig.paginators.DescribeHomeRegionControlsIterable responses = client .describeHomeRegionControlsPaginator(request); for (software.amazon.awssdk.services.migrationhubconfig.model.DescribeHomeRegionControlsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.migrationhubconfig.paginators.DescribeHomeRegionControlsIterable responses = client.describeHomeRegionControlsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeHomeRegionControls(software.amazon.awssdk.services.migrationhubconfig.model.DescribeHomeRegionControlsRequest)
operation.
This is a convenience which creates an instance of the
DescribeHomeRegionControlsRequest.Builder
avoiding the need to create one manually viaDescribeHomeRegionControlsRequest.builder()
- Parameters:
describeHomeRegionControlsRequest
- AConsumer
that will call methods onDescribeHomeRegionControlsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getHomeRegion
default GetHomeRegionResponse getHomeRegion(GetHomeRegionRequest getHomeRegionRequest) throws InternalServerErrorException, ServiceUnavailableException, AccessDeniedException, ThrottlingException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubConfigException 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.- Parameters:
getHomeRegionRequest
-- Returns:
- Result of the GetHomeRegion operation returned by the service.
- See Also:
-
getHomeRegion
default GetHomeRegionResponse getHomeRegion(Consumer<GetHomeRegionRequest.Builder> getHomeRegionRequest) throws InternalServerErrorException, ServiceUnavailableException, AccessDeniedException, ThrottlingException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubConfigException 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.
This is a convenience which creates an instance of the
GetHomeRegionRequest.Builder
avoiding the need to create one manually viaGetHomeRegionRequest.builder()
- Parameters:
getHomeRegionRequest
- AConsumer
that will call methods onGetHomeRegionRequest.Builder
to create a request.- Returns:
- Result of the GetHomeRegion operation returned by the service.
- See Also:
-
create
Create aMigrationHubConfigClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aMigrationHubConfigClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-