Class: AWS.MigrationHub
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.MigrationHub
- Identifier:
- migrationhub
- API Version:
- 2017-05-31
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
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.
Sending a Request Using MigrationHub
var migrationhub = new AWS.MigrationHub();
migrationhub.associateCreatedArtifact(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the MigrationHub object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var migrationhub = new AWS.MigrationHub({apiVersion: '2017-05-31'});
You can also set the API version globally in AWS.config.apiVersions
using
the migrationhub service identifier:
AWS.config.apiVersions = {
migrationhub: '2017-05-31',
// other service API versions
};
var migrationhub = new AWS.MigrationHub();
Constructor Summary collapse
-
new AWS.MigrationHub(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
associateCreatedArtifact(params = {}, callback) ⇒ AWS.Request
Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool.
-
associateDiscoveredResource(params = {}, callback) ⇒ AWS.Request
Associates a discovered resource ID from Application Discovery Service with a migration task.
.
-
createProgressUpdateStream(params = {}, callback) ⇒ AWS.Request
Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account.
-
deleteProgressUpdateStream(params = {}, callback) ⇒ AWS.Request
Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control.
-
describeApplicationState(params = {}, callback) ⇒ AWS.Request
Gets the migration status of an application.
.
-
describeMigrationTask(params = {}, callback) ⇒ AWS.Request
Retrieves a list of all attributes associated with a specific migration task.
.
-
disassociateCreatedArtifact(params = {}, callback) ⇒ AWS.Request
Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated.
-
disassociateDiscoveredResource(params = {}, callback) ⇒ AWS.Request
Disassociate an Application Discovery Service discovered resource from a migration task.
.
-
importMigrationTask(params = {}, callback) ⇒ AWS.Request
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. -
listApplicationStates(params = {}, callback) ⇒ AWS.Request
Lists all the migration statuses for your applications.
-
listCreatedArtifacts(params = {}, callback) ⇒ AWS.Request
Lists the created artifacts attached to a given migration task in an update stream.
-
listDiscoveredResources(params = {}, callback) ⇒ AWS.Request
Lists discovered resources associated with the given
MigrationTask
..
-
listMigrationTasks(params = {}, callback) ⇒ AWS.Request
Lists all, or filtered by resource name, migration tasks associated with the user account making this call.
-
listProgressUpdateStreams(params = {}, callback) ⇒ AWS.Request
Lists progress update streams associated with the user account making this call.
.
-
notifyApplicationState(params = {}, callback) ⇒ AWS.Request
Sets the migration state of an application.
-
notifyMigrationTaskState(params = {}, callback) ⇒ AWS.Request
Notifies Migration Hub of the current status, progress, or other detail regarding a migration task.
-
putResourceAttributes(params = {}, callback) ⇒ AWS.Request
Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.MigrationHub(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
associateCreatedArtifact(params = {}, callback) ⇒ AWS.Request
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.
associateDiscoveredResource(params = {}, callback) ⇒ AWS.Request
Associates a discovered resource ID from Application Discovery Service with a migration task.
createProgressUpdateStream(params = {}, callback) ⇒ AWS.Request
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(params = {}, callback) ⇒ AWS.Request
Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits:
-
The only parameter needed for
DeleteProgressUpdateStream
is the stream name (same as aCreateProgressUpdateStream
call). -
The call will return, and a background process will asynchronously delete the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts).
-
If the stream takes time to be deleted, it might still show up on a
ListProgressUpdateStreams
call. -
CreateProgressUpdateStream
,ImportMigrationTask
,NotifyMigrationTaskState
, and all Associate[*] APIs related to the tasks belonging to the stream will throw "InvalidInputException" if the stream of the same name is in the process of being deleted. -
Once the stream and all of its resources are deleted,
CreateProgressUpdateStream
for a stream of the same name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream).
describeApplicationState(params = {}, callback) ⇒ AWS.Request
Gets the migration status of an application.
describeMigrationTask(params = {}, callback) ⇒ AWS.Request
Retrieves a list of all attributes associated with a specific migration task.
disassociateCreatedArtifact(params = {}, callback) ⇒ AWS.Request
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.
disassociateDiscoveredResource(params = {}, callback) ⇒ AWS.Request
Disassociate an Application Discovery Service discovered resource from a migration task.
importMigrationTask(params = {}, callback) ⇒ AWS.Request
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.
listApplicationStates(params = {}, callback) ⇒ AWS.Request
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(params = {}, callback) ⇒ AWS.Request
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.
listDiscoveredResources(params = {}, callback) ⇒ AWS.Request
Lists discovered resources associated with the given MigrationTask
.
listMigrationTasks(params = {}, callback) ⇒ AWS.Request
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.
listProgressUpdateStreams(params = {}, callback) ⇒ AWS.Request
Lists progress update streams associated with the user account making this call.
notifyApplicationState(params = {}, callback) ⇒ AWS.Request
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(params = {}, callback) ⇒ AWS.Request
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.
putResourceAttributes(params = {}, callback) ⇒ AWS.Request
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.
ListDiscoveredResources
.