This package has been deprecated

Author message:

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

@aws-sdk/client-lightsail-browser

Description

Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, a managed database, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).

For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.

To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, see the Lightsail Dev Guide.

Installing

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

npm install @aws-sdk/client-lightsail-browser

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(LightsailClient) and the commands you need, for example AllocateStaticIpCommand:

//JavaScript
const {
  LightsailClient
} = require("@aws-sdk/client-lightsail-browser/LightsailClient");
const {
  AllocateStaticIpCommand
} = require("@aws-sdk/client-lightsail-browser/commands/AllocateStaticIpCommand");

//TypeScript
import { LightsailClient } from "@aws-sdk/client-lightsail-browser/LightsailClient";
import { AllocateStaticIpCommand } from "@aws-sdk/client-lightsail-browser/commands/AllocateStaticIpCommand";

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 lightsail = new LightsailClient({region: 'region'});
//clients can be shared by different commands
const params = {
  staticIpName: /**a string value*/,
};
const allocateStaticIpCommand = new AllocateStaticIpCommand(params);
lightsail.send(allocateStaticIpCommand).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 lightsail.send(allocateStaticIpCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
lightsail.send(allocateStaticIpCommand, (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-lightsail-browser/Lightsail";
const lightsail = new AWS.Lightsail({ region: "region" });
lightsail.allocateStaticIp(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 lightsail.send(allocateStaticIpCommand);
  // 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-lightsail-browser' 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.