Class: AWS.Mgn

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

    Account ID.

  • waveID — (String)

    Wave 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)

      Wave ARN.

    • creationDateTime — (String)

      Wave creation dateTime.

    • description — (String)

      Wave description.

    • isArchived — (Boolean)

      Wave archival status.

    • lastModifiedDateTime — (String)

      Wave last modified dateTime.

    • name — (String)

      Wave name.

    • tags — (map<String>)

      Wave tags.

    • waveAggregatedStatus — (map)

      Wave aggregated status.

      • healthStatus — (String)

        Wave aggregated status health status.

        Possible values include:
        • "HEALTHY"
        • "LAGGING"
        • "ERROR"
      • lastUpdateDateTime — (String)

        Wave aggregated status last update dateTime.

      • progressStatus — (String)

        Wave aggregated status progress status.

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

        DateTime marking when the first source server in the wave started replication.

      • totalApplications — (Integer)

        Wave aggregated status total applications amount.

    • waveID — (String)

      Wave ID.

Returns:

• (AWS.Request) —

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

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

    Account ID.

  • applicationIDs — (Array<String>)

    Application IDs list.

  • waveID — (String)

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

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

    Account ID.

  • applicationID — (String)

    Application ID.

  • sourceServerIDs — (Array<String>)

    Source server IDs list.

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.

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

    The request to change the source server migration account ID.

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

    • applicationID — (String)

      Source server application ID.

    • arn — (String)

      Source server ARN.

    • connectorAction — (map)

      Source Server connector action.

      • connectorArn — (String)

        Source Server connector action connector arn.

      • credentialsSecretArn — (String)

        Source Server connector action credentials secret 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"
          • "UNSUPPORTED_VM_CONFIGURATION"
          • "LAST_SNAPSHOT_JOB_FAILED"
        • 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"
        • "PENDING_SNAPSHOT_SHIPPING"
        • "SHIPPING_SNAPSHOT"
      • etaDateTime — (String)

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

      • lagDuration — (String)

        Request to query data replication lag duration.

      • lastSnapshotDateTime — (String)

        Request to query data replication last snapshot time.

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

    • fqdnForActionFramework — (String)

      Source server fqdn for action framework.

    • isArchived — (Boolean)

      Source server archived status.

    • launchedInstance — (map)

      Source server launched instance.

      • ec2InstanceID — (String)

        Launched instance EC2 ID.

      • firstBoot — (String)

        Launched instance first boot.

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

        Launched 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 finalized.

          • 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"
        • "DISCOVERED"
        • "PENDING_INSTALLATION"
    • replicationType — (String)

      Source server replication type.

      Possible values include:
      • "AGENT_BASED"
      • "SNAPSHOT_SHIPPING"
    • 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.

        • vmPath — (String)

          vCenter VM path 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.

    • userProvidedID — (String)

      Source server user provided ID.

    • vcenterClientID — (String)

      Source server vCenter client id.

Returns:

• (AWS.Request) —

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

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

    Account ID.

  • description — (String)

    Application description.

  • name — (String)

    Application name.

  • tags — (map<String>)

    Application 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:

    • applicationAggregatedStatus — (map)

      Application aggregated status.

      • healthStatus — (String)

        Application aggregated status health status.

        Possible values include:
        • "HEALTHY"
        • "LAGGING"
        • "ERROR"
      • lastUpdateDateTime — (String)

        Application aggregated status last update dateTime.

      • progressStatus — (String)

        Application aggregated status progress status.

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

        Application aggregated status total source servers amount.

    • applicationID — (String)

      Application ID.

    • arn — (String)

      Application ARN.

    • creationDateTime — (String)

      Application creation dateTime.

    • description — (String)

      Application description.

    • isArchived — (Boolean)

      Application archival status.

    • lastModifiedDateTime — (String)

      Application last modified dateTime.

    • name — (String)

      Application name.

    • tags — (map<String>)

      Application tags.

    • waveID — (String)

      Application wave ID.

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  ssmInstanceID: 'STRING_VALUE', /* required */
  ssmCommandConfig: {
    cloudWatchOutputEnabled: true || false, /* required */
    s3OutputEnabled: true || false, /* required */
    cloudWatchLogGroupName: 'STRING_VALUE',
    outputS3BucketName: 'STRING_VALUE'
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
mgn.createConnector(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: {}) —
  • name — (String)

    Create Connector request name.

  • ssmCommandConfig — (map)

    Create Connector request SSM command config.

    • cloudWatchLogGroupName — (String)

      Connector SSM command config CloudWatch log group name.

    • cloudWatchOutputEnabled — required — (Boolean)

      Connector SSM command config CloudWatch output enabled.

    • outputS3BucketName — (String)

      Connector SSM command config output S3 bucket name.

    • s3OutputEnabled — required — (Boolean)

      Connector SSM command config S3 output enabled.

  • ssmInstanceID — (String)

    Create Connector request SSM instance ID.

  • tags — (map<String>)

    Create Connector request 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:

    • arn — (String)

      Connector arn.

    • connectorID — (String)

      Connector ID.

    • name — (String)

      Connector name.

    • ssmCommandConfig — (map)

      Connector SSM command config.

      • cloudWatchLogGroupName — (String)

        Connector SSM command config CloudWatch log group name.

      • cloudWatchOutputEnabled — required — (Boolean)

        Connector SSM command config CloudWatch output enabled.

      • outputS3BucketName — (String)

        Connector SSM command config output S3 bucket name.

      • s3OutputEnabled — required — (Boolean)

        Connector SSM command config S3 output enabled.

    • ssmInstanceID — (String)

      Connector SSM instance ID.

    • tags — (map<String>)

      Connector tags.

Returns:

• (AWS.Request) —

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

var params = {
  associatePublicIpAddress: true || false,
  bootMode: LEGACY_BIOS | UEFI | USE_SOURCE,
  copyPrivateIp: true || false,
  copyTags: true || false,
  enableMapAutoTagging: true || false,
  largeVolumeConf: {
    iops: 'NUMBER_VALUE',
    throughput: 'NUMBER_VALUE',
    volumeType: io1 | io2 | gp3 | gp2 | st1 | sc1 | standard
  },
  launchDisposition: STOPPED | STARTED,
  licensing: {
    osByol: true || false
  },
  mapAutoTaggingMpeID: 'STRING_VALUE',
  postLaunchActions: {
    cloudWatchLogGroupName: 'STRING_VALUE',
    deployment: TEST_AND_CUTOVER | CUTOVER_ONLY | TEST_ONLY,
    s3LogBucket: 'STRING_VALUE',
    s3OutputKeyPrefix: 'STRING_VALUE',
    ssmDocuments: [
      {
        actionName: 'STRING_VALUE', /* required */
        ssmDocumentName: 'STRING_VALUE', /* required */
        externalParameters: {
          '<SsmDocumentParameterName>': {
            dynamicPath: 'STRING_VALUE'
          },
          /* '<SsmDocumentParameterName>': ... */
        },
        mustSucceedForCutover: true || false,
        parameters: {
          '<SsmDocumentParameterName>': [
            {
              parameterName: 'STRING_VALUE', /* required */
              parameterType: STRING /* required */
            },
            /* more items */
          ],
          /* '<SsmDocumentParameterName>': ... */
        },
        timeoutSeconds: 'NUMBER_VALUE'
      },
      /* more items */
    ]
  },
  smallVolumeConf: {
    iops: 'NUMBER_VALUE',
    throughput: 'NUMBER_VALUE',
    volumeType: io1 | io2 | gp3 | gp2 | st1 | sc1 | standard
  },
  smallVolumeMaxSize: 'NUMBER_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  targetInstanceTypeRightSizingMethod: NONE | BASIC
};
mgn.createLaunchConfigurationTemplate(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: {}) —
  • associatePublicIpAddress — (Boolean)

    Associate public Ip address.

  • bootMode — (String)

    Launch configuration template boot mode.

    Possible values include:
    • "LEGACY_BIOS"
    • "UEFI"
    • "USE_SOURCE"
  • copyPrivateIp — (Boolean)

    Copy private Ip.

  • copyTags — (Boolean)

    Copy tags.

  • enableMapAutoTagging — (Boolean)

    Enable map auto tagging.

  • largeVolumeConf — (map)

    Large volume config.

    • iops — (Integer)

      Launch template disk iops configuration.

    • throughput — (Integer)

      Launch template disk throughput configuration.

    • volumeType — (String)

      Launch template disk volume type configuration.

      Possible values include:
      • "io1"
      • "io2"
      • "gp3"
      • "gp2"
      • "st1"
      • "sc1"
      • "standard"
  • launchDisposition — (String)

    Launch disposition.

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

    Configure Licensing.

    • osByol — (Boolean)

      Configure BYOL OS licensing.

  • mapAutoTaggingMpeID — (String)

    Launch configuration template map auto tagging MPE ID.

  • postLaunchActions — (map)

    Launch configuration template post launch actions.

    • cloudWatchLogGroupName — (String)

      AWS Systems Manager Command's CloudWatch log group name.

    • deployment — (String)

      Deployment type in which AWS Systems Manager Documents will be executed.

      Possible values include:
      • "TEST_AND_CUTOVER"
      • "CUTOVER_ONLY"
      • "TEST_ONLY"
    • s3LogBucket — (String)

      AWS Systems Manager Command's logs S3 log bucket.

    • s3OutputKeyPrefix — (String)

      AWS Systems Manager Command's logs S3 output key prefix.

    • ssmDocuments — (Array<map>)

      AWS Systems Manager Documents.

      • actionName — required — (String)

        User-friendly name for the AWS Systems Manager Document.

      • externalParameters — (map<map>)

        AWS Systems Manager Document external parameters.

        • dynamicPath — (String)

          AWS Systems Manager Document external parameters dynamic path.

      • mustSucceedForCutover — (Boolean)

        If true, Cutover will not be enabled if the document has failed.

      • parameters — (map<Array<map>>)

        AWS Systems Manager Document parameters.

        • parameterName — required — (String)

          AWS Systems Manager Parameter Store parameter name.

        • parameterType — required — (String)

          AWS Systems Manager Parameter Store parameter type.

          Possible values include:
          • "STRING"
      • ssmDocumentName — required — (String)

        AWS Systems Manager Document name or full ARN.

      • timeoutSeconds — (Integer)

        AWS Systems Manager Document timeout seconds.

  • smallVolumeConf — (map)

    Small volume config.

    • iops — (Integer)

      Launch template disk iops configuration.

    • throughput — (Integer)

      Launch template disk throughput configuration.

    • volumeType — (String)

      Launch template disk volume type configuration.

      Possible values include:
      • "io1"
      • "io2"
      • "gp3"
      • "gp2"
      • "st1"
      • "sc1"
      • "standard"
  • smallVolumeMaxSize — (Integer)

    Small volume maximum size.

  • tags — (map<String>)

    Request to associate tags during creation of a Launch Configuration Template.

  • targetInstanceTypeRightSizingMethod — (String)

    Target instance type right-sizing method.

    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:

    • arn — (String)

      ARN of the Launch Configuration Template.

    • associatePublicIpAddress — (Boolean)

      Associate public Ip address.

    • bootMode — (String)

      Launch configuration template boot mode.

      Possible values include:
      • "LEGACY_BIOS"
      • "UEFI"
      • "USE_SOURCE"
    • copyPrivateIp — (Boolean)

      Copy private Ip.

    • copyTags — (Boolean)

      Copy tags.

    • ec2LaunchTemplateID — (String)

      EC2 launch template ID.

    • enableMapAutoTagging — (Boolean)

      Enable map auto tagging.

    • largeVolumeConf — (map)

      Large volume config.

      • iops — (Integer)

        Launch template disk iops configuration.

      • throughput — (Integer)

        Launch template disk throughput configuration.

      • volumeType — (String)

        Launch template disk volume type configuration.

        Possible values include:
        • "io1"
        • "io2"
        • "gp3"
        • "gp2"
        • "st1"
        • "sc1"
        • "standard"
    • launchConfigurationTemplateID — (String)

      ID of the Launch Configuration Template.

    • launchDisposition — (String)

      Launch disposition.

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

      Configure Licensing.

      • osByol — (Boolean)

        Configure BYOL OS licensing.

    • mapAutoTaggingMpeID — (String)

      Launch configuration template map auto tagging MPE ID.

    • postLaunchActions — (map)

      Post Launch Actions of the Launch Configuration Template.

      • cloudWatchLogGroupName — (String)

        AWS Systems Manager Command's CloudWatch log group name.

      • deployment — (String)

        Deployment type in which AWS Systems Manager Documents will be executed.

        Possible values include:
        • "TEST_AND_CUTOVER"
        • "CUTOVER_ONLY"
        • "TEST_ONLY"
      • s3LogBucket — (String)

        AWS Systems Manager Command's logs S3 log bucket.

      • s3OutputKeyPrefix — (String)

        AWS Systems Manager Command's logs S3 output key prefix.

      • ssmDocuments — (Array<map>)

        AWS Systems Manager Documents.

        • actionName — required — (String)

          User-friendly name for the AWS Systems Manager Document.

        • externalParameters — (map<map>)

          AWS Systems Manager Document external parameters.

          • dynamicPath — (String)

            AWS Systems Manager Document external parameters dynamic path.

        • mustSucceedForCutover — (Boolean)

          If true, Cutover will not be enabled if the document has failed.

        • parameters — (map<Array<map>>)

          AWS Systems Manager Document parameters.

          • parameterName — required — (String)

            AWS Systems Manager Parameter Store parameter name.

          • parameterType — required — (String)

            AWS Systems Manager Parameter Store parameter type.

            Possible values include:
            • "STRING"
        • ssmDocumentName — required — (String)

          AWS Systems Manager Document name or full ARN.

        • timeoutSeconds — (Integer)

          AWS Systems Manager Document timeout seconds.

    • smallVolumeConf — (map)

      Small volume config.

      • iops — (Integer)

        Launch template disk iops configuration.

      • throughput — (Integer)

        Launch template disk throughput configuration.

      • volumeType — (String)

        Launch template disk volume type configuration.

        Possible values include:
        • "io1"
        • "io2"
        • "gp3"
        • "gp2"
        • "st1"
        • "sc1"
        • "standard"
    • smallVolumeMaxSize — (Integer)

      Small volume maximum size.

    • tags — (map<String>)

      Tags of the Launch Configuration Template.

    • targetInstanceTypeRightSizingMethod — (String)

      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.

var params = {
  associateDefaultSecurityGroup: true || false, /* required */
  bandwidthThrottling: 'NUMBER_VALUE', /* required */
  createPublicIP: true || false, /* required */
  dataPlaneRouting: PRIVATE_IP | PUBLIC_IP, /* required */
  defaultLargeStagingDiskType: GP2 | ST1 | GP3, /* 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>': ... */
  },
  useFipsEndpoint: true || false
};
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 default large staging disk EBS volume type during Replication Settings template creation.

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

    Request to configure EBS encryption during Replication Settings template creation.

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

    Request to configure an EBS encryption 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 Security 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 Staging 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.

  • useFipsEndpoint — (Boolean)

    Request to use Fips Endpoint 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 throttling.

    • 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 default large Staging Disk type.

      Possible values include:
      • "GP2"
      • "ST1"
      • "GP3"
    • 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 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.

    • useFipsEndpoint — (Boolean)

      Replication Configuration template use Fips Endpoint.

Returns:

• (AWS.Request) —

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

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

    Account ID.

  • description — (String)

    Wave description.

  • name — (String)

    Wave name.

  • tags — (map<String>)

    Wave 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:

    • arn — (String)

      Wave ARN.

    • creationDateTime — (String)

      Wave creation dateTime.

    • description — (String)

      Wave description.

    • isArchived — (Boolean)

      Wave archival status.

    • lastModifiedDateTime — (String)

      Wave last modified dateTime.

    • name — (String)

      Wave name.

    • tags — (map<String>)

      Wave tags.

    • waveAggregatedStatus — (map)

      Wave aggregated status.

      • healthStatus — (String)

        Wave aggregated status health status.

        Possible values include:
        • "HEALTHY"
        • "LAGGING"
        • "ERROR"
      • lastUpdateDateTime — (String)

        Wave aggregated status last update dateTime.

      • progressStatus — (String)

        Wave aggregated status progress status.

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

        DateTime marking when the first source server in the wave started replication.

      • totalApplications — (Integer)

        Wave aggregated status total applications amount.

    • waveID — (String)

      Wave ID.

Returns:

• (AWS.Request) —

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

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

    Account ID.

  • applicationID — (String)

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

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

    Delete Connector request connector 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.

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

    Request to delete Job from service by Account ID.

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

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

    ID of resource to be deleted.

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.

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.

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

    Request to delete Source Server from service by Account ID.

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

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

    ID of resource to be deleted.

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.

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

    Account ID.

  • waveID — (String)

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

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

    Request to describe Job log Account ID.

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

var params = {
  accountID: 'STRING_VALUE',
  filters: {
    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: {}) —
  • accountID — (String)

    Request to describe job log items by Account ID.

  • 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 items by last date.

  • maxResults — (Integer)

    Request to describe job log items by max results.

  • nextToken — (String)

    Request to describe job log items 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 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"
        • launchedEc2InstanceID — (String)

          Participating server's launched ec2 instance ID.

        • postLaunchActionsStatus — (map)

          Participating server's Post Launch Actions Status.

          • postLaunchActionsLaunchStatusList — (Array<map>)

            List of Post Launch Action status.

            • executionID — (String)

              AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions.

            • executionStatus — (String)

              AWS Systems Manager Document's execution status.

              Possible values include:
              • "IN_PROGRESS"
              • "SUCCESS"
              • "FAILED"
            • failureReason — (String)

              AWS Systems Manager Document's failure reason.

            • ssmDocument — (map)

              AWS Systems Manager's Document of the of the Job Post Launch Actions.

              • actionName — required — (String)

                User-friendly name for the AWS Systems Manager Document.

              • externalParameters — (map<map>)

                AWS Systems Manager Document external parameters.

                • dynamicPath — (String)

                  AWS Systems Manager Document external parameters dynamic path.

              • mustSucceedForCutover — (Boolean)

                If true, Cutover will not be enabled if the document has failed.

              • parameters — (map<Array<map>>)

                AWS Systems Manager Document parameters.

                • parameterName — required — (String)

                  AWS Systems Manager Parameter Store parameter name.

                • parameterType — required — (String)

                  AWS Systems Manager Parameter Store parameter type.

                  Possible values include:
                  • "STRING"
              • ssmDocumentName — required — (String)

                AWS Systems Manager Document name or full ARN.

              • timeoutSeconds — (Integer)

                AWS Systems Manager Document timeout seconds.

            • ssmDocumentType — (String)

              AWS Systems Manager Document type.

              Possible values include:
              • "AUTOMATION"
              • "COMMAND"
          • ssmAgentDiscoveryDatetime — (String)

            Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.

        • sourceServerID — required — (String)

          Participating server Source Server ID.

      • status — (String)

        Job status.

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

        Tags associated with specific 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.

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

    Request to filter Launch Configuration Templates list by Launch Configuration Template ID.

  • maxResults — (Integer)

    Maximum results to be returned in DescribeLaunchConfigurationTemplates.

  • nextToken — (String)

    Next pagination token returned from DescribeLaunchConfigurationTemplates.

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

      List of items returned by DescribeLaunchConfigurationTemplates.

      • arn — (String)

        ARN of the Launch Configuration Template.

      • associatePublicIpAddress — (Boolean)

        Associate public Ip address.

      • bootMode — (String)

        Launch configuration template boot mode.

        Possible values include:
        • "LEGACY_BIOS"
        • "UEFI"
        • "USE_SOURCE"
      • copyPrivateIp — (Boolean)

        Copy private Ip.

      • copyTags — (Boolean)

        Copy tags.

      • ec2LaunchTemplateID — (String)

        EC2 launch template ID.

      • enableMapAutoTagging — (Boolean)

        Enable map auto tagging.

      • largeVolumeConf — (map)

        Large volume config.

        • iops — (Integer)

          Launch template disk iops configuration.

        • throughput — (Integer)

          Launch template disk throughput configuration.

        • volumeType — (String)

          Launch template disk volume type configuration.

          Possible values include:
          • "io1"
          • "io2"
          • "gp3"
          • "gp2"
          • "st1"
          • "sc1"
          • "standard"
      • launchConfigurationTemplateID — required — (String)

        ID of the Launch Configuration Template.

      • launchDisposition — (String)

        Launch disposition.

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

        Configure Licensing.

        • osByol — (Boolean)

          Configure BYOL OS licensing.

      • mapAutoTaggingMpeID — (String)

        Launch configuration template map auto tagging MPE ID.

      • postLaunchActions — (map)

        Post Launch Actions of the Launch Configuration Template.

        • cloudWatchLogGroupName — (String)

          AWS Systems Manager Command's CloudWatch log group name.

        • deployment — (String)

          Deployment type in which AWS Systems Manager Documents will be executed.

          Possible values include:
          • "TEST_AND_CUTOVER"
          • "CUTOVER_ONLY"
          • "TEST_ONLY"
        • s3LogBucket — (String)

          AWS Systems Manager Command's logs S3 log bucket.

        • s3OutputKeyPrefix — (String)

          AWS Systems Manager Command's logs S3 output key prefix.

        • ssmDocuments — (Array<map>)

          AWS Systems Manager Documents.

          • actionName — required — (String)

            User-friendly name for the AWS Systems Manager Document.

          • externalParameters — (map<map>)

            AWS Systems Manager Document external parameters.

            • dynamicPath — (String)

              AWS Systems Manager Document external parameters dynamic path.

          • mustSucceedForCutover — (Boolean)

            If true, Cutover will not be enabled if the document has failed.

          • parameters — (map<Array<map>>)

            AWS Systems Manager Document parameters.

            • parameterName — required — (String)

              AWS Systems Manager Parameter Store parameter name.

            • parameterType — required — (String)

              AWS Systems Manager Parameter Store parameter type.

              Possible values include:
              • "STRING"
          • ssmDocumentName — required — (String)

            AWS Systems Manager Document name or full ARN.

          • timeoutSeconds — (Integer)

            AWS Systems Manager Document timeout seconds.

      • smallVolumeConf — (map)

        Small volume config.

        • iops — (Integer)

          Launch template disk iops configuration.

        • throughput — (Integer)

          Launch template disk throughput configuration.

        • volumeType — (String)

          Launch template disk volume type configuration.

          Possible values include:
          • "io1"
          • "io2"
          • "gp3"
          • "gp2"
          • "st1"
          • "sc1"
          • "standard"
      • smallVolumeMaxSize — (Integer)

        Small volume maximum size.

      • tags — (map<String>)

        Tags of the Launch Configuration Template.

      • targetInstanceTypeRightSizingMethod — (String)

        Target instance type right-sizing method.

        Possible values include:
        • "NONE"
        • "BASIC"
    • nextToken — (String)

      Next pagination token returned from DescribeLaunchConfigurationTemplates.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  replicationConfigurationTemplateIDs: [
    'STRING_VALUE',
    /* more items */
  ]
};
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 throttling.

      • 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 default large Staging Disk type.

        Possible values include:
        • "GP2"
        • "ST1"
        • "GP3"
      • 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 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.

      • useFipsEndpoint — (Boolean)

        Replication Configuration template use Fips Endpoint.

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

var params = {
  accountID: 'STRING_VALUE',
  filters: {
    applicationIDs: [
      'STRING_VALUE',
      /* more items */
    ],
    isArchived: true || false,
    lifeCycleStates: [
      STOPPED | NOT_READY | READY_FOR_TEST | TESTING | READY_FOR_CUTOVER | CUTTING_OVER | CUTOVER | DISCONNECTED | DISCOVERED | PENDING_INSTALLATION,
      /* more items */
    ],
    replicationTypes: [
      AGENT_BASED | SNAPSHOT_SHIPPING,
      /* more items */
    ],
    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: {}) —
  • accountID — (String)

    Request to filter Source Servers list by Accoun ID.

  • filters — (map)

    Request to filter Source Servers list.

    • applicationIDs — (Array<String>)

      Request to filter Source Servers list by application IDs.

    • isArchived — (Boolean)

      Request to filter Source Servers list by archived.

    • lifeCycleStates — (Array<String>)

      Request to filter Source Servers list by life cycle states.

    • replicationTypes — (Array<String>)

      Request to filter Source Servers list by replication type.

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

      • applicationID — (String)

        Source server application ID.

      • arn — (String)

        Source server ARN.

      • connectorAction — (map)

        Source Server connector action.

        • connectorArn — (String)

          Source Server connector action connector arn.

        • credentialsSecretArn — (String)

          Source Server connector action credentials secret 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"
            • "UNSUPPORTED_VM_CONFIGURATION"
            • "LAST_SNAPSHOT_JOB_FAILED"
          • 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"
          • "PENDING_SNAPSHOT_SHIPPING"
          • "SHIPPING_SNAPSHOT"
        • etaDateTime — (String)

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

        • lagDuration — (String)

          Request to query data replication lag duration.

        • lastSnapshotDateTime — (String)

          Request to query data replication last snapshot time.

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

      • fqdnForActionFramework — (String)

        Source server fqdn for action framework.

      • isArchived — (Boolean)

        Source server archived status.

      • launchedInstance — (map)

        Source server launched instance.

        • ec2InstanceID — (String)

          Launched instance EC2 ID.

        • firstBoot — (String)

          Launched instance first boot.

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

          Launched 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 finalized.

            • 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"
          • "DISCOVERED"
          • "PENDING_INSTALLATION"
      • replicationType — (String)

        Source server replication type.

        Possible values include:
        • "AGENT_BASED"
        • "SNAPSHOT_SHIPPING"
      • 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.

          • vmPath — (String)

            vCenter VM path 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.

      • userProvidedID — (String)

        Source server user provided ID.

      • vcenterClientID — (String)

        Source server vCenter client id.

    • nextToken — (String)

      Request to filter Source Servers next token.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
mgn.describeVcenterClients(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)

    Maximum results to be returned in DescribeVcenterClients.

  • nextToken — (String)

    Next pagination token to be provided for DescribeVcenterClients.

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

      List of items returned by DescribeVcenterClients.

      • arn — (String)

        Arn of vCenter client.

      • datacenterName — (String)

        Datacenter name of vCenter client.

      • hostname — (String)

        Hostname of vCenter client .

      • lastSeenDatetime — (String)

        Last seen time of vCenter client.

      • sourceServerTags — (map<String>)

        Tags for Source Server of vCenter client.

      • tags — (map<String>)

        Tags for vCenter client.

      • vcenterClientID — (String)

        ID of vCenter client.

      • vcenterUUID — (String)

        Vcenter UUID of vCenter client.

    • nextToken — (String)

      Next pagination token returned from DescribeVcenterClients.

Returns:

• (AWS.Request) —

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

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

    Account ID.

  • applicationIDs — (Array<String>)

    Application IDs list.

  • waveID — (String)

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

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

    Account ID.

  • applicationID — (String)

    Application ID.

  • sourceServerIDs — (Array<String>)

    Source server IDs list.

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.

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

    Request to disconnect Source Server from service by Account ID.

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

    • applicationID — (String)

      Source server application ID.

    • arn — (String)

      Source server ARN.

    • connectorAction — (map)

      Source Server connector action.

      • connectorArn — (String)

        Source Server connector action connector arn.

      • credentialsSecretArn — (String)

        Source Server connector action credentials secret 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"
          • "UNSUPPORTED_VM_CONFIGURATION"
          • "LAST_SNAPSHOT_JOB_FAILED"
        • 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"
        • "PENDING_SNAPSHOT_SHIPPING"
        • "SHIPPING_SNAPSHOT"
      • etaDateTime — (String)

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

      • lagDuration — (String)

        Request to query data replication lag duration.

      • lastSnapshotDateTime — (String)

        Request to query data replication last snapshot time.

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

    • fqdnForActionFramework — (String)

      Source server fqdn for action framework.

    • isArchived — (Boolean)

      Source server archived status.

    • launchedInstance — (map)

      Source server launched instance.

      • ec2InstanceID — (String)

        Launched instance EC2 ID.

      • firstBoot — (String)

        Launched instance first boot.

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

        Launched 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 finalized.

          • 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"
        • "DISCOVERED"
        • "PENDING_INSTALLATION"
    • replicationType — (String)

      Source server replication type.

      Possible values include:
      • "AGENT_BASED"
      • "SNAPSHOT_SHIPPING"
    • 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.

        • vmPath — (String)

          vCenter VM path 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.

    • userProvidedID — (String)

      Source server user provided ID.

    • vcenterClientID — (String)

      Source server vCenter client id.

Returns:

• (AWS.Request) —

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

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

    Request to finalize Cutover by Source Account ID.

  • sourceServerID — (String)

    Request to finalize Cutover 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:

    • applicationID — (String)

      Source server application ID.

    • arn — (String)

      Source server ARN.

    • connectorAction — (map)

      Source Server connector action.

      • connectorArn — (String)

        Source Server connector action connector arn.

      • credentialsSecretArn — (String)

        Source Server connector action credentials secret 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"
          • "UNSUPPORTED_VM_CONFIGURATION"
          • "LAST_SNAPSHOT_JOB_FAILED"
        • 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"
        • "PENDING_SNAPSHOT_SHIPPING"
        • "SHIPPING_SNAPSHOT"
      • etaDateTime — (String)

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

      • lagDuration — (String)

        Request to query data replication lag duration.

      • lastSnapshotDateTime — (String)

        Request to query data replication last snapshot time.

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

    • fqdnForActionFramework — (String)

      Source server fqdn for action framework.

    • isArchived — (Boolean)

      Source server archived status.

    • launchedInstance — (map)

      Source server launched instance.

      • ec2InstanceID — (String)

        Launched instance EC2 ID.

      • firstBoot — (String)

        Launched instance first boot.

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

        Launched 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 finalized.

          • 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"
        • "DISCOVERED"
        • "PENDING_INSTALLATION"
    • replicationType — (String)

      Source server replication type.

      Possible values include:
      • "AGENT_BASED"
      • "SNAPSHOT_SHIPPING"
    • 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.

        • vmPath — (String)

          vCenter VM path 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.

    • userProvidedID — (String)

      Source server user provided ID.

    • vcenterClientID — (String)

      Source server vCenter client id.

Returns:

• (AWS.Request) —

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

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

    Request to get Launch Configuration information by Account ID.

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

    • bootMode — (String)

      Launch configuration boot mode.

      Possible values include:
      • "LEGACY_BIOS"
      • "UEFI"
      • "USE_SOURCE"
    • copyPrivateIp — (Boolean)

      Copy Private IP during Launch Configuration.

    • copyTags — (Boolean)

      Copy Tags during Launch Configuration.

    • ec2LaunchTemplateID — (String)

      Launch configuration EC2 Launch template ID.

    • enableMapAutoTagging — (Boolean)

      Enable map auto tagging.

    • launchDisposition — (String)

      Launch disposition for launch configuration.

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

      Launch configuration OS licensing.

      • osByol — (Boolean)

        Configure BYOL OS licensing.

    • mapAutoTaggingMpeID — (String)

      Map auto tagging MPE ID.

    • name — (String)

      Launch configuration name.

    • postLaunchActions — (map)

      Post Launch Actions to executed on the Test or Cutover instance.

      • cloudWatchLogGroupName — (String)

        AWS Systems Manager Command's CloudWatch log group name.

      • deployment — (String)

        Deployment type in which AWS Systems Manager Documents will be executed.

        Possible values include:
        • "TEST_AND_CUTOVER"
        • "CUTOVER_ONLY"
        • "TEST_ONLY"
      • s3LogBucket — (String)

        AWS Systems Manager Command's logs S3 log bucket.

      • s3OutputKeyPrefix — (String)

        AWS Systems Manager Command's logs S3 output key prefix.

      • ssmDocuments — (Array<map>)

        AWS Systems Manager Documents.

        • actionName — required — (String)

          User-friendly name for the AWS Systems Manager Document.

        • externalParameters — (map<map>)

          AWS Systems Manager Document external parameters.

          • dynamicPath — (String)

            AWS Systems Manager Document external parameters dynamic path.

        • mustSucceedForCutover — (Boolean)

          If true, Cutover will not be enabled if the document has failed.

        • parameters — (map<Array<map>>)

          AWS Systems Manager Document parameters.

          • parameterName — required — (String)

            AWS Systems Manager Parameter Store parameter name.

          • parameterType — required — (String)

            AWS Systems Manager Parameter Store parameter type.

            Possible values include:
            • "STRING"
        • ssmDocumentName — required — (String)

          AWS Systems Manager Document name or full ARN.

        • timeoutSeconds — (Integer)

          AWS Systems Manager Document timeout seconds.

    • sourceServerID — (String)

      Launch configuration Source Server ID.

    • targetInstanceTypeRightSizingMethod — (String)

      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.

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

    Request to get Replication Configuration by Account ID.

  • sourceServerID — (String)

    Request to get Replication Configuration 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"
      • "GP3"
    • 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"
        • "GP3"
        • "IO2"
      • throughput — (Integer)

        Replication Configuration replicated disk throughput.

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

    • useFipsEndpoint — (Boolean)

      Replication Configuration use Fips Endpoint.

Returns:

• (AWS.Request) —

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

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.

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

    Applications list Account ID.

  • filters — (map)

    Applications list filters.

    • applicationIDs — (Array<String>)

      Filter applications list by application ID.

    • isArchived — (Boolean)

      Filter applications list by archival status.

    • waveIDs — (Array<String>)

      Filter applications list by wave ID.

  • maxResults — (Integer)

    Maximum results to return when listing applications.

  • nextToken — (String)

    Request 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>)

      Applications list.

      • applicationAggregatedStatus — (map)

        Application aggregated status.

        • healthStatus — (String)

          Application aggregated status health status.

          Possible values include:
          • "HEALTHY"
          • "LAGGING"
          • "ERROR"
        • lastUpdateDateTime — (String)

          Application aggregated status last update dateTime.

        • progressStatus — (String)

          Application aggregated status progress status.

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

          Application aggregated status total source servers amount.

      • applicationID — (String)

        Application ID.

      • arn — (String)

        Application ARN.

      • creationDateTime — (String)

        Application creation dateTime.

      • description — (String)

        Application description.

      • isArchived — (Boolean)

        Application archival status.

      • lastModifiedDateTime — (String)

        Application last modified dateTime.

      • name — (String)

        Application name.

      • tags — (map<String>)

        Application tags.

      • waveID — (String)

        Application wave ID.

    • nextToken — (String)

      Response next token.

Returns:

• (AWS.Request) —

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