reset_cache

reset_cache(**kwargs)

Resets all cache disks that have encountered an error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters an error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point, you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.

Warning

If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.

See also: AWS API Documentation

Request Syntax

response = client.reset_cache(
    GatewayARN='string'
)
Parameters
GatewayARN (string) --

[REQUIRED]

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.

Return type
dict
Returns
Response Syntax
{
    'GatewayARN': 'string'
}

Response Structure

  • (dict) --
    • GatewayARN (string) --

      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.

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException
  • StorageGateway.Client.exceptions.InternalServerError

Examples

Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage.

response = client.reset_cache(
    GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C',
)

print(response)

Expected Output:

{
    'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C',
    'ResponseMetadata': {
        '...': '...',
    },
}