Interface MigrationHubAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
The AWS Migration Hub API methods help to obtain server and application migration status and integrate your resource-specific migration tool by providing a programmatic interface to Migration Hub.
Remember that you must set your AWS Migration Hub home region before you call any of these APIs, or a
HomeRegionNotSetException
error will be returned. Also, you must make the API calls while in your home
region.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateCreatedArtifact
(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.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.associateDiscoveredResource
(Consumer<AssociateDiscoveredResourceRequest.Builder> associateDiscoveredResourceRequest) Associates a discovered resource ID from Application Discovery Service with a migration task.associateDiscoveredResource
(AssociateDiscoveredResourceRequest associateDiscoveredResourceRequest) Associates a discovered resource ID from Application Discovery Service with a migration task.builder()
Create a builder that can be used to configure and create aMigrationHubAsyncClient
.static MigrationHubAsyncClient
create()
Create aMigrationHubAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.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.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.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.describeApplicationState
(Consumer<DescribeApplicationStateRequest.Builder> describeApplicationStateRequest) Gets the migration status of an application.describeApplicationState
(DescribeApplicationStateRequest describeApplicationStateRequest) Gets the migration status of an application.describeMigrationTask
(Consumer<DescribeMigrationTaskRequest.Builder> describeMigrationTaskRequest) Retrieves a list of all attributes associated with a specific migration task.describeMigrationTask
(DescribeMigrationTaskRequest describeMigrationTaskRequest) Retrieves a list of all attributes associated with a specific migration task.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.disassociateCreatedArtifact
(DisassociateCreatedArtifactRequest disassociateCreatedArtifactRequest) Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated.disassociateDiscoveredResource
(Consumer<DisassociateDiscoveredResourceRequest.Builder> disassociateDiscoveredResourceRequest) Disassociate an Application Discovery Service discovered resource from a migration task.disassociateDiscoveredResource
(DisassociateDiscoveredResourceRequest disassociateDiscoveredResourceRequest) Disassociate an Application Discovery Service discovered resource from a migration task.importMigrationTask
(Consumer<ImportMigrationTaskRequest.Builder> importMigrationTaskRequest) Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.importMigrationTask
(ImportMigrationTaskRequest importMigrationTaskRequest) Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.listApplicationStates
(Consumer<ListApplicationStatesRequest.Builder> listApplicationStatesRequest) Lists all the migration statuses for your applications.listApplicationStates
(ListApplicationStatesRequest listApplicationStatesRequest) Lists all the migration statuses for your applications.default ListApplicationStatesPublisher
listApplicationStatesPaginator
(Consumer<ListApplicationStatesRequest.Builder> listApplicationStatesRequest) This is a variant oflistApplicationStates(software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesRequest)
operation.default ListApplicationStatesPublisher
listApplicationStatesPaginator
(ListApplicationStatesRequest listApplicationStatesRequest) This is a variant oflistApplicationStates(software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesRequest)
operation.listCreatedArtifacts
(Consumer<ListCreatedArtifactsRequest.Builder> listCreatedArtifactsRequest) Lists the created artifacts attached to a given migration task in an update stream.listCreatedArtifacts
(ListCreatedArtifactsRequest listCreatedArtifactsRequest) Lists the created artifacts attached to a given migration task in an update stream.default ListCreatedArtifactsPublisher
listCreatedArtifactsPaginator
(Consumer<ListCreatedArtifactsRequest.Builder> listCreatedArtifactsRequest) This is a variant oflistCreatedArtifacts(software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsRequest)
operation.default ListCreatedArtifactsPublisher
listCreatedArtifactsPaginator
(ListCreatedArtifactsRequest listCreatedArtifactsRequest) This is a variant oflistCreatedArtifacts(software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsRequest)
operation.listDiscoveredResources
(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest) Lists discovered resources associated with the givenMigrationTask
.listDiscoveredResources
(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest) Lists discovered resources associated with the givenMigrationTask
.default ListDiscoveredResourcesPublisher
listDiscoveredResourcesPaginator
(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest) This is a variant oflistDiscoveredResources(software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesRequest)
operation.default ListDiscoveredResourcesPublisher
listDiscoveredResourcesPaginator
(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest) This is a variant oflistDiscoveredResources(software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesRequest)
operation.listMigrationTasks
(Consumer<ListMigrationTasksRequest.Builder> listMigrationTasksRequest) Lists all, or filtered by resource name, migration tasks associated with the user account making this call.listMigrationTasks
(ListMigrationTasksRequest listMigrationTasksRequest) Lists all, or filtered by resource name, migration tasks associated with the user account making this call.default ListMigrationTasksPublisher
listMigrationTasksPaginator
(Consumer<ListMigrationTasksRequest.Builder> listMigrationTasksRequest) This is a variant oflistMigrationTasks(software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksRequest)
operation.default ListMigrationTasksPublisher
listMigrationTasksPaginator
(ListMigrationTasksRequest listMigrationTasksRequest) This is a variant oflistMigrationTasks(software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksRequest)
operation.listProgressUpdateStreams
(Consumer<ListProgressUpdateStreamsRequest.Builder> listProgressUpdateStreamsRequest) Lists progress update streams associated with the user account making this call.listProgressUpdateStreams
(ListProgressUpdateStreamsRequest listProgressUpdateStreamsRequest) Lists progress update streams associated with the user account making this call.listProgressUpdateStreamsPaginator
(Consumer<ListProgressUpdateStreamsRequest.Builder> listProgressUpdateStreamsRequest) This is a variant oflistProgressUpdateStreams(software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsRequest)
operation.listProgressUpdateStreamsPaginator
(ListProgressUpdateStreamsRequest listProgressUpdateStreamsRequest) This is a variant oflistProgressUpdateStreams(software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsRequest)
operation.notifyApplicationState
(Consumer<NotifyApplicationStateRequest.Builder> notifyApplicationStateRequest) Sets the migration state of an application.notifyApplicationState
(NotifyApplicationStateRequest notifyApplicationStateRequest) Sets the migration state of an application.notifyMigrationTaskState
(Consumer<NotifyMigrationTaskStateRequest.Builder> notifyMigrationTaskStateRequest) Notifies Migration Hub of the current status, progress, or other detail regarding a migration task.notifyMigrationTaskState
(NotifyMigrationTaskStateRequest notifyMigrationTaskStateRequest) Notifies Migration Hub of the current status, progress, or other detail regarding a migration task.putResourceAttributes
(Consumer<PutResourceAttributesRequest.Builder> putResourceAttributesRequest) Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository.putResourceAttributes
(PutResourceAttributesRequest putResourceAttributesRequest) Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateCreatedArtifact
default CompletableFuture<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. 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.
- Parameters:
associateCreatedArtifactRequest
-- Returns:
- A Java Future containing the result of the AssociateCreatedArtifact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
-
associateCreatedArtifact
default CompletableFuture<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. 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 viaAssociateCreatedArtifactRequest.builder()
- Parameters:
associateCreatedArtifactRequest
- AConsumer
that will call methods onAssociateCreatedArtifactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateCreatedArtifact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
-
associateDiscoveredResource
default CompletableFuture<AssociateDiscoveredResourceResponse> associateDiscoveredResource(AssociateDiscoveredResourceRequest associateDiscoveredResourceRequest) Associates a discovered resource ID from Application Discovery Service with a migration task.
- Parameters:
associateDiscoveredResourceRequest
-- Returns:
- A Java Future containing the result of the AssociateDiscoveredResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- PolicyErrorException Exception raised when there are problems accessing Application Discovery Service
(Application Discovery Service); most likely due to a misconfigured policy or the
migrationhub-discovery
role is missing or not configured correctly. - ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
associateDiscoveredResource
default CompletableFuture<AssociateDiscoveredResourceResponse> associateDiscoveredResource(Consumer<AssociateDiscoveredResourceRequest.Builder> associateDiscoveredResourceRequest) Associates a discovered resource ID from Application Discovery Service with a migration task.
This is a convenience which creates an instance of the
AssociateDiscoveredResourceRequest.Builder
avoiding the need to create one manually viaAssociateDiscoveredResourceRequest.builder()
- Parameters:
associateDiscoveredResourceRequest
- AConsumer
that will call methods onAssociateDiscoveredResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateDiscoveredResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- PolicyErrorException Exception raised when there are problems accessing Application Discovery Service
(Application Discovery Service); most likely due to a misconfigured policy or the
migrationhub-discovery
role is missing or not configured correctly. - ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
createProgressUpdateStream
default CompletableFuture<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. 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.
- Parameters:
createProgressUpdateStreamRequest
-- Returns:
- A Java Future containing the result of the CreateProgressUpdateStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
createProgressUpdateStream
default CompletableFuture<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. 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 viaCreateProgressUpdateStreamRequest.builder()
- Parameters:
createProgressUpdateStreamRequest
- AConsumer
that will call methods onCreateProgressUpdateStreamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProgressUpdateStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
deleteProgressUpdateStream
default CompletableFuture<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. This API has the following traits:
-
The only parameter needed for
DeleteProgressUpdateStream
is the stream name (same as aCreateProgressUpdateStream
call). -
The call will return, and a background process will asynchronously delete the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts).
-
If the stream takes time to be deleted, it might still show up on a
ListProgressUpdateStreams
call. -
CreateProgressUpdateStream
,ImportMigrationTask
,NotifyMigrationTaskState
, and all Associate[*] APIs related to the tasks belonging to the stream will throw "InvalidInputException" if the stream of the same name is in the process of being deleted. -
Once the stream and all of its resources are deleted,
CreateProgressUpdateStream
for a stream of the same name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream).
- Parameters:
deleteProgressUpdateStreamRequest
-- Returns:
- A Java Future containing the result of the DeleteProgressUpdateStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
-
deleteProgressUpdateStream
default CompletableFuture<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. This API has the following traits:
-
The only parameter needed for
DeleteProgressUpdateStream
is the stream name (same as aCreateProgressUpdateStream
call). -
The call will return, and a background process will asynchronously delete the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts).
-
If the stream takes time to be deleted, it might still show up on a
ListProgressUpdateStreams
call. -
CreateProgressUpdateStream
,ImportMigrationTask
,NotifyMigrationTaskState
, and all Associate[*] APIs related to the tasks belonging to the stream will throw "InvalidInputException" if the stream of the same name is in the process of being deleted. -
Once the stream and all of its resources are deleted,
CreateProgressUpdateStream
for a stream of the same name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream).
This is a convenience which creates an instance of the
DeleteProgressUpdateStreamRequest.Builder
avoiding the need to create one manually viaDeleteProgressUpdateStreamRequest.builder()
- Parameters:
deleteProgressUpdateStreamRequest
- AConsumer
that will call methods onDeleteProgressUpdateStreamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProgressUpdateStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
-
describeApplicationState
default CompletableFuture<DescribeApplicationStateResponse> describeApplicationState(DescribeApplicationStateRequest describeApplicationStateRequest) Gets the migration status of an application.
- Parameters:
describeApplicationStateRequest
-- Returns:
- A Java Future containing the result of the DescribeApplicationState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- PolicyErrorException Exception raised when there are problems accessing Application Discovery Service
(Application Discovery Service); most likely due to a misconfigured policy or the
migrationhub-discovery
role is missing or not configured correctly. - ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
describeApplicationState
default CompletableFuture<DescribeApplicationStateResponse> describeApplicationState(Consumer<DescribeApplicationStateRequest.Builder> describeApplicationStateRequest) 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 viaDescribeApplicationStateRequest.builder()
- Parameters:
describeApplicationStateRequest
- AConsumer
that will call methods onDescribeApplicationStateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeApplicationState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- PolicyErrorException Exception raised when there are problems accessing Application Discovery Service
(Application Discovery Service); most likely due to a misconfigured policy or the
migrationhub-discovery
role is missing or not configured correctly. - ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
describeMigrationTask
default CompletableFuture<DescribeMigrationTaskResponse> describeMigrationTask(DescribeMigrationTaskRequest describeMigrationTaskRequest) Retrieves a list of all attributes associated with a specific migration task.
- Parameters:
describeMigrationTaskRequest
-- Returns:
- A Java Future containing the result of the DescribeMigrationTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
describeMigrationTask
default CompletableFuture<DescribeMigrationTaskResponse> describeMigrationTask(Consumer<DescribeMigrationTaskRequest.Builder> describeMigrationTaskRequest) 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 viaDescribeMigrationTaskRequest.builder()
- Parameters:
describeMigrationTaskRequest
- AConsumer
that will call methods onDescribeMigrationTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeMigrationTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
disassociateCreatedArtifact
default CompletableFuture<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. 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.
- Parameters:
disassociateCreatedArtifactRequest
-- Returns:
- A Java Future containing the result of the DisassociateCreatedArtifact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
-
disassociateCreatedArtifact
default CompletableFuture<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. 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 viaDisassociateCreatedArtifactRequest.builder()
- Parameters:
disassociateCreatedArtifactRequest
- AConsumer
that will call methods onDisassociateCreatedArtifactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateCreatedArtifact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
-
disassociateDiscoveredResource
default CompletableFuture<DisassociateDiscoveredResourceResponse> disassociateDiscoveredResource(DisassociateDiscoveredResourceRequest disassociateDiscoveredResourceRequest) Disassociate an Application Discovery Service discovered resource from a migration task.
- Parameters:
disassociateDiscoveredResourceRequest
-- Returns:
- A Java Future containing the result of the DisassociateDiscoveredResource operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
disassociateDiscoveredResource
default CompletableFuture<DisassociateDiscoveredResourceResponse> disassociateDiscoveredResource(Consumer<DisassociateDiscoveredResourceRequest.Builder> disassociateDiscoveredResourceRequest) Disassociate an Application Discovery Service 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 viaDisassociateDiscoveredResourceRequest.builder()
- Parameters:
disassociateDiscoveredResourceRequest
- AConsumer
that will call methods onDisassociateDiscoveredResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateDiscoveredResource operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
importMigrationTask
default CompletableFuture<ImportMigrationTaskResponse> 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.- Parameters:
importMigrationTaskRequest
-- Returns:
- A Java Future containing the result of the ImportMigrationTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
importMigrationTask
default CompletableFuture<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.
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 viaImportMigrationTaskRequest.builder()
- Parameters:
importMigrationTaskRequest
- AConsumer
that will call methods onImportMigrationTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ImportMigrationTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listApplicationStates
default CompletableFuture<ListApplicationStatesResponse> listApplicationStates(ListApplicationStatesRequest listApplicationStatesRequest) Lists all the migration statuses for your applications. If you use the optional
ApplicationIds
parameter, only the migration statuses for those applications will be returned.- Parameters:
listApplicationStatesRequest
-- Returns:
- A Java Future containing the result of the ListApplicationStates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listApplicationStates
default CompletableFuture<ListApplicationStatesResponse> listApplicationStates(Consumer<ListApplicationStatesRequest.Builder> listApplicationStatesRequest) Lists all the migration statuses for your applications. If you use the optional
ApplicationIds
parameter, only the migration statuses for those applications will be returned.
This is a convenience which creates an instance of the
ListApplicationStatesRequest.Builder
avoiding the need to create one manually viaListApplicationStatesRequest.builder()
- Parameters:
listApplicationStatesRequest
- AConsumer
that will call methods onListApplicationStatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplicationStates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listApplicationStatesPaginator
default ListApplicationStatesPublisher listApplicationStatesPaginator(ListApplicationStatesRequest listApplicationStatesRequest) This is a variant of
listApplicationStates(software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.migrationhub.paginators.ListApplicationStatesPublisher publisher = client.listApplicationStatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.migrationhub.paginators.ListApplicationStatesPublisher publisher = client.listApplicationStatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationStates(software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesRequest)
operation.- Parameters:
listApplicationStatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listApplicationStatesPaginator
default ListApplicationStatesPublisher listApplicationStatesPaginator(Consumer<ListApplicationStatesRequest.Builder> listApplicationStatesRequest) This is a variant of
listApplicationStates(software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.migrationhub.paginators.ListApplicationStatesPublisher publisher = client.listApplicationStatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.migrationhub.paginators.ListApplicationStatesPublisher publisher = client.listApplicationStatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationStates(software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesRequest)
operation.
This is a convenience which creates an instance of the
ListApplicationStatesRequest.Builder
avoiding the need to create one manually viaListApplicationStatesRequest.builder()
- Parameters:
listApplicationStatesRequest
- AConsumer
that will call methods onListApplicationStatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listCreatedArtifacts
default CompletableFuture<ListCreatedArtifactsResponse> 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.
- Parameters:
listCreatedArtifactsRequest
-- Returns:
- A Java Future containing the result of the ListCreatedArtifacts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
-
listCreatedArtifacts
default CompletableFuture<ListCreatedArtifactsResponse> listCreatedArtifacts(Consumer<ListCreatedArtifactsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListCreatedArtifactsRequest.Builder
avoiding the need to create one manually viaListCreatedArtifactsRequest.builder()
- Parameters:
listCreatedArtifactsRequest
- AConsumer
that will call methods onListCreatedArtifactsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCreatedArtifacts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
-
listCreatedArtifactsPaginator
default ListCreatedArtifactsPublisher listCreatedArtifactsPaginator(ListCreatedArtifactsRequest listCreatedArtifactsRequest) This is a variant of
listCreatedArtifacts(software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.migrationhub.paginators.ListCreatedArtifactsPublisher publisher = client.listCreatedArtifactsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.migrationhub.paginators.ListCreatedArtifactsPublisher publisher = client.listCreatedArtifactsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCreatedArtifacts(software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsRequest)
operation.- Parameters:
listCreatedArtifactsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listCreatedArtifactsPaginator
default ListCreatedArtifactsPublisher listCreatedArtifactsPaginator(Consumer<ListCreatedArtifactsRequest.Builder> listCreatedArtifactsRequest) This is a variant of
listCreatedArtifacts(software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.migrationhub.paginators.ListCreatedArtifactsPublisher publisher = client.listCreatedArtifactsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.migrationhub.paginators.ListCreatedArtifactsPublisher publisher = client.listCreatedArtifactsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCreatedArtifacts(software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsRequest)
operation.
This is a convenience which creates an instance of the
ListCreatedArtifactsRequest.Builder
avoiding the need to create one manually viaListCreatedArtifactsRequest.builder()
- Parameters:
listCreatedArtifactsRequest
- AConsumer
that will call methods onListCreatedArtifactsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listDiscoveredResources
default CompletableFuture<ListDiscoveredResourcesResponse> listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest) Lists discovered resources associated with the given
MigrationTask
.- Parameters:
listDiscoveredResourcesRequest
-- Returns:
- A Java Future containing the result of the ListDiscoveredResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listDiscoveredResources
default CompletableFuture<ListDiscoveredResourcesResponse> listDiscoveredResources(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest) 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 viaListDiscoveredResourcesRequest.builder()
- Parameters:
listDiscoveredResourcesRequest
- AConsumer
that will call methods onListDiscoveredResourcesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDiscoveredResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listDiscoveredResourcesPaginator
default ListDiscoveredResourcesPublisher listDiscoveredResourcesPaginator(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest) This is a variant of
listDiscoveredResources(software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.migrationhub.paginators.ListDiscoveredResourcesPublisher publisher = client.listDiscoveredResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.migrationhub.paginators.ListDiscoveredResourcesPublisher publisher = client.listDiscoveredResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDiscoveredResources(software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesRequest)
operation.- Parameters:
listDiscoveredResourcesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listDiscoveredResourcesPaginator
default ListDiscoveredResourcesPublisher listDiscoveredResourcesPaginator(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest) This is a variant of
listDiscoveredResources(software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.migrationhub.paginators.ListDiscoveredResourcesPublisher publisher = client.listDiscoveredResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.migrationhub.paginators.ListDiscoveredResourcesPublisher publisher = client.listDiscoveredResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDiscoveredResources(software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListDiscoveredResourcesRequest.Builder
avoiding the need to create one manually viaListDiscoveredResourcesRequest.builder()
- Parameters:
listDiscoveredResourcesRequest
- AConsumer
that will call methods onListDiscoveredResourcesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listMigrationTasks
default CompletableFuture<ListMigrationTasksResponse> 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.
- Parameters:
listMigrationTasksRequest
-- Returns:
- A Java Future containing the result of the ListMigrationTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- PolicyErrorException Exception raised when there are problems accessing Application Discovery Service
(Application Discovery Service); most likely due to a misconfigured policy or the
migrationhub-discovery
role is missing or not configured correctly. - ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
-
listMigrationTasks
default CompletableFuture<ListMigrationTasksResponse> listMigrationTasks(Consumer<ListMigrationTasksRequest.Builder> 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.
This is a convenience which creates an instance of the
ListMigrationTasksRequest.Builder
avoiding the need to create one manually viaListMigrationTasksRequest.builder()
- Parameters:
listMigrationTasksRequest
- AConsumer
that will call methods onListMigrationTasksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMigrationTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- PolicyErrorException Exception raised when there are problems accessing Application Discovery Service
(Application Discovery Service); most likely due to a misconfigured policy or the
migrationhub-discovery
role is missing or not configured correctly. - ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
-
listMigrationTasksPaginator
default ListMigrationTasksPublisher listMigrationTasksPaginator(ListMigrationTasksRequest listMigrationTasksRequest) This is a variant of
listMigrationTasks(software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.migrationhub.paginators.ListMigrationTasksPublisher publisher = client.listMigrationTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.migrationhub.paginators.ListMigrationTasksPublisher publisher = client.listMigrationTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMigrationTasks(software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksRequest)
operation.- Parameters:
listMigrationTasksRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- PolicyErrorException Exception raised when there are problems accessing Application Discovery Service
(Application Discovery Service); most likely due to a misconfigured policy or the
migrationhub-discovery
role is missing or not configured correctly. - ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listMigrationTasksPaginator
default ListMigrationTasksPublisher listMigrationTasksPaginator(Consumer<ListMigrationTasksRequest.Builder> listMigrationTasksRequest) This is a variant of
listMigrationTasks(software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.migrationhub.paginators.ListMigrationTasksPublisher publisher = client.listMigrationTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.migrationhub.paginators.ListMigrationTasksPublisher publisher = client.listMigrationTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMigrationTasks(software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksRequest)
operation.
This is a convenience which creates an instance of the
ListMigrationTasksRequest.Builder
avoiding the need to create one manually viaListMigrationTasksRequest.builder()
- Parameters:
listMigrationTasksRequest
- AConsumer
that will call methods onListMigrationTasksRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- PolicyErrorException Exception raised when there are problems accessing Application Discovery Service
(Application Discovery Service); most likely due to a misconfigured policy or the
migrationhub-discovery
role is missing or not configured correctly. - ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listProgressUpdateStreams
default CompletableFuture<ListProgressUpdateStreamsResponse> listProgressUpdateStreams(ListProgressUpdateStreamsRequest listProgressUpdateStreamsRequest) Lists progress update streams associated with the user account making this call.
- Parameters:
listProgressUpdateStreamsRequest
-- Returns:
- A Java Future containing the result of the ListProgressUpdateStreams operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listProgressUpdateStreams
default CompletableFuture<ListProgressUpdateStreamsResponse> listProgressUpdateStreams(Consumer<ListProgressUpdateStreamsRequest.Builder> listProgressUpdateStreamsRequest) 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 viaListProgressUpdateStreamsRequest.builder()
- Parameters:
listProgressUpdateStreamsRequest
- AConsumer
that will call methods onListProgressUpdateStreamsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProgressUpdateStreams operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listProgressUpdateStreamsPaginator
default ListProgressUpdateStreamsPublisher listProgressUpdateStreamsPaginator(ListProgressUpdateStreamsRequest listProgressUpdateStreamsRequest) This is a variant of
listProgressUpdateStreams(software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.migrationhub.paginators.ListProgressUpdateStreamsPublisher publisher = client.listProgressUpdateStreamsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.migrationhub.paginators.ListProgressUpdateStreamsPublisher publisher = client.listProgressUpdateStreamsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProgressUpdateStreams(software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsRequest)
operation.- Parameters:
listProgressUpdateStreamsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
listProgressUpdateStreamsPaginator
default ListProgressUpdateStreamsPublisher listProgressUpdateStreamsPaginator(Consumer<ListProgressUpdateStreamsRequest.Builder> listProgressUpdateStreamsRequest) This is a variant of
listProgressUpdateStreams(software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.migrationhub.paginators.ListProgressUpdateStreamsPublisher publisher = client.listProgressUpdateStreamsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.migrationhub.paginators.ListProgressUpdateStreamsPublisher publisher = client.listProgressUpdateStreamsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProgressUpdateStreams(software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsRequest)
operation.
This is a convenience which creates an instance of the
ListProgressUpdateStreamsRequest.Builder
avoiding the need to create one manually viaListProgressUpdateStreamsRequest.builder()
- Parameters:
listProgressUpdateStreamsRequest
- AConsumer
that will call methods onListProgressUpdateStreamsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
notifyApplicationState
default CompletableFuture<NotifyApplicationStateResponse> 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 toStatus
:NOT_STARTED | IN_PROGRESS | COMPLETED
.- Parameters:
notifyApplicationStateRequest
-- Returns:
- A Java Future containing the result of the NotifyApplicationState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- PolicyErrorException Exception raised when there are problems accessing Application Discovery Service
(Application Discovery Service); most likely due to a misconfigured policy or the
migrationhub-discovery
role is missing or not configured correctly. - ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
notifyApplicationState
default CompletableFuture<NotifyApplicationStateResponse> notifyApplicationState(Consumer<NotifyApplicationStateRequest.Builder> 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 toStatus
:NOT_STARTED | IN_PROGRESS | COMPLETED
.
This is a convenience which creates an instance of the
NotifyApplicationStateRequest.Builder
avoiding the need to create one manually viaNotifyApplicationStateRequest.builder()
- Parameters:
notifyApplicationStateRequest
- AConsumer
that will call methods onNotifyApplicationStateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the NotifyApplicationState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- PolicyErrorException Exception raised when there are problems accessing Application Discovery Service
(Application Discovery Service); most likely due to a misconfigured policy or the
migrationhub-discovery
role is missing or not configured correctly. - ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
notifyMigrationTaskState
default CompletableFuture<NotifyMigrationTaskStateResponse> 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.
- Parameters:
notifyMigrationTaskStateRequest
-- Returns:
- A Java Future containing the result of the NotifyMigrationTaskState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
-
notifyMigrationTaskState
default CompletableFuture<NotifyMigrationTaskStateResponse> notifyMigrationTaskState(Consumer<NotifyMigrationTaskStateRequest.Builder> 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.
This is a convenience which creates an instance of the
NotifyMigrationTaskStateRequest.Builder
avoiding the need to create one manually viaNotifyMigrationTaskStateRequest.builder()
- Parameters:
notifyMigrationTaskStateRequest
- AConsumer
that will call methods onNotifyMigrationTaskStateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the NotifyMigrationTaskState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
-
putResourceAttributes
default CompletableFuture<PutResourceAttributesResponse> putResourceAttributes(PutResourceAttributesRequest putResourceAttributesRequest) Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository. This association occurs asynchronously after
PutResourceAttributes
returns.-
Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to add an IP address, it will then be required to call it with both the IP and MAC addresses to prevent overriding the MAC address.
-
Note the instructions regarding the special use case of the
ResourceAttributeList
parameter when specifying any "VM" related value.
Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call
ListDiscoveredResources
.- Parameters:
putResourceAttributesRequest
-- Returns:
- A Java Future containing the result of the PutResourceAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
-
putResourceAttributes
default CompletableFuture<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 repository. This association occurs asynchronously after
PutResourceAttributes
returns.-
Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to add an IP address, it will then be required to call it with both the IP and MAC addresses to prevent overriding the MAC address.
-
Note the instructions regarding the special use case of the
ResourceAttributeList
parameter when specifying any "VM" related value.
Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call
ListDiscoveredResources
.
This is a convenience which creates an instance of the
PutResourceAttributesRequest.Builder
avoiding the need to create one manually viaPutResourceAttributesRequest.builder()
- Parameters:
putResourceAttributesRequest
- AConsumer
that will call methods onPutResourceAttributesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutResourceAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- InternalServerErrorException Exception raised when an internal, configuration, or dependency error is encountered.
- ServiceUnavailableException Exception raised when there is an internal, configuration, or dependency error encountered.
- DryRunOperationException Exception raised to indicate a successfully authorized action when the
DryRun
flag is set to "true". - UnauthorizedOperationException Exception raised to indicate a request was not authorized when the
DryRun
flag is set to "true". - InvalidInputException Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
- ResourceNotFoundException Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.
- HomeRegionNotSetException The home region is not set. Set the home region to continue.
- 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.
- See Also:
-
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aMigrationHubAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aMigrationHubAsyncClient
.
-