Interface MigrationHubClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface MigrationHubClient
extends AwsClient

Service client for accessing AWS Migration Hub. This can be created using the static builder() method.

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AssociateCreatedArtifactResponse	associateCreatedArtifact(Consumer<AssociateCreatedArtifactRequest.Builder> associateCreatedArtifactRequest)	Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool.
default AssociateCreatedArtifactResponse	associateCreatedArtifact(AssociateCreatedArtifactRequest associateCreatedArtifactRequest)	Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool.
default AssociateDiscoveredResourceResponse	associateDiscoveredResource(Consumer<AssociateDiscoveredResourceRequest.Builder> associateDiscoveredResourceRequest)	Associates a discovered resource ID from Application Discovery Service with a migration task.
default AssociateDiscoveredResourceResponse	associateDiscoveredResource(AssociateDiscoveredResourceRequest associateDiscoveredResourceRequest)	Associates a discovered resource ID from Application Discovery Service with a migration task.
static MigrationHubClientBuilder	builder()	Create a builder that can be used to configure and create a MigrationHubClient.
static MigrationHubClient	create()	Create a MigrationHubClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateProgressUpdateStreamResponse	createProgressUpdateStream(Consumer<CreateProgressUpdateStreamRequest.Builder> createProgressUpdateStreamRequest)	Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account.
default CreateProgressUpdateStreamResponse	createProgressUpdateStream(CreateProgressUpdateStreamRequest createProgressUpdateStreamRequest)	Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account.
default DeleteProgressUpdateStreamResponse	deleteProgressUpdateStream(Consumer<DeleteProgressUpdateStreamRequest.Builder> deleteProgressUpdateStreamRequest)	Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control.
default DeleteProgressUpdateStreamResponse	deleteProgressUpdateStream(DeleteProgressUpdateStreamRequest deleteProgressUpdateStreamRequest)	Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control.
default DescribeApplicationStateResponse	describeApplicationState(Consumer<DescribeApplicationStateRequest.Builder> describeApplicationStateRequest)	Gets the migration status of an application.
default DescribeApplicationStateResponse	describeApplicationState(DescribeApplicationStateRequest describeApplicationStateRequest)	Gets the migration status of an application.
default DescribeMigrationTaskResponse	describeMigrationTask(Consumer<DescribeMigrationTaskRequest.Builder> describeMigrationTaskRequest)	Retrieves a list of all attributes associated with a specific migration task.
default DescribeMigrationTaskResponse	describeMigrationTask(DescribeMigrationTaskRequest describeMigrationTaskRequest)	Retrieves a list of all attributes associated with a specific migration task.
default DisassociateCreatedArtifactResponse	disassociateCreatedArtifact(Consumer<DisassociateCreatedArtifactRequest.Builder> disassociateCreatedArtifactRequest)	Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated.
default DisassociateCreatedArtifactResponse	disassociateCreatedArtifact(DisassociateCreatedArtifactRequest disassociateCreatedArtifactRequest)	Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated.
default DisassociateDiscoveredResourceResponse	disassociateDiscoveredResource(Consumer<DisassociateDiscoveredResourceRequest.Builder> disassociateDiscoveredResourceRequest)	Disassociate an Application Discovery Service discovered resource from a migration task.
default DisassociateDiscoveredResourceResponse	disassociateDiscoveredResource(DisassociateDiscoveredResourceRequest disassociateDiscoveredResourceRequest)	Disassociate an Application Discovery Service discovered resource from a migration task.
default ImportMigrationTaskResponse	importMigrationTask(Consumer<ImportMigrationTaskRequest.Builder> importMigrationTaskRequest)	Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.
default ImportMigrationTaskResponse	importMigrationTask(ImportMigrationTaskRequest importMigrationTaskRequest)	Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.
default ListApplicationStatesResponse	listApplicationStates(Consumer<ListApplicationStatesRequest.Builder> listApplicationStatesRequest)	Lists all the migration statuses for your applications.
default ListApplicationStatesResponse	listApplicationStates(ListApplicationStatesRequest listApplicationStatesRequest)	Lists all the migration statuses for your applications.
default ListApplicationStatesIterable	listApplicationStatesPaginator(Consumer<ListApplicationStatesRequest.Builder> listApplicationStatesRequest)	This is a variant of listApplicationStates(software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesRequest) operation.
default ListApplicationStatesIterable	listApplicationStatesPaginator(ListApplicationStatesRequest listApplicationStatesRequest)	This is a variant of listApplicationStates(software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesRequest) operation.
default ListCreatedArtifactsResponse	listCreatedArtifacts(Consumer<ListCreatedArtifactsRequest.Builder> listCreatedArtifactsRequest)	Lists the created artifacts attached to a given migration task in an update stream.
default ListCreatedArtifactsResponse	listCreatedArtifacts(ListCreatedArtifactsRequest listCreatedArtifactsRequest)	Lists the created artifacts attached to a given migration task in an update stream.
default ListCreatedArtifactsIterable	listCreatedArtifactsPaginator(Consumer<ListCreatedArtifactsRequest.Builder> listCreatedArtifactsRequest)	This is a variant of listCreatedArtifacts(software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsRequest) operation.
default ListCreatedArtifactsIterable	listCreatedArtifactsPaginator(ListCreatedArtifactsRequest listCreatedArtifactsRequest)	This is a variant of listCreatedArtifacts(software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsRequest) operation.
default ListDiscoveredResourcesResponse	listDiscoveredResources(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest)	Lists discovered resources associated with the given MigrationTask.
default ListDiscoveredResourcesResponse	listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest)	Lists discovered resources associated with the given MigrationTask.
default ListDiscoveredResourcesIterable	listDiscoveredResourcesPaginator(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest)	This is a variant of listDiscoveredResources(software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesRequest) operation.
default ListDiscoveredResourcesIterable	listDiscoveredResourcesPaginator(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest)	This is a variant of listDiscoveredResources(software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesRequest) operation.
default ListMigrationTasksResponse	listMigrationTasks(Consumer<ListMigrationTasksRequest.Builder> listMigrationTasksRequest)	Lists all, or filtered by resource name, migration tasks associated with the user account making this call.
default ListMigrationTasksResponse	listMigrationTasks(ListMigrationTasksRequest listMigrationTasksRequest)	Lists all, or filtered by resource name, migration tasks associated with the user account making this call.
default ListMigrationTasksIterable	listMigrationTasksPaginator(Consumer<ListMigrationTasksRequest.Builder> listMigrationTasksRequest)	This is a variant of listMigrationTasks(software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksRequest) operation.
default ListMigrationTasksIterable	listMigrationTasksPaginator(ListMigrationTasksRequest listMigrationTasksRequest)	This is a variant of listMigrationTasks(software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksRequest) operation.
default ListProgressUpdateStreamsResponse	listProgressUpdateStreams(Consumer<ListProgressUpdateStreamsRequest.Builder> listProgressUpdateStreamsRequest)	Lists progress update streams associated with the user account making this call.
default ListProgressUpdateStreamsResponse	listProgressUpdateStreams(ListProgressUpdateStreamsRequest listProgressUpdateStreamsRequest)	Lists progress update streams associated with the user account making this call.
default ListProgressUpdateStreamsIterable	listProgressUpdateStreamsPaginator(Consumer<ListProgressUpdateStreamsRequest.Builder> listProgressUpdateStreamsRequest)	This is a variant of listProgressUpdateStreams(software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsRequest) operation.
default ListProgressUpdateStreamsIterable	listProgressUpdateStreamsPaginator(ListProgressUpdateStreamsRequest listProgressUpdateStreamsRequest)	This is a variant of listProgressUpdateStreams(software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsRequest) operation.
default NotifyApplicationStateResponse	notifyApplicationState(Consumer<NotifyApplicationStateRequest.Builder> notifyApplicationStateRequest)	Sets the migration state of an application.
default NotifyApplicationStateResponse	notifyApplicationState(NotifyApplicationStateRequest notifyApplicationStateRequest)	Sets the migration state of an application.
default NotifyMigrationTaskStateResponse	notifyMigrationTaskState(Consumer<NotifyMigrationTaskStateRequest.Builder> notifyMigrationTaskStateRequest)	Notifies Migration Hub of the current status, progress, or other detail regarding a migration task.
default NotifyMigrationTaskStateResponse	notifyMigrationTaskState(NotifyMigrationTaskStateRequest notifyMigrationTaskStateRequest)	Notifies Migration Hub of the current status, progress, or other detail regarding a migration task.
default PutResourceAttributesResponse	putResourceAttributes(Consumer<PutResourceAttributesRequest.Builder> putResourceAttributesRequest)	Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository.
default PutResourceAttributesResponse	putResourceAttributes(PutResourceAttributesRequest putResourceAttributesRequest)	Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository.
default MigrationHubServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

associateCreatedArtifact

default AssociateCreatedArtifactResponse associateCreatedArtifact(AssociateCreatedArtifactRequest associateCreatedArtifactRequest)
                                                           throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

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

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

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

Parameters:

associateCreatedArtifactRequest -

Returns:

Result of the AssociateCreatedArtifact operation returned by the service.

See Also:

• AWS API Documentation

associateCreatedArtifact

default AssociateCreatedArtifactResponse associateCreatedArtifact(Consumer<AssociateCreatedArtifactRequest.Builder> associateCreatedArtifactRequest)
                                                           throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

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

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

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

This is a convenience which creates an instance of the AssociateCreatedArtifactRequest.Builder avoiding the need to create one manually via AssociateCreatedArtifactRequest.builder()

Parameters:

associateCreatedArtifactRequest - A Consumer that will call methods on AssociateCreatedArtifactRequest.Builder to create a request.

Returns:

Result of the AssociateCreatedArtifact operation returned by the service.

See Also:

• AWS API Documentation

associateDiscoveredResource

default AssociateDiscoveredResourceResponse associateDiscoveredResource(AssociateDiscoveredResourceRequest associateDiscoveredResourceRequest)
                                                                 throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
PolicyErrorException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

Parameters:

associateDiscoveredResourceRequest -

Returns:

Result of the AssociateDiscoveredResource operation returned by the service.

See Also:

• AWS API Documentation

associateDiscoveredResource

default AssociateDiscoveredResourceResponse associateDiscoveredResource(Consumer<AssociateDiscoveredResourceRequest.Builder> associateDiscoveredResourceRequest)
                                                                 throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
PolicyErrorException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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 via AssociateDiscoveredResourceRequest.builder()

Parameters:

associateDiscoveredResourceRequest - A Consumer that will call methods on AssociateDiscoveredResourceRequest.Builder to create a request.

Returns:

Result of the AssociateDiscoveredResource operation returned by the service.

See Also:

• AWS API Documentation

createProgressUpdateStream

default CreateProgressUpdateStreamResponse createProgressUpdateStream(CreateProgressUpdateStreamRequest createProgressUpdateStreamRequest)
                                                               throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

Parameters:

createProgressUpdateStreamRequest -

Returns:

Result of the CreateProgressUpdateStream operation returned by the service.

See Also:

• AWS API Documentation

createProgressUpdateStream

default CreateProgressUpdateStreamResponse createProgressUpdateStream(Consumer<CreateProgressUpdateStreamRequest.Builder> createProgressUpdateStreamRequest)
                                                               throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

This is a convenience which creates an instance of the CreateProgressUpdateStreamRequest.Builder avoiding the need to create one manually via CreateProgressUpdateStreamRequest.builder()

Parameters:

createProgressUpdateStreamRequest - A Consumer that will call methods on CreateProgressUpdateStreamRequest.Builder to create a request.

Returns:

Result of the CreateProgressUpdateStream operation returned by the service.

See Also:

• AWS API Documentation

deleteProgressUpdateStream

default DeleteProgressUpdateStreamResponse deleteProgressUpdateStream(DeleteProgressUpdateStreamRequest deleteProgressUpdateStreamRequest)
                                                               throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

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

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

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

• CreateProgressUpdateStream, ImportMigrationTask, NotifyMigrationTaskState, and all Associate[*] APIs 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:

Result of the DeleteProgressUpdateStream operation returned by the service.

See Also:

• AWS API Documentation

deleteProgressUpdateStream

default DeleteProgressUpdateStreamResponse deleteProgressUpdateStream(Consumer<DeleteProgressUpdateStreamRequest.Builder> deleteProgressUpdateStreamRequest)
                                                               throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

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

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

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

• CreateProgressUpdateStream, ImportMigrationTask, NotifyMigrationTaskState, and all Associate[*] APIs 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 via DeleteProgressUpdateStreamRequest.builder()

Parameters:

deleteProgressUpdateStreamRequest - A Consumer that will call methods on DeleteProgressUpdateStreamRequest.Builder to create a request.

Returns:

Result of the DeleteProgressUpdateStream operation returned by the service.

See Also:

• AWS API Documentation

describeApplicationState

default DescribeApplicationStateResponse describeApplicationState(DescribeApplicationStateRequest describeApplicationStateRequest)
                                                           throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
PolicyErrorException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

Gets the migration status of an application.

Parameters:

describeApplicationStateRequest -

Returns:

Result of the DescribeApplicationState operation returned by the service.

See Also:

• AWS API Documentation

describeApplicationState

default DescribeApplicationStateResponse describeApplicationState(Consumer<DescribeApplicationStateRequest.Builder> describeApplicationStateRequest)
                                                           throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
PolicyErrorException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

Gets the migration status of an application.

This is a convenience which creates an instance of the DescribeApplicationStateRequest.Builder avoiding the need to create one manually via DescribeApplicationStateRequest.builder()

Parameters:

describeApplicationStateRequest - A Consumer that will call methods on DescribeApplicationStateRequest.Builder to create a request.

Returns:

Result of the DescribeApplicationState operation returned by the service.

See Also:

• AWS API Documentation

describeMigrationTask

default DescribeMigrationTaskResponse describeMigrationTask(DescribeMigrationTaskRequest describeMigrationTaskRequest)
                                                     throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

Parameters:

describeMigrationTaskRequest -

Returns:

Result of the DescribeMigrationTask operation returned by the service.

See Also:

• AWS API Documentation

describeMigrationTask

default DescribeMigrationTaskResponse describeMigrationTask(Consumer<DescribeMigrationTaskRequest.Builder> describeMigrationTaskRequest)
                                                     throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

This is a convenience which creates an instance of the DescribeMigrationTaskRequest.Builder avoiding the need to create one manually via DescribeMigrationTaskRequest.builder()

Parameters:

describeMigrationTaskRequest - A Consumer that will call methods on DescribeMigrationTaskRequest.Builder to create a request.

Returns:

Result of the DescribeMigrationTask operation returned by the service.

See Also:

• AWS API Documentation

disassociateCreatedArtifact

default DisassociateCreatedArtifactResponse disassociateCreatedArtifact(DisassociateCreatedArtifactRequest disassociateCreatedArtifactRequest)
                                                                 throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

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

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

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

Parameters:

disassociateCreatedArtifactRequest -

Returns:

Result of the DisassociateCreatedArtifact operation returned by the service.

See Also:

• AWS API Documentation

disassociateCreatedArtifact

default DisassociateCreatedArtifactResponse disassociateCreatedArtifact(Consumer<DisassociateCreatedArtifactRequest.Builder> disassociateCreatedArtifactRequest)
                                                                 throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

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

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

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

This is a convenience which creates an instance of the DisassociateCreatedArtifactRequest.Builder avoiding the need to create one manually via DisassociateCreatedArtifactRequest.builder()

Parameters:

disassociateCreatedArtifactRequest - A Consumer that will call methods on DisassociateCreatedArtifactRequest.Builder to create a request.

Returns:

Result of the DisassociateCreatedArtifact operation returned by the service.

See Also:

• AWS API Documentation

disassociateDiscoveredResource

default DisassociateDiscoveredResourceResponse disassociateDiscoveredResource(DisassociateDiscoveredResourceRequest disassociateDiscoveredResourceRequest)
                                                                       throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

Parameters:

disassociateDiscoveredResourceRequest -

Returns:

Result of the DisassociateDiscoveredResource operation returned by the service.

See Also:

• AWS API Documentation

disassociateDiscoveredResource

default DisassociateDiscoveredResourceResponse disassociateDiscoveredResource(Consumer<DisassociateDiscoveredResourceRequest.Builder> disassociateDiscoveredResourceRequest)
                                                                       throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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 via DisassociateDiscoveredResourceRequest.builder()

Parameters:

disassociateDiscoveredResourceRequest - A Consumer that will call methods on DisassociateDiscoveredResourceRequest.Builder to create a request.

Returns:

Result of the DisassociateDiscoveredResource operation returned by the service.

See Also:

• AWS API Documentation

importMigrationTask

default ImportMigrationTaskResponse importMigrationTask(ImportMigrationTaskRequest importMigrationTaskRequest)
                                                 throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

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

Parameters:

importMigrationTaskRequest -

Returns:

Result of the ImportMigrationTask operation returned by the service.

See Also:

• AWS API Documentation

importMigrationTask

default ImportMigrationTaskResponse importMigrationTask(Consumer<ImportMigrationTaskRequest.Builder> importMigrationTaskRequest)
                                                 throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

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

This is a convenience which creates an instance of the ImportMigrationTaskRequest.Builder avoiding the need to create one manually via ImportMigrationTaskRequest.builder()

Parameters:

importMigrationTaskRequest - A Consumer that will call methods on ImportMigrationTaskRequest.Builder to create a request.

Returns:

Result of the ImportMigrationTask operation returned by the service.

See Also:

• AWS API Documentation

listApplicationStates

default ListApplicationStatesResponse listApplicationStates(ListApplicationStatesRequest listApplicationStatesRequest)
                                                     throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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:

Result of the ListApplicationStates operation returned by the service.

See Also:

• AWS API Documentation

listApplicationStates

default ListApplicationStatesResponse listApplicationStates(Consumer<ListApplicationStatesRequest.Builder> listApplicationStatesRequest)
                                                     throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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 via ListApplicationStatesRequest.builder()

Parameters:

listApplicationStatesRequest - A Consumer that will call methods on ListApplicationStatesRequest.Builder to create a request.

Returns:

Result of the ListApplicationStates operation returned by the service.

See Also:

• AWS API Documentation

listApplicationStatesPaginator

default ListApplicationStatesIterable listApplicationStatesPaginator(ListApplicationStatesRequest listApplicationStatesRequest)
                                                              throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

This is a variant of listApplicationStates(software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.migrationhub.paginators.ListApplicationStatesIterable responses = client.listApplicationStatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.migrationhub.paginators.ListApplicationStatesIterable responses = client
             .listApplicationStatesPaginator(request);
     for (software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.migrationhub.paginators.ListApplicationStatesIterable responses = client.listApplicationStatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listApplicationStatesPaginator

default ListApplicationStatesIterable listApplicationStatesPaginator(Consumer<ListApplicationStatesRequest.Builder> listApplicationStatesRequest)
                                                              throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

This is a variant of listApplicationStates(software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.migrationhub.paginators.ListApplicationStatesIterable responses = client.listApplicationStatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.migrationhub.paginators.ListApplicationStatesIterable responses = client
             .listApplicationStatesPaginator(request);
     for (software.amazon.awssdk.services.migrationhub.model.ListApplicationStatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.migrationhub.paginators.ListApplicationStatesIterable responses = client.listApplicationStatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListApplicationStatesRequest.builder()

Parameters:

listApplicationStatesRequest - A Consumer that will call methods on ListApplicationStatesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCreatedArtifacts

default ListCreatedArtifactsResponse listCreatedArtifacts(ListCreatedArtifactsRequest listCreatedArtifactsRequest)
                                                   throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

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

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

• Lists created artifacts in a paginated interface.

Parameters:

listCreatedArtifactsRequest -

Returns:

Result of the ListCreatedArtifacts operation returned by the service.

See Also:

• AWS API Documentation

listCreatedArtifacts

default ListCreatedArtifactsResponse listCreatedArtifacts(Consumer<ListCreatedArtifactsRequest.Builder> listCreatedArtifactsRequest)
                                                   throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

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

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

• Lists created artifacts in a paginated interface.

This is a convenience which creates an instance of the ListCreatedArtifactsRequest.Builder avoiding the need to create one manually via ListCreatedArtifactsRequest.builder()

Parameters:

listCreatedArtifactsRequest - A Consumer that will call methods on ListCreatedArtifactsRequest.Builder to create a request.

Returns:

Result of the ListCreatedArtifacts operation returned by the service.

See Also:

• AWS API Documentation

listCreatedArtifactsPaginator

default ListCreatedArtifactsIterable listCreatedArtifactsPaginator(ListCreatedArtifactsRequest listCreatedArtifactsRequest)
                                                            throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

This is a variant of listCreatedArtifacts(software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.migrationhub.paginators.ListCreatedArtifactsIterable responses = client.listCreatedArtifactsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.migrationhub.paginators.ListCreatedArtifactsIterable responses = client
             .listCreatedArtifactsPaginator(request);
     for (software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.migrationhub.paginators.ListCreatedArtifactsIterable responses = client.listCreatedArtifactsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCreatedArtifactsPaginator

default ListCreatedArtifactsIterable listCreatedArtifactsPaginator(Consumer<ListCreatedArtifactsRequest.Builder> listCreatedArtifactsRequest)
                                                            throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

This is a variant of listCreatedArtifacts(software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.migrationhub.paginators.ListCreatedArtifactsIterable responses = client.listCreatedArtifactsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.migrationhub.paginators.ListCreatedArtifactsIterable responses = client
             .listCreatedArtifactsPaginator(request);
     for (software.amazon.awssdk.services.migrationhub.model.ListCreatedArtifactsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.migrationhub.paginators.ListCreatedArtifactsIterable responses = client.listCreatedArtifactsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListCreatedArtifactsRequest.builder()

Parameters:

listCreatedArtifactsRequest - A Consumer that will call methods on ListCreatedArtifactsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDiscoveredResources

default ListDiscoveredResourcesResponse listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest)
                                                         throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

Lists discovered resources associated with the given MigrationTask.

Parameters:

listDiscoveredResourcesRequest -

Returns:

Result of the ListDiscoveredResources operation returned by the service.

See Also:

• AWS API Documentation

listDiscoveredResources

default ListDiscoveredResourcesResponse listDiscoveredResources(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest)
                                                         throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

Lists discovered resources associated with the given MigrationTask.

This is a convenience which creates an instance of the ListDiscoveredResourcesRequest.Builder avoiding the need to create one manually via ListDiscoveredResourcesRequest.builder()

Parameters:

listDiscoveredResourcesRequest - A Consumer that will call methods on ListDiscoveredResourcesRequest.Builder to create a request.

Returns:

Result of the ListDiscoveredResources operation returned by the service.

See Also:

• AWS API Documentation

listDiscoveredResourcesPaginator

default ListDiscoveredResourcesIterable listDiscoveredResourcesPaginator(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest)
                                                                  throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

This is a variant of listDiscoveredResources(software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.migrationhub.paginators.ListDiscoveredResourcesIterable responses = client.listDiscoveredResourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.migrationhub.paginators.ListDiscoveredResourcesIterable responses = client
             .listDiscoveredResourcesPaginator(request);
     for (software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.migrationhub.paginators.ListDiscoveredResourcesIterable responses = client.listDiscoveredResourcesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDiscoveredResourcesPaginator

default ListDiscoveredResourcesIterable listDiscoveredResourcesPaginator(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest)
                                                                  throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

This is a variant of listDiscoveredResources(software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.migrationhub.paginators.ListDiscoveredResourcesIterable responses = client.listDiscoveredResourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.migrationhub.paginators.ListDiscoveredResourcesIterable responses = client
             .listDiscoveredResourcesPaginator(request);
     for (software.amazon.awssdk.services.migrationhub.model.ListDiscoveredResourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.migrationhub.paginators.ListDiscoveredResourcesIterable responses = client.listDiscoveredResourcesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListDiscoveredResourcesRequest.builder()

Parameters:

listDiscoveredResourcesRequest - A Consumer that will call methods on ListDiscoveredResourcesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listMigrationTasks

default ListMigrationTasksResponse listMigrationTasks(ListMigrationTasksRequest listMigrationTasksRequest)
                                               throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
PolicyErrorException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

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

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

• Lists migration tasks in a paginated interface.

Parameters:

listMigrationTasksRequest -

Returns:

Result of the ListMigrationTasks operation returned by the service.

See Also:

• AWS API Documentation

listMigrationTasks

default ListMigrationTasksResponse listMigrationTasks(Consumer<ListMigrationTasksRequest.Builder> listMigrationTasksRequest)
                                               throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
PolicyErrorException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

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

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

• Lists migration tasks in a paginated interface.

This is a convenience which creates an instance of the ListMigrationTasksRequest.Builder avoiding the need to create one manually via ListMigrationTasksRequest.builder()

Parameters:

listMigrationTasksRequest - A Consumer that will call methods on ListMigrationTasksRequest.Builder to create a request.

Returns:

Result of the ListMigrationTasks operation returned by the service.

See Also:

• AWS API Documentation

listMigrationTasksPaginator

default ListMigrationTasksIterable listMigrationTasksPaginator(ListMigrationTasksRequest listMigrationTasksRequest)
                                                        throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
PolicyErrorException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

This is a variant of listMigrationTasks(software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.migrationhub.paginators.ListMigrationTasksIterable responses = client.listMigrationTasksPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.migrationhub.paginators.ListMigrationTasksIterable responses = client
             .listMigrationTasksPaginator(request);
     for (software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.migrationhub.paginators.ListMigrationTasksIterable responses = client.listMigrationTasksPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listMigrationTasksPaginator

default ListMigrationTasksIterable listMigrationTasksPaginator(Consumer<ListMigrationTasksRequest.Builder> listMigrationTasksRequest)
                                                        throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
PolicyErrorException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

This is a variant of listMigrationTasks(software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.migrationhub.paginators.ListMigrationTasksIterable responses = client.listMigrationTasksPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.migrationhub.paginators.ListMigrationTasksIterable responses = client
             .listMigrationTasksPaginator(request);
     for (software.amazon.awssdk.services.migrationhub.model.ListMigrationTasksResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.migrationhub.paginators.ListMigrationTasksIterable responses = client.listMigrationTasksPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListMigrationTasksRequest.builder()

Parameters:

listMigrationTasksRequest - A Consumer that will call methods on ListMigrationTasksRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProgressUpdateStreams

default ListProgressUpdateStreamsResponse listProgressUpdateStreams(ListProgressUpdateStreamsRequest listProgressUpdateStreamsRequest)
                                                             throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

Parameters:

listProgressUpdateStreamsRequest -

Returns:

Result of the ListProgressUpdateStreams operation returned by the service.

See Also:

• AWS API Documentation

listProgressUpdateStreams

default ListProgressUpdateStreamsResponse listProgressUpdateStreams(Consumer<ListProgressUpdateStreamsRequest.Builder> listProgressUpdateStreamsRequest)
                                                             throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

This is a convenience which creates an instance of the ListProgressUpdateStreamsRequest.Builder avoiding the need to create one manually via ListProgressUpdateStreamsRequest.builder()

Parameters:

listProgressUpdateStreamsRequest - A Consumer that will call methods on ListProgressUpdateStreamsRequest.Builder to create a request.

Returns:

Result of the ListProgressUpdateStreams operation returned by the service.

See Also:

• AWS API Documentation

listProgressUpdateStreamsPaginator

default ListProgressUpdateStreamsIterable listProgressUpdateStreamsPaginator(ListProgressUpdateStreamsRequest listProgressUpdateStreamsRequest)
                                                                      throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

This is a variant of listProgressUpdateStreams(software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.migrationhub.paginators.ListProgressUpdateStreamsIterable responses = client.listProgressUpdateStreamsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.migrationhub.paginators.ListProgressUpdateStreamsIterable responses = client
             .listProgressUpdateStreamsPaginator(request);
     for (software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.migrationhub.paginators.ListProgressUpdateStreamsIterable responses = client.listProgressUpdateStreamsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProgressUpdateStreamsPaginator

default ListProgressUpdateStreamsIterable listProgressUpdateStreamsPaginator(Consumer<ListProgressUpdateStreamsRequest.Builder> listProgressUpdateStreamsRequest)
                                                                      throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
InvalidInputException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

This is a variant of listProgressUpdateStreams(software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.migrationhub.paginators.ListProgressUpdateStreamsIterable responses = client.listProgressUpdateStreamsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.migrationhub.paginators.ListProgressUpdateStreamsIterable responses = client
             .listProgressUpdateStreamsPaginator(request);
     for (software.amazon.awssdk.services.migrationhub.model.ListProgressUpdateStreamsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.migrationhub.paginators.ListProgressUpdateStreamsIterable responses = client.listProgressUpdateStreamsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListProgressUpdateStreamsRequest.builder()

Parameters:

listProgressUpdateStreamsRequest - A Consumer that will call methods on ListProgressUpdateStreamsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

notifyApplicationState

default NotifyApplicationStateResponse notifyApplicationState(NotifyApplicationStateRequest notifyApplicationStateRequest)
                                                       throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
PolicyErrorException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

Parameters:

notifyApplicationStateRequest -

Returns:

Result of the NotifyApplicationState operation returned by the service.

See Also:

• AWS API Documentation

notifyApplicationState

default NotifyApplicationStateResponse notifyApplicationState(Consumer<NotifyApplicationStateRequest.Builder> notifyApplicationStateRequest)
                                                       throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
PolicyErrorException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

This is a convenience which creates an instance of the NotifyApplicationStateRequest.Builder avoiding the need to create one manually via NotifyApplicationStateRequest.builder()

Parameters:

notifyApplicationStateRequest - A Consumer that will call methods on NotifyApplicationStateRequest.Builder to create a request.

Returns:

Result of the NotifyApplicationState operation returned by the service.

See Also:

• AWS API Documentation

notifyMigrationTaskState

default NotifyMigrationTaskStateResponse notifyMigrationTaskState(NotifyMigrationTaskStateRequest notifyMigrationTaskStateRequest)
                                                           throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

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

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

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

Parameters:

notifyMigrationTaskStateRequest -

Returns:

Result of the NotifyMigrationTaskState operation returned by the service.

See Also:

• AWS API Documentation

notifyMigrationTaskState

default NotifyMigrationTaskStateResponse notifyMigrationTaskState(Consumer<NotifyMigrationTaskStateRequest.Builder> notifyMigrationTaskStateRequest)
                                                           throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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

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

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

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

This is a convenience which creates an instance of the NotifyMigrationTaskStateRequest.Builder avoiding the need to create one manually via NotifyMigrationTaskStateRequest.builder()

Parameters:

notifyMigrationTaskStateRequest - A Consumer that will call methods on NotifyMigrationTaskStateRequest.Builder to create a request.

Returns:

Result of the NotifyMigrationTaskState operation returned by the service.

See Also:

• AWS API Documentation

putResourceAttributes

default PutResourceAttributesResponse putResourceAttributes(PutResourceAttributesRequest putResourceAttributesRequest)
                                                     throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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:

Result of the PutResourceAttributes operation returned by the service.

See Also:

• AWS API Documentation

putResourceAttributes

default PutResourceAttributesResponse putResourceAttributes(Consumer<PutResourceAttributesRequest.Builder> putResourceAttributesRequest)
                                                     throws AccessDeniedException,
ThrottlingException,
InternalServerErrorException,
ServiceUnavailableException,
DryRunOperationException,
UnauthorizedOperationException,
InvalidInputException,
ResourceNotFoundException,
HomeRegionNotSetException,
AwsServiceException,
SdkClientException,
MigrationHubException

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 via PutResourceAttributesRequest.builder()

Parameters:

putResourceAttributesRequest - A Consumer that will call methods on PutResourceAttributesRequest.Builder to create a request.

Returns:

Result of the PutResourceAttributes operation returned by the service.

See Also:

• AWS API Documentation

create

static MigrationHubClient create()

Create a MigrationHubClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static MigrationHubClientBuilder builder()

Create a builder that can be used to configure and create a MigrationHubClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default MigrationHubServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration