- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
MigrationHubClient
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.
Installation
npm install @aws-sdk/client-migration-hub
yarn add @aws-sdk/client-migration-hub
pnpm add @aws-sdk/client-migration-hub
MigrationHubClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
AssociateCreatedArtifactCommand | 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:
|
AssociateDiscoveredResourceCommand | Associates a discovered resource ID from Application Discovery Service with a migration task. |
AssociateSourceResourceCommand | Associates a source resource with a migration task. For example, the source resource can be a source server, an application, or a migration wave. |
CreateProgressUpdateStreamCommand | 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. |
DeleteProgressUpdateStreamCommand | 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:
|
DescribeApplicationStateCommand | Gets the migration status of an application. |
DescribeMigrationTaskCommand | Retrieves a list of all attributes associated with a specific migration task. |
DisassociateCreatedArtifactCommand | 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:
|
DisassociateDiscoveredResourceCommand | Disassociate an Application Discovery Service discovered resource from a migration task. |
DisassociateSourceResourceCommand | Removes the association between a source resource and a migration task. |
ImportMigrationTaskCommand | 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 |
ListApplicationStatesCommand | Lists all the migration statuses for your applications. If you use the optional |
ListCreatedArtifactsCommand | Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits:
|
ListDiscoveredResourcesCommand | Lists discovered resources associated with the given |
ListMigrationTaskUpdatesCommand | This is a paginated API that returns all the migration-task states for the specified |
ListMigrationTasksCommand | Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits:
|
ListProgressUpdateStreamsCommand | Lists progress update streams associated with the user account making this call. |
ListSourceResourcesCommand | Lists all the source resource that are associated with the specified |
NotifyApplicationStateCommand | Sets the migration state of an application. For a given application identified by the value passed to |
NotifyMigrationTaskStateCommand | Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:
|
PutResourceAttributesCommand | 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
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 |
MigrationHubClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: MigrationHubClientConfig