com.amazonaws.services.migrationhubconfig

Interface AWSMigrationHubConfig

All Known Subinterfaces:

AWSMigrationHubConfigAsync

All Known Implementing Classes:

AbstractAWSMigrationHubConfig, AbstractAWSMigrationHubConfigAsync, AWSMigrationHubConfigAsyncClient, AWSMigrationHubConfigClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSMigrationHubConfig

Interface for accessing AWS Migration Hub Config.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSMigrationHubConfig instead.

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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateHomeRegionControlResult	createHomeRegionControl(CreateHomeRegionControlRequest createHomeRegionControlRequest) This API sets up the home region for the calling account only.
DeleteHomeRegionControlResult	deleteHomeRegionControl(DeleteHomeRegionControlRequest deleteHomeRegionControlRequest) This operation deletes the home region configuration for the calling account.
DescribeHomeRegionControlsResult	describeHomeRegionControls(DescribeHomeRegionControlsRequest describeHomeRegionControlsRequest) 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 getHomeRegionRequest) Returns the calling account’s home region, if configured.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createHomeRegionControl

CreateHomeRegionControlResult createHomeRegionControl(CreateHomeRegionControlRequest createHomeRegionControlRequest)

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

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

DeleteHomeRegionControlResult deleteHomeRegionControl(DeleteHomeRegionControlRequest deleteHomeRegionControlRequest)

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.

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

DescribeHomeRegionControlsResult describeHomeRegionControls(DescribeHomeRegionControlsRequest describeHomeRegionControlsRequest)

This API permits filtering on the ControlId and HomeRegion fields.

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

GetHomeRegionResult getHomeRegion(GetHomeRegionRequest getHomeRegionRequest)

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.

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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