Class: AWS.SMS

var params = {
  seedReplicationTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  serverId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  encrypted: true || false,
  frequency: 'NUMBER_VALUE',
  kmsKeyId: 'STRING_VALUE',
  licenseType: AWS | BYOL,
  numberOfRecentAmisToKeep: 'NUMBER_VALUE',
  roleName: 'STRING_VALUE',
  runOnce: true || false
};
sms.createReplicationJob(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: {}) —
  • serverId — (String)

    The ID of the server.

  • seedReplicationTime — (Date)

    The seed replication time.

  • frequency — (Integer)

    The time between consecutive replication runs, in hours.

  • runOnce — (Boolean)

    Indicates whether to run the replication job one time.

  • licenseType — (String)

    The license type to be used for the AMI created by a successful replication run.

    Possible values include:
    • "AWS"
    • "BYOL"
  • roleName — (String)

    The name of the IAM role to be used by the Server Migration Service.

  • description — (String)

    The description of the replication job.

  • numberOfRecentAmisToKeep — (Integer)

    The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.

  • encrypted — (Boolean)

    Indicates whether the replication job produces encrypted AMIs.

  • kmsKeyId — (String)

    The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

    • KMS key ID

    • KMS key alias

    • ARN referring to the KMS key ID

    • ARN referring to the KMS key alias

    If encrypted is true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

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:

    • replicationJobId — (String)

      The unique identifier of the replication job.

Returns:

• (AWS.Request) —

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

var params = {
  appId: 'STRING_VALUE',
  forceStopAppReplication: true || false,
  forceTerminateApp: true || false
};
sms.deleteApp(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: {}) —
  • appId — (String)

    The ID of the application.

  • forceStopAppReplication — (Boolean)

    Indicates whether to stop all replication jobs corresponding to the servers in the application while deleting the application.

  • forceTerminateApp — (Boolean)

    Indicates whether to terminate the stack corresponding to the application while deleting the application.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  appId: 'STRING_VALUE'
};
sms.deleteAppLaunchConfiguration(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: {}) —
  • appId — (String)

    The ID of the application.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  appId: 'STRING_VALUE'
};
sms.deleteAppReplicationConfiguration(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: {}) —
  • appId — (String)

    The ID of the application.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

    The ID of the application.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

    The ID of the replication job.

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 = {
};
sms.deleteServerCatalog(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 = {
  connectorId: 'STRING_VALUE' /* required */
};
sms.disassociateConnector(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)

    The ID of the connector.

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 = {
  appId: 'STRING_VALUE',
  changesetFormat: JSON | YAML
};
sms.generateChangeSet(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: {}) —
  • appId — (String)

    The ID of the application associated with the change set.

  • changesetFormat — (String)

    The format for the change set.

    Possible values include:
    • "JSON"
    • "YAML"

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:

    • s3Location — (map)

      The location of the Amazon S3 object.

      • bucket — (String)

        The Amazon S3 bucket name.

      • key — (String)

        The Amazon S3 bucket key.

Returns:

• (AWS.Request) —

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

var params = {
  appId: 'STRING_VALUE',
  templateFormat: JSON | YAML
};
sms.generateTemplate(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: {}) —
  • appId — (String)

    The ID of the application associated with the CloudFormation template.

  • templateFormat — (String)

    The format for generating the CloudFormation template.

    Possible values include:
    • "JSON"
    • "YAML"

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:

    • s3Location — (map)

      The location of the Amazon S3 object.

      • bucket — (String)

        The Amazon S3 bucket name.

      • key — (String)

        The Amazon S3 bucket key.

Returns:

• (AWS.Request) —

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

var params = {
  appId: 'STRING_VALUE'
};
sms.getApp(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: {}) —
  • appId — (String)

    The ID of the application.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • appSummary — (map)

      Information about the application.

      • appId — (String)

        The unique ID of the application.

      • importedAppId — (String)

        The ID of the application.

      • name — (String)

        The name of the application.

      • description — (String)

        The description of the application.

      • status — (String)

        Status of the application.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "DELETED"
        • "DELETE_FAILED"
      • statusMessage — (String)

        A message related to the status of the application

      • replicationConfigurationStatus — (String)

        Status of the replication configuration.

        Possible values include:
        • "NOT_CONFIGURED"
        • "CONFIGURED"
      • replicationStatus — (String)

        The replication status of the application.

        Possible values include:
        • "READY_FOR_CONFIGURATION"
        • "CONFIGURATION_IN_PROGRESS"
        • "CONFIGURATION_INVALID"
        • "READY_FOR_REPLICATION"
        • "VALIDATION_IN_PROGRESS"
        • "REPLICATION_PENDING"
        • "REPLICATION_IN_PROGRESS"
        • "REPLICATED"
        • "PARTIALLY_REPLICATED"
        • "DELTA_REPLICATION_IN_PROGRESS"
        • "DELTA_REPLICATED"
        • "DELTA_REPLICATION_FAILED"
        • "REPLICATION_FAILED"
        • "REPLICATION_STOPPING"
        • "REPLICATION_STOP_FAILED"
        • "REPLICATION_STOPPED"
      • replicationStatusMessage — (String)

        A message related to the replication status of the application.

      • latestReplicationTime — (Date)

        The timestamp of the application's most recent successful replication.

      • launchConfigurationStatus — (String)

        Status of the launch configuration.

        Possible values include:
        • "NOT_CONFIGURED"
        • "CONFIGURED"
      • launchStatus — (String)

        The launch status of the application.

        Possible values include:
        • "READY_FOR_CONFIGURATION"
        • "CONFIGURATION_IN_PROGRESS"
        • "CONFIGURATION_INVALID"
        • "READY_FOR_LAUNCH"
        • "VALIDATION_IN_PROGRESS"
        • "LAUNCH_PENDING"
        • "LAUNCH_IN_PROGRESS"
        • "LAUNCHED"
        • "PARTIALLY_LAUNCHED"
        • "DELTA_LAUNCH_IN_PROGRESS"
        • "DELTA_LAUNCH_FAILED"
        • "LAUNCH_FAILED"
        • "TERMINATE_IN_PROGRESS"
        • "TERMINATE_FAILED"
        • "TERMINATED"
      • launchStatusMessage — (String)

        A message related to the launch status of the application.

      • launchDetails — (map)

        Details about the latest launch of the application.

        • latestLaunchTime — (Date)

          The latest time that this application was launched successfully.

        • stackName — (String)

          The name of the latest stack launched for this application.

        • stackId — (String)

          The ID of the latest stack launched for this application.

      • creationTime — (Date)

        The creation time of the application.

      • lastModified — (Date)

        The last modified time of the application.

      • roleName — (String)

        The name of the service role in the customer's account used by Server Migration Service.

      • totalServerGroups — (Integer)

        The number of server groups present in the application.

      • totalServers — (Integer)

        The number of servers present in the application.

    • serverGroups — (Array<map>)

      The server groups that belong to the application.

      • serverGroupId — (String)

        The ID of a server group.

      • name — (String)

        The name of a server group.

      • serverList — (Array<map>)

        The servers that belong to a server group.

        • serverId — (String)

          The ID of the server.

        • serverType — (String)

          The type of server.

          Possible values include:
          • "VIRTUAL_MACHINE"
        • vmServer — (map)

          Information about the VM server.

          • vmServerAddress — (map)

            The VM server location.

            • vmManagerId — (String)

              The ID of the VM manager.

            • vmId — (String)

              The ID of the VM.

          • vmName — (String)

            The name of the VM.

          • vmManagerName — (String)

            The name of the VM manager.

          • vmManagerType — (String)

            The type of VM management product.

            Possible values include:
            • "VSPHERE"
            • "SCVMM"
            • "HYPERV-MANAGER"
          • vmPath — (String)

            The VM folder path in the vCenter Server virtual machine inventory tree.

        • replicationJobId — (String)

          The ID of the replication job.

        • replicationJobTerminated — (Boolean)

          Indicates whether the replication job is deleted or failed.

    • tags — (Array<map>)

      The tags associated with the application.

      • key — (String)

        The tag key.

      • value — (String)

        The tag value.

Returns:

• (AWS.Request) —

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

var params = {
  appId: 'STRING_VALUE'
};
sms.getAppLaunchConfiguration(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: {}) —
  • appId — (String)

    The ID of the application.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • appId — (String)

      The ID of the application.

    • roleName — (String)

      The name of the service role in the customer's account that CloudFormation uses to launch the application.

    • autoLaunch — (Boolean)

      Indicates whether the application is configured to launch automatically after replication is complete.

    • serverGroupLaunchConfigurations — (Array<map>)

      The launch configurations for server groups in this application.

      • serverGroupId — (String)

        The ID of the server group with which the launch configuration is associated.

      • launchOrder — (Integer)

        The launch order of servers in the server group.

      • serverLaunchConfigurations — (Array<map>)

        The launch configuration for servers in the server group.

        • server — (map)

          The ID of the server with which the launch configuration is associated.

          • serverId — (String)

            The ID of the server.

          • serverType — (String)

            The type of server.

            Possible values include:
            • "VIRTUAL_MACHINE"
          • vmServer — (map)

            Information about the VM server.

            • vmServerAddress — (map)

              The VM server location.

              • vmManagerId — (String)

                The ID of the VM manager.

              • vmId — (String)

                The ID of the VM.

            • vmName — (String)

              The name of the VM.

            • vmManagerName — (String)

              The name of the VM manager.

            • vmManagerType — (String)

              The type of VM management product.

              Possible values include:
              • "VSPHERE"
              • "SCVMM"
              • "HYPERV-MANAGER"
            • vmPath — (String)

              The VM folder path in the vCenter Server virtual machine inventory tree.

          • replicationJobId — (String)

            The ID of the replication job.

          • replicationJobTerminated — (Boolean)

            Indicates whether the replication job is deleted or failed.

        • logicalId — (String)

          The logical ID of the server in the CloudFormation template.

        • vpc — (String)

          The ID of the VPC into which the server should be launched.

        • subnet — (String)

          The ID of the subnet the server should be launched into.

        • securityGroup — (String)

          The ID of the security group that applies to the launched server.

        • ec2KeyName — (String)

          The name of the Amazon EC2 SSH key to be used for connecting to the launched server.

        • userData — (map)

          Location of the user-data script to be executed when launching the server.

          • s3Location — (map)

            Amazon S3 location of the user-data script.

            • bucket — (String)

              The Amazon S3 bucket name.

            • key — (String)

              The Amazon S3 bucket key.

        • instanceType — (String)

          The instance type to use when launching the server.

        • associatePublicIpAddress — (Boolean)

          Indicates whether a publicly accessible IP address is created when launching the server.

        • iamInstanceProfileName — (String)

          The name of the IAM instance profile.

        • configureScript — (map)

          Location of an Amazon S3 object.

          • bucket — (String)

            The Amazon S3 bucket name.

          • key — (String)

            The Amazon S3 bucket key.

        • configureScriptType — (String)

          The type of configuration script.

          Possible values include:
          • "SHELL_SCRIPT"
          • "POWERSHELL_SCRIPT"

Returns:

• (AWS.Request) —

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

var params = {
  appId: 'STRING_VALUE'
};
sms.getAppReplicationConfiguration(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: {}) —
  • appId — (String)

    The ID of the application.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • serverGroupReplicationConfigurations — (Array<map>)

      The replication configurations associated with server groups in this application.

      • serverGroupId — (String)

        The ID of the server group with which this replication configuration is associated.

      • serverReplicationConfigurations — (Array<map>)

        The replication configuration for servers in the server group.

        • server — (map)

          The ID of the server with which this replication configuration is associated.

          • serverId — (String)

            The ID of the server.

          • serverType — (String)

            The type of server.

            Possible values include:
            • "VIRTUAL_MACHINE"
          • vmServer — (map)

            Information about the VM server.

            • vmServerAddress — (map)

              The VM server location.

              • vmManagerId — (String)

                The ID of the VM manager.

              • vmId — (String)

                The ID of the VM.

            • vmName — (String)

              The name of the VM.

            • vmManagerName — (String)

              The name of the VM manager.

            • vmManagerType — (String)

              The type of VM management product.

              Possible values include:
              • "VSPHERE"
              • "SCVMM"
              • "HYPERV-MANAGER"
            • vmPath — (String)

              The VM folder path in the vCenter Server virtual machine inventory tree.

          • replicationJobId — (String)

            The ID of the replication job.

          • replicationJobTerminated — (Boolean)

            Indicates whether the replication job is deleted or failed.

        • serverReplicationParameters — (map)

          The parameters for replicating the server.

          • seedTime — (Date)

            The seed time for creating a replication job for the server.

          • frequency — (Integer)

            The frequency of creating replication jobs for the server.

          • runOnce — (Boolean)

            Indicates whether to run the replication job one time.

          • licenseType — (String)

            The license type for creating a replication job for the server.

            Possible values include:
            • "AWS"
            • "BYOL"
          • numberOfRecentAmisToKeep — (Integer)

            The number of recent AMIs to keep when creating a replication job for this server.

          • encrypted — (Boolean)

            Indicates whether the replication job produces encrypted AMIs.

          • kmsKeyId — (String)

            The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

            • KMS key ID

            • KMS key alias

            • ARN referring to the KMS key ID

            • ARN referring to the KMS key alias

            If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

Returns:

• (AWS.Request) —

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

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

    The ID of the application.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • appValidationConfigurations — (Array<map>)

      The configuration for application validation.

      • validationId — (String)

        The ID of the validation.

      • name — (String)

        The name of the configuration.

      • appValidationStrategy — (String)

        The validation strategy.

        Possible values include:
        • "SSM"
      • ssmValidationParameters — (map)

        The validation parameters.

        • source — (map)

          The location of the validation script.

          • s3Location — (map)

            Location of an Amazon S3 object.

            • bucket — (String)

              The Amazon S3 bucket name.

            • key — (String)

              The Amazon S3 bucket key.

        • instanceId — (String)

          The ID of the instance. The instance must have the following tag: UserForSMSApplicationValidation=true.

        • scriptType — (String)

          The type of validation script.

          Possible values include:
          • "SHELL_SCRIPT"
          • "POWERSHELL_SCRIPT"
        • command — (String)

          The command to run the validation script.

        • executionTimeoutSeconds — (Integer)

          The timeout interval, in seconds.

        • outputS3BucketName — (String)

          The name of the S3 bucket for output.

    • serverGroupValidationConfigurations — (Array<map>)

      The configuration for instance validation.

      • serverGroupId — (String)

        The ID of the server group.

      • serverValidationConfigurations — (Array<map>)

        The validation configuration.

        • server — (map)

          Represents a server.

          • serverId — (String)

            The ID of the server.

          • serverType — (String)

            The type of server.

            Possible values include:
            • "VIRTUAL_MACHINE"
          • vmServer — (map)

            Information about the VM server.

            • vmServerAddress — (map)

              The VM server location.

              • vmManagerId — (String)

                The ID of the VM manager.

              • vmId — (String)

                The ID of the VM.

            • vmName — (String)

              The name of the VM.

            • vmManagerName — (String)

              The name of the VM manager.

            • vmManagerType — (String)

              The type of VM management product.

              Possible values include:
              • "VSPHERE"
              • "SCVMM"
              • "HYPERV-MANAGER"
            • vmPath — (String)

              The VM folder path in the vCenter Server virtual machine inventory tree.

          • replicationJobId — (String)

            The ID of the replication job.

          • replicationJobTerminated — (Boolean)

            Indicates whether the replication job is deleted or failed.

        • validationId — (String)

          The ID of the validation.

        • name — (String)

          The name of the configuration.

        • serverValidationStrategy — (String)

          The validation strategy.

          Possible values include:
          • "USERDATA"
        • userDataValidationParameters — (map)

          The validation parameters.

          • source — (map)

            The location of the validation script.

            • s3Location — (map)

              Location of an Amazon S3 object.

              • bucket — (String)

                The Amazon S3 bucket name.

              • key — (String)

                The Amazon S3 bucket key.

          • scriptType — (String)

            The type of validation script.

            Possible values include:
            • "SHELL_SCRIPT"
            • "POWERSHELL_SCRIPT"

Returns:

• (AWS.Request) —

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

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

    The ID of the application.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • validationOutputList — (Array<map>)

      The validation output.

      • validationId — (String)

        The ID of the validation.

      • name — (String)

        The name of the validation.

      • status — (String)

        The status of the validation.

        Possible values include:
        • "READY_FOR_VALIDATION"
        • "PENDING"
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "FAILED"
      • statusMessage — (String)

        The status message.

      • latestValidationTime — (Date)

        The latest time that the validation was performed.

      • appValidationOutput — (map)

        The output from validating an application.

        • ssmOutput — (map)

          Output from using SSM to validate the application.

          • s3Location — (map)

            Location of an Amazon S3 object.

            • bucket — (String)

              The Amazon S3 bucket name.

            • key — (String)

              The Amazon S3 bucket key.

      • serverValidationOutput — (map)

        The output from validation an instance.

        • server — (map)

          Represents a server.

          • serverId — (String)

            The ID of the server.

          • serverType — (String)

            The type of server.

            Possible values include:
            • "VIRTUAL_MACHINE"
          • vmServer — (map)

            Information about the VM server.

            • vmServerAddress — (map)

              The VM server location.

              • vmManagerId — (String)

                The ID of the VM manager.

              • vmId — (String)

                The ID of the VM.

            • vmName — (String)

              The name of the VM.

            • vmManagerName — (String)

              The name of the VM manager.

            • vmManagerType — (String)

              The type of VM management product.

              Possible values include:
              • "VSPHERE"
              • "SCVMM"
              • "HYPERV-MANAGER"
            • vmPath — (String)

              The VM folder path in the vCenter Server virtual machine inventory tree.

          • replicationJobId — (String)

            The ID of the replication job.

          • replicationJobTerminated — (Boolean)

            Indicates whether the replication job is deleted or failed.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
sms.getConnectors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The token for the next set of results.

  • maxResults — (Integer)

    The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

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:

    • connectorList — (Array<map>)

      Information about the registered connectors.

      • connectorId — (String)

        The ID of the connector.

      • version — (String)

        The connector version.

      • status — (String)

        The status of the connector.

        Possible values include:
        • "HEALTHY"
        • "UNHEALTHY"
      • capabilityList — (Array<String>)

        The capabilities of the connector.

      • vmManagerName — (String)

        The name of the VM manager.

      • vmManagerType — (String)

        The VM management product.

        Possible values include:
        • "VSPHERE"
        • "SCVMM"
        • "HYPERV-MANAGER"
      • vmManagerId — (String)

        The ID of the VM manager.

      • ipAddress — (String)

        The IP address of the connector.

      • macAddress — (String)

        The MAC address of the connector.

      • associatedOn — (Date)

        The time the connector was associated.

    • nextToken — (String)

      The token required to retrieve the next set of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  replicationJobId: 'STRING_VALUE'
};
sms.getReplicationJobs(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: {}) —
  • replicationJobId — (String)

    The ID of the replication job.

  • nextToken — (String)

    The token for the next set of results.

  • maxResults — (Integer)

    The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

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:

    • replicationJobList — (Array<map>)

      Information about the replication jobs.

      • replicationJobId — (String)

        The ID of the replication job.

      • serverId — (String)

        The ID of the server.

      • serverType — (String)

        The type of server.

        Possible values include:
        • "VIRTUAL_MACHINE"
      • vmServer — (map)

        Information about the VM server.

        • vmServerAddress — (map)

          The VM server location.

          • vmManagerId — (String)

            The ID of the VM manager.

          • vmId — (String)

            The ID of the VM.

        • vmName — (String)

          The name of the VM.

        • vmManagerName — (String)

          The name of the VM manager.

        • vmManagerType — (String)

          The type of VM management product.

          Possible values include:
          • "VSPHERE"
          • "SCVMM"
          • "HYPERV-MANAGER"
        • vmPath — (String)

          The VM folder path in the vCenter Server virtual machine inventory tree.

      • seedReplicationTime — (Date)

        The seed replication time.

      • frequency — (Integer)

        The time between consecutive replication runs, in hours.

      • runOnce — (Boolean)

        Indicates whether to run the replication job one time.

      • nextReplicationRunStartTime — (Date)

        The start time of the next replication run.

      • licenseType — (String)

        The license type to be used for the AMI created by a successful replication run.

        Possible values include:
        • "AWS"
        • "BYOL"
      • roleName — (String)

        The name of the IAM role to be used by Server Migration Service.

      • latestAmiId — (String)

        The ID of the latest Amazon Machine Image (AMI).

      • state — (String)

        The state of the replication job.

        Possible values include:
        • "PENDING"
        • "ACTIVE"
        • "FAILED"
        • "DELETING"
        • "DELETED"
        • "COMPLETED"
        • "PAUSED_ON_FAILURE"
        • "FAILING"
      • statusMessage — (String)

        The description of the current status of the replication job.

      • description — (String)

        The description of the replication job.

      • numberOfRecentAmisToKeep — (Integer)

        The number of recent AMIs to keep in the customer's account for a replication job. By default, the value is set to zero, meaning that all AMIs are kept.

      • encrypted — (Boolean)

        Indicates whether the replication job should produce encrypted AMIs.

      • kmsKeyId — (String)

        The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

        • KMS key ID

        • KMS key alias

        • ARN referring to the KMS key ID

        • ARN referring to the KMS key alias

        If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

      • replicationRunList — (Array<map>)

        Information about the replication runs.

        • replicationRunId — (String)

          The ID of the replication run.

        • state — (String)

          The state of the replication run.

          Possible values include:
          • "PENDING"
          • "MISSED"
          • "ACTIVE"
          • "FAILED"
          • "COMPLETED"
          • "DELETING"
          • "DELETED"
        • type — (String)

          The type of replication run.

          Possible values include:
          • "ON_DEMAND"
          • "AUTOMATIC"
        • stageDetails — (map)

          Details about the current stage of the replication run.

          • stage — (String)

            The current stage of a replication run.

          • stageProgress — (String)

            The progress of the current stage of a replication run.

        • statusMessage — (String)

          The description of the current status of the replication job.

        • amiId — (String)

          The ID of the Amazon Machine Image (AMI) from the replication run.

        • scheduledStartTime — (Date)

          The start time of the next replication run.

        • completedTime — (Date)

          The completion time of the last replication run.

        • description — (String)

          The description of the replication run.

        • encrypted — (Boolean)

          Indicates whether the replication run should produce an encrypted AMI.

        • kmsKeyId — (String)

          The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

          • KMS key ID

          • KMS key alias

          • ARN referring to the KMS key ID

          • ARN referring to the KMS key alias

          If encrypted is true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

    • nextToken — (String)

      The token required to retrieve the next set of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

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

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

    The ID of the replication job.

  • nextToken — (String)

    The token for the next set of results.

  • maxResults — (Integer)

    The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

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:

    • replicationJob — (map)

      Information about the replication job.

      • replicationJobId — (String)

        The ID of the replication job.

      • serverId — (String)

        The ID of the server.

      • serverType — (String)

        The type of server.

        Possible values include:
        • "VIRTUAL_MACHINE"
      • vmServer — (map)

        Information about the VM server.

        • vmServerAddress — (map)

          The VM server location.

          • vmManagerId — (String)

            The ID of the VM manager.

          • vmId — (String)

            The ID of the VM.

        • vmName — (String)

          The name of the VM.

        • vmManagerName — (String)

          The name of the VM manager.

        • vmManagerType — (String)

          The type of VM management product.

          Possible values include:
          • "VSPHERE"
          • "SCVMM"
          • "HYPERV-MANAGER"
        • vmPath — (String)

          The VM folder path in the vCenter Server virtual machine inventory tree.

      • seedReplicationTime — (Date)

        The seed replication time.

      • frequency — (Integer)

        The time between consecutive replication runs, in hours.

      • runOnce — (Boolean)

        Indicates whether to run the replication job one time.

      • nextReplicationRunStartTime — (Date)

        The start time of the next replication run.

      • licenseType — (String)

        The license type to be used for the AMI created by a successful replication run.

        Possible values include:
        • "AWS"
        • "BYOL"
      • roleName — (String)

        The name of the IAM role to be used by Server Migration Service.

      • latestAmiId — (String)

        The ID of the latest Amazon Machine Image (AMI).

      • state — (String)

        The state of the replication job.

        Possible values include:
        • "PENDING"
        • "ACTIVE"
        • "FAILED"
        • "DELETING"
        • "DELETED"
        • "COMPLETED"
        • "PAUSED_ON_FAILURE"
        • "FAILING"
      • statusMessage — (String)

        The description of the current status of the replication job.

      • description — (String)

        The description of the replication job.

      • numberOfRecentAmisToKeep — (Integer)

        The number of recent AMIs to keep in the customer's account for a replication job. By default, the value is set to zero, meaning that all AMIs are kept.

      • encrypted — (Boolean)

        Indicates whether the replication job should produce encrypted AMIs.

      • kmsKeyId — (String)

        The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

        • KMS key ID

        • KMS key alias

        • ARN referring to the KMS key ID

        • ARN referring to the KMS key alias

        If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

      • replicationRunList — (Array<map>)

        Information about the replication runs.

        • replicationRunId — (String)

          The ID of the replication run.

        • state — (String)

          The state of the replication run.

          Possible values include:
          • "PENDING"
          • "MISSED"
          • "ACTIVE"
          • "FAILED"
          • "COMPLETED"
          • "DELETING"
          • "DELETED"
        • type — (String)

          The type of replication run.

          Possible values include:
          • "ON_DEMAND"
          • "AUTOMATIC"
        • stageDetails — (map)

          Details about the current stage of the replication run.

          • stage — (String)

            The current stage of a replication run.

          • stageProgress — (String)

            The progress of the current stage of a replication run.

        • statusMessage — (String)

          The description of the current status of the replication job.

        • amiId — (String)

          The ID of the Amazon Machine Image (AMI) from the replication run.

        • scheduledStartTime — (Date)

          The start time of the next replication run.

        • completedTime — (Date)

          The completion time of the last replication run.

        • description — (String)

          The description of the replication run.

        • encrypted — (Boolean)

          Indicates whether the replication run should produce an encrypted AMI.

        • kmsKeyId — (String)

          The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

          • KMS key ID

          • KMS key alias

          • ARN referring to the KMS key ID

          • ARN referring to the KMS key alias

          If encrypted is true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

    • replicationRunList — (Array<map>)

      Information about the replication runs.

      • replicationRunId — (String)

        The ID of the replication run.

      • state — (String)

        The state of the replication run.

        Possible values include:
        • "PENDING"
        • "MISSED"
        • "ACTIVE"
        • "FAILED"
        • "COMPLETED"
        • "DELETING"
        • "DELETED"
      • type — (String)

        The type of replication run.

        Possible values include:
        • "ON_DEMAND"
        • "AUTOMATIC"
      • stageDetails — (map)

        Details about the current stage of the replication run.

        • stage — (String)

          The current stage of a replication run.

        • stageProgress — (String)

          The progress of the current stage of a replication run.

      • statusMessage — (String)

        The description of the current status of the replication job.

      • amiId — (String)

        The ID of the Amazon Machine Image (AMI) from the replication run.

      • scheduledStartTime — (Date)

        The start time of the next replication run.

      • completedTime — (Date)

        The completion time of the last replication run.

      • description — (String)

        The description of the replication run.

      • encrypted — (Boolean)

        Indicates whether the replication run should produce an encrypted AMI.

      • kmsKeyId — (String)

        The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

        • KMS key ID

        • KMS key alias

        • ARN referring to the KMS key ID

        • ARN referring to the KMS key alias

        If encrypted is true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

    • nextToken — (String)

      The token required to retrieve the next set of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  vmServerAddressList: [
    {
      vmId: 'STRING_VALUE',
      vmManagerId: 'STRING_VALUE'
    },
    /* more items */
  ]
};
sms.getServers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The token for the next set of results.

  • maxResults — (Integer)

    The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

  • vmServerAddressList — (Array<map>)

    The server addresses.

    • vmManagerId — (String)

      The ID of the VM manager.

    • vmId — (String)

      The ID of the VM.

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:

    • lastModifiedOn — (Date)

      The time when the server was last modified.

    • serverCatalogStatus — (String)

      The status of the server catalog.

      Possible values include:
      • "NOT_IMPORTED"
      • "IMPORTING"
      • "AVAILABLE"
      • "DELETED"
      • "EXPIRED"
    • serverList — (Array<map>)

      Information about the servers.

      • serverId — (String)

        The ID of the server.

      • serverType — (String)

        The type of server.

        Possible values include:
        • "VIRTUAL_MACHINE"
      • vmServer — (map)

        Information about the VM server.

        • vmServerAddress — (map)

          The VM server location.

          • vmManagerId — (String)

            The ID of the VM manager.

          • vmId — (String)

            The ID of the VM.

        • vmName — (String)

          The name of the VM.

        • vmManagerName — (String)

          The name of the VM manager.

        • vmManagerType — (String)

          The type of VM management product.

          Possible values include:
          • "VSPHERE"
          • "SCVMM"
          • "HYPERV-MANAGER"
        • vmPath — (String)

          The VM folder path in the vCenter Server virtual machine inventory tree.

      • replicationJobId — (String)

        The ID of the replication job.

      • replicationJobTerminated — (Boolean)

        Indicates whether the replication job is deleted or failed.

    • nextToken — (String)

      The token required to retrieve the next set of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

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

var params = {
  roleName: 'STRING_VALUE'
};
sms.importAppCatalog(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: {}) —
  • roleName — (String)

    The name of the service role. If you omit this parameter, we create a service-linked role for Migration Hub in your account. Otherwise, the role that you provide must have the policy and trust policy described in the Migration Hub User Guide.

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 = {
};
sms.importServerCatalog(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 = {
  appId: 'STRING_VALUE'
};
sms.launchApp(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: {}) —
  • appId — (String)

    The ID of the application.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

    The unique application IDs.

  • nextToken — (String)

    The token for the next set of results.

  • maxResults — (Integer)

    The maximum number of results to return in a single call. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

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:

    • apps — (Array<map>)

      The application summaries.

      • appId — (String)

        The unique ID of the application.

      • importedAppId — (String)

        The ID of the application.

      • name — (String)

        The name of the application.

      • description — (String)

        The description of the application.

      • status — (String)

        Status of the application.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "DELETED"
        • "DELETE_FAILED"
      • statusMessage — (String)

        A message related to the status of the application

      • replicationConfigurationStatus — (String)

        Status of the replication configuration.

        Possible values include:
        • "NOT_CONFIGURED"
        • "CONFIGURED"
      • replicationStatus — (String)

        The replication status of the application.

        Possible values include:
        • "READY_FOR_CONFIGURATION"
        • "CONFIGURATION_IN_PROGRESS"
        • "CONFIGURATION_INVALID"
        • "READY_FOR_REPLICATION"
        • "VALIDATION_IN_PROGRESS"
        • "REPLICATION_PENDING"
        • "REPLICATION_IN_PROGRESS"
        • "REPLICATED"
        • "PARTIALLY_REPLICATED"
        • "DELTA_REPLICATION_IN_PROGRESS"
        • "DELTA_REPLICATED"
        • "DELTA_REPLICATION_FAILED"
        • "REPLICATION_FAILED"
        • "REPLICATION_STOPPING"
        • "REPLICATION_STOP_FAILED"
        • "REPLICATION_STOPPED"
      • replicationStatusMessage — (String)

        A message related to the replication status of the application.

      • latestReplicationTime — (Date)

        The timestamp of the application's most recent successful replication.

      • launchConfigurationStatus — (String)

        Status of the launch configuration.

        Possible values include:
        • "NOT_CONFIGURED"
        • "CONFIGURED"
      • launchStatus — (String)

        The launch status of the application.

        Possible values include:
        • "READY_FOR_CONFIGURATION"
        • "CONFIGURATION_IN_PROGRESS"
        • "CONFIGURATION_INVALID"
        • "READY_FOR_LAUNCH"
        • "VALIDATION_IN_PROGRESS"
        • "LAUNCH_PENDING"
        • "LAUNCH_IN_PROGRESS"
        • "LAUNCHED"
        • "PARTIALLY_LAUNCHED"
        • "DELTA_LAUNCH_IN_PROGRESS"
        • "DELTA_LAUNCH_FAILED"
        • "LAUNCH_FAILED"
        • "TERMINATE_IN_PROGRESS"
        • "TERMINATE_FAILED"
        • "TERMINATED"
      • launchStatusMessage — (String)

        A message related to the launch status of the application.

      • launchDetails — (map)

        Details about the latest launch of the application.

        • latestLaunchTime — (Date)

          The latest time that this application was launched successfully.

        • stackName — (String)

          The name of the latest stack launched for this application.

        • stackId — (String)

          The ID of the latest stack launched for this application.

      • creationTime — (Date)

        The creation time of the application.

      • lastModified — (Date)

        The last modified time of the application.

      • roleName — (String)

        The name of the service role in the customer's account used by Server Migration Service.

      • totalServerGroups — (Integer)

        The number of server groups present in the application.

      • totalServers — (Integer)

        The number of servers present in the application.

    • nextToken — (String)

      The token required to retrieve the next set of results. This value is null when there are no more results to return.

Returns:

• (AWS.Request) —

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

var params = {
  appId: 'STRING_VALUE', /* required */
  notificationContext: {
    status: READY_FOR_VALIDATION | PENDING | IN_PROGRESS | SUCCEEDED | FAILED,
    statusMessage: 'STRING_VALUE',
    validationId: 'STRING_VALUE'
  }
};
sms.notifyAppValidationOutput(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: {}) —
  • appId — (String)

    The ID of the application.

  • notificationContext — (map)

    The notification information.

    • validationId — (String)

      The ID of the validation.

    • status — (String)

      The status of the validation.

      Possible values include:
      • "READY_FOR_VALIDATION"
      • "PENDING"
      • "IN_PROGRESS"
      • "SUCCEEDED"
      • "FAILED"
    • statusMessage — (String)

      The status message.

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 = {
  appId: 'STRING_VALUE',
  autoLaunch: true || false,
  roleName: 'STRING_VALUE',
  serverGroupLaunchConfigurations: [
    {
      launchOrder: 'NUMBER_VALUE',
      serverGroupId: 'STRING_VALUE',
      serverLaunchConfigurations: [
        {
          associatePublicIpAddress: true || false,
          configureScript: {
            bucket: 'STRING_VALUE',
            key: 'STRING_VALUE'
          },
          configureScriptType: SHELL_SCRIPT | POWERSHELL_SCRIPT,
          ec2KeyName: 'STRING_VALUE',
          iamInstanceProfileName: 'STRING_VALUE',
          instanceType: 'STRING_VALUE',
          logicalId: 'STRING_VALUE',
          securityGroup: 'STRING_VALUE',
          server: {
            replicationJobId: 'STRING_VALUE',
            replicationJobTerminated: true || false,
            serverId: 'STRING_VALUE',
            serverType: VIRTUAL_MACHINE,
            vmServer: {
              vmManagerName: 'STRING_VALUE',
              vmManagerType: VSPHERE | SCVMM | HYPERV-MANAGER,
              vmName: 'STRING_VALUE',
              vmPath: 'STRING_VALUE',
              vmServerAddress: {
                vmId: 'STRING_VALUE',
                vmManagerId: 'STRING_VALUE'
              }
            }
          },
          subnet: 'STRING_VALUE',
          userData: {
            s3Location: {
              bucket: 'STRING_VALUE',
              key: 'STRING_VALUE'
            }
          },
          vpc: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
sms.putAppLaunchConfiguration(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: {}) —
  • appId — (String)

    The ID of the application.

  • roleName — (String)

    The name of service role in the customer's account that CloudFormation uses to launch the application.

  • autoLaunch — (Boolean)

    Indicates whether the application is configured to launch automatically after replication is complete.

  • serverGroupLaunchConfigurations — (Array<map>)

    Information about the launch configurations for server groups in the application.

    • serverGroupId — (String)

      The ID of the server group with which the launch configuration is associated.

    • launchOrder — (Integer)

      The launch order of servers in the server group.

    • serverLaunchConfigurations — (Array<map>)

      The launch configuration for servers in the server group.

      • server — (map)

        The ID of the server with which the launch configuration is associated.

        • serverId — (String)

          The ID of the server.

        • serverType — (String)

          The type of server.

          Possible values include:
          • "VIRTUAL_MACHINE"
        • vmServer — (map)

          Information about the VM server.

          • vmServerAddress — (map)

            The VM server location.

            • vmManagerId — (String)

              The ID of the VM manager.

            • vmId — (String)

              The ID of the VM.

          • vmName — (String)

            The name of the VM.

          • vmManagerName — (String)

            The name of the VM manager.

          • vmManagerType — (String)

            The type of VM management product.

            Possible values include:
            • "VSPHERE"
            • "SCVMM"
            • "HYPERV-MANAGER"
          • vmPath — (String)

            The VM folder path in the vCenter Server virtual machine inventory tree.

        • replicationJobId — (String)

          The ID of the replication job.

        • replicationJobTerminated — (Boolean)

          Indicates whether the replication job is deleted or failed.

      • logicalId — (String)

        The logical ID of the server in the CloudFormation template.

      • vpc — (String)

        The ID of the VPC into which the server should be launched.

      • subnet — (String)

        The ID of the subnet the server should be launched into.

      • securityGroup — (String)

        The ID of the security group that applies to the launched server.

      • ec2KeyName — (String)

        The name of the Amazon EC2 SSH key to be used for connecting to the launched server.

      • userData — (map)

        Location of the user-data script to be executed when launching the server.

        • s3Location — (map)

          Amazon S3 location of the user-data script.

          • bucket — (String)

            The Amazon S3 bucket name.

          • key — (String)

            The Amazon S3 bucket key.

      • instanceType — (String)

        The instance type to use when launching the server.

      • associatePublicIpAddress — (Boolean)

        Indicates whether a publicly accessible IP address is created when launching the server.

      • iamInstanceProfileName — (String)

        The name of the IAM instance profile.

      • configureScript — (map)

        Location of an Amazon S3 object.

        • bucket — (String)

          The Amazon S3 bucket name.

        • key — (String)

          The Amazon S3 bucket key.

      • configureScriptType — (String)

        The type of configuration script.

        Possible values include:
        • "SHELL_SCRIPT"
        • "POWERSHELL_SCRIPT"

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 = {
  appId: 'STRING_VALUE',
  serverGroupReplicationConfigurations: [
    {
      serverGroupId: 'STRING_VALUE',
      serverReplicationConfigurations: [
        {
          server: {
            replicationJobId: 'STRING_VALUE',
            replicationJobTerminated: true || false,
            serverId: 'STRING_VALUE',
            serverType: VIRTUAL_MACHINE,
            vmServer: {
              vmManagerName: 'STRING_VALUE',
              vmManagerType: VSPHERE | SCVMM | HYPERV-MANAGER,
              vmName: 'STRING_VALUE',
              vmPath: 'STRING_VALUE',
              vmServerAddress: {
                vmId: 'STRING_VALUE',
                vmManagerId: 'STRING_VALUE'
              }
            }
          },
          serverReplicationParameters: {
            encrypted: true || false,
            frequency: 'NUMBER_VALUE',
            kmsKeyId: 'STRING_VALUE',
            licenseType: AWS | BYOL,
            numberOfRecentAmisToKeep: 'NUMBER_VALUE',
            runOnce: true || false,
            seedTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
          }
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
sms.putAppReplicationConfiguration(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: {}) —
  • appId — (String)

    The ID of the application.

  • serverGroupReplicationConfigurations — (Array<map>)

    Information about the replication configurations for server groups in the application.

    • serverGroupId — (String)

      The ID of the server group with which this replication configuration is associated.

    • serverReplicationConfigurations — (Array<map>)

      The replication configuration for servers in the server group.

      • server — (map)

        The ID of the server with which this replication configuration is associated.

        • serverId — (String)

          The ID of the server.

        • serverType — (String)

          The type of server.

          Possible values include:
          • "VIRTUAL_MACHINE"
        • vmServer — (map)

          Information about the VM server.

          • vmServerAddress — (map)

            The VM server location.

            • vmManagerId — (String)

              The ID of the VM manager.

            • vmId — (String)

              The ID of the VM.

          • vmName — (String)

            The name of the VM.

          • vmManagerName — (String)

            The name of the VM manager.

          • vmManagerType — (String)

            The type of VM management product.

            Possible values include:
            • "VSPHERE"
            • "SCVMM"
            • "HYPERV-MANAGER"
          • vmPath — (String)

            The VM folder path in the vCenter Server virtual machine inventory tree.

        • replicationJobId — (String)

          The ID of the replication job.

        • replicationJobTerminated — (Boolean)

          Indicates whether the replication job is deleted or failed.

      • serverReplicationParameters — (map)

        The parameters for replicating the server.

        • seedTime — (Date)

          The seed time for creating a replication job for the server.

        • frequency — (Integer)

          The frequency of creating replication jobs for the server.

        • runOnce — (Boolean)

          Indicates whether to run the replication job one time.

        • licenseType — (String)

          The license type for creating a replication job for the server.

          Possible values include:
          • "AWS"
          • "BYOL"
        • numberOfRecentAmisToKeep — (Integer)

          The number of recent AMIs to keep when creating a replication job for this server.

        • encrypted — (Boolean)

          Indicates whether the replication job produces encrypted AMIs.

        • kmsKeyId — (String)

          The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

          • KMS key ID

          • KMS key alias

          • ARN referring to the KMS key ID

          • ARN referring to the KMS key alias

          If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

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 = {
  appId: 'STRING_VALUE', /* required */
  appValidationConfigurations: [
    {
      appValidationStrategy: SSM,
      name: 'STRING_VALUE',
      ssmValidationParameters: {
        command: 'STRING_VALUE',
        executionTimeoutSeconds: 'NUMBER_VALUE',
        instanceId: 'STRING_VALUE',
        outputS3BucketName: 'STRING_VALUE',
        scriptType: SHELL_SCRIPT | POWERSHELL_SCRIPT,
        source: {
          s3Location: {
            bucket: 'STRING_VALUE',
            key: 'STRING_VALUE'
          }
        }
      },
      validationId: 'STRING_VALUE'
    },
    /* more items */
  ],
  serverGroupValidationConfigurations: [
    {
      serverGroupId: 'STRING_VALUE',
      serverValidationConfigurations: [
        {
          name: 'STRING_VALUE',
          server: {
            replicationJobId: 'STRING_VALUE',
            replicationJobTerminated: true || false,
            serverId: 'STRING_VALUE',
            serverType: VIRTUAL_MACHINE,
            vmServer: {
              vmManagerName: 'STRING_VALUE',
              vmManagerType: VSPHERE | SCVMM | HYPERV-MANAGER,
              vmName: 'STRING_VALUE',
              vmPath: 'STRING_VALUE',
              vmServerAddress: {
                vmId: 'STRING_VALUE',
                vmManagerId: 'STRING_VALUE'
              }
            }
          },
          serverValidationStrategy: USERDATA,
          userDataValidationParameters: {
            scriptType: SHELL_SCRIPT | POWERSHELL_SCRIPT,
            source: {
              s3Location: {
                bucket: 'STRING_VALUE',
                key: 'STRING_VALUE'
              }
            }
          },
          validationId: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
sms.putAppValidationConfiguration(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: {}) —
  • appId — (String)

    The ID of the application.

  • appValidationConfigurations — (Array<map>)

    The configuration for application validation.

    • validationId — (String)

      The ID of the validation.

    • name — (String)

      The name of the configuration.

    • appValidationStrategy — (String)

      The validation strategy.

      Possible values include:
      • "SSM"
    • ssmValidationParameters — (map)

      The validation parameters.

      • source — (map)

        The location of the validation script.

        • s3Location — (map)

          Location of an Amazon S3 object.

          • bucket — (String)

            The Amazon S3 bucket name.

          • key — (String)

            The Amazon S3 bucket key.

      • instanceId — (String)

        The ID of the instance. The instance must have the following tag: UserForSMSApplicationValidation=true.

      • scriptType — (String)

        The type of validation script.

        Possible values include:
        • "SHELL_SCRIPT"
        • "POWERSHELL_SCRIPT"
      • command — (String)

        The command to run the validation script.

      • executionTimeoutSeconds — (Integer)

        The timeout interval, in seconds.

      • outputS3BucketName — (String)

        The name of the S3 bucket for output.

  • serverGroupValidationConfigurations — (Array<map>)

    The configuration for instance validation.

    • serverGroupId — (String)

      The ID of the server group.

    • serverValidationConfigurations — (Array<map>)

      The validation configuration.

      • server — (map)

        Represents a server.

        • serverId — (String)

          The ID of the server.

        • serverType — (String)

          The type of server.

          Possible values include:
          • "VIRTUAL_MACHINE"
        • vmServer — (map)

          Information about the VM server.

          • vmServerAddress — (map)

            The VM server location.

            • vmManagerId — (String)

              The ID of the VM manager.

            • vmId — (String)

              The ID of the VM.

          • vmName — (String)

            The name of the VM.

          • vmManagerName — (String)

            The name of the VM manager.

          • vmManagerType — (String)

            The type of VM management product.

            Possible values include:
            • "VSPHERE"
            • "SCVMM"
            • "HYPERV-MANAGER"
          • vmPath — (String)

            The VM folder path in the vCenter Server virtual machine inventory tree.

        • replicationJobId — (String)

          The ID of the replication job.

        • replicationJobTerminated — (Boolean)

          Indicates whether the replication job is deleted or failed.

      • validationId — (String)

        The ID of the validation.

      • name — (String)

        The name of the configuration.

      • serverValidationStrategy — (String)

        The validation strategy.

        Possible values include:
        • "USERDATA"
      • userDataValidationParameters — (map)

        The validation parameters.

        • source — (map)

          The location of the validation script.

          • s3Location — (map)

            Location of an Amazon S3 object.

            • bucket — (String)

              The Amazon S3 bucket name.

            • key — (String)

              The Amazon S3 bucket key.

        • scriptType — (String)

          The type of validation script.

          Possible values include:
          • "SHELL_SCRIPT"
          • "POWERSHELL_SCRIPT"

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 = {
  appId: 'STRING_VALUE'
};
sms.startAppReplication(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: {}) —
  • appId — (String)

    The ID of the application.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  appId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
sms.startOnDemandAppReplication(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: {}) —
  • appId — (String)

    The ID of the application.

  • description — (String)

    The description of the replication run.

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 = {
  replicationJobId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
sms.startOnDemandReplicationRun(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: {}) —
  • replicationJobId — (String)

    The ID of the replication job.

  • description — (String)

    The description of the replication run.

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:

    • replicationRunId — (String)

      The ID of the replication run.

Returns:

• (AWS.Request) —

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

var params = {
  appId: 'STRING_VALUE'
};
sms.stopAppReplication(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: {}) —
  • appId — (String)

    The ID of the application.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  appId: 'STRING_VALUE'
};
sms.terminateApp(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: {}) —
  • appId — (String)

    The ID of the application.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  appId: 'STRING_VALUE',
  description: 'STRING_VALUE',
  name: 'STRING_VALUE',
  roleName: 'STRING_VALUE',
  serverGroups: [
    {
      name: 'STRING_VALUE',
      serverGroupId: 'STRING_VALUE',
      serverList: [
        {
          replicationJobId: 'STRING_VALUE',
          replicationJobTerminated: true || false,
          serverId: 'STRING_VALUE',
          serverType: VIRTUAL_MACHINE,
          vmServer: {
            vmManagerName: 'STRING_VALUE',
            vmManagerType: VSPHERE | SCVMM | HYPERV-MANAGER,
            vmName: 'STRING_VALUE',
            vmPath: 'STRING_VALUE',
            vmServerAddress: {
              vmId: 'STRING_VALUE',
              vmManagerId: 'STRING_VALUE'
            }
          }
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  tags: [
    {
      key: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
sms.updateApp(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: {}) —
  • appId — (String)

    The ID of the application.

  • name — (String)

    The new name of the application.

  • description — (String)

    The new description of the application.

  • roleName — (String)

    The name of the service role in the customer's account used by Server Migration Service.

  • serverGroups — (Array<map>)

    The server groups in the application to update.

    • serverGroupId — (String)

      The ID of a server group.

    • name — (String)

      The name of a server group.

    • serverList — (Array<map>)

      The servers that belong to a server group.

      • serverId — (String)

        The ID of the server.

      • serverType — (String)

        The type of server.

        Possible values include:
        • "VIRTUAL_MACHINE"
      • vmServer — (map)

        Information about the VM server.

        • vmServerAddress — (map)

          The VM server location.

          • vmManagerId — (String)

            The ID of the VM manager.

          • vmId — (String)

            The ID of the VM.

        • vmName — (String)

          The name of the VM.

        • vmManagerName — (String)

          The name of the VM manager.

        • vmManagerType — (String)

          The type of VM management product.

          Possible values include:
          • "VSPHERE"
          • "SCVMM"
          • "HYPERV-MANAGER"
        • vmPath — (String)

          The VM folder path in the vCenter Server virtual machine inventory tree.

      • replicationJobId — (String)

        The ID of the replication job.

      • replicationJobTerminated — (Boolean)

        Indicates whether the replication job is deleted or failed.

  • tags — (Array<map>)

    The tags to associate with the application.

    • key — (String)

      The tag key.

    • value — (String)

      The tag value.

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:

    • appSummary — (map)

      A summary description of the application.

      • appId — (String)

        The unique ID of the application.

      • importedAppId — (String)

        The ID of the application.

      • name — (String)

        The name of the application.

      • description — (String)

        The description of the application.

      • status — (String)

        Status of the application.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "DELETED"
        • "DELETE_FAILED"
      • statusMessage — (String)

        A message related to the status of the application

      • replicationConfigurationStatus — (String)

        Status of the replication configuration.

        Possible values include:
        • "NOT_CONFIGURED"
        • "CONFIGURED"
      • replicationStatus — (String)

        The replication status of the application.

        Possible values include:
        • "READY_FOR_CONFIGURATION"
        • "CONFIGURATION_IN_PROGRESS"
        • "CONFIGURATION_INVALID"
        • "READY_FOR_REPLICATION"
        • "VALIDATION_IN_PROGRESS"
        • "REPLICATION_PENDING"
        • "REPLICATION_IN_PROGRESS"
        • "REPLICATED"
        • "PARTIALLY_REPLICATED"
        • "DELTA_REPLICATION_IN_PROGRESS"
        • "DELTA_REPLICATED"
        • "DELTA_REPLICATION_FAILED"
        • "REPLICATION_FAILED"
        • "REPLICATION_STOPPING"
        • "REPLICATION_STOP_FAILED"
        • "REPLICATION_STOPPED"
      • replicationStatusMessage — (String)

        A message related to the replication status of the application.

      • latestReplicationTime — (Date)

        The timestamp of the application's most recent successful replication.

      • launchConfigurationStatus — (String)

        Status of the launch configuration.

        Possible values include:
        • "NOT_CONFIGURED"
        • "CONFIGURED"
      • launchStatus — (String)

        The launch status of the application.

        Possible values include:
        • "READY_FOR_CONFIGURATION"
        • "CONFIGURATION_IN_PROGRESS"
        • "CONFIGURATION_INVALID"
        • "READY_FOR_LAUNCH"
        • "VALIDATION_IN_PROGRESS"
        • "LAUNCH_PENDING"
        • "LAUNCH_IN_PROGRESS"
        • "LAUNCHED"
        • "PARTIALLY_LAUNCHED"
        • "DELTA_LAUNCH_IN_PROGRESS"
        • "DELTA_LAUNCH_FAILED"
        • "LAUNCH_FAILED"
        • "TERMINATE_IN_PROGRESS"
        • "TERMINATE_FAILED"
        • "TERMINATED"
      • launchStatusMessage — (String)

        A message related to the launch status of the application.

      • launchDetails — (map)

        Details about the latest launch of the application.

        • latestLaunchTime — (Date)

          The latest time that this application was launched successfully.

        • stackName — (String)

          The name of the latest stack launched for this application.

        • stackId — (String)

          The ID of the latest stack launched for this application.

      • creationTime — (Date)

        The creation time of the application.

      • lastModified — (Date)

        The last modified time of the application.

      • roleName — (String)

        The name of the service role in the customer's account used by Server Migration Service.

      • totalServerGroups — (Integer)

        The number of server groups present in the application.

      • totalServers — (Integer)

        The number of servers present in the application.

    • serverGroups — (Array<map>)

      The updated server groups in the application.

      • serverGroupId — (String)

        The ID of a server group.

      • name — (String)

        The name of a server group.

      • serverList — (Array<map>)

        The servers that belong to a server group.

        • serverId — (String)

          The ID of the server.

        • serverType — (String)

          The type of server.

          Possible values include:
          • "VIRTUAL_MACHINE"
        • vmServer — (map)

          Information about the VM server.

          • vmServerAddress — (map)

            The VM server location.

            • vmManagerId — (String)

              The ID of the VM manager.

            • vmId — (String)

              The ID of the VM.

          • vmName — (String)

            The name of the VM.

          • vmManagerName — (String)

            The name of the VM manager.

          • vmManagerType — (String)

            The type of VM management product.

            Possible values include:
            • "VSPHERE"
            • "SCVMM"
            • "HYPERV-MANAGER"
          • vmPath — (String)

            The VM folder path in the vCenter Server virtual machine inventory tree.

        • replicationJobId — (String)

          The ID of the replication job.

        • replicationJobTerminated — (Boolean)

          Indicates whether the replication job is deleted or failed.

    • tags — (Array<map>)

      The tags associated with the application.

      • key — (String)

        The tag key.

      • value — (String)

        The tag value.

Returns:

• (AWS.Request) —

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

var params = {
  replicationJobId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  encrypted: true || false,
  frequency: 'NUMBER_VALUE',
  kmsKeyId: 'STRING_VALUE',
  licenseType: AWS | BYOL,
  nextReplicationRunStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  numberOfRecentAmisToKeep: 'NUMBER_VALUE',
  roleName: 'STRING_VALUE'
};
sms.updateReplicationJob(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: {}) —
  • replicationJobId — (String)

    The ID of the replication job.

  • frequency — (Integer)

    The time between consecutive replication runs, in hours.

  • nextReplicationRunStartTime — (Date)

    The start time of the next replication run.

  • licenseType — (String)

    The license type to be used for the AMI created by a successful replication run.

    Possible values include:
    • "AWS"
    • "BYOL"
  • roleName — (String)

    The name of the IAM role to be used by Server Migration Service.

  • description — (String)

    The description of the replication job.

  • numberOfRecentAmisToKeep — (Integer)

    The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.

  • encrypted — (Boolean)

    When true, the replication job produces encrypted AMIs. For more information, KmsKeyId.

  • kmsKeyId — (String)

    The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

    • KMS key ID

    • KMS key alias

    • ARN referring to the KMS key ID

    • ARN referring to the KMS key alias

    If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

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.