Class: AWS.MigrationHub

Inherits:
AWS.Service show all
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.

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();

Version:

  • 2017-05-31

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

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.

Examples:

Constructing a MigrationHub object

var migrationhub = new AWS.MigrationHub({apiVersion: '2017-05-31'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.MigrationHub.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.MigrationHub.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.MigrationHub.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

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.

Service Reference:

Examples:

Calling the associateCreatedArtifact operation

var params = {
  CreatedArtifact: { /* required */
    Name: 'STRING_VALUE', /* required */
    Description: 'STRING_VALUE'
  },
  MigrationTaskName: 'STRING_VALUE', /* required */
  ProgressUpdateStream: 'STRING_VALUE', /* required */
  DryRun: true || false
};
migrationhub.associateCreatedArtifact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProgressUpdateStream — (String)

      The name of the ProgressUpdateStream.

    • MigrationTaskName — (String)

      Unique identifier that references the migration task.

    • CreatedArtifact — (map)

      An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)

      • Name — required — (String)

        An ARN that uniquely identifies the result of a migration task.

      • Description — (String)

        A description that can be free-form text to record additional detail about the artifact for clarity or for later reference.

    • DryRun — (Boolean)

      Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateDiscoveredResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the associateDiscoveredResource operation

var params = {
  DiscoveredResource: { /* required */
    ConfigurationId: 'STRING_VALUE', /* required */
    Description: 'STRING_VALUE'
  },
  MigrationTaskName: 'STRING_VALUE', /* required */
  ProgressUpdateStream: 'STRING_VALUE', /* required */
  DryRun: true || false
};
migrationhub.associateDiscoveredResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProgressUpdateStream — (String)

      The name of the ProgressUpdateStream.

    • MigrationTaskName — (String)

      The identifier given to the MigrationTask.

    • DiscoveredResource — (map)

      Object representing a Resource.

      • ConfigurationId — required — (String)

        The configurationId in ADS that uniquely identifies the on-premise resource.

      • Description — (String)

        A description that can be free-form text to record additional detail about the discovered resource for clarity or later reference.

    • DryRun — (Boolean)

      Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the createProgressUpdateStream operation

var params = {
  ProgressUpdateStreamName: 'STRING_VALUE', /* required */
  DryRun: true || false
};
migrationhub.createProgressUpdateStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProgressUpdateStreamName — (String)

      The name of the ProgressUpdateStream.

    • DryRun — (Boolean)

      Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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 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 realted 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).

Service Reference:

Examples:

Calling the deleteProgressUpdateStream operation

var params = {
  ProgressUpdateStreamName: 'STRING_VALUE', /* required */
  DryRun: true || false
};
migrationhub.deleteProgressUpdateStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProgressUpdateStreamName — (String)

      The name of the ProgressUpdateStream.

    • DryRun — (Boolean)

      Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeApplicationState(params = {}, callback) ⇒ AWS.Request

Gets the migration status of an application.

Service Reference:

Examples:

Calling the describeApplicationState operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
migrationhub.describeApplicationState(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String)

      The configurationId in ADS that uniquely identifies the grouped application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationStatus — (String)

        Status of the application - Not Started, In-Progress, Complete.

        Possible values include:
        • "NOT_STARTED"
        • "IN_PROGRESS"
        • "COMPLETED"
      • LastUpdatedTime — (Date)

        The timestamp when the application status was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeMigrationTask(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeMigrationTask operation

var params = {
  MigrationTaskName: 'STRING_VALUE', /* required */
  ProgressUpdateStream: 'STRING_VALUE' /* required */
};
migrationhub.describeMigrationTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProgressUpdateStream — (String)

      The name of the ProgressUpdateStream.

    • MigrationTaskName — (String)

      The identifier given to the MigrationTask.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MigrationTask — (map)

        Object encapsulating information about the migration task.

        • ProgressUpdateStream — (String)

          A name that identifies the vendor of the migration tool being used.

        • MigrationTaskName — (String)

          Unique identifier that references the migration task.

        • Task — (map)

          Task object encapsulating task information.

          • Status — required — (String)

            Status of the task - Not Started, In-Progress, Complete.

            Possible values include:
            • "NOT_STARTED"
            • "IN_PROGRESS"
            • "FAILED"
            • "COMPLETED"
          • StatusDetail — (String)

            Details of task status as notified by a migration tool. A tool might use this field to provide clarifying information about the status that is unique to that tool or that explains an error state.

          • ProgressPercent — (Integer)

            Indication of the percentage completion of the task.

        • UpdateDateTime — (Date)

          The timestamp when the task was gathered.

        • ResourceAttributeList — (Array<map>)

          • Type — required — (String)

            Type of resource.

            Possible values include:
            • "IPV4_ADDRESS"
            • "IPV6_ADDRESS"
            • "MAC_ADDRESS"
            • "FQDN"
            • "VM_MANAGER_ID"
            • "VM_MANAGED_OBJECT_REFERENCE"
            • "VM_NAME"
            • "VM_PATH"
            • "BIOS_ID"
            • "MOTHERBOARD_SERIAL_NUMBER"
          • Value — required — (String)

            Value of the resource type.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the disassociateCreatedArtifact operation

var params = {
  CreatedArtifactName: 'STRING_VALUE', /* required */
  MigrationTaskName: 'STRING_VALUE', /* required */
  ProgressUpdateStream: 'STRING_VALUE', /* required */
  DryRun: true || false
};
migrationhub.disassociateCreatedArtifact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProgressUpdateStream — (String)

      The name of the ProgressUpdateStream.

    • MigrationTaskName — (String)

      Unique identifier that references the migration task to be disassociated with the artifact.

    • CreatedArtifactName — (String)

      An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)

    • DryRun — (Boolean)

      Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disassociateDiscoveredResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the disassociateDiscoveredResource operation

var params = {
  ConfigurationId: 'STRING_VALUE', /* required */
  MigrationTaskName: 'STRING_VALUE', /* required */
  ProgressUpdateStream: 'STRING_VALUE', /* required */
  DryRun: true || false
};
migrationhub.disassociateDiscoveredResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProgressUpdateStream — (String)

      The name of the ProgressUpdateStream.

    • MigrationTaskName — (String)

      The identifier given to the MigrationTask.

    • ConfigurationId — (String)

      ConfigurationId of the ADS resource to be disassociated.

    • DryRun — (Boolean)

      Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the importMigrationTask operation

var params = {
  MigrationTaskName: 'STRING_VALUE', /* required */
  ProgressUpdateStream: 'STRING_VALUE', /* required */
  DryRun: true || false
};
migrationhub.importMigrationTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProgressUpdateStream — (String)

      The name of the ProgressUpdateStream.

    • MigrationTaskName — (String)

      Unique identifier that references the migration task.

    • DryRun — (Boolean)

      Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the listCreatedArtifacts operation

var params = {
  MigrationTaskName: 'STRING_VALUE', /* required */
  ProgressUpdateStream: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
migrationhub.listCreatedArtifacts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProgressUpdateStream — (String)

      The name of the ProgressUpdateStream.

    • MigrationTaskName — (String)

      Unique identifier that references the migration task.

    • NextToken — (String)

      If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

    • MaxResults — (Integer)

      Maximum number of results to be returned per page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        If there are more created artifacts than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

      • CreatedArtifactList — (Array<map>)

        List of created artifacts up to the maximum number of results specified in the request.

        • Name — required — (String)

          An ARN that uniquely identifies the result of a migration task.

        • Description — (String)

          A description that can be free-form text to record additional detail about the artifact for clarity or for later reference.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDiscoveredResources(params = {}, callback) ⇒ AWS.Request

Lists discovered resources associated with the given MigrationTask.

Service Reference:

Examples:

Calling the listDiscoveredResources operation

var params = {
  MigrationTaskName: 'STRING_VALUE', /* required */
  ProgressUpdateStream: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
migrationhub.listDiscoveredResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProgressUpdateStream — (String)

      The name of the ProgressUpdateStream.

    • MigrationTaskName — (String)

      The name of the MigrationTask.

    • NextToken — (String)

      If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

    • MaxResults — (Integer)

      The maximum number of results returned per page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        If there are more discovered resources than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

      • DiscoveredResourceList — (Array<map>)

        Returned list of discovered resources associated with the given MigrationTask.

        • ConfigurationId — required — (String)

          The configurationId in ADS that uniquely identifies the on-premise resource.

        • Description — (String)

          A description that can be free-form text to record additional detail about the discovered resource for clarity or later reference.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the listMigrationTasks operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceName: 'STRING_VALUE'
};
migrationhub.listMigrationTasks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

    • MaxResults — (Integer)

      Value to specify how many results are returned per page.

    • ResourceName — (String)

      Filter migration tasks by discovered resource name.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        If there are more migration tasks than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

      • MigrationTaskSummaryList — (Array<map>)

        Lists the migration task's summary which includes: MigrationTaskName, ProgressPercent, ProgressUpdateStream, Status, and the UpdateDateTime for each task.

        • ProgressUpdateStream — (String)

          An AWS resource used for access control. It should uniquely identify the migration tool as it is used for all updates made by the tool.

        • MigrationTaskName — (String)

          Unique identifier that references the migration task.

        • Status — (String)

          Status of the task.

          Possible values include:
          • "NOT_STARTED"
          • "IN_PROGRESS"
          • "FAILED"
          • "COMPLETED"
        • ProgressPercent — (Integer)

        • StatusDetail — (String)

          Detail information of what is being done within the overall status state.

        • UpdateDateTime — (Date)

          The timestamp when the task was gathered.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listProgressUpdateStreams(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listProgressUpdateStreams operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
migrationhub.listProgressUpdateStreams(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

    • MaxResults — (Integer)

      Filter to limit the maximum number of results to list per page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProgressUpdateStreamSummaryList — (Array<map>)

        List of progress update streams up to the max number of results passed in the input.

        • ProgressUpdateStreamName — (String)

          The name of the ProgressUpdateStream.

      • NextToken — (String)

        If there are more streams created than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the notifyApplicationState operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  Status: NOT_STARTED | IN_PROGRESS | COMPLETED, /* required */
  DryRun: true || false
};
migrationhub.notifyApplicationState(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String)

      The configurationId in ADS that uniquely identifies the grouped application.

    • Status — (String)

      Status of the application - Not Started, In-Progress, Complete.

      Possible values include:
      • "NOT_STARTED"
      • "IN_PROGRESS"
      • "COMPLETED"
    • DryRun — (Boolean)

      Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the notifyMigrationTaskState operation

var params = {
  MigrationTaskName: 'STRING_VALUE', /* required */
  NextUpdateSeconds: 'NUMBER_VALUE', /* required */
  ProgressUpdateStream: 'STRING_VALUE', /* required */
  Task: { /* required */
    Status: NOT_STARTED | IN_PROGRESS | FAILED | COMPLETED, /* required */
    ProgressPercent: 'NUMBER_VALUE',
    StatusDetail: 'STRING_VALUE'
  },
  UpdateDateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  DryRun: true || false
};
migrationhub.notifyMigrationTaskState(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProgressUpdateStream — (String)

      The name of the ProgressUpdateStream.

    • MigrationTaskName — (String)

      Unique identifier that references the migration task.

    • Task — (map)

      Information about the task's progress and status.

      • Status — required — (String)

        Status of the task - Not Started, In-Progress, Complete.

        Possible values include:
        • "NOT_STARTED"
        • "IN_PROGRESS"
        • "FAILED"
        • "COMPLETED"
      • StatusDetail — (String)

        Details of task status as notified by a migration tool. A tool might use this field to provide clarifying information about the status that is unique to that tool or that explains an error state.

      • ProgressPercent — (Integer)

        Indication of the percentage completion of the task.

    • UpdateDateTime — (Date)

      The timestamp when the task was gathered.

    • NextUpdateSeconds — (Integer)

      Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale.

    • DryRun — (Boolean)

      Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putResourceAttributes(params = {}, callback) ⇒ AWS.Request

Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s 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 overiding the MAC address.

  • Note the instructions regarding the special use case of the ResourceAttributeList parameter when specifying any "VM" related value.

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 ListDiscoveredResources.

Service Reference:

Examples:

Calling the putResourceAttributes operation

var params = {
  MigrationTaskName: 'STRING_VALUE', /* required */
  ProgressUpdateStream: 'STRING_VALUE', /* required */
  ResourceAttributeList: [ /* required */
    {
      Type: IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER, /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  DryRun: true || false
};
migrationhub.putResourceAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProgressUpdateStream — (String)

      The name of the ProgressUpdateStream.

    • MigrationTaskName — (String)

      Unique identifier that references the migration task.

    • ResourceAttributeList — (Array<map>)

      Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service (ADS)'s repository.

      Note: Takes the object array of ResourceAttribute where the Type field is reserved for the following values: IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER where the identifying value can be a string up to 256 characters.

      • If any "VM" related value is set for a ResourceAttribute object, it is required that VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID is not set, then all "VM" fields will be discarded and "VM" fields will not be used for matching the migration task to a server in Application Discovery Service (ADS)'s repository. See the Example section below for a use case of specifying "VM" related values.

      • If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the ResourceAttributeList parameter to maximize the chances of matching.
      • Type — required — (String)

        Type of resource.

        Possible values include:
        • "IPV4_ADDRESS"
        • "IPV6_ADDRESS"
        • "MAC_ADDRESS"
        • "FQDN"
        • "VM_MANAGER_ID"
        • "VM_MANAGED_OBJECT_REFERENCE"
        • "VM_NAME"
        • "VM_PATH"
        • "BIOS_ID"
        • "MOTHERBOARD_SERIAL_NUMBER"
      • Value — required — (String)

        Value of the resource type.

    • DryRun — (Boolean)

      Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.