com.amazonaws.services.migrationhubconfig

Class AWSMigrationHubConfigAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.migrationhubconfig.AWSMigrationHubConfigClient

com.amazonaws.services.migrationhubconfig.AWSMigrationHubConfigAsyncClient

All Implemented Interfaces:

AWSMigrationHubConfig, AWSMigrationHubConfigAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSMigrationHubConfigAsyncClient
extends AWSMigrationHubConfigClient
implements AWSMigrationHubConfigAsync

Client for accessing AWS Migration Hub Config asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

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

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.migrationhubconfig.AWSMigrationHubConfig

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSMigrationHubConfigAsyncClientBuilder	asyncBuilder()
Future<CreateHomeRegionControlResult>	createHomeRegionControlAsync(CreateHomeRegionControlRequest request) This API sets up the home region for the calling account only.
Future<CreateHomeRegionControlResult>	createHomeRegionControlAsync(CreateHomeRegionControlRequest request, AsyncHandler<CreateHomeRegionControlRequest,CreateHomeRegionControlResult> asyncHandler) This API sets up the home region for the calling account only.
Future<DeleteHomeRegionControlResult>	deleteHomeRegionControlAsync(DeleteHomeRegionControlRequest request) This operation deletes the home region configuration for the calling account.
Future<DeleteHomeRegionControlResult>	deleteHomeRegionControlAsync(DeleteHomeRegionControlRequest request, AsyncHandler<DeleteHomeRegionControlRequest,DeleteHomeRegionControlResult> asyncHandler) This operation deletes the home region configuration for the calling account.
Future<DescribeHomeRegionControlsResult>	describeHomeRegionControlsAsync(DescribeHomeRegionControlsRequest request) This API permits filtering on the ControlId and HomeRegion fields.
Future<DescribeHomeRegionControlsResult>	describeHomeRegionControlsAsync(DescribeHomeRegionControlsRequest request, AsyncHandler<DescribeHomeRegionControlsRequest,DescribeHomeRegionControlsResult> asyncHandler) This API permits filtering on the ControlId and HomeRegion fields.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetHomeRegionResult>	getHomeRegionAsync(GetHomeRegionRequest request) Returns the calling account’s home region, if configured.
Future<GetHomeRegionResult>	getHomeRegionAsync(GetHomeRegionRequest request, AsyncHandler<GetHomeRegionRequest,GetHomeRegionResult> asyncHandler) Returns the calling account’s home region, if configured.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.migrationhubconfig.AWSMigrationHubConfigClient

builder, createHomeRegionControl, deleteHomeRegionControl, describeHomeRegionControls, getCachedResponseMetadata, getHomeRegion

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.migrationhubconfig.AWSMigrationHubConfig

createHomeRegionControl, deleteHomeRegionControl, describeHomeRegionControls, getCachedResponseMetadata, getHomeRegion

Method Detail

asyncBuilder

public static AWSMigrationHubConfigAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

createHomeRegionControlAsync

public Future<CreateHomeRegionControlResult> createHomeRegionControlAsync(CreateHomeRegionControlRequest request)

Description copied from interface: AWSMigrationHubConfigAsync

This API sets up the home region for the calling account only.

Specified by:

createHomeRegionControlAsync in interface AWSMigrationHubConfigAsync

Returns:

A Java Future containing the result of the CreateHomeRegionControl operation returned by the service.

See Also:

AWS API Documentation

createHomeRegionControlAsync

public Future<CreateHomeRegionControlResult> createHomeRegionControlAsync(CreateHomeRegionControlRequest request,
                                                                          AsyncHandler<CreateHomeRegionControlRequest,CreateHomeRegionControlResult> asyncHandler)

Description copied from interface: AWSMigrationHubConfigAsync

This API sets up the home region for the calling account only.

Specified by:

createHomeRegionControlAsync in interface AWSMigrationHubConfigAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateHomeRegionControl operation returned by the service.

See Also:

AWS API Documentation

deleteHomeRegionControlAsync

public Future<DeleteHomeRegionControlResult> deleteHomeRegionControlAsync(DeleteHomeRegionControlRequest request)

Description copied from interface: AWSMigrationHubConfigAsync

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.

Specified by:

deleteHomeRegionControlAsync in interface AWSMigrationHubConfigAsync

Returns:

A Java Future containing the result of the DeleteHomeRegionControl operation returned by the service.

See Also:

AWS API Documentation

deleteHomeRegionControlAsync

public Future<DeleteHomeRegionControlResult> deleteHomeRegionControlAsync(DeleteHomeRegionControlRequest request,
                                                                          AsyncHandler<DeleteHomeRegionControlRequest,DeleteHomeRegionControlResult> asyncHandler)

Description copied from interface: AWSMigrationHubConfigAsync

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.

Specified by:

deleteHomeRegionControlAsync in interface AWSMigrationHubConfigAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteHomeRegionControl operation returned by the service.

See Also:

AWS API Documentation

describeHomeRegionControlsAsync

public Future<DescribeHomeRegionControlsResult> describeHomeRegionControlsAsync(DescribeHomeRegionControlsRequest request)

Description copied from interface: AWSMigrationHubConfigAsync

This API permits filtering on the ControlId and HomeRegion fields.

Specified by:

describeHomeRegionControlsAsync in interface AWSMigrationHubConfigAsync

Returns:

A Java Future containing the result of the DescribeHomeRegionControls operation returned by the service.

See Also:

AWS API Documentation

describeHomeRegionControlsAsync

public Future<DescribeHomeRegionControlsResult> describeHomeRegionControlsAsync(DescribeHomeRegionControlsRequest request,
                                                                                AsyncHandler<DescribeHomeRegionControlsRequest,DescribeHomeRegionControlsResult> asyncHandler)

Description copied from interface: AWSMigrationHubConfigAsync

This API permits filtering on the ControlId and HomeRegion fields.

Specified by:

describeHomeRegionControlsAsync in interface AWSMigrationHubConfigAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeHomeRegionControls operation returned by the service.

See Also:

AWS API Documentation

getHomeRegionAsync

public Future<GetHomeRegionResult> getHomeRegionAsync(GetHomeRegionRequest request)

Description copied from interface: AWSMigrationHubConfigAsync

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.

Specified by:

getHomeRegionAsync in interface AWSMigrationHubConfigAsync

Returns:

A Java Future containing the result of the GetHomeRegion operation returned by the service.

See Also:

AWS API Documentation

getHomeRegionAsync

public Future<GetHomeRegionResult> getHomeRegionAsync(GetHomeRegionRequest request,
                                                      AsyncHandler<GetHomeRegionRequest,GetHomeRegionResult> asyncHandler)

Description copied from interface: AWSMigrationHubConfigAsync

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.

Specified by:

getHomeRegionAsync in interface AWSMigrationHubConfigAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetHomeRegion operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSMigrationHubConfig

Overrides:

shutdown in class AWSMigrationHubConfigClient