describe_working_storage

describe_working_storage(**kwargs)

Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead.

Note

Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.

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

See also: AWS API Documentation

Request Syntax

response = client.describe_working_storage(
    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',
    'DiskIds': [
        'string',
    ],
    'WorkingStorageUsedInBytes': 123,
    'WorkingStorageAllocatedInBytes': 123
}

Response Structure

• (dict) --

  A JSON object containing the following fields:

  • 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.

  • DiskIds (list) --

    An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

    • (string) --
  • WorkingStorageUsedInBytes (integer) --

    The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.

  • WorkingStorageAllocatedInBytes (integer) --

    The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.

Exceptions

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

Examples

This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.

response = client.describe_working_storage(
    GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)

print(response)

Expected Output:

{
    'DiskIds': [
        'pci-0000:03:00.0-scsi-0:0:0:0',
        'pci-0000:03:00.0-scsi-0:0:1:0',
    ],
    'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'WorkingStorageAllocatedInBytes': 2199023255552,
    'WorkingStorageUsedInBytes': 789207040,
    'ResponseMetadata': {
        '...': '...',
    },
}