This package has been deprecated

Author message:

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

@aws-sdk/client-storage-gateway-node

Description

AWS Storage Gateway Service

AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the AWS storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.

Use the following links to get started using the AWS Storage Gateway Service API Reference:

• AWS Storage Gateway Required Request Headers: Describes the required headers that you must send with every POST request to AWS Storage Gateway.

• Signing Requests: AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.

• Error Responses: Provides reference information about AWS Storage Gateway errors.

• Operations in AWS Storage Gateway: Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.

• AWS Storage Gateway Regions and Endpoints: Provides a list of each AWS region and endpoints available for use with AWS Storage Gateway.

AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected.

IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs.

For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:

arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.

For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016.

Installing

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

npm install @aws-sdk/client-storage-gateway-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(StorageGatewayClient) and the commands you need, for example ActivateGatewayCommand:

//JavaScript
const {
  StorageGatewayClient
} = require("@aws-sdk/client-storage-gateway-node/StorageGatewayClient");
const {
  ActivateGatewayCommand
} = require("@aws-sdk/client-storage-gateway-node/commands/ActivateGatewayCommand");

//TypeScript
import { StorageGatewayClient } from "@aws-sdk/client-storage-gateway-node/StorageGatewayClient";
import { ActivateGatewayCommand } from "@aws-sdk/client-storage-gateway-node/commands/ActivateGatewayCommand";

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 storageGateway = new StorageGatewayClient({region: 'region'});
//clients can be shared by different commands
const params = {
  ActivationKey: /**a string value*/,
  GatewayName: /**a string value*/,
  GatewayTimezone: /**a string value*/,
  GatewayRegion: /**a string value*/,
};
const activateGatewayCommand = new ActivateGatewayCommand(params);
storageGateway.send(activateGatewayCommand).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 storageGateway.send(activateGatewayCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
storageGateway.send(activateGatewayCommand, (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-storage-gateway-node/StorageGateway";
const storageGateway = new AWS.StorageGateway({ region: "region" });
storageGateway.activateGateway(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 storageGateway.send(activateGatewayCommand);
  // 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-storage-gateway-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.