(constructor)

[configuration]

Constructs a new instance of the <code>MigrationHubClient</code> class

config

The resolved configuration of MigrationHubClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-migration-hub!MigrationHubClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

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 <code>HomeRegionNotSetException</code> error will be returned. Also, you must make the API calls while in your home region.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

profile

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

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

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: <ul> <li> Migration tools can call the <code>AssociateCreatedArtifact</code> operation to indicate which AWS artifact is associated with a migration task. </li> <li> The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: <code>arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b</code>. </li> <li> Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, etc. </li> </ul>

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: <ul> <li> The only parameter needed for <code>DeleteProgressUpdateStream</code> is the stream name (same as a <code>CreateProgressUpdateStream</code> call). </li> <li> 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). </li> <li> If the stream takes time to be deleted, it might still show up on a <code>ListProgressUpdateStreams</code> call. </li> <li> <code>CreateProgressUpdateStream</code>, <code>ImportMigrationTask</code>, <code>NotifyMigrationTaskState</code>, 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. </li> <li> Once the stream and all of its resources are deleted, <code>CreateProgressUpdateStream</code> 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). </li> </ul>

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: <ul> <li> A migration user can call the <code>DisassociateCreatedArtifacts</code> operation to disassociate a created AWS Artifact from a migration task. </li> <li> The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: <code>arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b</code>. </li> <li> Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or RDS instance, etc. </li> </ul>

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 <code>NotifyMigrationTaskState</code> API as the migration tool must first register the migration task with Migration Hub.

ListApplicationStatesCommand

Lists all the migration statuses for your applications. If you use the optional <code>ApplicationIds</code> parameter, only the migration statuses for those applications will be returned.

ListCreatedArtifactsCommand

Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits: <ul> <li> Gets the list of the created artifacts while migration is taking place. </li> <li> Shows the artifacts created by the migration tool that was associated by the <code>AssociateCreatedArtifact</code> API. </li> <li> Lists created artifacts in a paginated interface. </li> </ul>

ListDiscoveredResourcesCommand

Lists discovered resources associated with the given <code>MigrationTask</code>.

ListMigrationTaskUpdatesCommand

This is a paginated API that returns all the migration-task states for the specified <code>MigrationTaskName</code> and <code>ProgressUpdateStream</code>.

ListMigrationTasksCommand

Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits: <ul> <li> Can show a summary list of the most recent migration tasks. </li> <li> Can show a summary list of migration tasks associated with a given discovered resource. </li> <li> Lists migration tasks in a paginated interface. </li> </ul>

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 <code>MigrationTaskName</code> and <code>ProgressUpdateStream</code>.

NotifyApplicationStateCommand

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

NotifyMigrationTaskStateCommand

Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits: <ul> <li> Migration tools will call the <code>NotifyMigrationTaskState</code> API to share the latest progress and status. </li> <li> <code>MigrationTaskName</code> is used for addressing updates to the correct target. </li> <li> <code>ProgressUpdateStream</code> is used for access control and to provide a namespace for each migration tool. </li> </ul>

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 <code>PutResourceAttributes</code> returns. <important> <ul> <li> 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. </li> <li> Note the instructions regarding the special use case of the <a href="https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#migrationhub-PutResourceAttributes-request-ResourceAttributeList"> <code>ResourceAttributeList</code> </a> parameter when specifying any "VM" related value. </li> </ul> </important> <note> 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 <code>ListDiscoveredResources</code>. </note>