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.

Sending a Request Using SMS

var sms = new AWS.SMS();
sms.createReplicationJob(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.

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

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

The CreateReplicationJob API is used to create a ReplicationJob to replicate a server on AWS. Call this API to first create a ReplicationJob, which will then schedule periodic ReplicationRuns to replicate your server to AWS. Each ReplicationRun will result in the creation of an AWS AMI.

Service Reference:

Examples:

Calling the createReplicationJob operation

var params = {
  frequency: 0, /* required */
  seedReplicationTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  serverId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  licenseType: AWS | BYOL,
  roleName: 'STRING_VALUE'
};
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) Unique Identifier for a server
    • seedReplicationTime — (Date) Timestamp of an operation
    • frequency — (Integer) Interval between Replication Runs. This value is specified in hours, and represents the time between consecutive Replication Runs.
    • licenseType — (String) The license type to be used for the Amazon Machine Image (AMI) created after a successful ReplicationRun. Possible values include:
      • "AWS"
      • "BYOL"
    • roleName — (String) Name of service role in customer's account to be used by SMS service.
    • description — (String) The description for a Replication Job/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:

      • replicationJobId — (String) The unique identifier for a Replication Job.

Returns:

  • (AWS.Request)

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

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

The DeleteReplicationJob API is used to delete a ReplicationJob, resulting in no further ReplicationRuns. This will delete the contents of the S3 bucket used to store SMS artifacts, but will not delete any AMIs created by the SMS service.

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 unique identifier for a 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

The DeleteServerCatalog API clears all servers from your server catalog. This means that these servers will no longer be accessible to the Server Migration Service.

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

The DisassociateConnector API will disassociate a connector from the Server Migration Service, rendering it unavailable 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) Unique Identifier for 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.

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

The GetConnectors API returns a list of connectors that are registered with the Server Migration Service.

Service Reference:

Examples:

Calling the getConnectors operation

var params = {
  maxResults: 0,
  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) Pagination token to pass as input to API call
    • maxResults — (Integer) The maximum number of results to return in one API call. If left empty, this will default to 50.

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>) List of connectors
        • connectorId — (String) Unique Identifier for Connector
        • version — (String) Connector version string
        • status — (String) Status of on-premise Connector Possible values include:
          • "HEALTHY"
          • "UNHEALTHY"
        • capabilityList — (Array<String>) List of Connector Capabilities
        • vmManagerName — (String) VM Manager Name
        • vmManagerType — (String) VM Management Product Possible values include:
          • "VSPHERE"
        • vmManagerId — (String) Unique Identifier for VM Manager
        • ipAddress — (String) Internet Protocol (IP) Address
        • macAddress — (String) Hardware (MAC) address
        • associatedOn — (Date) Timestamp of an operation
      • nextToken — (String) Pagination token to pass as input to API call

Returns:

  • (AWS.Request)

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

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

The GetReplicationJobs API will return all of your ReplicationJobs and their details. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationJobs.

Service Reference:

Examples:

Calling the getReplicationJobs operation

var params = {
  maxResults: 0,
  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 unique identifier for a Replication Job.
    • nextToken — (String) Pagination token to pass as input to API call
    • maxResults — (Integer) The maximum number of results to return in one API call. If left empty, this will default to 50.

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>) List of Replication Jobs
        • replicationJobId — (String) The unique identifier for a Replication Job.
        • serverId — (String) Unique Identifier for a server
        • serverType — (String) Type of server. Possible values include:
          • "VIRTUAL_MACHINE"
        • vmServer — (map) Object representing a VM server
          • vmServerAddress — (map) Object representing a server's location
            • vmManagerId — (String) Unique Identifier for VM Manager
            • vmId — (String) Unique Identifier for a VM
          • vmName — (String) Name of Virtual Machine
          • vmManagerName — (String) VM Manager Name
          • vmManagerType — (String) VM Management Product Possible values include:
            • "VSPHERE"
          • vmPath — (String) Path to VM
        • seedReplicationTime — (Date) Timestamp of an operation
        • frequency — (Integer) Interval between Replication Runs. This value is specified in hours, and represents the time between consecutive Replication Runs.
        • nextReplicationRunStartTime — (Date) Timestamp of an operation
        • licenseType — (String) The license type to be used for the Amazon Machine Image (AMI) created after a successful ReplicationRun. Possible values include:
          • "AWS"
          • "BYOL"
        • roleName — (String) Name of service role in customer's account to be used by SMS service.
        • latestAmiId — (String) The AMI id for the image resulting from a Replication Run.
        • state — (String) Current state of Replication Job Possible values include:
          • "PENDING"
          • "ACTIVE"
          • "FAILED"
          • "DELETING"
          • "DELETED"
        • statusMessage — (String) String describing current status of Replication Job
        • description — (String) The description for a Replication Job/Run.
        • replicationRunList — (Array<map>) List of Replication Runs
          • replicationRunId — (String) The unique identifier for a Replication Run.
          • state — (String) Current state of Replication Run Possible values include:
            • "PENDING"
            • "MISSED"
            • "ACTIVE"
            • "FAILED"
            • "COMPLETED"
            • "DELETING"
            • "DELETED"
          • type — (String) Type of Replication Run Possible values include:
            • "ON_DEMAND"
            • "AUTOMATIC"
          • statusMessage — (String) String describing current status of Replication Run
          • amiId — (String) The AMI id for the image resulting from a Replication Run.
          • scheduledStartTime — (Date) Timestamp of an operation
          • completedTime — (Date) Timestamp of an operation
          • description — (String) The description for a Replication Job/Run.
      • nextToken — (String) Pagination token to pass as input to API call

Returns:

  • (AWS.Request)

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

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

The GetReplicationRuns API will return all ReplicationRuns for a given ReplicationJob. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationRuns for a ReplicationJob.

Service Reference:

Examples:

Calling the getReplicationRuns operation

var params = {
  replicationJobId: 'STRING_VALUE', /* required */
  maxResults: 0,
  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 unique identifier for a Replication Job.
    • nextToken — (String) Pagination token to pass as input to API call
    • maxResults — (Integer) The maximum number of results to return in one API call. If left empty, this will default to 50.

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) Object representing a Replication Job
        • replicationJobId — (String) The unique identifier for a Replication Job.
        • serverId — (String) Unique Identifier for a server
        • serverType — (String) Type of server. Possible values include:
          • "VIRTUAL_MACHINE"
        • vmServer — (map) Object representing a VM server
          • vmServerAddress — (map) Object representing a server's location
            • vmManagerId — (String) Unique Identifier for VM Manager
            • vmId — (String) Unique Identifier for a VM
          • vmName — (String) Name of Virtual Machine
          • vmManagerName — (String) VM Manager Name
          • vmManagerType — (String) VM Management Product Possible values include:
            • "VSPHERE"
          • vmPath — (String) Path to VM
        • seedReplicationTime — (Date) Timestamp of an operation
        • frequency — (Integer) Interval between Replication Runs. This value is specified in hours, and represents the time between consecutive Replication Runs.
        • nextReplicationRunStartTime — (Date) Timestamp of an operation
        • licenseType — (String) The license type to be used for the Amazon Machine Image (AMI) created after a successful ReplicationRun. Possible values include:
          • "AWS"
          • "BYOL"
        • roleName — (String) Name of service role in customer's account to be used by SMS service.
        • latestAmiId — (String) The AMI id for the image resulting from a Replication Run.
        • state — (String) Current state of Replication Job Possible values include:
          • "PENDING"
          • "ACTIVE"
          • "FAILED"
          • "DELETING"
          • "DELETED"
        • statusMessage — (String) String describing current status of Replication Job
        • description — (String) The description for a Replication Job/Run.
        • replicationRunList — (Array<map>) List of Replication Runs
          • replicationRunId — (String) The unique identifier for a Replication Run.
          • state — (String) Current state of Replication Run Possible values include:
            • "PENDING"
            • "MISSED"
            • "ACTIVE"
            • "FAILED"
            • "COMPLETED"
            • "DELETING"
            • "DELETED"
          • type — (String) Type of Replication Run Possible values include:
            • "ON_DEMAND"
            • "AUTOMATIC"
          • statusMessage — (String) String describing current status of Replication Run
          • amiId — (String) The AMI id for the image resulting from a Replication Run.
          • scheduledStartTime — (Date) Timestamp of an operation
          • completedTime — (Date) Timestamp of an operation
          • description — (String) The description for a Replication Job/Run.
      • replicationRunList — (Array<map>) List of Replication Runs
        • replicationRunId — (String) The unique identifier for a Replication Run.
        • state — (String) Current state of Replication Run Possible values include:
          • "PENDING"
          • "MISSED"
          • "ACTIVE"
          • "FAILED"
          • "COMPLETED"
          • "DELETING"
          • "DELETED"
        • type — (String) Type of Replication Run Possible values include:
          • "ON_DEMAND"
          • "AUTOMATIC"
        • statusMessage — (String) String describing current status of Replication Run
        • amiId — (String) The AMI id for the image resulting from a Replication Run.
        • scheduledStartTime — (Date) Timestamp of an operation
        • completedTime — (Date) Timestamp of an operation
        • description — (String) The description for a Replication Job/Run.
      • nextToken — (String) Pagination token to pass as input to API call

Returns:

  • (AWS.Request)

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

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

The GetServers API returns a list of all servers in your server catalog. For this call to succeed, you must previously have called ImportServerCatalog.

Service Reference:

Examples:

Calling the getServers operation

var params = {
  maxResults: 0,
  nextToken: 'STRING_VALUE'
};
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) Pagination token to pass as input to API call
    • maxResults — (Integer) The maximum number of results to return in one API call. If left empty, this will default to 50.

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) Timestamp of an operation
      • serverCatalogStatus — (String) Status of Server catalog Possible values include:
        • "NOT_IMPORTED"
        • "IMPORTING"
        • "AVAILABLE"
        • "DELETED"
        • "EXPIRED"
      • serverList — (Array<map>) List of servers from catalog
        • serverId — (String) Unique Identifier for a server
        • serverType — (String) Type of server. Possible values include:
          • "VIRTUAL_MACHINE"
        • vmServer — (map) Object representing a VM server
          • vmServerAddress — (map) Object representing a server's location
            • vmManagerId — (String) Unique Identifier for VM Manager
            • vmId — (String) Unique Identifier for a VM
          • vmName — (String) Name of Virtual Machine
          • vmManagerName — (String) VM Manager Name
          • vmManagerType — (String) VM Management Product Possible values include:
            • "VSPHERE"
          • vmPath — (String) Path to VM
        • replicationJobId — (String) The unique identifier for a Replication Job.
        • replicationJobTerminated — (Boolean) An indicator of the Replication Job being deleted or failed.
      • nextToken — (String) Pagination token to pass as input to API call

Returns:

  • (AWS.Request)

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

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

The ImportServerCatalog API is used to gather the complete list of on-premises servers on your premises. This API call requires connectors to be installed and monitoring all servers you would like imported. This API call returns immediately, but may take some time to retrieve all of 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.

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

The StartOnDemandReplicationRun API is used to start a ReplicationRun on demand (in addition to those that are scheduled based on your frequency). This ReplicationRun will start immediately. StartOnDemandReplicationRun is subject to limits on how many on demand ReplicationRuns you may call per 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 unique identifier for a Replication Job.
    • description — (String) The description for a Replication Job/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 unique identifier for a Replication Run.

Returns:

  • (AWS.Request)

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

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

The UpdateReplicationJob API is used to change the settings of your existing ReplicationJob created using CreateReplicationJob. Calling this API will affect the next scheduled ReplicationRun.

Service Reference:

Examples:

Calling the updateReplicationJob operation

var params = {
  replicationJobId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  frequency: 0,
  licenseType: AWS | BYOL,
  nextReplicationRunStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  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 unique identifier for a Replication Job.
    • frequency — (Integer) Interval between Replication Runs. This value is specified in hours, and represents the time between consecutive Replication Runs.
    • nextReplicationRunStartTime — (Date) Timestamp of an operation
    • licenseType — (String) The license type to be used for the Amazon Machine Image (AMI) created after a successful ReplicationRun. Possible values include:
      • "AWS"
      • "BYOL"
    • roleName — (String) Name of service role in customer's account to be used by SMS service.
    • description — (String) The description for a Replication Job/Run.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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