@Generated(value="software.amazon.awssdk:codegen") public interface MigrationHubConfigClient extends 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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static MigrationHubConfigClientBuilder |
builder()
Create a builder that can be used to configure and create a
MigrationHubConfigClient . |
static MigrationHubConfigClient |
create()
Create a
MigrationHubConfigClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
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 DescribeHomeRegionControlsResponse |
describeHomeRegionControls(Consumer<DescribeHomeRegionControlsRequest.Builder> describeHomeRegionControlsRequest)
This API permits filtering on the
ControlId and HomeRegion fields. |
default DescribeHomeRegionControlsResponse |
describeHomeRegionControls(DescribeHomeRegionControlsRequest describeHomeRegionControlsRequest)
This API permits filtering on the
ControlId and HomeRegion fields. |
default DescribeHomeRegionControlsIterable |
describeHomeRegionControlsPaginator(Consumer<DescribeHomeRegionControlsRequest.Builder> describeHomeRegionControlsRequest)
This API permits filtering on the
ControlId and HomeRegion fields. |
default DescribeHomeRegionControlsIterable |
describeHomeRegionControlsPaginator(DescribeHomeRegionControlsRequest describeHomeRegionControlsRequest)
This API permits filtering on the
ControlId and HomeRegion fields. |
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.
|
static ServiceMetadata |
serviceMetadata() |
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static MigrationHubConfigClient create()
MigrationHubConfigClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static MigrationHubConfigClientBuilder builder()
MigrationHubConfigClient
.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.
createHomeRegionControlRequest
- InternalServerErrorException
- Exception raised when an internal, configuration, or dependency error is encountered.ServiceUnavailableException
- Exception raised when a request fails due to temporary unavailability of the service.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.DryRunOperationException
- Exception raised to indicate that authorization of an action was successful, when the DryRun
flag is set to true.InvalidInputException
- Exception raised when the provided input violates a policy constraint or is entered in the wrong format
or data type.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateHomeRegionControlRequest.builder()
createHomeRegionControlRequest
- A Consumer
that will call methods on CreateHomeRegionControlRequest.Builder
to create a
request.InternalServerErrorException
- Exception raised when an internal, configuration, or dependency error is encountered.ServiceUnavailableException
- Exception raised when a request fails due to temporary unavailability of the service.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.DryRunOperationException
- Exception raised to indicate that authorization of an action was successful, when the DryRun
flag is set to true.InvalidInputException
- Exception raised when the provided input violates a policy constraint or is entered in the wrong format
or data type.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeHomeRegionControlsResponse describeHomeRegionControls(DescribeHomeRegionControlsRequest describeHomeRegionControlsRequest) throws InternalServerErrorException, ServiceUnavailableException, AccessDeniedException, ThrottlingException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubConfigException
This API permits filtering on the ControlId
and HomeRegion
fields.
describeHomeRegionControlsRequest
- InternalServerErrorException
- Exception raised when an internal, configuration, or dependency error is encountered.ServiceUnavailableException
- Exception raised when a request fails due to temporary unavailability of the service.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.InvalidInputException
- Exception raised when the provided input violates a policy constraint or is entered in the wrong format
or data type.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeHomeRegionControlsResponse describeHomeRegionControls(Consumer<DescribeHomeRegionControlsRequest.Builder> describeHomeRegionControlsRequest) throws InternalServerErrorException, ServiceUnavailableException, AccessDeniedException, ThrottlingException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubConfigException
This API permits filtering on the ControlId
and HomeRegion
fields.
This is a convenience which creates an instance of the DescribeHomeRegionControlsRequest.Builder
avoiding
the need to create one manually via DescribeHomeRegionControlsRequest.builder()
describeHomeRegionControlsRequest
- A Consumer
that will call methods on DescribeHomeRegionControlsRequest.Builder
to create a
request.InternalServerErrorException
- Exception raised when an internal, configuration, or dependency error is encountered.ServiceUnavailableException
- Exception raised when a request fails due to temporary unavailability of the service.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.InvalidInputException
- Exception raised when the provided input violates a policy constraint or is entered in the wrong format
or data type.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeHomeRegionControlsIterable describeHomeRegionControlsPaginator(DescribeHomeRegionControlsRequest describeHomeRegionControlsRequest) throws InternalServerErrorException, ServiceUnavailableException, AccessDeniedException, ThrottlingException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubConfigException
This API permits filtering on the ControlId
and HomeRegion
fields.
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 Stream
software.amazon.awssdk.services.migrationhubconfig.paginators.DescribeHomeRegionControlsIterable responses = client.describeHomeRegionControlsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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.
describeHomeRegionControlsRequest
- InternalServerErrorException
- Exception raised when an internal, configuration, or dependency error is encountered.ServiceUnavailableException
- Exception raised when a request fails due to temporary unavailability of the service.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.InvalidInputException
- Exception raised when the provided input violates a policy constraint or is entered in the wrong format
or data type.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeHomeRegionControlsIterable describeHomeRegionControlsPaginator(Consumer<DescribeHomeRegionControlsRequest.Builder> describeHomeRegionControlsRequest) throws InternalServerErrorException, ServiceUnavailableException, AccessDeniedException, ThrottlingException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubConfigException
This API permits filtering on the ControlId
and HomeRegion
fields.
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 Stream
software.amazon.awssdk.services.migrationhubconfig.paginators.DescribeHomeRegionControlsIterable responses = client.describeHomeRegionControlsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.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 via DescribeHomeRegionControlsRequest.builder()
describeHomeRegionControlsRequest
- A Consumer
that will call methods on DescribeHomeRegionControlsRequest.Builder
to create a
request.InternalServerErrorException
- Exception raised when an internal, configuration, or dependency error is encountered.ServiceUnavailableException
- Exception raised when a request fails due to temporary unavailability of the service.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.InvalidInputException
- Exception raised when the provided input violates a policy constraint or is entered in the wrong format
or data type.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
getHomeRegionRequest
- InternalServerErrorException
- Exception raised when an internal, configuration, or dependency error is encountered.ServiceUnavailableException
- Exception raised when a request fails due to temporary unavailability of the service.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.InvalidInputException
- Exception raised when the provided input violates a policy constraint or is entered in the wrong format
or data type.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetHomeRegionRequest.builder()
getHomeRegionRequest
- A Consumer
that will call methods on GetHomeRegionRequest.Builder
to create a request.InternalServerErrorException
- Exception raised when an internal, configuration, or dependency error is encountered.ServiceUnavailableException
- Exception raised when a request fails due to temporary unavailability of the service.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.InvalidInputException
- Exception raised when the provided input violates a policy constraint or is entered in the wrong format
or data type.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()