@Generated(value="software.amazon.awssdk:codegen") public interface MigrationHubClient extends SdkClient
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AssociateCreatedArtifactResponse |
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.
|
default AssociateCreatedArtifactResponse |
associateCreatedArtifact(Consumer<AssociateCreatedArtifactRequest.Builder> associateCreatedArtifactRequest)
Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration
task performed by a migration tool.
|
default AssociateDiscoveredResourceResponse |
associateDiscoveredResource(AssociateDiscoveredResourceRequest associateDiscoveredResourceRequest)
Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.
|
default AssociateDiscoveredResourceResponse |
associateDiscoveredResource(Consumer<AssociateDiscoveredResourceRequest.Builder> associateDiscoveredResourceRequest)
Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.
|
static MigrationHubClientBuilder |
builder()
Create a builder that can be used to configure and create a
MigrationHubClient . |
static MigrationHubClient |
create()
Create a
MigrationHubClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateProgressUpdateStreamResponse |
createProgressUpdateStream(Consumer<CreateProgressUpdateStreamRequest.Builder> 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.
|
default CreateProgressUpdateStreamResponse |
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.
|
default DeleteProgressUpdateStreamResponse |
deleteProgressUpdateStream(Consumer<DeleteProgressUpdateStreamRequest.Builder> deleteProgressUpdateStreamRequest)
Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource
used for access control.
|
default DeleteProgressUpdateStreamResponse |
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.
|
default DescribeApplicationStateResponse |
describeApplicationState(Consumer<DescribeApplicationStateRequest.Builder> describeApplicationStateRequest)
Gets the migration status of an application.
|
default DescribeApplicationStateResponse |
describeApplicationState(DescribeApplicationStateRequest describeApplicationStateRequest)
Gets the migration status of an application.
|
default DescribeMigrationTaskResponse |
describeMigrationTask(Consumer<DescribeMigrationTaskRequest.Builder> describeMigrationTaskRequest)
Retrieves a list of all attributes associated with a specific migration task.
|
default DescribeMigrationTaskResponse |
describeMigrationTask(DescribeMigrationTaskRequest describeMigrationTaskRequest)
Retrieves a list of all attributes associated with a specific migration task.
|
default DisassociateCreatedArtifactResponse |
disassociateCreatedArtifact(Consumer<DisassociateCreatedArtifactRequest.Builder> disassociateCreatedArtifactRequest)
Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was
previously associated.
|
default DisassociateCreatedArtifactResponse |
disassociateCreatedArtifact(DisassociateCreatedArtifactRequest disassociateCreatedArtifactRequest)
Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was
previously associated.
|
default DisassociateDiscoveredResourceResponse |
disassociateDiscoveredResource(Consumer<DisassociateDiscoveredResourceRequest.Builder> disassociateDiscoveredResourceRequest)
Disassociate an Application Discovery Service (ADS) discovered resource from a migration task.
|
default DisassociateDiscoveredResourceResponse |
disassociateDiscoveredResource(DisassociateDiscoveredResourceRequest disassociateDiscoveredResourceRequest)
Disassociate an Application Discovery Service (ADS) discovered resource from a migration task.
|
default ImportMigrationTaskResponse |
importMigrationTask(Consumer<ImportMigrationTaskRequest.Builder> importMigrationTaskRequest)
Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration
tool.
|
default ImportMigrationTaskResponse |
importMigrationTask(ImportMigrationTaskRequest importMigrationTaskRequest)
Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration
tool.
|
default ListCreatedArtifactsResponse |
listCreatedArtifacts(Consumer<ListCreatedArtifactsRequest.Builder> listCreatedArtifactsRequest)
Lists the created artifacts attached to a given migration task in an update stream.
|
default ListCreatedArtifactsResponse |
listCreatedArtifacts(ListCreatedArtifactsRequest listCreatedArtifactsRequest)
Lists the created artifacts attached to a given migration task in an update stream.
|
default ListDiscoveredResourcesResponse |
listDiscoveredResources(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest)
Lists discovered resources associated with the given
MigrationTask . |
default ListDiscoveredResourcesResponse |
listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest)
Lists discovered resources associated with the given
MigrationTask . |
default ListMigrationTasksResponse |
listMigrationTasks(Consumer<ListMigrationTasksRequest.Builder> listMigrationTasksRequest)
Lists all, or filtered by resource name, migration tasks associated with the user account making this call.
|
default ListMigrationTasksResponse |
listMigrationTasks(ListMigrationTasksRequest listMigrationTasksRequest)
Lists all, or filtered by resource name, migration tasks associated with the user account making this call.
|
default ListProgressUpdateStreamsResponse |
listProgressUpdateStreams(Consumer<ListProgressUpdateStreamsRequest.Builder> listProgressUpdateStreamsRequest)
Lists progress update streams associated with the user account making this call.
|
default ListProgressUpdateStreamsResponse |
listProgressUpdateStreams(ListProgressUpdateStreamsRequest listProgressUpdateStreamsRequest)
Lists progress update streams associated with the user account making this call.
|
default NotifyApplicationStateResponse |
notifyApplicationState(Consumer<NotifyApplicationStateRequest.Builder> notifyApplicationStateRequest)
Sets the migration state of an application.
|
default NotifyApplicationStateResponse |
notifyApplicationState(NotifyApplicationStateRequest notifyApplicationStateRequest)
Sets the migration state of an application.
|
default NotifyMigrationTaskStateResponse |
notifyMigrationTaskState(Consumer<NotifyMigrationTaskStateRequest.Builder> notifyMigrationTaskStateRequest)
Notifies Migration Hub of the current status, progress, or other detail regarding a migration task.
|
default NotifyMigrationTaskStateResponse |
notifyMigrationTaskState(NotifyMigrationTaskStateRequest notifyMigrationTaskStateRequest)
Notifies Migration Hub of the current status, progress, or other detail regarding a migration task.
|
default PutResourceAttributesResponse |
putResourceAttributes(Consumer<PutResourceAttributesRequest.Builder> putResourceAttributesRequest)
Provides identifying details of the resource being migrated so that it can be associated in the Application
Discovery Service (ADS)'s repository.
|
default PutResourceAttributesResponse |
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.
|
static ServiceMetadata |
serviceMetadata() |
serviceName
close
static final String SERVICE_NAME
static MigrationHubClient create()
MigrationHubClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static MigrationHubClientBuilder builder()
MigrationHubClient
.default AssociateCreatedArtifactResponse associateCreatedArtifact(AssociateCreatedArtifactRequest associateCreatedArtifactRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateCreatedArtifactResponse associateCreatedArtifact(Consumer<AssociateCreatedArtifactRequest.Builder> associateCreatedArtifactRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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.
This is a convenience which creates an instance of the AssociateCreatedArtifactRequest.Builder
avoiding
the need to create one manually via AssociateCreatedArtifactRequest.builder()
associateCreatedArtifactRequest
- A Consumer
that will call methods on AssociateCreatedArtifactRequest.Builder
to create a
request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateDiscoveredResourceResponse associateDiscoveredResource(AssociateDiscoveredResourceRequest associateDiscoveredResourceRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, PolicyErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.
associateDiscoveredResourceRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 ADS (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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AssociateDiscoveredResourceResponse associateDiscoveredResource(Consumer<AssociateDiscoveredResourceRequest.Builder> associateDiscoveredResourceRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, PolicyErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.
This is a convenience which creates an instance of the AssociateDiscoveredResourceRequest.Builder
avoiding the need to create one manually via AssociateDiscoveredResourceRequest.builder()
associateDiscoveredResourceRequest
- A Consumer
that will call methods on AssociateDiscoveredResourceRequest.Builder
to create
a request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 ADS (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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateProgressUpdateStreamResponse createProgressUpdateStream(CreateProgressUpdateStreamRequest createProgressUpdateStreamRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubException
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
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateProgressUpdateStreamResponse createProgressUpdateStream(Consumer<CreateProgressUpdateStreamRequest.Builder> createProgressUpdateStreamRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubException
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.
This is a convenience which creates an instance of the CreateProgressUpdateStreamRequest.Builder
avoiding
the need to create one manually via CreateProgressUpdateStreamRequest.builder()
createProgressUpdateStreamRequest
- A Consumer
that will call methods on CreateProgressUpdateStreamRequest.Builder
to create a
request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteProgressUpdateStreamResponse deleteProgressUpdateStream(DeleteProgressUpdateStreamRequest deleteProgressUpdateStreamRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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 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
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteProgressUpdateStreamResponse deleteProgressUpdateStream(Consumer<DeleteProgressUpdateStreamRequest.Builder> deleteProgressUpdateStreamRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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 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).
This is a convenience which creates an instance of the DeleteProgressUpdateStreamRequest.Builder
avoiding
the need to create one manually via DeleteProgressUpdateStreamRequest.builder()
deleteProgressUpdateStreamRequest
- A Consumer
that will call methods on DeleteProgressUpdateStreamRequest.Builder
to create a
request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeApplicationStateResponse describeApplicationState(DescribeApplicationStateRequest describeApplicationStateRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, InvalidInputException, PolicyErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
Gets the migration status of an application.
describeApplicationStateRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 ADS (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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeApplicationStateResponse describeApplicationState(Consumer<DescribeApplicationStateRequest.Builder> describeApplicationStateRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, InvalidInputException, PolicyErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
Gets the migration status of an application.
This is a convenience which creates an instance of the DescribeApplicationStateRequest.Builder
avoiding
the need to create one manually via DescribeApplicationStateRequest.builder()
describeApplicationStateRequest
- A Consumer
that will call methods on DescribeApplicationStateRequest.Builder
to create a
request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 ADS (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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeMigrationTaskResponse describeMigrationTask(DescribeMigrationTaskRequest describeMigrationTaskRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
Retrieves a list of all attributes associated with a specific migration task.
describeMigrationTaskRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeMigrationTaskResponse describeMigrationTask(Consumer<DescribeMigrationTaskRequest.Builder> describeMigrationTaskRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
Retrieves a list of all attributes associated with a specific migration task.
This is a convenience which creates an instance of the DescribeMigrationTaskRequest.Builder
avoiding the
need to create one manually via DescribeMigrationTaskRequest.builder()
describeMigrationTaskRequest
- A Consumer
that will call methods on DescribeMigrationTaskRequest.Builder
to create a
request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateCreatedArtifactResponse disassociateCreatedArtifact(DisassociateCreatedArtifactRequest disassociateCreatedArtifactRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateCreatedArtifactResponse disassociateCreatedArtifact(Consumer<DisassociateCreatedArtifactRequest.Builder> disassociateCreatedArtifactRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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.
This is a convenience which creates an instance of the DisassociateCreatedArtifactRequest.Builder
avoiding the need to create one manually via DisassociateCreatedArtifactRequest.builder()
disassociateCreatedArtifactRequest
- A Consumer
that will call methods on DisassociateCreatedArtifactRequest.Builder
to create
a request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateDiscoveredResourceResponse disassociateDiscoveredResource(DisassociateDiscoveredResourceRequest disassociateDiscoveredResourceRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
Disassociate an Application Discovery Service (ADS) discovered resource from a migration task.
disassociateDiscoveredResourceRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisassociateDiscoveredResourceResponse disassociateDiscoveredResource(Consumer<DisassociateDiscoveredResourceRequest.Builder> disassociateDiscoveredResourceRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
Disassociate an Application Discovery Service (ADS) discovered resource from a migration task.
This is a convenience which creates an instance of the DisassociateDiscoveredResourceRequest.Builder
avoiding the need to create one manually via DisassociateDiscoveredResourceRequest.builder()
disassociateDiscoveredResourceRequest
- A Consumer
that will call methods on DisassociateDiscoveredResourceRequest.Builder
to
create a request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ImportMigrationTaskResponse importMigrationTask(ImportMigrationTaskRequest importMigrationTaskRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ImportMigrationTaskResponse importMigrationTask(Consumer<ImportMigrationTaskRequest.Builder> importMigrationTaskRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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.
This is a convenience which creates an instance of the ImportMigrationTaskRequest.Builder
avoiding the
need to create one manually via ImportMigrationTaskRequest.builder()
importMigrationTaskRequest
- A Consumer
that will call methods on ImportMigrationTaskRequest.Builder
to create a
request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListCreatedArtifactsResponse listCreatedArtifacts(ListCreatedArtifactsRequest listCreatedArtifactsRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListCreatedArtifactsResponse listCreatedArtifacts(Consumer<ListCreatedArtifactsRequest.Builder> listCreatedArtifactsRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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.
This is a convenience which creates an instance of the ListCreatedArtifactsRequest.Builder
avoiding the
need to create one manually via ListCreatedArtifactsRequest.builder()
listCreatedArtifactsRequest
- A Consumer
that will call methods on ListCreatedArtifactsRequest.Builder
to create a
request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDiscoveredResourcesResponse listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
Lists discovered resources associated with the given MigrationTask
.
listDiscoveredResourcesRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDiscoveredResourcesResponse listDiscoveredResources(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
Lists discovered resources associated with the given MigrationTask
.
This is a convenience which creates an instance of the ListDiscoveredResourcesRequest.Builder
avoiding
the need to create one manually via ListDiscoveredResourcesRequest.builder()
listDiscoveredResourcesRequest
- A Consumer
that will call methods on ListDiscoveredResourcesRequest.Builder
to create a
request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMigrationTasksResponse listMigrationTasks(ListMigrationTasksRequest listMigrationTasksRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, InvalidInputException, PolicyErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 ADS (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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListMigrationTasksResponse listMigrationTasks(Consumer<ListMigrationTasksRequest.Builder> listMigrationTasksRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, InvalidInputException, PolicyErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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.
This is a convenience which creates an instance of the ListMigrationTasksRequest.Builder
avoiding the
need to create one manually via ListMigrationTasksRequest.builder()
listMigrationTasksRequest
- A Consumer
that will call methods on ListMigrationTasksRequest.Builder
to create a
request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 ADS (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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListProgressUpdateStreamsResponse listProgressUpdateStreams(ListProgressUpdateStreamsRequest listProgressUpdateStreamsRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubException
Lists progress update streams associated with the user account making this call.
listProgressUpdateStreamsRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListProgressUpdateStreamsResponse listProgressUpdateStreams(Consumer<ListProgressUpdateStreamsRequest.Builder> listProgressUpdateStreamsRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, InvalidInputException, AwsServiceException, SdkClientException, MigrationHubException
Lists progress update streams associated with the user account making this call.
This is a convenience which creates an instance of the ListProgressUpdateStreamsRequest.Builder
avoiding
the need to create one manually via ListProgressUpdateStreamsRequest.builder()
listProgressUpdateStreamsRequest
- A Consumer
that will call methods on ListProgressUpdateStreamsRequest.Builder
to create a
request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default NotifyApplicationStateResponse notifyApplicationState(NotifyApplicationStateRequest notifyApplicationStateRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, PolicyErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 ADS (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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default NotifyApplicationStateResponse notifyApplicationState(Consumer<NotifyApplicationStateRequest.Builder> notifyApplicationStateRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, PolicyErrorException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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
.
This is a convenience which creates an instance of the NotifyApplicationStateRequest.Builder
avoiding the
need to create one manually via NotifyApplicationStateRequest.builder()
notifyApplicationStateRequest
- A Consumer
that will call methods on NotifyApplicationStateRequest.Builder
to create a
request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 ADS (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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default NotifyMigrationTaskStateResponse notifyMigrationTaskState(NotifyMigrationTaskStateRequest notifyMigrationTaskStateRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default NotifyMigrationTaskStateResponse notifyMigrationTaskState(Consumer<NotifyMigrationTaskStateRequest.Builder> notifyMigrationTaskStateRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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.
This is a convenience which creates an instance of the NotifyMigrationTaskStateRequest.Builder
avoiding
the need to create one manually via NotifyMigrationTaskStateRequest.builder()
notifyMigrationTaskStateRequest
- A Consumer
that will call methods on NotifyMigrationTaskStateRequest.Builder
to create a
request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutResourceAttributesResponse putResourceAttributes(PutResourceAttributesRequest putResourceAttributesRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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.
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
.
putResourceAttributesRequest
- AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutResourceAttributesResponse putResourceAttributes(Consumer<PutResourceAttributesRequest.Builder> putResourceAttributesRequest) throws AccessDeniedException, InternalServerErrorException, ServiceUnavailableException, DryRunOperationException, UnauthorizedOperationException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, MigrationHubException
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.
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
.
This is a convenience which creates an instance of the PutResourceAttributesRequest.Builder
avoiding the
need to create one manually via PutResourceAttributesRequest.builder()
putResourceAttributesRequest
- A Consumer
that will call methods on PutResourceAttributesRequest.Builder
to create a
request.AccessDeniedException
- You do not have sufficient access to perform this action.InternalServerErrorException
- Exception raised when there is an internal, configuration, or dependency error 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 (ADS configuration, update stream, migration
task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MigrationHubException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.