- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
AddUploadBufferCommand
Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume, and tape gateway types.
In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { StorageGatewayClient, AddUploadBufferCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import
// const { StorageGatewayClient, AddUploadBufferCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import
const client = new StorageGatewayClient(config);
const input = { // AddUploadBufferInput
GatewayARN: "STRING_VALUE", // required
DiskIds: [ // DiskIds // required
"STRING_VALUE",
],
};
const command = new AddUploadBufferCommand(input);
const response = await client.send(command);
// { // AddUploadBufferOutput
// GatewayARN: "STRING_VALUE",
// };
Example Usage
AddUploadBufferCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
DiskIdsRequired | string[] | undefined | An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API. |
GatewayARNRequired | string | undefined | The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region. |
AddUploadBufferCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
GatewayARN | string | undefined | The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalServerError | server | An internal server error has occurred during the request. For more information, see the error and message fields. |
| InvalidGatewayRequestException | client | An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields. |
| StorageGatewayServiceException | Base exception class for all service exceptions from StorageGateway service. |