Class: AWS.SMS

Inherits:
AWS.Service show all
Identifier:
sms
API Version:
2016-10-24
Defined in:
(unknown)

Overview

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

Service Description

This is the AWS Sever Migration Service API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types for the AWS Sever Migration Service (AWS SMS). The topic for each action shows the Query API request parameters and the XML response. You can also view the XML request elements in the WSDL.

Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.

To learn more about the Server Migration Service, see the following resources:

Sending a Request Using SMS

var sms = new AWS.SMS();
sms.createApp(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SMS object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var sms = new AWS.SMS({apiVersion: '2016-10-24'});

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

AWS.config.apiVersions = {
  sms: '2016-10-24',
  // other service API versions
};

var sms = new AWS.SMS();

Version:

  • 2016-10-24

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a SMS object

var sms = new AWS.SMS({apiVersion: '2016-10-24'});

Options Hash (options):

  • params (map)

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

  • endpoint (String)

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

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

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

  • credentialProvider (AWS.CredentialProviderChain)

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

  • region (String)

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

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

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

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

  • convertResponseTypes (Boolean)

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

  • correctClockSkew (Boolean)

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

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

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

  • s3DisableBodySigning (Boolean)

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

  • retryDelayOptions (map)

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

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

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

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

  • useAccelerateEndpoint (Boolean)

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

  • clientSideMonitoring (Boolean)

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

  • endpointDiscoveryEnabled (Boolean)

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

  • endpointCacheSize (Number)

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

  • hostPrefixEnabled (Boolean)

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

  • stsRegionalEndpoints ('legacy'|'regional')

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

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.

Service Reference:

Examples:

Calling the createApp operation

var params = {
  clientToken: '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.createApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      Name of the new application.

    • description — (String)

      Description of the new application

    • roleName — (String)

      Name of service role in customer's account to be used by AWS SMS.

    • clientToken — (String)

      A unique, case-sensitive identifier you provide to ensure idempotency of application creation.

    • serverGroups — (Array<map>)

      List of server groups to include in the application.

      • serverGroupId — (String)

        Identifier of a server group.

      • name — (String)

        Name of a server group.

      • serverList — (Array<map>)

        List of servers belonging to a server group.

        • serverId — (String)

          The identifier of the server.

        • serverType — (String)

          The type of server.

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

          Information about the VM server.

          • vmServerAddress — (map)

            Information about the VM server location.

            • vmManagerId — (String)

              The identifier of the VM manager.

            • vmId — (String)

              The identifier 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 identifier of the replication job.

        • replicationJobTerminated — (Boolean)

          Indicates whether the replication job is deleted or failed.

    • tags — (Array<map>)

      List of tags to be associated with the application.

      • key — (String)

        Tag key.

      • value — (String)

        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)

        Summary description of the application.

        • appId — (String)

          Unique ID of the application.

        • name — (String)

          Name of the application.

        • description — (String)

          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

        • replicationStatus — (String)

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

          Timestamp of the application's most recent successful replication.

        • launchStatus — (String)

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

            Latest time this application was launched successfully.

          • stackName — (String)

            Name of the latest stack launched for this application.

          • stackId — (String)

            Identifier of the latest stack launched for this application.

        • creationTime — (Date)

          Time of creation of this application.

        • lastModified — (Date)

          Timestamp of the application's creation.

        • roleName — (String)

          Name of the service role in the customer's account used by AWS SMS.

        • totalServerGroups — (Integer)

          Number of server groups present in the application.

        • totalServers — (Integer)

          Number of servers present in the application.

      • serverGroups — (Array<map>)

        List of server groups included in the application.

        • serverGroupId — (String)

          Identifier of a server group.

        • name — (String)

          Name of a server group.

        • serverList — (Array<map>)

          List of servers belonging to a server group.

          • serverId — (String)

            The identifier of the server.

          • serverType — (String)

            The type of server.

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

            Information about the VM server.

            • vmServerAddress — (map)

              Information about the VM server location.

              • vmManagerId — (String)

                The identifier of the VM manager.

              • vmId — (String)

                The identifier 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 identifier of the replication job.

          • replicationJobTerminated — (Boolean)

            Indicates whether the replication job is deleted or failed.

      • tags — (Array<map>)

        List of taags associated with the application.

        • key — (String)

          Tag key.

        • value — (String)

          Tag value.

Returns:

  • (AWS.Request)

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

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

Creates a replication job. The replication job schedules periodic replication runs to replicate your server to AWS. Each replication run creates an Amazon Machine Image (AMI).

Service Reference:

Examples:

Calling the createReplicationJob operation

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 identifier of the server.

    • seedReplicationTime — (Date)

      The seed replication time.

    • frequency — (Integer)

      The time between consecutive replication runs, in hours.

    • runOnce — (Boolean)

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

    • description — (String)

      The description of the replication job.

    • numberOfRecentAmisToKeep — (Integer)

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

    • encrypted — (Boolean)

      When true, the replication job produces encrypted AMIs. See also KmsKeyId below.

    • kmsKeyId — (String)

      KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

      • KMS key ID

      • KMS key alias

      • ARN referring to KMS key ID

      • ARN referring to KMS key alias

      If encrypted is true but a KMS key id is not specified, the customer's default KMS key for 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.

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

Deletes an existing application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.

Service Reference:

Examples:

Calling the deleteApp operation

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)

      ID of the application to delete.

    • forceStopAppReplication — (Boolean)

      While deleting the application, stop all replication jobs corresponding to the servers in the application.

    • forceTerminateApp — (Boolean)

      While deleting the application, terminate the stack corresponding to 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.

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

Deletes existing launch configuration for an application.

Service Reference:

Examples:

Calling the deleteAppLaunchConfiguration operation

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)

      ID of the application associated with the launch configuration.

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.

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

Deletes existing replication configuration for an application.

Examples:

Calling the deleteAppReplicationConfiguration operation

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)

      ID of the application associated with the replication configuration.

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.

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

Deletes the specified replication job.

After you delete a replication job, there are no further replication runs. AWS deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created by the replication runs are not deleted.

Service Reference:

Examples:

Calling the deleteReplicationJob operation

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

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

Deletes all servers from your server catalog.

Service Reference:

Examples:

Calling the deleteServerCatalog operation

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.

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

Disassociates the specified connector from AWS SMS.

After you disassociate a connector, it is no longer available to support replication jobs.

Service Reference:

Examples:

Calling the disassociateConnector operation

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

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

Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

Service Reference:

Examples:

Calling the generateChangeSet operation

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)

      ID of the application associated with the change set.

    • changesetFormat — (String)

      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)

        Location of the Amazon S3 object.

        • bucket — (String)

          Amazon S3 bucket name.

        • key — (String)

          Amazon S3 bucket key.

Returns:

  • (AWS.Request)

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

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

Generates an Amazon CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

Service Reference:

Examples:

Calling the generateTemplate operation

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)

      ID of the application associated with the Amazon CloudFormation template.

    • templateFormat — (String)

      Format for generating the Amazon 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)

        Location of the Amazon S3 object.

        • bucket — (String)

          Amazon S3 bucket name.

        • key — (String)

          Amazon S3 bucket key.

Returns:

  • (AWS.Request)

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

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

Retrieve information about an application.

Service Reference:

Examples:

Calling the getApp operation

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)

      ID of the application whose information is being retrieved.

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)

          Unique ID of the application.

        • name — (String)

          Name of the application.

        • description — (String)

          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

        • replicationStatus — (String)

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

          Timestamp of the application's most recent successful replication.

        • launchStatus — (String)

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

            Latest time this application was launched successfully.

          • stackName — (String)

            Name of the latest stack launched for this application.

          • stackId — (String)

            Identifier of the latest stack launched for this application.

        • creationTime — (Date)

          Time of creation of this application.

        • lastModified — (Date)

          Timestamp of the application's creation.

        • roleName — (String)

          Name of the service role in the customer's account used by AWS SMS.

        • totalServerGroups — (Integer)

          Number of server groups present in the application.

        • totalServers — (Integer)

          Number of servers present in the application.

      • serverGroups — (Array<map>)

        List of server groups belonging to the application.

        • serverGroupId — (String)

          Identifier of a server group.

        • name — (String)

          Name of a server group.

        • serverList — (Array<map>)

          List of servers belonging to a server group.

          • serverId — (String)

            The identifier of the server.

          • serverType — (String)

            The type of server.

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

            Information about the VM server.

            • vmServerAddress — (map)

              Information about the VM server location.

              • vmManagerId — (String)

                The identifier of the VM manager.

              • vmId — (String)

                The identifier 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 identifier of the replication job.

          • replicationJobTerminated — (Boolean)

            Indicates whether the replication job is deleted or failed.

      • tags — (Array<map>)

        List of tags associated with the application.

        • key — (String)

          Tag key.

        • value — (String)

          Tag value.

Returns:

  • (AWS.Request)

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

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

Retrieves the application launch configuration associated with an application.

Service Reference:

Examples:

Calling the getAppLaunchConfiguration operation

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)

      ID of the application launch configuration.

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)

        ID of the application associated with the launch configuration.

      • roleName — (String)

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

      • serverGroupLaunchConfigurations — (Array<map>)

        List of launch configurations for server groups in this application.

        • serverGroupId — (String)

          Identifier of the server group the launch configuration is associated with.

        • launchOrder — (Integer)

          Launch order of servers in the server group.

        • serverLaunchConfigurations — (Array<map>)

          Launch configuration for servers in the server group.

          • server — (map)

            Identifier of the server the launch configuration is associated with.

            • serverId — (String)

              The identifier of the server.

            • serverType — (String)

              The type of server.

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

              Information about the VM server.

              • vmServerAddress — (map)

                Information about the VM server location.

                • vmManagerId — (String)

                  The identifier of the VM manager.

                • vmId — (String)

                  The identifier 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 identifier of the replication job.

            • replicationJobTerminated — (Boolean)

              Indicates whether the replication job is deleted or failed.

          • logicalId — (String)

            Logical ID of the server in the Amazon CloudFormation template.

          • vpc — (String)

            Identifier of the VPC the server should be launched into.

          • subnet — (String)

            Identifier of the subnet the server should be launched into.

          • securityGroup — (String)

            Identifier of the security group that applies to the launched server.

          • ec2KeyName — (String)

            Name of the 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)

                Amazon S3 bucket name.

              • key — (String)

                Amazon S3 bucket key.

          • instanceType — (String)

            Instance type to be used for launching the server.

          • associatePublicIpAddress — (Boolean)

            If true, a publicly accessible IP address is created when launching the server.

Returns:

  • (AWS.Request)

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

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

Retrieves an application replication configuration associatd with an application.

Service Reference:

Examples:

Calling the getAppReplicationConfiguration operation

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)

      ID of the application associated with the replication configuration.

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

        Replication configurations associated with server groups in this application.

        • serverGroupId — (String)

          Identifier of the server group this replication configuration is associated with.

        • serverReplicationConfigurations — (Array<map>)

          Replication configuration for servers in the server group.

          • server — (map)

            Identifier of the server this replication configuration is associated with.

            • serverId — (String)

              The identifier of the server.

            • serverType — (String)

              The type of server.

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

              Information about the VM server.

              • vmServerAddress — (map)

                Information about the VM server location.

                • vmManagerId — (String)

                  The identifier of the VM manager.

                • vmId — (String)

                  The identifier 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 identifier of the replication job.

            • replicationJobTerminated — (Boolean)

              Indicates whether the replication job is deleted or failed.

          • serverReplicationParameters — (map)

            Parameters for replicating the server.

            • seedTime — (Date)

              Seed time for creating a replication job for the server.

            • frequency — (Integer)

              Frequency of creating replication jobs for the server.

            • runOnce — (Boolean)

            • licenseType — (String)

              License type for creating a replication job for the server.

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

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

            • encrypted — (Boolean)

              When true, the replication job produces encrypted AMIs. See also KmsKeyId below.

            • kmsKeyId — (String)

              KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

              • KMS key ID

              • KMS key alias

              • ARN referring to KMS key ID

              • ARN referring to KMS key alias

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

Returns:

  • (AWS.Request)

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

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

Describes the connectors registered with the AWS SMS.

Service Reference:

Examples:

Calling the getConnectors operation

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

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

Describes the specified replication job or all of your replication jobs.

Service Reference:

Examples:

Calling the getReplicationJobs operation

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 identifier 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 identifier of the replication job.

        • serverId — (String)

          The identifier of the server.

        • serverType — (String)

          The type of server.

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

          Information about the VM server.

          • vmServerAddress — (map)

            Information about the VM server location.

            • vmManagerId — (String)

              The identifier of the VM manager.

            • vmId — (String)

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

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

          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)

          Whether the replication job should produce encrypted AMIs or not. See also KmsKeyId below.

        • kmsKeyId — (String)

          KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

          • KMS key ID

          • KMS key alias

          • ARN referring to KMS key ID

          • ARN referring to KMS key alias

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

        • replicationRunList — (Array<map>)

          Information about the replication runs.

          • replicationRunId — (String)

            The identifier 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 of the current stage of the replication run.

            • stage — (String)

              String describing the current stage of a replication run.

            • stageProgress — (String)

              String describing 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 identifier 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)

            Whether the replication run should produce encrypted AMI or not. See also KmsKeyId below.

          • kmsKeyId — (String)

            KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

            • KMS key ID

            • KMS key alias

            • ARN referring to KMS key ID

            • ARN referring to KMS key alias

            If encrypted is true but a KMS key id is not specified, the customer's default KMS key for 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.

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

Describes the replication runs for the specified replication job.

Service Reference:

Examples:

Calling the getReplicationRuns operation

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 identifier 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 identifier of the replication job.

        • serverId — (String)

          The identifier of the server.

        • serverType — (String)

          The type of server.

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

          Information about the VM server.

          • vmServerAddress — (map)

            Information about the VM server location.

            • vmManagerId — (String)

              The identifier of the VM manager.

            • vmId — (String)

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

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

          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)

          Whether the replication job should produce encrypted AMIs or not. See also KmsKeyId below.

        • kmsKeyId — (String)

          KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

          • KMS key ID

          • KMS key alias

          • ARN referring to KMS key ID

          • ARN referring to KMS key alias

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

        • replicationRunList — (Array<map>)

          Information about the replication runs.

          • replicationRunId — (String)

            The identifier 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 of the current stage of the replication run.

            • stage — (String)

              String describing the current stage of a replication run.

            • stageProgress — (String)

              String describing 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 identifier 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)

            Whether the replication run should produce encrypted AMI or not. See also KmsKeyId below.

          • kmsKeyId — (String)

            KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

            • KMS key ID

            • KMS key alias

            • ARN referring to KMS key ID

            • ARN referring to KMS key alias

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

      • replicationRunList — (Array<map>)

        Information about the replication runs.

        • replicationRunId — (String)

          The identifier 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 of the current stage of the replication run.

          • stage — (String)

            String describing the current stage of a replication run.

          • stageProgress — (String)

            String describing 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 identifier 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)

          Whether the replication run should produce encrypted AMI or not. See also KmsKeyId below.

        • kmsKeyId — (String)

          KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

          • KMS key ID

          • KMS key alias

          • ARN referring to KMS key ID

          • ARN referring to KMS key alias

          If encrypted is true but a KMS key id is not specified, the customer's default KMS key for 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.

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

Describes the servers in your server catalog.

Before you can describe your servers, you must import them using ImportServerCatalog.

Service Reference:

Examples:

Calling the getServers operation

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

      List of VmServerAddress objects

      • vmManagerId — (String)

        The identifier of the VM manager.

      • vmId — (String)

        The identifier 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 identifier of the server.

        • serverType — (String)

          The type of server.

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

          Information about the VM server.

          • vmServerAddress — (map)

            Information about the VM server location.

            • vmManagerId — (String)

              The identifier of the VM manager.

            • vmId — (String)

              The identifier 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 identifier 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.

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

Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers that you want to import.

This call returns immediately, but might take additional time to retrieve all the servers.

Service Reference:

Examples:

Calling the importServerCatalog operation

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.

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

Launches an application stack.

Service Reference:

Examples:

Calling the launchApp operation

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)

      ID of the application to launch.

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.

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

Returns a list of summaries for all applications.

Service Reference:

Examples:

Calling the listApps operation

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

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

      • apps — (Array<map>)

        A list of application summaries.

        • appId — (String)

          Unique ID of the application.

        • name — (String)

          Name of the application.

        • description — (String)

          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

        • replicationStatus — (String)

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

          Timestamp of the application's most recent successful replication.

        • launchStatus — (String)

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

            Latest time this application was launched successfully.

          • stackName — (String)

            Name of the latest stack launched for this application.

          • stackId — (String)

            Identifier of the latest stack launched for this application.

        • creationTime — (Date)

          Time of creation of this application.

        • lastModified — (Date)

          Timestamp of the application's creation.

        • roleName — (String)

          Name of the service role in the customer's account used by AWS SMS.

        • totalServerGroups — (Integer)

          Number of server groups present in the application.

        • totalServers — (Integer)

          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.

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

Creates a launch configuration for an application.

Service Reference:

Examples:

Calling the putAppLaunchConfiguration operation

var params = {
  appId: 'STRING_VALUE',
  roleName: 'STRING_VALUE',
  serverGroupLaunchConfigurations: [
    {
      launchOrder: 'NUMBER_VALUE',
      serverGroupId: 'STRING_VALUE',
      serverLaunchConfigurations: [
        {
          associatePublicIpAddress: true || false,
          ec2KeyName: '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)

      ID of the application associated with the launch configuration.

    • roleName — (String)

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

    • serverGroupLaunchConfigurations — (Array<map>)

      Launch configurations for server groups in the application.

      • serverGroupId — (String)

        Identifier of the server group the launch configuration is associated with.

      • launchOrder — (Integer)

        Launch order of servers in the server group.

      • serverLaunchConfigurations — (Array<map>)

        Launch configuration for servers in the server group.

        • server — (map)

          Identifier of the server the launch configuration is associated with.

          • serverId — (String)

            The identifier of the server.

          • serverType — (String)

            The type of server.

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

            Information about the VM server.

            • vmServerAddress — (map)

              Information about the VM server location.

              • vmManagerId — (String)

                The identifier of the VM manager.

              • vmId — (String)

                The identifier 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 identifier of the replication job.

          • replicationJobTerminated — (Boolean)

            Indicates whether the replication job is deleted or failed.

        • logicalId — (String)

          Logical ID of the server in the Amazon CloudFormation template.

        • vpc — (String)

          Identifier of the VPC the server should be launched into.

        • subnet — (String)

          Identifier of the subnet the server should be launched into.

        • securityGroup — (String)

          Identifier of the security group that applies to the launched server.

        • ec2KeyName — (String)

          Name of the 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)

              Amazon S3 bucket name.

            • key — (String)

              Amazon S3 bucket key.

        • instanceType — (String)

          Instance type to be used for launching the server.

        • associatePublicIpAddress — (Boolean)

          If true, a publicly accessible IP address is created when launching the server.

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.

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

Creates or updates a replication configuration for an application.

Service Reference:

Examples:

Calling the putAppReplicationConfiguration operation

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)

      ID of the application tassociated with the replication configuration.

    • serverGroupReplicationConfigurations — (Array<map>)

      Replication configurations for server groups in the application.

      • serverGroupId — (String)

        Identifier of the server group this replication configuration is associated with.

      • serverReplicationConfigurations — (Array<map>)

        Replication configuration for servers in the server group.

        • server — (map)

          Identifier of the server this replication configuration is associated with.

          • serverId — (String)

            The identifier of the server.

          • serverType — (String)

            The type of server.

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

            Information about the VM server.

            • vmServerAddress — (map)

              Information about the VM server location.

              • vmManagerId — (String)

                The identifier of the VM manager.

              • vmId — (String)

                The identifier 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 identifier of the replication job.

          • replicationJobTerminated — (Boolean)

            Indicates whether the replication job is deleted or failed.

        • serverReplicationParameters — (map)

          Parameters for replicating the server.

          • seedTime — (Date)

            Seed time for creating a replication job for the server.

          • frequency — (Integer)

            Frequency of creating replication jobs for the server.

          • runOnce — (Boolean)

          • licenseType — (String)

            License type for creating a replication job for the server.

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

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

          • encrypted — (Boolean)

            When true, the replication job produces encrypted AMIs. See also KmsKeyId below.

          • kmsKeyId — (String)

            KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

            • KMS key ID

            • KMS key alias

            • ARN referring to KMS key ID

            • ARN referring to KMS key alias

            If encrypted is true but a KMS key id is not specified, the customer's default KMS key for 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.

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

Starts replicating an application.

Service Reference:

Examples:

Calling the startAppReplication operation

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)

      ID of the application to replicate.

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.

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

Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled.

There is a limit on the number of on-demand replications runs you can request in a 24-hour period.

Service Reference:

Examples:

Calling the startOnDemandReplicationRun operation

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 identifier 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 identifier of the replication run.

Returns:

  • (AWS.Request)

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

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

Stops replicating an application.

Service Reference:

Examples:

Calling the stopAppReplication operation

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)

      ID of the application to stop replicating.

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.

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

Terminates the stack for an application.

Service Reference:

Examples:

Calling the terminateApp operation

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)

      ID of the application to terminate.

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.

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

Updates an application.

Service Reference:

Examples:

Calling the updateApp operation

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)

      ID of the application to update.

    • name — (String)

      New name of the application.

    • description — (String)

      New description of the application.

    • roleName — (String)

      Name of the service role in the customer's account used by AWS SMS.

    • serverGroups — (Array<map>)

      List of server groups in the application to update.

      • serverGroupId — (String)

        Identifier of a server group.

      • name — (String)

        Name of a server group.

      • serverList — (Array<map>)

        List of servers belonging to a server group.

        • serverId — (String)

          The identifier of the server.

        • serverType — (String)

          The type of server.

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

          Information about the VM server.

          • vmServerAddress — (map)

            Information about the VM server location.

            • vmManagerId — (String)

              The identifier of the VM manager.

            • vmId — (String)

              The identifier 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 identifier of the replication job.

        • replicationJobTerminated — (Boolean)

          Indicates whether the replication job is deleted or failed.

    • tags — (Array<map>)

      List of tags to associate with the application.

      • key — (String)

        Tag key.

      • value — (String)

        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)

        Summary description of the application.

        • appId — (String)

          Unique ID of the application.

        • name — (String)

          Name of the application.

        • description — (String)

          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

        • replicationStatus — (String)

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

          Timestamp of the application's most recent successful replication.

        • launchStatus — (String)

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

            Latest time this application was launched successfully.

          • stackName — (String)

            Name of the latest stack launched for this application.

          • stackId — (String)

            Identifier of the latest stack launched for this application.

        • creationTime — (Date)

          Time of creation of this application.

        • lastModified — (Date)

          Timestamp of the application's creation.

        • roleName — (String)

          Name of the service role in the customer's account used by AWS SMS.

        • totalServerGroups — (Integer)

          Number of server groups present in the application.

        • totalServers — (Integer)

          Number of servers present in the application.

      • serverGroups — (Array<map>)

        List of updated server groups in the application.

        • serverGroupId — (String)

          Identifier of a server group.

        • name — (String)

          Name of a server group.

        • serverList — (Array<map>)

          List of servers belonging to a server group.

          • serverId — (String)

            The identifier of the server.

          • serverType — (String)

            The type of server.

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

            Information about the VM server.

            • vmServerAddress — (map)

              Information about the VM server location.

              • vmManagerId — (String)

                The identifier of the VM manager.

              • vmId — (String)

                The identifier 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 identifier of the replication job.

          • replicationJobTerminated — (Boolean)

            Indicates whether the replication job is deleted or failed.

      • tags — (Array<map>)

        List of tags associated with the application.

        • key — (String)

          Tag key.

        • value — (String)

          Tag value.

Returns:

  • (AWS.Request)

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

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

Updates the specified settings for the specified replication job.

Service Reference:

Examples:

Calling the updateReplicationJob operation

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 identifier 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 AWS SMS.

    • description — (String)

      The description of the replication job.

    • numberOfRecentAmisToKeep — (Integer)

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

    • encrypted — (Boolean)

      When true, the replication job produces encrypted AMIs . See also KmsKeyId below.

    • kmsKeyId — (String)

      KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

      • KMS key ID

      • KMS key alias

      • ARN referring to KMS key ID

      • ARN referring to KMS key alias

      If encrypted is true but a KMS key id is not specified, the customer's default KMS key for 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.