AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Returns information about the cache of a gateway. This operation is only supported in the cached volume,tape and file gateway architectures.

The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

Note:

For PCL this operation is only available in asynchronous form. Please refer to DescribeCacheAsync.

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

Syntax

C#
public abstract DescribeCacheResponse DescribeCache(
         DescribeCacheRequest request
)
Parameters
request
Type: Amazon.StorageGateway.Model.DescribeCacheRequest

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

Return Value
The response from the DescribeCache service method, as returned by StorageGateway.

Exceptions

ExceptionCondition
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 cache of a gateway.

To describe cache information


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

long cacheAllocatedInBytes = response.CacheAllocatedInBytes;
double cacheDirtyPercentage = response.CacheDirtyPercentage;
double cacheHitPercentage = response.CacheHitPercentage;
double cacheMissPercentage = response.CacheMissPercentage;
double cacheUsedPercentage = response.CacheUsedPercentage;
List diskIds = response.DiskIds;
string gatewayARN = response.GatewayARN;

            

Version Information

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also