com.amazonaws.services.migrationhubconfig

Class AWSMigrationHubConfigClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.migrationhubconfig.AWSMigrationHubConfigClient

All Implemented Interfaces:

AWSMigrationHubConfig

Direct Known Subclasses:

AWSMigrationHubConfigAsyncClient

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

Client for accessing AWS Migration Hub Config. All service calls made using this client are blocking, and will not return until the service call 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 AWSMigrationHubConfigClientBuilder	builder()
CreateHomeRegionControlResult	createHomeRegionControl(CreateHomeRegionControlRequest request) This API sets up the home region for the calling account only.
DeleteHomeRegionControlResult	deleteHomeRegionControl(DeleteHomeRegionControlRequest request) This operation deletes the home region configuration for the calling account.
DescribeHomeRegionControlsResult	describeHomeRegionControls(DescribeHomeRegionControlsRequest request) This API permits filtering on the ControlId and HomeRegion fields.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetHomeRegionResult	getHomeRegion(GetHomeRegionRequest request) Returns the calling account’s home region, if configured.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

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

Method Detail

builder

public static AWSMigrationHubConfigClientBuilder builder()

createHomeRegionControl

public CreateHomeRegionControlResult createHomeRegionControl(CreateHomeRegionControlRequest request)

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

Specified by:

createHomeRegionControl in interface AWSMigrationHubConfig

Parameters:

createHomeRegionControlRequest -

Returns:

Result of the CreateHomeRegionControl operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteHomeRegionControl

public DeleteHomeRegionControlResult deleteHomeRegionControl(DeleteHomeRegionControlRequest request)

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:

deleteHomeRegionControl in interface AWSMigrationHubConfig

Parameters:

deleteHomeRegionControlRequest -

Returns:

Result of the DeleteHomeRegionControl operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeHomeRegionControls

public DescribeHomeRegionControlsResult describeHomeRegionControls(DescribeHomeRegionControlsRequest request)

This API permits filtering on the ControlId and HomeRegion fields.

Specified by:

describeHomeRegionControls in interface AWSMigrationHubConfig

Parameters:

describeHomeRegionControlsRequest -

Returns:

Result of the DescribeHomeRegionControls operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getHomeRegion

public GetHomeRegionResult getHomeRegion(GetHomeRegionRequest request)

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:

getHomeRegion in interface AWSMigrationHubConfig

Parameters:

getHomeRegionRequest -

Returns:

Result of the GetHomeRegion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSMigrationHubConfig

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSMigrationHubConfig

Overrides:

shutdown in class AmazonWebServiceClient