MigrationHub class

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.

Constructors

MigrationHub({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

associateCreatedArtifact({required CreatedArtifact createdArtifact, required String migrationTaskName, required String progressUpdateStream, bool? dryRun}) → Future<void>
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:
associateDiscoveredResource({required DiscoveredResource discoveredResource, required String migrationTaskName, required String progressUpdateStream, bool? dryRun}) → Future<void>
Associates a discovered resource ID from Application Discovery Service with a migration task.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createProgressUpdateStream({required String progressUpdateStreamName, bool? dryRun}) → Future<void>
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.
deleteProgressUpdateStream({required String progressUpdateStreamName, bool? dryRun}) → Future<void>
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:
describeApplicationState({required String applicationId}) → Future<DescribeApplicationStateResult>
Gets the migration status of an application.
describeMigrationTask({required String migrationTaskName, required String progressUpdateStream}) → Future<DescribeMigrationTaskResult>
Retrieves a list of all attributes associated with a specific migration task.
disassociateCreatedArtifact({required String createdArtifactName, required String migrationTaskName, required String progressUpdateStream, bool? dryRun}) → Future<void>
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:
disassociateDiscoveredResource({required String configurationId, required String migrationTaskName, required String progressUpdateStream, bool? dryRun}) → Future<void>
Disassociate an Application Discovery Service discovered resource from a migration task.
importMigrationTask({required String migrationTaskName, required String progressUpdateStream, bool? dryRun}) → Future<void>
Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.
listApplicationStates({List<String>? applicationIds, int? maxResults, String? nextToken}) → Future<ListApplicationStatesResult>
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.
listCreatedArtifacts({required String migrationTaskName, required String progressUpdateStream, int? maxResults, String? nextToken}) → Future<ListCreatedArtifactsResult>
Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits:
listDiscoveredResources({required String migrationTaskName, required String progressUpdateStream, int? maxResults, String? nextToken}) → Future<ListDiscoveredResourcesResult>
Lists discovered resources associated with the given MigrationTask.
listMigrationTasks({int? maxResults, String? nextToken, String? resourceName}) → Future<ListMigrationTasksResult>
Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits:
listProgressUpdateStreams({int? maxResults, String? nextToken}) → Future<ListProgressUpdateStreamsResult>
Lists progress update streams associated with the user account making this call.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyApplicationState({required String applicationId, required ApplicationStatus status, bool? dryRun, DateTime? updateDateTime}) → Future<void>
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.
notifyMigrationTaskState({required String migrationTaskName, required int nextUpdateSeconds, required String progressUpdateStream, required Task task, required DateTime updateDateTime, bool? dryRun}) → Future<void>
Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:
putResourceAttributes({required String migrationTaskName, required String progressUpdateStream, required List<ResourceAttribute> resourceAttributeList, bool? dryRun}) → Future<void>
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.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited