This package has been deprecated

Author message:

The package @aws-sdk/client-sms-node has been renamed to @aws-sdk/client-sms. Please install the renamed package.

@aws-sdk/client-sms-node

Description

AAWS Sever Migration Service

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:

• AWS Sever Migration Service product page

• AWS Sever Migration Service User Guide

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-sms-node

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(SMSClient) and the commands you need, for example CreateAppCommand:

//JavaScript
const { SMSClient } = require("@aws-sdk/client-sms-node/SMSClient");
const {
  CreateAppCommand
} = require("@aws-sdk/client-sms-node/commands/CreateAppCommand");

//TypeScript
import { SMSClient } from "@aws-sdk/client-sms-node/SMSClient";
import { CreateAppCommand } from "@aws-sdk/client-sms-node/commands/CreateAppCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

const sMS = new SMSClient({ region: "region" });
//clients can be shared by different commands
const params = {};
const createAppCommand = new CreateAppCommand(params);
sMS
  .send(createAppCommand)
  .then(data => {
    // do something
  })
  .catch(error => {
    // error handling
  });

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await sMS.send(createAppCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
sMS.send(createAppCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-sms-node/SMS";
const sMS = new AWS.SMS({ region: "region" });
sMS.createApp(params, (err, data) => {
  //do something
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await sMS.send(createAppCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.extendedRequestId}`
  );
  /*
The keys within exceptions are also parsed. You can access them by specifying exception names:
    if(error.name === 'SomeServiceException') {
        const value = error.specialKeyInException;
    }
*/
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-sms-node' package is updated. To contribute to SDK you can checkout our code generator package.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.