@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSMigrationHub
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSMigrationHub
instead.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AssociateCreatedArtifactResult |
associateCreatedArtifact(AssociateCreatedArtifactRequest associateCreatedArtifactRequest)
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 associateDiscoveredResourceRequest)
Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.
|
CreateProgressUpdateStreamResult |
createProgressUpdateStream(CreateProgressUpdateStreamRequest createProgressUpdateStreamRequest)
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 deleteProgressUpdateStreamRequest)
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 describeApplicationStateRequest)
Gets the migration status of an application.
|
DescribeMigrationTaskResult |
describeMigrationTask(DescribeMigrationTaskRequest describeMigrationTaskRequest)
Retrieves a list of all attributes associated with a specific migration task.
|
DisassociateCreatedArtifactResult |
disassociateCreatedArtifact(DisassociateCreatedArtifactRequest disassociateCreatedArtifactRequest)
Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was
previously associated.
|
DisassociateDiscoveredResourceResult |
disassociateDiscoveredResource(DisassociateDiscoveredResourceRequest disassociateDiscoveredResourceRequest)
Disassociate an Application Discovery Service (ADS) 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 importMigrationTaskRequest)
Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration
tool.
|
ListCreatedArtifactsResult |
listCreatedArtifacts(ListCreatedArtifactsRequest listCreatedArtifactsRequest)
Lists the created artifacts attached to a given migration task in an update stream.
|
ListDiscoveredResourcesResult |
listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest)
Lists discovered resources associated with the given
MigrationTask . |
ListMigrationTasksResult |
listMigrationTasks(ListMigrationTasksRequest listMigrationTasksRequest)
Lists all, or filtered by resource name, migration tasks associated with the user account making this call.
|
ListProgressUpdateStreamsResult |
listProgressUpdateStreams(ListProgressUpdateStreamsRequest listProgressUpdateStreamsRequest)
Lists progress update streams associated with the user account making this call.
|
NotifyApplicationStateResult |
notifyApplicationState(NotifyApplicationStateRequest notifyApplicationStateRequest)
Sets the migration state of an application.
|
NotifyMigrationTaskStateResult |
notifyMigrationTaskState(NotifyMigrationTaskStateRequest notifyMigrationTaskStateRequest)
Notifies Migration Hub of the current status, progress, or other detail regarding a migration task.
|
PutResourceAttributesResult |
putResourceAttributes(PutResourceAttributesRequest putResourceAttributesRequest)
Provides identifying details of the resource being migrated so that it can be associated in the Application
Discovery Service (ADS)'s repository.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
static final String ENDPOINT_PREFIX
AssociateCreatedArtifactResult associateCreatedArtifact(AssociateCreatedArtifactRequest associateCreatedArtifactRequest)
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.
associateCreatedArtifactRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.AssociateDiscoveredResourceResult associateDiscoveredResource(AssociateDiscoveredResourceRequest associateDiscoveredResourceRequest)
Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.
associateDiscoveredResourceRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.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 ADS (Application Discovery Service); most likely due
to a misconfigured policy or the ADSCaller
role is missing or not configured correctly.ResourceNotFoundException
- Exception raised when the request references a resource (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.CreateProgressUpdateStreamResult createProgressUpdateStream(CreateProgressUpdateStreamRequest createProgressUpdateStreamRequest)
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.
createProgressUpdateStreamRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.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.DeleteProgressUpdateStreamResult deleteProgressUpdateStream(DeleteProgressUpdateStreamRequest deleteProgressUpdateStreamRequest)
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 be doing the actual delete of 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 realted 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).
deleteProgressUpdateStreamRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.DescribeApplicationStateResult describeApplicationState(DescribeApplicationStateRequest describeApplicationStateRequest)
Gets the migration status of an application.
describeApplicationStateRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.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 ADS (Application Discovery Service); most likely due
to a misconfigured policy or the ADSCaller
role is missing or not configured correctly.ResourceNotFoundException
- Exception raised when the request references a resource (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.DescribeMigrationTaskResult describeMigrationTask(DescribeMigrationTaskRequest describeMigrationTaskRequest)
Retrieves a list of all attributes associated with a specific migration task.
describeMigrationTaskRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.DisassociateCreatedArtifactResult disassociateCreatedArtifact(DisassociateCreatedArtifactRequest disassociateCreatedArtifactRequest)
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.
disassociateCreatedArtifactRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.DisassociateDiscoveredResourceResult disassociateDiscoveredResource(DisassociateDiscoveredResourceRequest disassociateDiscoveredResourceRequest)
Disassociate an Application Discovery Service (ADS) discovered resource from a migration task.
disassociateDiscoveredResourceRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.ImportMigrationTaskResult importMigrationTask(ImportMigrationTaskRequest importMigrationTaskRequest)
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.
importMigrationTaskRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.ListCreatedArtifactsResult listCreatedArtifacts(ListCreatedArtifactsRequest listCreatedArtifactsRequest)
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.
listCreatedArtifactsRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.ListDiscoveredResourcesResult listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest)
Lists discovered resources associated with the given MigrationTask
.
listDiscoveredResourcesRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.ListMigrationTasksResult listMigrationTasks(ListMigrationTasksRequest listMigrationTasksRequest)
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.
listMigrationTasksRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.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 ADS (Application Discovery Service); most likely due
to a misconfigured policy or the ADSCaller
role is missing or not configured correctly.ResourceNotFoundException
- Exception raised when the request references a resource (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.ListProgressUpdateStreamsResult listProgressUpdateStreams(ListProgressUpdateStreamsRequest listProgressUpdateStreamsRequest)
Lists progress update streams associated with the user account making this call.
listProgressUpdateStreamsRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.InvalidInputException
- Exception raised when the provided input violates a policy constraint or is entered in the wrong format
or data type.NotifyApplicationStateResult notifyApplicationState(NotifyApplicationStateRequest notifyApplicationStateRequest)
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
.
notifyApplicationStateRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.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 ADS (Application Discovery Service); most likely due
to a misconfigured policy or the ADSCaller
role is missing or not configured correctly.ResourceNotFoundException
- Exception raised when the request references a resource (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.NotifyMigrationTaskStateResult notifyMigrationTaskState(NotifyMigrationTaskStateRequest notifyMigrationTaskStateRequest)
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.
notifyMigrationTaskStateRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.PutResourceAttributesResult putResourceAttributes(PutResourceAttributesRequest putResourceAttributesRequest)
Provides identifying details of the resource being migrated so that it can be associated in the Application
Discovery Service (ADS)'s 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 overiding the MAC address.
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 ListAssociatedResource
.
putResourceAttributesRequest
- AccessDeniedException
- Exception raised when the account making the call is not whitelisted or there are other authentication
errors.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error encountered.ServiceUnavailableException
- Exception raised when the service encounters throttled communication with upstream dependencies or is
overloaded with requests.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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.