com.amazonaws.services.migrationhub

Class AWSMigrationHubClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.migrationhub.AWSMigrationHubClient

All Implemented Interfaces:

AWSMigrationHub

Direct Known Subclasses:

AWSMigrationHubAsyncClient

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

Client for accessing AWS Migration Hub. All service calls made using this client are blocking, and will not return until the service call completes.

The AWS Migration Hub API methods help to obtain server and application migration status and integrate your resource-specific migration tool by providing a programmatic interface to Migration Hub.

Remember that you must set your AWS Migration Hub home region before you call any of these APIs, or a HomeRegionNotSetException error will be returned. Also, you must make the API calls while in your home region.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.migrationhub.AWSMigrationHub

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateCreatedArtifactResult	associateCreatedArtifact(AssociateCreatedArtifactRequest request) Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool.
AssociateDiscoveredResourceResult	associateDiscoveredResource(AssociateDiscoveredResourceRequest request) Associates a discovered resource ID from Application Discovery Service with a migration task.
static AWSMigrationHubClientBuilder	builder()
CreateProgressUpdateStreamResult	createProgressUpdateStream(CreateProgressUpdateStreamRequest request) Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account.
DeleteProgressUpdateStreamResult	deleteProgressUpdateStream(DeleteProgressUpdateStreamRequest request) Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control.
DescribeApplicationStateResult	describeApplicationState(DescribeApplicationStateRequest request) Gets the migration status of an application.
DescribeMigrationTaskResult	describeMigrationTask(DescribeMigrationTaskRequest request) Retrieves a list of all attributes associated with a specific migration task.
DisassociateCreatedArtifactResult	disassociateCreatedArtifact(DisassociateCreatedArtifactRequest request) Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated.
DisassociateDiscoveredResourceResult	disassociateDiscoveredResource(DisassociateDiscoveredResourceRequest request) Disassociate an Application Discovery Service discovered resource from a migration task.
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.
ImportMigrationTaskResult	importMigrationTask(ImportMigrationTaskRequest request) Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.
ListApplicationStatesResult	listApplicationStates(ListApplicationStatesRequest request) Lists all the migration statuses for your applications.
ListCreatedArtifactsResult	listCreatedArtifacts(ListCreatedArtifactsRequest request) Lists the created artifacts attached to a given migration task in an update stream.
ListDiscoveredResourcesResult	listDiscoveredResources(ListDiscoveredResourcesRequest request) Lists discovered resources associated with the given MigrationTask.
ListMigrationTasksResult	listMigrationTasks(ListMigrationTasksRequest request) Lists all, or filtered by resource name, migration tasks associated with the user account making this call.
ListProgressUpdateStreamsResult	listProgressUpdateStreams(ListProgressUpdateStreamsRequest request) Lists progress update streams associated with the user account making this call.
NotifyApplicationStateResult	notifyApplicationState(NotifyApplicationStateRequest request) Sets the migration state of an application.
NotifyMigrationTaskStateResult	notifyMigrationTaskState(NotifyMigrationTaskStateRequest request) Notifies Migration Hub of the current status, progress, or other detail regarding a migration task.
PutResourceAttributesResult	putResourceAttributes(PutResourceAttributesRequest request) Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository.
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 AWSMigrationHubClientBuilder builder()

associateCreatedArtifact

public AssociateCreatedArtifactResult associateCreatedArtifact(AssociateCreatedArtifactRequest request)

Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits:

• Migration tools can call the AssociateCreatedArtifact operation to indicate which AWS artifact is associated with a migration task.

• The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b.

• Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, etc.

Specified by:

associateCreatedArtifact in interface AWSMigrationHub

Parameters:

associateCreatedArtifactRequest -

Returns:

Result of the AssociateCreatedArtifact operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperationException - Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperationException - Exception raised to indicate a request was not authorized 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.

ResourceNotFoundException - Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

associateDiscoveredResource

public AssociateDiscoveredResourceResult associateDiscoveredResource(AssociateDiscoveredResourceRequest request)

Associates a discovered resource ID from Application Discovery Service with a migration task.

Specified by:

associateDiscoveredResource in interface AWSMigrationHub

Parameters:

associateDiscoveredResourceRequest -

Returns:

Result of the AssociateDiscoveredResource operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperationException - Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperationException - Exception raised to indicate a request was not authorized 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.

PolicyErrorException - Exception raised when there are problems accessing Application Discovery Service (Application Discovery Service); most likely due to a misconfigured policy or the migrationhub-discovery role is missing or not configured correctly.

ResourceNotFoundException - Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

createProgressUpdateStream

public CreateProgressUpdateStreamResult createProgressUpdateStream(CreateProgressUpdateStreamRequest request)

Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account. It must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.

Specified by:

createProgressUpdateStream in interface AWSMigrationHub

Parameters:

createProgressUpdateStreamRequest -

Returns:

Result of the CreateProgressUpdateStream operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperationException - Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperationException - Exception raised to indicate a request was not authorized 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.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

deleteProgressUpdateStream

public DeleteProgressUpdateStreamResult deleteProgressUpdateStream(DeleteProgressUpdateStreamRequest request)

Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits:

• The only parameter needed for DeleteProgressUpdateStream is the stream name (same as a CreateProgressUpdateStream call).

• The call will return, and a background process will asynchronously delete the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts).

• If the stream takes time to be deleted, it might still show up on a ListProgressUpdateStreams call.

• CreateProgressUpdateStream, ImportMigrationTask, NotifyMigrationTaskState, and all Associate[*] APIs related to the tasks belonging to the stream will throw "InvalidInputException" if the stream of the same name is in the process of being deleted.

• Once the stream and all of its resources are deleted, CreateProgressUpdateStream for a stream of the same name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream).

Specified by:

deleteProgressUpdateStream in interface AWSMigrationHub

Parameters:

deleteProgressUpdateStreamRequest -

Returns:

Result of the DeleteProgressUpdateStream operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperationException - Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperationException - Exception raised to indicate a request was not authorized 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.

ResourceNotFoundException - Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

describeApplicationState

public DescribeApplicationStateResult describeApplicationState(DescribeApplicationStateRequest request)

Gets the migration status of an application.

Specified by:

describeApplicationState in interface AWSMigrationHub

Parameters:

describeApplicationStateRequest -

Returns:

Result of the DescribeApplicationState operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException - Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

PolicyErrorException - Exception raised when there are problems accessing Application Discovery Service (Application Discovery Service); most likely due to a misconfigured policy or the migrationhub-discovery role is missing or not configured correctly.

ResourceNotFoundException - Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

describeMigrationTask

public DescribeMigrationTaskResult describeMigrationTask(DescribeMigrationTaskRequest request)

Retrieves a list of all attributes associated with a specific migration task.

Specified by:

describeMigrationTask in interface AWSMigrationHub

Parameters:

describeMigrationTaskRequest -

Returns:

Result of the DescribeMigrationTask operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException - Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException - Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

disassociateCreatedArtifact

public DisassociateCreatedArtifactResult disassociateCreatedArtifact(DisassociateCreatedArtifactRequest request)

Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated. This API has the following traits:

• A migration user can call the DisassociateCreatedArtifacts operation to disassociate a created AWS Artifact from a migration task.

• The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b.

• Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or RDS instance, etc.

Specified by:

disassociateCreatedArtifact in interface AWSMigrationHub

Parameters:

disassociateCreatedArtifactRequest -

Returns:

Result of the DisassociateCreatedArtifact operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperationException - Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperationException - Exception raised to indicate a request was not authorized 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.

ResourceNotFoundException - Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

disassociateDiscoveredResource

public DisassociateDiscoveredResourceResult disassociateDiscoveredResource(DisassociateDiscoveredResourceRequest request)

Disassociate an Application Discovery Service discovered resource from a migration task.

Specified by:

disassociateDiscoveredResource in interface AWSMigrationHub

Parameters:

disassociateDiscoveredResourceRequest -

Returns:

Result of the DisassociateDiscoveredResource operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperationException - Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperationException - Exception raised to indicate a request was not authorized 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.

ResourceNotFoundException - Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

importMigrationTask

public ImportMigrationTaskResult importMigrationTask(ImportMigrationTaskRequest request)

Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.

This API is a prerequisite to calling the NotifyMigrationTaskState API as the migration tool must first register the migration task with Migration Hub.

Specified by:

importMigrationTask in interface AWSMigrationHub

Parameters:

importMigrationTaskRequest -

Returns:

Result of the ImportMigrationTask operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperationException - Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperationException - Exception raised to indicate a request was not authorized 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.

ResourceNotFoundException - Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

listApplicationStates

public ListApplicationStatesResult listApplicationStates(ListApplicationStatesRequest request)

Lists all the migration statuses for your applications. If you use the optional ApplicationIds parameter, only the migration statuses for those applications will be returned.

Specified by:

listApplicationStates in interface AWSMigrationHub

Parameters:

listApplicationStatesRequest -

Returns:

Result of the ListApplicationStates operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException - Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

listCreatedArtifacts

public ListCreatedArtifactsResult listCreatedArtifacts(ListCreatedArtifactsRequest request)

Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits:

• Gets the list of the created artifacts while migration is taking place.

• Shows the artifacts created by the migration tool that was associated by the AssociateCreatedArtifact API.

• Lists created artifacts in a paginated interface.

Specified by:

listCreatedArtifacts in interface AWSMigrationHub

Parameters:

listCreatedArtifactsRequest -

Returns:

Result of the ListCreatedArtifacts operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException - Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException - Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

listDiscoveredResources

public ListDiscoveredResourcesResult listDiscoveredResources(ListDiscoveredResourcesRequest request)

Lists discovered resources associated with the given MigrationTask.

Specified by:

listDiscoveredResources in interface AWSMigrationHub

Parameters:

listDiscoveredResourcesRequest -

Returns:

Result of the ListDiscoveredResources operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException - Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException - Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

listMigrationTasks

public ListMigrationTasksResult listMigrationTasks(ListMigrationTasksRequest request)

Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits:

• Can show a summary list of the most recent migration tasks.

• Can show a summary list of migration tasks associated with a given discovered resource.

• Lists migration tasks in a paginated interface.

Specified by:

listMigrationTasks in interface AWSMigrationHub

Parameters:

listMigrationTasksRequest -

Returns:

Result of the ListMigrationTasks operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException - Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

PolicyErrorException - Exception raised when there are problems accessing Application Discovery Service (Application Discovery Service); most likely due to a misconfigured policy or the migrationhub-discovery role is missing or not configured correctly.

ResourceNotFoundException - Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

listProgressUpdateStreams

public ListProgressUpdateStreamsResult listProgressUpdateStreams(ListProgressUpdateStreamsRequest request)

Lists progress update streams associated with the user account making this call.

Specified by:

listProgressUpdateStreams in interface AWSMigrationHub

Parameters:

listProgressUpdateStreamsRequest -

Returns:

Result of the ListProgressUpdateStreams operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

InvalidInputException - Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

notifyApplicationState

public NotifyApplicationStateResult notifyApplicationState(NotifyApplicationStateRequest request)

Sets the migration state of an application. For a given application identified by the value passed to ApplicationId, its status is set or updated by passing one of three values to Status: NOT_STARTED | IN_PROGRESS | COMPLETED.

Specified by:

notifyApplicationState in interface AWSMigrationHub

Parameters:

notifyApplicationStateRequest -

Returns:

Result of the NotifyApplicationState operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperationException - Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperationException - Exception raised to indicate a request was not authorized 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.

PolicyErrorException - Exception raised when there are problems accessing Application Discovery Service (Application Discovery Service); most likely due to a misconfigured policy or the migrationhub-discovery role is missing or not configured correctly.

ResourceNotFoundException - Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

notifyMigrationTaskState

public NotifyMigrationTaskStateResult notifyMigrationTaskState(NotifyMigrationTaskStateRequest request)

Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:

• Migration tools will call the NotifyMigrationTaskState API to share the latest progress and status.

• MigrationTaskName is used for addressing updates to the correct target.

• ProgressUpdateStream is used for access control and to provide a namespace for each migration tool.

Specified by:

notifyMigrationTaskState in interface AWSMigrationHub

Parameters:

notifyMigrationTaskStateRequest -

Returns:

Result of the NotifyMigrationTaskState operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperationException - Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperationException - Exception raised to indicate a request was not authorized 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.

ResourceNotFoundException - Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

See Also:

AWS API Documentation

putResourceAttributes

public PutResourceAttributesResult putResourceAttributes(PutResourceAttributesRequest request)

Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository. This association occurs asynchronously after PutResourceAttributes returns.

• Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to add an IP address, it will then be required to call it with both the IP and MAC addresses to prevent overriding the MAC address.

• Note the instructions regarding the special use case of the ResourceAttributeList parameter when specifying any "VM" related value.

Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call ListDiscoveredResources.

Specified by:

putResourceAttributes in interface AWSMigrationHub

Parameters:

putResourceAttributesRequest -

Returns:

Result of the PutResourceAttributes operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

InternalServerErrorException - Exception raised when an internal, configuration, or dependency error is encountered.

ServiceUnavailableException - Exception raised when there is an internal, configuration, or dependency error encountered.

DryRunOperationException - Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".

UnauthorizedOperationException - Exception raised to indicate a request was not authorized 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.

ResourceNotFoundException - Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

HomeRegionNotSetException - The home region is not set. Set the home region to continue.

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 AWSMigrationHub

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 AWSMigrationHub

Overrides:

shutdown in class AmazonWebServiceClient