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.

Container for the parameters to the DescribeCache operation. Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.StorageGateway.AmazonStorageGatewayRequest
      Amazon.StorageGateway.Model.DescribeCacheRequest

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

Syntax

C#
public class DescribeCacheRequest : AmazonStorageGatewayRequest
         IAmazonWebServiceRequest

The DescribeCacheRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeCacheRequest()

Properties

NameTypeDescription
Public Property GatewayARN System.String

Gets and sets the property GatewayARN.

Examples

Returns information about the cache of a gateway.

To describe cache information


var client = new AmazonStorageGatewayClient();
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<string> diskIds = response.DiskIds;
string gatewayARN = response.GatewayARN;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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