AmazonStorageGatewayClient.DescribeUploadBuffer Method (DescribeUploadBufferRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DescribeUploadBufferAsync.

Namespace: Amazon.StorageGateway
Assembly: AWSSDK.StorageGateway.dll
Version: 3.x.y.z

Syntax

public virtual DescribeUploadBufferResponse DescribeUploadBuffer(
         DescribeUploadBufferRequest request
)

Parameters

request: Type: Amazon.StorageGateway.Model.DescribeUploadBufferRequest

Container for the necessary parameters to execute the DescribeUploadBuffer service method.

Return Value

Type: DescribeUploadBufferResponse

The response from the DescribeUploadBuffer service method, as returned by StorageGateway.

Exceptions

Exception	Condition
InternalServerErrorException	An internal server error has occurred during the request. For more information, see the error and message fields.
InvalidGatewayRequestException	An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

Examples

Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used.

To describe upload buffer of gateway


var client = new AmazonStorageGatewayClient();
var response = client.DescribeUploadBuffer(new DescribeUploadBufferRequest 
{
    GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
});

List<string> diskIds = response.DiskIds;
string gatewayARN = response.GatewayARN;
long uploadBufferAllocatedInBytes = response.UploadBufferAllocatedInBytes;
long uploadBufferUsedInBytes = response.UploadBufferUsedInBytes;

Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used.

To describe upload buffer of a gateway


var client = new AmazonStorageGatewayClient();
var response = client.DescribeUploadBuffer(new DescribeUploadBufferRequest 
{
    GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
});

List<string> diskIds = response.DiskIds;
string gatewayARN = response.GatewayARN;
long uploadBufferAllocatedInBytes = response.UploadBufferAllocatedInBytes;
long uploadBufferUsedInBytes = response.UploadBufferUsedInBytes;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonStorageGatewayClient.DescribeUploadBuffer (DescribeUploadBufferRequest)

Method