You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Mgn

Inherits:
AWS.Service show all
Identifier:
mgn
API Version:
2020-02-26
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

The Application Migration Service service.

Sending a Request Using Mgn

var mgn = new AWS.Mgn();
mgn.terminateTargetInstances(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 Mgn object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var mgn = new AWS.Mgn({apiVersion: '2020-02-26'});

You can also set the API version globally in AWS.config.apiVersions using the mgn service identifier:

AWS.config.apiVersions = {
  mgn: '2020-02-26',
  // other service API versions
};

var mgn = new AWS.Mgn();

Version:

  • 2020-02-26

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Mgn(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Mgn object

var mgn = new AWS.Mgn({apiVersion: '2020-02-26'});

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|AWS.Endpoint) —

    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' or an Endpoint object.

  • 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.Mgn.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Mgn.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.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets 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 error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • 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|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

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

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

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

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

Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER. This command only works if the Source Server is already launchable (dataReplicationInfo.lagDuration is not null.)

Service Reference:

Examples:

Calling the changeServerLifeCycleState operation

var params = {
  lifeCycle: { /* required */
    state: READY_FOR_TEST | READY_FOR_CUTOVER | CUTOVER /* required */
  },
  sourceServerID: 'STRING_VALUE' /* required */
};
mgn.changeServerLifeCycleState(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: {}) —
    • lifeCycle — (map)

      The request to change the source server migration lifecycle state.

      • state — required — (String)

        The request to change the source server migration lifecycle state.

        Possible values include:
        • "READY_FOR_TEST"
        • "READY_FOR_CUTOVER"
        • "CUTOVER"
    • sourceServerID — (String)

      The request to change the source server migration lifecycle state by source server ID.

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:

      • arn — (String)

        Source server ARN.

      • dataReplicationInfo — (map)

        Source server data replication info.

        • dataReplicationError — (map)

          Error in obtaining data replication info.

          • error — (String)

            Error in data replication.

            Possible values include:
            • "AGENT_NOT_SEEN"
            • "SNAPSHOTS_FAILURE"
            • "NOT_CONVERGING"
            • "UNSTABLE_NETWORK"
            • "FAILED_TO_CREATE_SECURITY_GROUP"
            • "FAILED_TO_LAUNCH_REPLICATION_SERVER"
            • "FAILED_TO_BOOT_REPLICATION_SERVER"
            • "FAILED_TO_AUTHENTICATE_WITH_SERVICE"
            • "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE"
            • "FAILED_TO_CREATE_STAGING_DISKS"
            • "FAILED_TO_ATTACH_STAGING_DISKS"
            • "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT"
            • "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER"
            • "FAILED_TO_START_DATA_TRANSFER"
          • rawError — (String)

            Error in data replication.

        • dataReplicationInitiation — (map)

          Request to query whether data replication has been initiated.

          • nextAttemptDateTime — (String)

            Request to query next data initiation date and time.

          • startDateTime — (String)

            Request to query data initiation start date and time.

          • steps — (Array<map>)

            Request to query data initiation steps.

            • name — (String)

              Request to query data initiation step name.

              Possible values include:
              • "WAIT"
              • "CREATE_SECURITY_GROUP"
              • "LAUNCH_REPLICATION_SERVER"
              • "BOOT_REPLICATION_SERVER"
              • "AUTHENTICATE_WITH_SERVICE"
              • "DOWNLOAD_REPLICATION_SOFTWARE"
              • "CREATE_STAGING_DISKS"
              • "ATTACH_STAGING_DISKS"
              • "PAIR_REPLICATION_SERVER_WITH_AGENT"
              • "CONNECT_AGENT_TO_REPLICATION_SERVER"
              • "START_DATA_TRANSFER"
            • status — (String)

              Request to query data initiation status.

              Possible values include:
              • "NOT_STARTED"
              • "IN_PROGRESS"
              • "SUCCEEDED"
              • "FAILED"
              • "SKIPPED"
        • dataReplicationState — (String)

          Request to query the data replication state.

          Possible values include:
          • "STOPPED"
          • "INITIATING"
          • "INITIAL_SYNC"
          • "BACKLOG"
          • "CREATING_SNAPSHOT"
          • "CONTINUOUS"
          • "PAUSED"
          • "RESCAN"
          • "STALLED"
          • "DISCONNECTED"
        • etaDateTime — (String)

          Request to query the time when data replication will be complete.

        • lagDuration — (String)

          Request to query data replication lag durating.

        • replicatedDisks — (Array<map>)

          Request to query disks replicated.

          • backloggedStorageBytes — (Integer)

            Request to query data replication backlog size in bytes.

          • deviceName — (String)

            Request to query device name.

          • replicatedStorageBytes — (Integer)

            Request to query amount of data replicated in bytes.

          • rescannedStorageBytes — (Integer)

            Request to query amount of data rescanned in bytes.

          • totalStorageBytes — (Integer)

            Request to query total amount of data replicated in bytes.

      • isArchived — (Boolean)

        Source server archived status.

      • launchedInstance — (map)

        Source server launched instance.

        • ec2InstanceID — (String)

          Configure launced instance EC2 ID.

        • firstBoot — (String)

          Configure launced instance first boot.

          Possible values include:
          • "WAITING"
          • "SUCCEEDED"
          • "UNKNOWN"
          • "STOPPED"
        • jobID — (String)

          Configure launced instance Job ID.

      • lifeCycle — (map)

        Source server lifecycle state.

        • addedToServiceDateTime — (String)

          Lifecycle added to service data and time.

        • elapsedReplicationDuration — (String)

          Lifecycle elapsed time and duration.

        • firstByteDateTime — (String)

          Lifecycle replication initiation date and time.

        • lastCutover — (map)

          Lifecycle last Cutover.

          • finalized — (map)

            Lifecycle Cutover finalized date and time.

            • apiCallDateTime — (String)

              Lifecycle Cutover finalized date and time.

          • initiated — (map)

            Lifecycle last Cutover initiated.

            • apiCallDateTime — (String)

            • jobID — (String)

              Lifecycle last Cutover initiated by Job ID.

          • reverted — (map)

            Lifecycle last Cutover reverted.

            • apiCallDateTime — (String)

              Lifecycle last Cutover reverted API call date time.

        • lastSeenByServiceDateTime — (String)

          Lifecycle last seen date and time.

        • lastTest — (map)

          Lifecycle last Test.

          • finalized — (map)

            Lifecycle last Test finlized.

            • apiCallDateTime — (String)

              Lifecycle Test failed API call date and time.

          • initiated — (map)

            Lifecycle last Test initiated.

            • apiCallDateTime — (String)

              Lifecycle last Test initiated API call date and time.

            • jobID — (String)

              Lifecycle last Test initiated Job ID.

          • reverted — (map)

            Lifecycle last Test reverted.

            • apiCallDateTime — (String)

              Lifecycle last Test reverted API call date and time.

        • state — (String)

          Lifecycle state.

          Possible values include:
          • "STOPPED"
          • "NOT_READY"
          • "READY_FOR_TEST"
          • "TESTING"
          • "READY_FOR_CUTOVER"
          • "CUTTING_OVER"
          • "CUTOVER"
          • "DISCONNECTED"
      • sourceProperties — (map)

        Source server properties.

        • cpus — (Array<map>)

          Source Server CPUs.

          • cores — (Integer)

            The number of CPU cores on the source server.

          • modelName — (String)

            The source server's CPU model name.

        • disks — (Array<map>)

          Source Server disks.

          • bytes — (Integer)

            The amount of storage on the disk in bytes.

          • deviceName — (String)

            The disk or device name.

        • identificationHints — (map)

          Source server identification hints.

          • awsInstanceID — (String)

            AWS Instance ID identification hint.

          • fqdn — (String)

            FQDN address identification hint.

          • hostname — (String)

            Hostname identification hint.

          • vmWareUuid — (String)

            vmWare UUID identification hint.

        • lastUpdatedDateTime — (String)

          Source server last update date and time.

        • networkInterfaces — (Array<map>)

          Source server network interfaces.

          • ips — (Array<String>)

            Network interface IPs.

          • isPrimary — (Boolean)

            Network interface primary IP.

          • macAddress — (String)

            Network interface Mac address.

        • os — (map)

          Source server OS.

          • fullString — (String)

            OS full string.

        • ramBytes — (Integer)

          Source server RAM in bytes.

        • recommendedInstanceType — (String)

          Source server recommended instance type.

      • sourceServerID — (String)

        Source server ID.

      • tags — (map<String>)

        Source server Tags.

Returns:

  • (AWS.Request) —

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

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

Creates a new ReplicationConfigurationTemplate.

Service Reference:

Examples:

Calling the createReplicationConfigurationTemplate operation

var params = {
  associateDefaultSecurityGroup: true || false, /* required */
  bandwidthThrottling: 'NUMBER_VALUE', /* required */
  createPublicIP: true || false, /* required */
  dataPlaneRouting: PRIVATE_IP | PUBLIC_IP, /* required */
  defaultLargeStagingDiskType: GP2 | ST1, /* required */
  ebsEncryption: DEFAULT | CUSTOM, /* required */
  replicationServerInstanceType: 'STRING_VALUE', /* required */
  replicationServersSecurityGroupsIDs: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  stagingAreaSubnetId: 'STRING_VALUE', /* required */
  stagingAreaTags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  useDedicatedReplicationServer: true || false, /* required */
  ebsEncryptionKeyArn: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
mgn.createReplicationConfigurationTemplate(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: {}) —
    • associateDefaultSecurityGroup — (Boolean)

      Request to associate the default Application Migration Service Security group with the Replication Settings template.

    • bandwidthThrottling — (Integer)

      Request to configure bandwidth throttling during Replication Settings template creation.

    • createPublicIP — (Boolean)

      Request to create Public IP during Replication Settings template creation.

    • dataPlaneRouting — (String)

      Request to configure data plane routing during Replication Settings template creation.

      Possible values include:
      • "PRIVATE_IP"
      • "PUBLIC_IP"
    • defaultLargeStagingDiskType — (String)

      Request to configure the Staging Disk EBS volume type to "gp2" during Replication Settings template creation.

      Possible values include:
      • "GP2"
      • "ST1"
    • ebsEncryption — (String)

      Request to configure EBS enryption during Replication Settings template creation.

      Possible values include:
      • "DEFAULT"
      • "CUSTOM"
    • ebsEncryptionKeyArn — (String)

      Request to configure an EBS enryption key during Replication Settings template creation.

    • replicationServerInstanceType — (String)

      Request to configure the Replication Server instance type during Replication Settings template creation.

    • replicationServersSecurityGroupsIDs — (Array<String>)

      Request to configure the Replication Server Secuirity group ID during Replication Settings template creation.

    • stagingAreaSubnetId — (String)

      Request to configure the Staging Area subnet ID during Replication Settings template creation.

    • stagingAreaTags — (map<String>)

      Request to configure Staiging Area tags during Replication Settings template creation.

    • tags — (map<String>)

      Request to configure tags during Replication Settings template creation.

    • useDedicatedReplicationServer — (Boolean)

      Request to use Dedicated Replication Servers during Replication Settings template creation.

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:

      • arn — (String)

        Replication Configuration template ARN.

      • associateDefaultSecurityGroup — (Boolean)

        Replication Configuration template associate default Application Migration Service Security group.

      • bandwidthThrottling — (Integer)

        Replication Configuration template bandwidth throtting.

      • createPublicIP — (Boolean)

        Replication Configuration template create Public IP.

      • dataPlaneRouting — (String)

        Replication Configuration template data plane routing.

        Possible values include:
        • "PRIVATE_IP"
        • "PUBLIC_IP"
      • defaultLargeStagingDiskType — (String)

        Replication Configuration template use dedault large Staging Disk type.

        Possible values include:
        • "GP2"
        • "ST1"
      • ebsEncryption — (String)

        Replication Configuration template EBS encryption.

        Possible values include:
        • "DEFAULT"
        • "CUSTOM"
      • ebsEncryptionKeyArn — (String)

        Replication Configuration template EBS encryption key ARN.

      • replicationConfigurationTemplateID — (String)

        Replication Configuration template template ID.

      • replicationServerInstanceType — (String)

        Replication Configuration template server instance type.

      • replicationServersSecurityGroupsIDs — (Array<String>)

        Replication Configuration template server Security Groups IDs.

      • stagingAreaSubnetId — (String)

        Replication Configuration template Staging Area subnet ID.

      • stagingAreaTags — (map<String>)

        Replication Configuration template Staging Area Tags.

      • tags — (map<String>)

        Replication Configuration template Tags.

      • useDedicatedReplicationServer — (Boolean)

        Replication Configuration template use Dedicated Replication Server.

Returns:

  • (AWS.Request) —

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

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

Deletes a single Job by ID.

Service Reference:

Examples:

Calling the deleteJob operation

var params = {
  jobID: 'STRING_VALUE' /* required */
};
mgn.deleteJob(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: {}) —
    • jobID — (String)

      Request to delete Job from service by Job ID.

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.

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

Deletes a single Replication Configuration Template by ID

Service Reference:

Examples:

Calling the deleteReplicationConfigurationTemplate operation

var params = {
  replicationConfigurationTemplateID: 'STRING_VALUE' /* required */
};
mgn.deleteReplicationConfigurationTemplate(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: {}) —
    • replicationConfigurationTemplateID — (String)

      Request to delete Replication Configuration Template from service by Replication Configuration Template ID.

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.

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

Deletes a single source server by ID.

Service Reference:

Examples:

Calling the deleteSourceServer operation

var params = {
  sourceServerID: 'STRING_VALUE' /* required */
};
mgn.deleteSourceServer(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: {}) —
    • sourceServerID — (String)

      Request to delete Source Server from service by Server ID.

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.

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

Retrieves detailed Job log with paging.

Service Reference:

Examples:

Calling the describeJobLogItems operation

var params = {
  jobID: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
mgn.describeJobLogItems(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: {}) —
    • jobID — (String)

      Request to describe Job log job ID.

    • maxResults — (Integer)

      Request to describe Job log item maximum results.

    • nextToken — (String)

      Request to describe Job log next token.

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:

      • items — (Array<map>)

        Request to describe Job log response items.

        • event — (String)

          Job log event.

          Possible values include:
          • "JOB_START"
          • "SERVER_SKIPPED"
          • "CLEANUP_START"
          • "CLEANUP_END"
          • "CLEANUP_FAIL"
          • "SNAPSHOT_START"
          • "SNAPSHOT_END"
          • "SNAPSHOT_FAIL"
          • "USING_PREVIOUS_SNAPSHOT"
          • "CONVERSION_START"
          • "CONVERSION_END"
          • "CONVERSION_FAIL"
          • "LAUNCH_START"
          • "LAUNCH_FAILED"
          • "JOB_CANCEL"
          • "JOB_END"
        • eventData — (map)

          Job event data

          • conversionServerID — (String)

            Job Event conversion Server ID.

          • rawError — (String)

            Job error.

          • sourceServerID — (String)

            Job Event Source Server ID.

          • targetInstanceID — (String)

            Job Event Target instance ID.

        • logDateTime — (String)

          Job log event date and time.

      • nextToken — (String)

        Request to describe Job log response next token.

Returns:

  • (AWS.Request) —

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

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

Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normaly created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.

Service Reference:

Examples:

Calling the describeJobs operation

var params = {
  filters: { /* required */
    fromDate: 'STRING_VALUE',
    jobIDs: [
      'STRING_VALUE',
      /* more items */
    ],
    toDate: 'STRING_VALUE'
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
mgn.describeJobs(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: {}) —
    • filters — (map)

      Request to describe Job log filters.

      • fromDate — (String)

        Request to describe Job log filters by date.

      • jobIDs — (Array<String>)

        Request to describe Job log filters by job ID.

      • toDate — (String)

        Request to describe Job log by last date.

    • maxResults — (Integer)

      Request to describe Job log by max results.

    • nextToken — (String)

      Request to describe Job logby next token.

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:

      • items — (Array<map>)

        Request to describe Job log items.

        • arn — (String)

          the ARN of the specific Job.

        • creationDateTime — (String)

          Job creation time.

        • endDateTime — (String)

          Job end time.

        • initiatedBy — (String)

          Job initiated by field.

          Possible values include:
          • "START_TEST"
          • "START_CUTOVER"
          • "DIAGNOSTIC"
          • "TERMINATE"
        • jobID — required — (String)

          Job ID.

        • participatingServers — (Array<map>)

          Servers participating in a specific Job.

          • launchStatus — (String)

            Participating server launch status.

            Possible values include:
            • "PENDING"
            • "IN_PROGRESS"
            • "LAUNCHED"
            • "FAILED"
            • "TERMINATED"
          • sourceServerID — (String)

            Participating server Source Server ID.

        • status — (String)

          Job status.

          Possible values include:
          • "PENDING"
          • "STARTED"
          • "COMPLETED"
        • tags — (map<String>)

          Tags associated with spcific Job.

        • type — (String)

          Job type.

          Possible values include:
          • "LAUNCH"
          • "TERMINATE"
      • nextToken — (String)

        Request to describe Job response by next token.

Returns:

  • (AWS.Request) —

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

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

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

Service Reference:

Examples:

Calling the describeReplicationConfigurationTemplates operation

var params = {
  replicationConfigurationTemplateIDs: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
mgn.describeReplicationConfigurationTemplates(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: {}) —
    • maxResults — (Integer)

      Request to describe Replication Configuration template by max results.

    • nextToken — (String)

      Request to describe Replication Configuration template by next token.

    • replicationConfigurationTemplateIDs — (Array<String>)

      Request to describe Replication Configuration template by template IDs.

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:

      • items — (Array<map>)

        Request to describe Replication Configuration template by items.

        • arn — (String)

          Replication Configuration template ARN.

        • associateDefaultSecurityGroup — (Boolean)

          Replication Configuration template associate default Application Migration Service Security group.

        • bandwidthThrottling — (Integer)

          Replication Configuration template bandwidth throtting.

        • createPublicIP — (Boolean)

          Replication Configuration template create Public IP.

        • dataPlaneRouting — (String)

          Replication Configuration template data plane routing.

          Possible values include:
          • "PRIVATE_IP"
          • "PUBLIC_IP"
        • defaultLargeStagingDiskType — (String)

          Replication Configuration template use dedault large Staging Disk type.

          Possible values include:
          • "GP2"
          • "ST1"
        • ebsEncryption — (String)

          Replication Configuration template EBS encryption.

          Possible values include:
          • "DEFAULT"
          • "CUSTOM"
        • ebsEncryptionKeyArn — (String)

          Replication Configuration template EBS encryption key ARN.

        • replicationConfigurationTemplateID — required — (String)

          Replication Configuration template template ID.

        • replicationServerInstanceType — (String)

          Replication Configuration template server instance type.

        • replicationServersSecurityGroupsIDs — (Array<String>)

          Replication Configuration template server Security Groups IDs.

        • stagingAreaSubnetId — (String)

          Replication Configuration template Staging Area subnet ID.

        • stagingAreaTags — (map<String>)

          Replication Configuration template Staging Area Tags.

        • tags — (map<String>)

          Replication Configuration template Tags.

        • useDedicatedReplicationServer — (Boolean)

          Replication Configuration template use Dedicated Replication Server.

      • nextToken — (String)

        Request to describe Replication Configuration template by next token.

Returns:

  • (AWS.Request) —

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

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

Retrieves all SourceServers or multiple SourceServers by ID.

Service Reference:

Examples:

Calling the describeSourceServers operation

var params = {
  filters: { /* required */
    isArchived: true || false,
    sourceServerIDs: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
mgn.describeSourceServers(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: {}) —
    • filters — (map)

      Request to filter Source Servers list.

      • isArchived — (Boolean)

        Request to filter Source Servers list by archived.

      • sourceServerIDs — (Array<String>)

        Request to filter Source Servers list by Source Server ID.

    • maxResults — (Integer)

      Request to filter Source Servers list by maximum results.

    • nextToken — (String)

      Request to filter Source Servers list by next token.

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:

      • items — (Array<map>)

        Request to filter Source Servers list by item.

        • arn — (String)

          Source server ARN.

        • dataReplicationInfo — (map)

          Source server data replication info.

          • dataReplicationError — (map)

            Error in obtaining data replication info.

            • error — (String)

              Error in data replication.

              Possible values include:
              • "AGENT_NOT_SEEN"
              • "SNAPSHOTS_FAILURE"
              • "NOT_CONVERGING"
              • "UNSTABLE_NETWORK"
              • "FAILED_TO_CREATE_SECURITY_GROUP"
              • "FAILED_TO_LAUNCH_REPLICATION_SERVER"
              • "FAILED_TO_BOOT_REPLICATION_SERVER"
              • "FAILED_TO_AUTHENTICATE_WITH_SERVICE"
              • "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE"
              • "FAILED_TO_CREATE_STAGING_DISKS"
              • "FAILED_TO_ATTACH_STAGING_DISKS"
              • "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT"
              • "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER"
              • "FAILED_TO_START_DATA_TRANSFER"
            • rawError — (String)

              Error in data replication.

          • dataReplicationInitiation — (map)

            Request to query whether data replication has been initiated.

            • nextAttemptDateTime — (String)

              Request to query next data initiation date and time.

            • startDateTime — (String)

              Request to query data initiation start date and time.

            • steps — (Array<map>)

              Request to query data initiation steps.

              • name — (String)

                Request to query data initiation step name.

                Possible values include:
                • "WAIT"
                • "CREATE_SECURITY_GROUP"
                • "LAUNCH_REPLICATION_SERVER"
                • "BOOT_REPLICATION_SERVER"
                • "AUTHENTICATE_WITH_SERVICE"
                • "DOWNLOAD_REPLICATION_SOFTWARE"
                • "CREATE_STAGING_DISKS"
                • "ATTACH_STAGING_DISKS"
                • "PAIR_REPLICATION_SERVER_WITH_AGENT"
                • "CONNECT_AGENT_TO_REPLICATION_SERVER"
                • "START_DATA_TRANSFER"
              • status — (String)

                Request to query data initiation status.

                Possible values include:
                • "NOT_STARTED"
                • "IN_PROGRESS"
                • "SUCCEEDED"
                • "FAILED"
                • "SKIPPED"
          • dataReplicationState — (String)

            Request to query the data replication state.

            Possible values include:
            • "STOPPED"
            • "INITIATING"
            • "INITIAL_SYNC"
            • "BACKLOG"
            • "CREATING_SNAPSHOT"
            • "CONTINUOUS"
            • "PAUSED"
            • "RESCAN"
            • "STALLED"
            • "DISCONNECTED"
          • etaDateTime — (String)

            Request to query the time when data replication will be complete.

          • lagDuration — (String)

            Request to query data replication lag durating.

          • replicatedDisks — (Array<map>)

            Request to query disks replicated.

            • backloggedStorageBytes — (Integer)

              Request to query data replication backlog size in bytes.

            • deviceName — (String)

              Request to query device name.

            • replicatedStorageBytes — (Integer)

              Request to query amount of data replicated in bytes.

            • rescannedStorageBytes — (Integer)

              Request to query amount of data rescanned in bytes.

            • totalStorageBytes — (Integer)

              Request to query total amount of data replicated in bytes.

        • isArchived — (Boolean)

          Source server archived status.

        • launchedInstance — (map)

          Source server launched instance.

          • ec2InstanceID — (String)

            Configure launced instance EC2 ID.

          • firstBoot — (String)

            Configure launced instance first boot.

            Possible values include:
            • "WAITING"
            • "SUCCEEDED"
            • "UNKNOWN"
            • "STOPPED"
          • jobID — (String)

            Configure launced instance Job ID.

        • lifeCycle — (map)

          Source server lifecycle state.

          • addedToServiceDateTime — (String)

            Lifecycle added to service data and time.

          • elapsedReplicationDuration — (String)

            Lifecycle elapsed time and duration.

          • firstByteDateTime — (String)

            Lifecycle replication initiation date and time.

          • lastCutover — (map)

            Lifecycle last Cutover.

            • finalized — (map)

              Lifecycle Cutover finalized date and time.

              • apiCallDateTime — (String)

                Lifecycle Cutover finalized date and time.

            • initiated — (map)

              Lifecycle last Cutover initiated.

              • apiCallDateTime — (String)

              • jobID — (String)

                Lifecycle last Cutover initiated by Job ID.

            • reverted — (map)

              Lifecycle last Cutover reverted.

              • apiCallDateTime — (String)

                Lifecycle last Cutover reverted API call date time.

          • lastSeenByServiceDateTime — (String)

            Lifecycle last seen date and time.

          • lastTest — (map)

            Lifecycle last Test.

            • finalized — (map)

              Lifecycle last Test finlized.

              • apiCallDateTime — (String)

                Lifecycle Test failed API call date and time.

            • initiated — (map)

              Lifecycle last Test initiated.

              • apiCallDateTime — (String)

                Lifecycle last Test initiated API call date and time.

              • jobID — (String)

                Lifecycle last Test initiated Job ID.

            • reverted — (map)

              Lifecycle last Test reverted.

              • apiCallDateTime — (String)

                Lifecycle last Test reverted API call date and time.

          • state — (String)

            Lifecycle state.

            Possible values include:
            • "STOPPED"
            • "NOT_READY"
            • "READY_FOR_TEST"
            • "TESTING"
            • "READY_FOR_CUTOVER"
            • "CUTTING_OVER"
            • "CUTOVER"
            • "DISCONNECTED"
        • sourceProperties — (map)

          Source server properties.

          • cpus — (Array<map>)

            Source Server CPUs.

            • cores — (Integer)

              The number of CPU cores on the source server.

            • modelName — (String)

              The source server's CPU model name.

          • disks — (Array<map>)

            Source Server disks.

            • bytes — (Integer)

              The amount of storage on the disk in bytes.

            • deviceName — (String)

              The disk or device name.

          • identificationHints — (map)

            Source server identification hints.

            • awsInstanceID — (String)

              AWS Instance ID identification hint.

            • fqdn — (String)

              FQDN address identification hint.

            • hostname — (String)

              Hostname identification hint.

            • vmWareUuid — (String)

              vmWare UUID identification hint.

          • lastUpdatedDateTime — (String)

            Source server last update date and time.

          • networkInterfaces — (Array<map>)

            Source server network interfaces.

            • ips — (Array<String>)

              Network interface IPs.

            • isPrimary — (Boolean)

              Network interface primary IP.

            • macAddress — (String)

              Network interface Mac address.

          • os — (map)

            Source server OS.

            • fullString — (String)

              OS full string.

          • ramBytes — (Integer)

            Source server RAM in bytes.

          • recommendedInstanceType — (String)

            Source server recommended instance type.

        • sourceServerID — (String)

          Source server ID.

        • tags — (map<String>)

          Source server Tags.

      • nextToken — (String)

        Request to filter Source Servers next token.

Returns:

  • (AWS.Request) —

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

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

Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communciating with the Application Migration Service service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDurationwill be nullified.

Service Reference:

Examples:

Calling the disconnectFromService operation

var params = {
  sourceServerID: 'STRING_VALUE' /* required */
};
mgn.disconnectFromService(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: {}) —
    • sourceServerID — (String)

      Request to disconnect Source Server from service by Server ID.

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:

      • arn — (String)

        Source server ARN.

      • dataReplicationInfo — (map)

        Source server data replication info.

        • dataReplicationError — (map)

          Error in obtaining data replication info.

          • error — (String)

            Error in data replication.

            Possible values include:
            • "AGENT_NOT_SEEN"
            • "SNAPSHOTS_FAILURE"
            • "NOT_CONVERGING"
            • "UNSTABLE_NETWORK"
            • "FAILED_TO_CREATE_SECURITY_GROUP"
            • "FAILED_TO_LAUNCH_REPLICATION_SERVER"
            • "FAILED_TO_BOOT_REPLICATION_SERVER"
            • "FAILED_TO_AUTHENTICATE_WITH_SERVICE"
            • "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE"
            • "FAILED_TO_CREATE_STAGING_DISKS"
            • "FAILED_TO_ATTACH_STAGING_DISKS"
            • "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT"
            • "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER"
            • "FAILED_TO_START_DATA_TRANSFER"
          • rawError — (String)

            Error in data replication.

        • dataReplicationInitiation — (map)

          Request to query whether data replication has been initiated.

          • nextAttemptDateTime — (String)

            Request to query next data initiation date and time.

          • startDateTime — (String)

            Request to query data initiation start date and time.

          • steps — (Array<map>)

            Request to query data initiation steps.

            • name — (String)

              Request to query data initiation step name.

              Possible values include:
              • "WAIT"
              • "CREATE_SECURITY_GROUP"
              • "LAUNCH_REPLICATION_SERVER"
              • "BOOT_REPLICATION_SERVER"
              • "AUTHENTICATE_WITH_SERVICE"
              • "DOWNLOAD_REPLICATION_SOFTWARE"
              • "CREATE_STAGING_DISKS"
              • "ATTACH_STAGING_DISKS"
              • "PAIR_REPLICATION_SERVER_WITH_AGENT"
              • "CONNECT_AGENT_TO_REPLICATION_SERVER"
              • "START_DATA_TRANSFER"
            • status — (String)

              Request to query data initiation status.

              Possible values include:
              • "NOT_STARTED"
              • "IN_PROGRESS"
              • "SUCCEEDED"
              • "FAILED"
              • "SKIPPED"
        • dataReplicationState — (String)

          Request to query the data replication state.

          Possible values include:
          • "STOPPED"
          • "INITIATING"
          • "INITIAL_SYNC"
          • "BACKLOG"
          • "CREATING_SNAPSHOT"
          • "CONTINUOUS"
          • "PAUSED"
          • "RESCAN"
          • "STALLED"
          • "DISCONNECTED"
        • etaDateTime — (String)

          Request to query the time when data replication will be complete.

        • lagDuration — (String)

          Request to query data replication lag durating.

        • replicatedDisks — (Array<map>)

          Request to query disks replicated.

          • backloggedStorageBytes — (Integer)

            Request to query data replication backlog size in bytes.

          • deviceName — (String)

            Request to query device name.

          • replicatedStorageBytes — (Integer)

            Request to query amount of data replicated in bytes.

          • rescannedStorageBytes — (Integer)

            Request to query amount of data rescanned in bytes.

          • totalStorageBytes — (Integer)

            Request to query total amount of data replicated in bytes.

      • isArchived — (Boolean)

        Source server archived status.

      • launchedInstance — (map)

        Source server launched instance.

        • ec2InstanceID — (String)

          Configure launced instance EC2 ID.

        • firstBoot — (String)

          Configure launced instance first boot.

          Possible values include:
          • "WAITING"
          • "SUCCEEDED"
          • "UNKNOWN"
          • "STOPPED"
        • jobID — (String)

          Configure launced instance Job ID.

      • lifeCycle — (map)

        Source server lifecycle state.

        • addedToServiceDateTime — (String)

          Lifecycle added to service data and time.

        • elapsedReplicationDuration — (String)

          Lifecycle elapsed time and duration.

        • firstByteDateTime — (String)

          Lifecycle replication initiation date and time.

        • lastCutover — (map)

          Lifecycle last Cutover.

          • finalized — (map)

            Lifecycle Cutover finalized date and time.

            • apiCallDateTime — (String)

              Lifecycle Cutover finalized date and time.

          • initiated — (map)

            Lifecycle last Cutover initiated.

            • apiCallDateTime — (String)

            • jobID — (String)

              Lifecycle last Cutover initiated by Job ID.

          • reverted — (map)

            Lifecycle last Cutover reverted.

            • apiCallDateTime — (String)

              Lifecycle last Cutover reverted API call date time.

        • lastSeenByServiceDateTime — (String)

          Lifecycle last seen date and time.

        • lastTest — (map)

          Lifecycle last Test.

          • finalized — (map)

            Lifecycle last Test finlized.

            • apiCallDateTime — (String)

              Lifecycle Test failed API call date and time.

          • initiated — (map)

            Lifecycle last Test initiated.

            • apiCallDateTime — (String)

              Lifecycle last Test initiated API call date and time.

            • jobID — (String)

              Lifecycle last Test initiated Job ID.

          • reverted — (map)

            Lifecycle last Test reverted.

            • apiCallDateTime — (String)

              Lifecycle last Test reverted API call date and time.

        • state — (String)

          Lifecycle state.

          Possible values include:
          • "STOPPED"
          • "NOT_READY"
          • "READY_FOR_TEST"
          • "TESTING"
          • "READY_FOR_CUTOVER"
          • "CUTTING_OVER"
          • "CUTOVER"
          • "DISCONNECTED"
      • sourceProperties — (map)

        Source server properties.

        • cpus — (Array<map>)

          Source Server CPUs.

          • cores — (Integer)

            The number of CPU cores on the source server.

          • modelName — (String)

            The source server's CPU model name.

        • disks — (Array<map>)

          Source Server disks.

          • bytes — (Integer)

            The amount of storage on the disk in bytes.

          • deviceName — (String)

            The disk or device name.

        • identificationHints — (map)

          Source server identification hints.

          • awsInstanceID — (String)

            AWS Instance ID identification hint.

          • fqdn — (String)

            FQDN address identification hint.

          • hostname — (String)

            Hostname identification hint.

          • vmWareUuid — (String)

            vmWare UUID identification hint.

        • lastUpdatedDateTime — (String)

          Source server last update date and time.

        • networkInterfaces — (Array<map>)

          Source server network interfaces.

          • ips — (Array<String>)

            Network interface IPs.

          • isPrimary — (Boolean)

            Network interface primary IP.

          • macAddress — (String)

            Network interface Mac address.

        • os — (map)

          Source server OS.

          • fullString — (String)

            OS full string.

        • ramBytes — (Integer)

          Source server RAM in bytes.

        • recommendedInstanceType — (String)

          Source server recommended instance type.

      • sourceServerID — (String)

        Source server ID.

      • tags — (map<String>)

        Source server Tags.

Returns:

  • (AWS.Request) —

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

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

Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDurationwill be nullified.

Service Reference:

Examples:

Calling the finalizeCutover operation

var params = {
  sourceServerID: 'STRING_VALUE' /* required */
};
mgn.finalizeCutover(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: {}) —
    • sourceServerID — (String)

      Request to finalize Cutover by Soure Server ID.

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:

      • arn — (String)

        Source server ARN.

      • dataReplicationInfo — (map)

        Source server data replication info.

        • dataReplicationError — (map)

          Error in obtaining data replication info.

          • error — (String)

            Error in data replication.

            Possible values include:
            • "AGENT_NOT_SEEN"
            • "SNAPSHOTS_FAILURE"
            • "NOT_CONVERGING"
            • "UNSTABLE_NETWORK"
            • "FAILED_TO_CREATE_SECURITY_GROUP"
            • "FAILED_TO_LAUNCH_REPLICATION_SERVER"
            • "FAILED_TO_BOOT_REPLICATION_SERVER"
            • "FAILED_TO_AUTHENTICATE_WITH_SERVICE"
            • "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE"
            • "FAILED_TO_CREATE_STAGING_DISKS"
            • "FAILED_TO_ATTACH_STAGING_DISKS"
            • "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT"
            • "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER"
            • "FAILED_TO_START_DATA_TRANSFER"
          • rawError — (String)

            Error in data replication.

        • dataReplicationInitiation — (map)

          Request to query whether data replication has been initiated.

          • nextAttemptDateTime — (String)

            Request to query next data initiation date and time.

          • startDateTime — (String)

            Request to query data initiation start date and time.

          • steps — (Array<map>)

            Request to query data initiation steps.

            • name — (String)

              Request to query data initiation step name.

              Possible values include:
              • "WAIT"
              • "CREATE_SECURITY_GROUP"
              • "LAUNCH_REPLICATION_SERVER"
              • "BOOT_REPLICATION_SERVER"
              • "AUTHENTICATE_WITH_SERVICE"
              • "DOWNLOAD_REPLICATION_SOFTWARE"
              • "CREATE_STAGING_DISKS"
              • "ATTACH_STAGING_DISKS"
              • "PAIR_REPLICATION_SERVER_WITH_AGENT"
              • "CONNECT_AGENT_TO_REPLICATION_SERVER"
              • "START_DATA_TRANSFER"
            • status — (String)

              Request to query data initiation status.

              Possible values include:
              • "NOT_STARTED"
              • "IN_PROGRESS"
              • "SUCCEEDED"
              • "FAILED"
              • "SKIPPED"
        • dataReplicationState — (String)

          Request to query the data replication state.

          Possible values include:
          • "STOPPED"
          • "INITIATING"
          • "INITIAL_SYNC"
          • "BACKLOG"
          • "CREATING_SNAPSHOT"
          • "CONTINUOUS"
          • "PAUSED"
          • "RESCAN"
          • "STALLED"
          • "DISCONNECTED"
        • etaDateTime — (String)

          Request to query the time when data replication will be complete.

        • lagDuration — (String)

          Request to query data replication lag durating.

        • replicatedDisks — (Array<map>)

          Request to query disks replicated.

          • backloggedStorageBytes — (Integer)

            Request to query data replication backlog size in bytes.

          • deviceName — (String)

            Request to query device name.

          • replicatedStorageBytes — (Integer)

            Request to query amount of data replicated in bytes.

          • rescannedStorageBytes — (Integer)

            Request to query amount of data rescanned in bytes.

          • totalStorageBytes — (Integer)

            Request to query total amount of data replicated in bytes.

      • isArchived — (Boolean)

        Source server archived status.

      • launchedInstance — (map)

        Source server launched instance.

        • ec2InstanceID — (String)

          Configure launced instance EC2 ID.

        • firstBoot — (String)

          Configure launced instance first boot.

          Possible values include:
          • "WAITING"
          • "SUCCEEDED"
          • "UNKNOWN"
          • "STOPPED"
        • jobID — (String)

          Configure launced instance Job ID.

      • lifeCycle — (map)

        Source server lifecycle state.

        • addedToServiceDateTime — (String)

          Lifecycle added to service data and time.

        • elapsedReplicationDuration — (String)

          Lifecycle elapsed time and duration.

        • firstByteDateTime — (String)

          Lifecycle replication initiation date and time.

        • lastCutover — (map)

          Lifecycle last Cutover.

          • finalized — (map)

            Lifecycle Cutover finalized date and time.

            • apiCallDateTime — (String)

              Lifecycle Cutover finalized date and time.

          • initiated — (map)

            Lifecycle last Cutover initiated.

            • apiCallDateTime — (String)

            • jobID — (String)

              Lifecycle last Cutover initiated by Job ID.

          • reverted — (map)

            Lifecycle last Cutover reverted.

            • apiCallDateTime — (String)

              Lifecycle last Cutover reverted API call date time.

        • lastSeenByServiceDateTime — (String)

          Lifecycle last seen date and time.

        • lastTest — (map)

          Lifecycle last Test.

          • finalized — (map)

            Lifecycle last Test finlized.

            • apiCallDateTime — (String)

              Lifecycle Test failed API call date and time.

          • initiated — (map)

            Lifecycle last Test initiated.

            • apiCallDateTime — (String)

              Lifecycle last Test initiated API call date and time.

            • jobID — (String)

              Lifecycle last Test initiated Job ID.

          • reverted — (map)

            Lifecycle last Test reverted.

            • apiCallDateTime — (String)

              Lifecycle last Test reverted API call date and time.

        • state — (String)

          Lifecycle state.

          Possible values include:
          • "STOPPED"
          • "NOT_READY"
          • "READY_FOR_TEST"
          • "TESTING"
          • "READY_FOR_CUTOVER"
          • "CUTTING_OVER"
          • "CUTOVER"
          • "DISCONNECTED"
      • sourceProperties — (map)

        Source server properties.

        • cpus — (Array<map>)

          Source Server CPUs.

          • cores — (Integer)

            The number of CPU cores on the source server.

          • modelName — (String)

            The source server's CPU model name.

        • disks — (Array<map>)

          Source Server disks.

          • bytes — (Integer)

            The amount of storage on the disk in bytes.

          • deviceName — (String)

            The disk or device name.

        • identificationHints — (map)

          Source server identification hints.

          • awsInstanceID — (String)

            AWS Instance ID identification hint.

          • fqdn — (String)

            FQDN address identification hint.

          • hostname — (String)

            Hostname identification hint.

          • vmWareUuid — (String)

            vmWare UUID identification hint.

        • lastUpdatedDateTime — (String)

          Source server last update date and time.

        • networkInterfaces — (Array<map>)

          Source server network interfaces.

          • ips — (Array<String>)

            Network interface IPs.

          • isPrimary — (Boolean)

            Network interface primary IP.

          • macAddress — (String)

            Network interface Mac address.

        • os — (map)

          Source server OS.

          • fullString — (String)

            OS full string.

        • ramBytes — (Integer)

          Source server RAM in bytes.

        • recommendedInstanceType — (String)

          Source server recommended instance type.

      • sourceServerID — (String)

        Source server ID.

      • tags — (map<String>)

        Source server Tags.

Returns:

  • (AWS.Request) —

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

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

Lists all LaunchConfigurations available, filtered by Source Server IDs.

Service Reference:

Examples:

Calling the getLaunchConfiguration operation

var params = {
  sourceServerID: 'STRING_VALUE' /* required */
};
mgn.getLaunchConfiguration(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: {}) —
    • sourceServerID — (String)

      Request to get Launch Configuration information by Source Server ID.

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:

      • copyPrivateIp — (Boolean)

        Copy Private IP during Launch Configuration.

      • copyTags — (Boolean)

        Copy Tags during Launch Configuration.

      • ec2LaunchTemplateID — (String)

        Configure EC2 lauch configuration template ID.

      • launchDisposition — (String)

        Configure launch dispostion for launch configuration.

        Possible values include:
        • "STOPPED"
        • "STARTED"
      • licensing — (map)

        Configure launch configuration OS licensing.

        • osByol — (Boolean)

          Configure BYOL OS licensing.

      • name — (String)

        Configure launch configuration name.

      • sourceServerID — (String)

        Configure launch configuration Source Server ID.

      • targetInstanceTypeRightSizingMethod — (String)

        Configure launch configuration Target instance type right sizing method.

        Possible values include:
        • "NONE"
        • "BASIC"

Returns:

  • (AWS.Request) —

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

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

Lists all ReplicationConfigurations, filtered by Source Server ID.

Service Reference:

Examples:

Calling the getReplicationConfiguration operation

var params = {
  sourceServerID: 'STRING_VALUE' /* required */
};
mgn.getReplicationConfiguration(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: {}) —
    • sourceServerID — (String)

      Request to get Replication Configuaration by Source Server ID.

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:

      • associateDefaultSecurityGroup — (Boolean)

        Replication Configuration associate default Application Migration Service Security Group.

      • bandwidthThrottling — (Integer)

        Replication Configuration set bandwidth throttling.

      • createPublicIP — (Boolean)

        Replication Configuration create Public IP.

      • dataPlaneRouting — (String)

        Replication Configuration data plane routing.

        Possible values include:
        • "PRIVATE_IP"
        • "PUBLIC_IP"
      • defaultLargeStagingDiskType — (String)

        Replication Configuration use default large Staging Disks.

        Possible values include:
        • "GP2"
        • "ST1"
      • ebsEncryption — (String)

        Replication Configuration EBS encryption.

        Possible values include:
        • "DEFAULT"
        • "CUSTOM"
      • ebsEncryptionKeyArn — (String)

        Replication Configuration EBS encryption key ARN.

      • name — (String)

        Replication Configuration name.

      • replicatedDisks — (Array<map>)

        Replication Configuration replicated disks.

        • deviceName — (String)

          Replication Configuration replicated disk device name.

        • iops — (Integer)

          Replication Configuration replicated disk IOPs.

        • isBootDisk — (Boolean)

          Replication Configuration replicated disk boot disk.

        • stagingDiskType — (String)

          Replication Configuration replicated disk staging disk type.

          Possible values include:
          • "AUTO"
          • "GP2"
          • "IO1"
          • "SC1"
          • "ST1"
          • "STANDARD"
      • replicationServerInstanceType — (String)

        Replication Configuration Replication Server instance type.

      • replicationServersSecurityGroupsIDs — (Array<String>)

        Replication Configuration Replication Server Security Group IDs.

      • sourceServerID — (String)

        Replication Configuration Source Server ID.

      • stagingAreaSubnetId — (String)

        Replication Configuration Staging Area subnet ID.

      • stagingAreaTags — (map<String>)

        Replication Configuration Staging Area tags.

      • useDedicatedReplicationServer — (Boolean)

        Replication Configuration use Dedicated Replication Server.

Returns:

  • (AWS.Request) —

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

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

Initialize Application Migration Service.

Service Reference:

Examples:

Calling the initializeService operation

var params = {
};
mgn.initializeService(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: {})

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.

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

List all tags for your Application Migration Service resources.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
mgn.listTagsForResource(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: {}) —
    • resourceArn — (String)

      List tags for resource request by ARN.

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:

      • tags — (map<String>)

        List tags for resource response.

Returns:

  • (AWS.Request) —

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

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

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle.state which equals DISCONNECTED or CUTOVER.

Service Reference:

Examples:

Calling the markAsArchived operation

var params = {
  sourceServerID: 'STRING_VALUE' /* required */
};
mgn.markAsArchived(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: {}) —
    • sourceServerID — (String)

      Mark as archived by Source Server ID.

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:

      • arn — (String)

        Source server ARN.

      • dataReplicationInfo — (map)

        Source server data replication info.

        • dataReplicationError — (map)

          Error in obtaining data replication info.

          • error — (String)

            Error in data replication.

            Possible values include:
            • "AGENT_NOT_SEEN"
            • "SNAPSHOTS_FAILURE"
            • "NOT_CONVERGING"
            • "UNSTABLE_NETWORK"
            • "FAILED_TO_CREATE_SECURITY_GROUP"
            • "FAILED_TO_LAUNCH_REPLICATION_SERVER"
            • "FAILED_TO_BOOT_REPLICATION_SERVER"
            • "FAILED_TO_AUTHENTICATE_WITH_SERVICE"
            • "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE"
            • "FAILED_TO_CREATE_STAGING_DISKS"
            • "FAILED_TO_ATTACH_STAGING_DISKS"
            • "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT"
            • "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER"
            • "FAILED_TO_START_DATA_TRANSFER"
          • rawError — (String)

            Error in data replication.

        • dataReplicationInitiation — (map)

          Request to query whether data replication has been initiated.

          • nextAttemptDateTime — (String)

            Request to query next data initiation date and time.

          • startDateTime — (String)

            Request to query data initiation start date and time.

          • steps — (Array<map>)

            Request to query data initiation steps.

            • name — (String)

              Request to query data initiation step name.

              Possible values include:
              • "WAIT"
              • "CREATE_SECURITY_GROUP"
              • "LAUNCH_REPLICATION_SERVER"
              • "BOOT_REPLICATION_SERVER"
              • "AUTHENTICATE_WITH_SERVICE"
              • "DOWNLOAD_REPLICATION_SOFTWARE"
              • "CREATE_STAGING_DISKS"
              • "ATTACH_STAGING_DISKS"
              • "PAIR_REPLICATION_SERVER_WITH_AGENT"
              • "CONNECT_AGENT_TO_REPLICATION_SERVER"
              • "START_DATA_TRANSFER"
            • status — (String)

              Request to query data initiation status.

              Possible values include:
              • "NOT_STARTED"
              • "IN_PROGRESS"
              • "SUCCEEDED"
              • "FAILED"
              • "SKIPPED"
        • dataReplicationState — (String)

          Request to query the data replication state.

          Possible values include:
          • "STOPPED"
          • "INITIATING"
          • "INITIAL_SYNC"
          • "BACKLOG"
          • "CREATING_SNAPSHOT"
          • "CONTINUOUS"
          • "PAUSED"
          • "RESCAN"
          • "STALLED"
          • "DISCONNECTED"
        • etaDateTime — (String)

          Request to query the time when data replication will be complete.

        • lagDuration — (String)

          Request to query data replication lag durating.

        • replicatedDisks — (Array<map>)

          Request to query disks replicated.

          • backloggedStorageBytes — (Integer)

            Request to query data replication backlog size in bytes.

          • deviceName — (String)

            Request to query device name.

          • replicatedStorageBytes — (Integer)

            Request to query amount of data replicated in bytes.

          • rescannedStorageBytes — (Integer)

            Request to query amount of data rescanned in bytes.

          • totalStorageBytes — (Integer)

            Request to query total amount of data replicated in bytes.

      • isArchived — (Boolean)

        Source server archived status.

      • launchedInstance — (map)

        Source server launched instance.

        • ec2InstanceID — (String)

          Configure launced instance EC2 ID.

        • firstBoot — (String)

          Configure launced instance first boot.

          Possible values include:
          • "WAITING"
          • "SUCCEEDED"
          • "UNKNOWN"
          • "STOPPED"
        • jobID — (String)

          Configure launced instance Job ID.

      • lifeCycle — (map)

        Source server lifecycle state.

        • addedToServiceDateTime — (String)

          Lifecycle added to service data and time.

        • elapsedReplicationDuration — (String)

          Lifecycle elapsed time and duration.

        • firstByteDateTime — (String)

          Lifecycle replication initiation date and time.

        • lastCutover — (map)

          Lifecycle last Cutover.

          • finalized — (map)

            Lifecycle Cutover finalized date and time.

            • apiCallDateTime — (String)

              Lifecycle Cutover finalized date and time.

          • initiated — (map)

            Lifecycle last Cutover initiated.

            • apiCallDateTime — (String)

            • jobID — (String)

              Lifecycle last Cutover initiated by Job ID.

          • reverted — (map)

            Lifecycle last Cutover reverted.

            • apiCallDateTime — (String)

              Lifecycle last Cutover reverted API call date time.

        • lastSeenByServiceDateTime — (String)

          Lifecycle last seen date and time.

        • lastTest — (map)

          Lifecycle last Test.

          • finalized — (map)

            Lifecycle last Test finlized.

            • apiCallDateTime — (String)

              Lifecycle Test failed API call date and time.

          • initiated — (map)

            Lifecycle last Test initiated.

            • apiCallDateTime — (String)

              Lifecycle last Test initiated API call date and time.

            • jobID — (String)

              Lifecycle last Test initiated Job ID.

          • reverted — (map)

            Lifecycle last Test reverted.

            • apiCallDateTime — (String)

              Lifecycle last Test reverted API call date and time.

        • state — (String)

          Lifecycle state.

          Possible values include:
          • "STOPPED"
          • "NOT_READY"
          • "READY_FOR_TEST"
          • "TESTING"
          • "READY_FOR_CUTOVER"
          • "CUTTING_OVER"
          • "CUTOVER"
          • "DISCONNECTED"
      • sourceProperties — (map)

        Source server properties.

        • cpus — (Array<map>)

          Source Server CPUs.

          • cores — (Integer)

            The number of CPU cores on the source server.

          • modelName — (String)

            The source server's CPU model name.

        • disks — (Array<map>)

          Source Server disks.

          • bytes — (Integer)

            The amount of storage on the disk in bytes.

          • deviceName — (String)

            The disk or device name.

        • identificationHints — (map)

          Source server identification hints.

          • awsInstanceID — (String)

            AWS Instance ID identification hint.

          • fqdn — (String)

            FQDN address identification hint.

          • hostname — (String)

            Hostname identification hint.

          • vmWareUuid — (String)

            vmWare UUID identification hint.

        • lastUpdatedDateTime — (String)

          Source server last update date and time.

        • networkInterfaces — (Array<map>)

          Source server network interfaces.

          • ips — (Array<String>)

            Network interface IPs.

          • isPrimary — (Boolean)

            Network interface primary IP.

          • macAddress — (String)

            Network interface Mac address.

        • os — (map)

          Source server OS.

          • fullString — (String)

            OS full string.

        • ramBytes — (Integer)

          Source server RAM in bytes.

        • recommendedInstanceType — (String)

          Source server recommended instance type.

      • sourceServerID — (String)

        Source server ID.

      • tags — (map<String>)

        Source server Tags.

Returns:

  • (AWS.Request) —

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

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

Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started. This command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED state.

Service Reference:

Examples:

Calling the retryDataReplication operation

var params = {
  sourceServerID: 'STRING_VALUE' /* required */
};
mgn.retryDataReplication(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: {}) —
    • sourceServerID — (String)

      Retry data replication for Source Server ID.

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:

      • arn — (String)

        Source server ARN.

      • dataReplicationInfo — (map)

        Source server data replication info.

        • dataReplicationError — (map)

          Error in obtaining data replication info.

          • error — (String)

            Error in data replication.

            Possible values include:
            • "AGENT_NOT_SEEN"
            • "SNAPSHOTS_FAILURE"
            • "NOT_CONVERGING"
            • "UNSTABLE_NETWORK"
            • "FAILED_TO_CREATE_SECURITY_GROUP"
            • "FAILED_TO_LAUNCH_REPLICATION_SERVER"
            • "FAILED_TO_BOOT_REPLICATION_SERVER"
            • "FAILED_TO_AUTHENTICATE_WITH_SERVICE"
            • "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE"
            • "FAILED_TO_CREATE_STAGING_DISKS"
            • "FAILED_TO_ATTACH_STAGING_DISKS"
            • "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT"
            • "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER"
            • "FAILED_TO_START_DATA_TRANSFER"
          • rawError — (String)

            Error in data replication.

        • dataReplicationInitiation — (map)

          Request to query whether data replication has been initiated.

          • nextAttemptDateTime — (String)

            Request to query next data initiation date and time.

          • startDateTime — (String)

            Request to query data initiation start date and time.

          • steps — (Array<map>)

            Request to query data initiation steps.

            • name — (String)

              Request to query data initiation step name.

              Possible values include:
              • "WAIT"
              • "CREATE_SECURITY_GROUP"
              • "LAUNCH_REPLICATION_SERVER"
              • "BOOT_REPLICATION_SERVER"
              • "AUTHENTICATE_WITH_SERVICE"
              • "DOWNLOAD_REPLICATION_SOFTWARE"
              • "CREATE_STAGING_DISKS"
              • "ATTACH_STAGING_DISKS"
              • "PAIR_REPLICATION_SERVER_WITH_AGENT"
              • "CONNECT_AGENT_TO_REPLICATION_SERVER"
              • "START_DATA_TRANSFER"
            • status — (String)

              Request to query data initiation status.

              Possible values include:
              • "NOT_STARTED"
              • "IN_PROGRESS"
              • "SUCCEEDED"
              • "FAILED"
              • "SKIPPED"
        • dataReplicationState — (String)

          Request to query the data replication state.

          Possible values include:
          • "STOPPED"
          • "INITIATING"
          • "INITIAL_SYNC"
          • "BACKLOG"
          • "CREATING_SNAPSHOT"
          • "CONTINUOUS"
          • "PAUSED"
          • "RESCAN"
          • "STALLED"
          • "DISCONNECTED"
        • etaDateTime — (String)

          Request to query the time when data replication will be complete.

        • lagDuration — (String)

          Request to query data replication lag durating.

        • replicatedDisks — (Array<map>)

          Request to query disks replicated.

          • backloggedStorageBytes — (Integer)

            Request to query data replication backlog size in bytes.

          • deviceName — (String)

            Request to query device name.

          • replicatedStorageBytes — (Integer)

            Request to query amount of data replicated in bytes.

          • rescannedStorageBytes — (Integer)

            Request to query amount of data rescanned in bytes.

          • totalStorageBytes — (Integer)

            Request to query total amount of data replicated in bytes.

      • isArchived — (Boolean)

        Source server archived status.

      • launchedInstance — (map)

        Source server launched instance.

        • ec2InstanceID — (String)

          Configure launced instance EC2 ID.

        • firstBoot — (String)

          Configure launced instance first boot.

          Possible values include:
          • "WAITING"
          • "SUCCEEDED"
          • "UNKNOWN"
          • "STOPPED"
        • jobID — (String)

          Configure launced instance Job ID.

      • lifeCycle — (map)

        Source server lifecycle state.

        • addedToServiceDateTime — (String)

          Lifecycle added to service data and time.

        • elapsedReplicationDuration — (String)

          Lifecycle elapsed time and duration.

        • firstByteDateTime — (String)

          Lifecycle replication initiation date and time.

        • lastCutover — (map)

          Lifecycle last Cutover.

          • finalized — (map)

            Lifecycle Cutover finalized date and time.

            • apiCallDateTime — (String)

              Lifecycle Cutover finalized date and time.

          • initiated — (map)

            Lifecycle last Cutover initiated.

            • apiCallDateTime — (String)

            • jobID — (String)

              Lifecycle last Cutover initiated by Job ID.

          • reverted — (map)

            Lifecycle last Cutover reverted.

            • apiCallDateTime — (String)

              Lifecycle last Cutover reverted API call date time.

        • lastSeenByServiceDateTime — (String)

          Lifecycle last seen date and time.

        • lastTest — (map)

          Lifecycle last Test.

          • finalized — (map)

            Lifecycle last Test finlized.

            • apiCallDateTime — (String)

              Lifecycle Test failed API call date and time.

          • initiated — (map)

            Lifecycle last Test initiated.

            • apiCallDateTime — (String)

              Lifecycle last Test initiated API call date and time.

            • jobID — (String)

              Lifecycle last Test initiated Job ID.

          • reverted — (map)

            Lifecycle last Test reverted.

            • apiCallDateTime — (String)

              Lifecycle last Test reverted API call date and time.

        • state — (String)

          Lifecycle state.

          Possible values include:
          • "STOPPED"
          • "NOT_READY"
          • "READY_FOR_TEST"
          • "TESTING"
          • "READY_FOR_CUTOVER"
          • "CUTTING_OVER"
          • "CUTOVER"
          • "DISCONNECTED"
      • sourceProperties — (map)

        Source server properties.

        • cpus — (Array<map>)

          Source Server CPUs.

          • cores — (Integer)

            The number of CPU cores on the source server.

          • modelName — (String)

            The source server's CPU model name.

        • disks — (Array<map>)

          Source Server disks.

          • bytes — (Integer)

            The amount of storage on the disk in bytes.

          • deviceName — (String)

            The disk or device name.

        • identificationHints — (map)

          Source server identification hints.

          • awsInstanceID — (String)

            AWS Instance ID identification hint.

          • fqdn — (String)

            FQDN address identification hint.

          • hostname — (String)

            Hostname identification hint.

          • vmWareUuid — (String)

            vmWare UUID identification hint.

        • lastUpdatedDateTime — (String)

          Source server last update date and time.

        • networkInterfaces — (Array<map>)

          Source server network interfaces.

          • ips — (Array<String>)

            Network interface IPs.

          • isPrimary — (Boolean)

            Network interface primary IP.

          • macAddress — (String)

            Network interface Mac address.

        • os — (map)

          Source server OS.

          • fullString — (String)

            OS full string.

        • ramBytes — (Integer)

          Source server RAM in bytes.

        • recommendedInstanceType — (String)

          Source server recommended instance type.

      • sourceServerID — (String)

        Source server ID.

      • tags — (map<String>)

        Source server Tags.

Returns:

  • (AWS.Request) —

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

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

Launches a Cutover Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartCutover and changes the SourceServer.lifeCycle.state property to CUTTING_OVER.

Service Reference:

Examples:

Calling the startCutover operation

var params = {
  sourceServerIDs: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
mgn.startCutover(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: {}) —
    • sourceServerIDs — (Array<String>)

      Start Cutover by Source Server IDs.

    • tags — (map<String>)

      Start Cutover by Tags.

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:

      • job — (map)

        Start Cutover Job response.

        • arn — (String)

          the ARN of the specific Job.

        • creationDateTime — (String)

          Job creation time.

        • endDateTime — (String)

          Job end time.

        • initiatedBy — (String)

          Job initiated by field.

          Possible values include:
          • "START_TEST"
          • "START_CUTOVER"
          • "DIAGNOSTIC"
          • "TERMINATE"
        • jobID — required — (String)

          Job ID.

        • participatingServers — (Array<map>)

          Servers participating in a specific Job.

          • launchStatus — (String)

            Participating server launch status.

            Possible values include:
            • "PENDING"
            • "IN_PROGRESS"
            • "LAUNCHED"
            • "FAILED"
            • "TERMINATED"
          • sourceServerID — (String)

            Participating server Source Server ID.

        • status — (String)

          Job status.

          Possible values include:
          • "PENDING"
          • "STARTED"
          • "COMPLETED"
        • tags — (map<String>)

          Tags associated with spcific Job.

        • type — (String)

          Job type.

          Possible values include:
          • "LAUNCH"
          • "TERMINATE"

Returns:

  • (AWS.Request) —

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

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

Lauches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.

Service Reference:

Examples:

Calling the startTest operation

var params = {
  sourceServerIDs: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
mgn.startTest(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: {}) —
    • sourceServerIDs — (Array<String>)

      Start Test for Source Server IDs.

    • tags — (map<String>)

      Start Test by Tags.

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:

      • job — (map)

        Start Test Job response.

        • arn — (String)

          the ARN of the specific Job.

        • creationDateTime — (String)

          Job creation time.

        • endDateTime — (String)

          Job end time.

        • initiatedBy — (String)

          Job initiated by field.

          Possible values include:
          • "START_TEST"
          • "START_CUTOVER"
          • "DIAGNOSTIC"
          • "TERMINATE"
        • jobID — required — (String)

          Job ID.

        • participatingServers — (Array<map>)

          Servers participating in a specific Job.

          • launchStatus — (String)

            Participating server launch status.

            Possible values include:
            • "PENDING"
            • "IN_PROGRESS"
            • "LAUNCHED"
            • "FAILED"
            • "TERMINATED"
          • sourceServerID — (String)

            Participating server Source Server ID.

        • status — (String)

          Job status.

          Possible values include:
          • "PENDING"
          • "STARTED"
          • "COMPLETED"
        • tags — (map<String>)

          Tags associated with spcific Job.

        • type — (String)

          Job type.

          Possible values include:
          • "LAUNCH"
          • "TERMINATE"

Returns:

  • (AWS.Request) —

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

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

Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
mgn.tagResource(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: {}) —
    • resourceArn — (String)

      Tag resource by ARN.

    • tags — (map<String>)

      Tag resource by Tags.

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.

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

Starts a job that terminates specific launched EC2 Test and Cutover instances. This command will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER.

Service Reference:

Examples:

Calling the terminateTargetInstances operation

var params = {
  sourceServerIDs: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
mgn.terminateTargetInstances(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: {}) —
    • sourceServerIDs — (Array<String>)

      Terminate Target instance by Source Server IDs.

    • tags — (map<String>)

      Terminate Target instance by Tags.

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:

      • job — (map)

        Terminate Target instance Job response.

        • arn — (String)

          the ARN of the specific Job.

        • creationDateTime — (String)

          Job creation time.

        • endDateTime — (String)

          Job end time.

        • initiatedBy — (String)

          Job initiated by field.

          Possible values include:
          • "START_TEST"
          • "START_CUTOVER"
          • "DIAGNOSTIC"
          • "TERMINATE"
        • jobID — required — (String)

          Job ID.

        • participatingServers — (Array<map>)

          Servers participating in a specific Job.

          • launchStatus — (String)

            Participating server launch status.

            Possible values include:
            • "PENDING"
            • "IN_PROGRESS"
            • "LAUNCHED"
            • "FAILED"
            • "TERMINATED"
          • sourceServerID — (String)

            Participating server Source Server ID.

        • status — (String)

          Job status.

          Possible values include:
          • "PENDING"
          • "STARTED"
          • "COMPLETED"
        • tags — (map<String>)

          Tags associated with spcific Job.

        • type — (String)

          Job type.

          Possible values include:
          • "LAUNCH"
          • "TERMINATE"

Returns:

  • (AWS.Request) —

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

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

Deletes the specified set of tags from the specified set of Application Migration Service resources.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
mgn.untagResource(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: {}) —
    • resourceArn — (String)

      Untag resource by ARN.

    • tagKeys — (Array<String>)

      Untag resource by Keys.

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.

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

Updates multiple LaunchConfigurations by Source Server ID.

Service Reference:

Examples:

Calling the updateLaunchConfiguration operation

var params = {
  sourceServerID: 'STRING_VALUE', /* required */
  copyPrivateIp: true || false,
  copyTags: true || false,
  launchDisposition: STOPPED | STARTED,
  licensing: {
    osByol: true || false
  },
  name: 'STRING_VALUE',
  targetInstanceTypeRightSizingMethod: NONE | BASIC
};
mgn.updateLaunchConfiguration(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: {}) —
    • copyPrivateIp — (Boolean)

      Update Launch configuration copy Private IP request.

    • copyTags — (Boolean)

      Update Launch configuration copy Tags request.

    • launchDisposition — (String)

      Update Launch configuration launch disposition request.

      Possible values include:
      • "STOPPED"
      • "STARTED"
    • licensing — (map)

      Update Launch configuration licensing request.

      • osByol — (Boolean)

        Configure BYOL OS licensing.

    • name — (String)

      Update Launch configuration name request.

    • sourceServerID — (String)

      Update Launch configuration by Source Server ID request.

    • targetInstanceTypeRightSizingMethod — (String)

      Update Launch configuration Target instance right sizing request.

      Possible values include:
      • "NONE"
      • "BASIC"

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:

      • copyPrivateIp — (Boolean)

        Copy Private IP during Launch Configuration.

      • copyTags — (Boolean)

        Copy Tags during Launch Configuration.

      • ec2LaunchTemplateID — (String)

        Configure EC2 lauch configuration template ID.

      • launchDisposition — (String)

        Configure launch dispostion for launch configuration.

        Possible values include:
        • "STOPPED"
        • "STARTED"
      • licensing — (map)

        Configure launch configuration OS licensing.

        • osByol — (Boolean)

          Configure BYOL OS licensing.

      • name — (String)

        Configure launch configuration name.

      • sourceServerID — (String)

        Configure launch configuration Source Server ID.

      • targetInstanceTypeRightSizingMethod — (String)

        Configure launch configuration Target instance type right sizing method.

        Possible values include:
        • "NONE"
        • "BASIC"

Returns:

  • (AWS.Request) —

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

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

Allows you to update multiple ReplicationConfigurations by Source Server ID.

Service Reference:

Examples:

Calling the updateReplicationConfiguration operation

var params = {
  sourceServerID: 'STRING_VALUE', /* required */
  associateDefaultSecurityGroup: true || false,
  bandwidthThrottling: 'NUMBER_VALUE',
  createPublicIP: true || false,
  dataPlaneRouting: PRIVATE_IP | PUBLIC_IP,
  defaultLargeStagingDiskType: GP2 | ST1,
  ebsEncryption: DEFAULT | CUSTOM,
  ebsEncryptionKeyArn: 'STRING_VALUE',
  name: 'STRING_VALUE',
  replicatedDisks: [
    {
      deviceName: 'STRING_VALUE',
      iops: 'NUMBER_VALUE',
      isBootDisk: true || false,
      stagingDiskType: AUTO | GP2 | IO1 | SC1 | ST1 | STANDARD
    },
    /* more items */
  ],
  replicationServerInstanceType: 'STRING_VALUE',
  replicationServersSecurityGroupsIDs: [
    'STRING_VALUE',
    /* more items */
  ],
  stagingAreaSubnetId: 'STRING_VALUE',
  stagingAreaTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  useDedicatedReplicationServer: true || false
};
mgn.updateReplicationConfiguration(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: {}) —
    • associateDefaultSecurityGroup — (Boolean)

      Update replication configuration associate default Application Migration Service Security group request.

    • bandwidthThrottling — (Integer)

      Update replication configuration bandwidth throttling request.

    • createPublicIP — (Boolean)

      Update replication configuration create Public IP request.

    • dataPlaneRouting — (String)

      Update replication configuration data plane routing request.

      Possible values include:
      • "PRIVATE_IP"
      • "PUBLIC_IP"
    • defaultLargeStagingDiskType — (String)

      Update replication configuration use default large Staging Disk type request.

      Possible values include:
      • "GP2"
      • "ST1"
    • ebsEncryption — (String)

      Update replication configuration EBS encryption request.

      Possible values include:
      • "DEFAULT"
      • "CUSTOM"
    • ebsEncryptionKeyArn — (String)

      Update replication configuration EBS encryption key ARN request.

    • name — (String)

      Update replication configuration name request.

    • replicatedDisks — (Array<map>)

      Update replication configuration replicated disks request.

      • deviceName — (String)

        Replication Configuration replicated disk device name.

      • iops — (Integer)

        Replication Configuration replicated disk IOPs.

      • isBootDisk — (Boolean)

        Replication Configuration replicated disk boot disk.

      • stagingDiskType — (String)

        Replication Configuration replicated disk staging disk type.

        Possible values include:
        • "AUTO"
        • "GP2"
        • "IO1"
        • "SC1"
        • "ST1"
        • "STANDARD"
    • replicationServerInstanceType — (String)

      Update replication configuration Replication Server instance type request.

    • replicationServersSecurityGroupsIDs — (Array<String>)

      Update replication configuration Replication Server Security Groups IDs request.

    • sourceServerID — (String)

      Update replication configuration Source Server ID request.

    • stagingAreaSubnetId — (String)

      Update replication configuration Staging Area subnet request.

    • stagingAreaTags — (map<String>)

      Update replication configuration Staging Area Tags request.

    • useDedicatedReplicationServer — (Boolean)

      Update replication configuration use dedicated Replication Server request.

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:

      • associateDefaultSecurityGroup — (Boolean)

        Replication Configuration associate default Application Migration Service Security Group.

      • bandwidthThrottling — (Integer)

        Replication Configuration set bandwidth throttling.

      • createPublicIP — (Boolean)

        Replication Configuration create Public IP.

      • dataPlaneRouting — (String)

        Replication Configuration data plane routing.

        Possible values include:
        • "PRIVATE_IP"
        • "PUBLIC_IP"
      • defaultLargeStagingDiskType — (String)

        Replication Configuration use default large Staging Disks.

        Possible values include:
        • "GP2"
        • "ST1"
      • ebsEncryption — (String)

        Replication Configuration EBS encryption.

        Possible values include:
        • "DEFAULT"
        • "CUSTOM"
      • ebsEncryptionKeyArn — (String)

        Replication Configuration EBS encryption key ARN.

      • name — (String)

        Replication Configuration name.

      • replicatedDisks — (Array<map>)

        Replication Configuration replicated disks.

        • deviceName — (String)

          Replication Configuration replicated disk device name.

        • iops — (Integer)

          Replication Configuration replicated disk IOPs.

        • isBootDisk — (Boolean)

          Replication Configuration replicated disk boot disk.

        • stagingDiskType — (String)

          Replication Configuration replicated disk staging disk type.

          Possible values include:
          • "AUTO"
          • "GP2"
          • "IO1"
          • "SC1"
          • "ST1"
          • "STANDARD"
      • replicationServerInstanceType — (String)

        Replication Configuration Replication Server instance type.

      • replicationServersSecurityGroupsIDs — (Array<String>)

        Replication Configuration Replication Server Security Group IDs.

      • sourceServerID — (String)

        Replication Configuration Source Server ID.

      • stagingAreaSubnetId — (String)

        Replication Configuration Staging Area subnet ID.

      • stagingAreaTags — (map<String>)

        Replication Configuration Staging Area tags.

      • useDedicatedReplicationServer — (Boolean)

        Replication Configuration use Dedicated Replication Server.

Returns:

  • (AWS.Request) —

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

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

Updates multiple ReplicationConfigurationTemplates by ID.

Service Reference:

Examples:

Calling the updateReplicationConfigurationTemplate operation

var params = {
  replicationConfigurationTemplateID: 'STRING_VALUE', /* required */
  arn: 'STRING_VALUE',
  associateDefaultSecurityGroup: true || false,
  bandwidthThrottling: 'NUMBER_VALUE',
  createPublicIP: true || false,
  dataPlaneRouting: PRIVATE_IP | PUBLIC_IP,
  defaultLargeStagingDiskType: GP2 | ST1,
  ebsEncryption: DEFAULT | CUSTOM,
  ebsEncryptionKeyArn: 'STRING_VALUE',
  replicationServerInstanceType: 'STRING_VALUE',
  replicationServersSecurityGroupsIDs: [
    'STRING_VALUE',
    /* more items */
  ],
  stagingAreaSubnetId: 'STRING_VALUE',
  stagingAreaTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  useDedicatedReplicationServer: true || false
};
mgn.updateReplicationConfigurationTemplate(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: {}) —
    • arn — (String)

      Update replication configuration template ARN request.

    • associateDefaultSecurityGroup — (Boolean)

      Update replication configuration template associate default Application Migration Service Security group request.

    • bandwidthThrottling — (Integer)

      Update replication configuration template bandwidth throttling request.

    • createPublicIP — (Boolean)

      Update replication configuration template create Public IP request.

    • dataPlaneRouting — (String)

      Update replication configuration template data plane routing request.

      Possible values include:
      • "PRIVATE_IP"
      • "PUBLIC_IP"
    • defaultLargeStagingDiskType — (String)

      Update replication configuration template use default large Staging Disk type request.

      Possible values include:
      • "GP2"
      • "ST1"
    • ebsEncryption — (String)

      Update replication configuration template EBS encryption request.

      Possible values include:
      • "DEFAULT"
      • "CUSTOM"
    • ebsEncryptionKeyArn — (String)

      Update replication configuration template EBS encryption key ARN request.

    • replicationConfigurationTemplateID — (String)

      Update replication configuration template template ID request.

    • replicationServerInstanceType — (String)

      Update replication configuration template Replication Server instance type request.

    • replicationServersSecurityGroupsIDs — (Array<String>)

      Update replication configuration template Replication Server Security groups IDs request.

    • stagingAreaSubnetId — (String)

      Update replication configuration template Staging Area subnet ID request.

    • stagingAreaTags — (map<String>)

      Update replication configuration template Staging Area Tags request.

    • useDedicatedReplicationServer — (Boolean)

      Update replication configuration template use dedicated Replication Server request.

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:

      • arn — (String)

        Replication Configuration template ARN.

      • associateDefaultSecurityGroup — (Boolean)

        Replication Configuration template associate default Application Migration Service Security group.

      • bandwidthThrottling — (Integer)

        Replication Configuration template bandwidth throtting.

      • createPublicIP — (Boolean)

        Replication Configuration template create Public IP.

      • dataPlaneRouting — (String)

        Replication Configuration template data plane routing.

        Possible values include:
        • "PRIVATE_IP"
        • "PUBLIC_IP"
      • defaultLargeStagingDiskType — (String)

        Replication Configuration template use dedault large Staging Disk type.

        Possible values include:
        • "GP2"
        • "ST1"
      • ebsEncryption — (String)

        Replication Configuration template EBS encryption.

        Possible values include:
        • "DEFAULT"
        • "CUSTOM"
      • ebsEncryptionKeyArn — (String)

        Replication Configuration template EBS encryption key ARN.

      • replicationConfigurationTemplateID — (String)

        Replication Configuration template template ID.

      • replicationServerInstanceType — (String)

        Replication Configuration template server instance type.

      • replicationServersSecurityGroupsIDs — (Array<String>)

        Replication Configuration template server Security Groups IDs.

      • stagingAreaSubnetId — (String)

        Replication Configuration template Staging Area subnet ID.

      • stagingAreaTags — (map<String>)

        Replication Configuration template Staging Area Tags.

      • tags — (map<String>)

        Replication Configuration template Tags.

      • useDedicatedReplicationServer — (Boolean)

        Replication Configuration template use Dedicated Replication Server.

Returns:

  • (AWS.Request) —

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