import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeUploadBufferInput, DescribeUploadBufferOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeUploadBufferCommand}. */ export interface DescribeUploadBufferCommandInput extends DescribeUploadBufferInput { } /** * @public * * The output of {@link DescribeUploadBufferCommand}. */ export interface DescribeUploadBufferCommandOutput extends DescribeUploadBufferOutput, __MetadataBearer { } declare const DescribeUploadBufferCommand_base: { new (input: DescribeUploadBufferCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeUploadBufferCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns information about the upload buffer of a gateway. This operation is supported * for the stored volume, cached volume, and tape gateway types.

*

The response includes disk IDs that are configured as upload buffer space, and it * includes the amount of upload buffer space allocated and used.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { StorageGatewayClient, DescribeUploadBufferCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import * // const { StorageGatewayClient, DescribeUploadBufferCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import * // import type { StorageGatewayClientConfig } from "@aws-sdk/client-storage-gateway"; * const config = {}; // type is StorageGatewayClientConfig * const client = new StorageGatewayClient(config); * const input = { // DescribeUploadBufferInput * GatewayARN: "STRING_VALUE", // required * }; * const command = new DescribeUploadBufferCommand(input); * const response = await client.send(command); * // { // DescribeUploadBufferOutput * // GatewayARN: "STRING_VALUE", * // DiskIds: [ // DiskIds * // "STRING_VALUE", * // ], * // UploadBufferUsedInBytes: Number("long"), * // UploadBufferAllocatedInBytes: Number("long"), * // }; * * ``` * * @param DescribeUploadBufferCommandInput - {@link DescribeUploadBufferCommandInput} * @returns {@link DescribeUploadBufferCommandOutput} * @see {@link DescribeUploadBufferCommandInput} for command's `input` shape. * @see {@link DescribeUploadBufferCommandOutput} for command's `response` shape. * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape. * * @throws {@link InternalServerError} (server fault) *

An internal server error has occurred during the request. For more information, see the * error and message fields.

* * @throws {@link InvalidGatewayRequestException} (client fault) *

An exception occurred because an invalid gateway request was issued to the service. For * more information, see the error and message fields.

* * @throws {@link StorageGatewayServiceException} *

Base exception class for all service exceptions from StorageGateway service.

* * * @example To describe upload buffer of a gateway * ```javascript * // Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used. * const input = { * GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" * }; * const command = new DescribeUploadBufferCommand(input); * const response = await client.send(command); * /* response is * { * DiskIds: [ * "pci-0000:03:00.0-scsi-0:0:0:0", * "pci-0000:04:00.0-scsi-0:1:0:0" * ], * GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", * UploadBufferAllocatedInBytes: 161061273600, * UploadBufferUsedInBytes: 0 * } * *\/ * ``` * * @example To describe upload buffer of gateway * ```javascript * // Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used. * const input = { * GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" * }; * const command = new DescribeUploadBufferCommand(input); * const response = await client.send(command); * /* response is * { * DiskIds: [ * "pci-0000:03:00.0-scsi-0:0:0:0", * "pci-0000:04:00.0-scsi-0:1:0:0" * ], * GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", * UploadBufferAllocatedInBytes: 0, * UploadBufferUsedInBytes: 161061273600 * } * *\/ * ``` * * @public */ export declare class DescribeUploadBufferCommand extends DescribeUploadBufferCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeUploadBufferInput; output: DescribeUploadBufferOutput; }; sdk: { input: DescribeUploadBufferCommandInput; output: DescribeUploadBufferCommandOutput; }; }; }