StorageGateway / Client / list_volume_recovery_points

list_volume_recovery_points#

StorageGateway.Client.list_volume_recovery_points(**kwargs)#

Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.

Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.

See also: AWS API Documentation

Request Syntax

response = client.list_volume_recovery_points(
    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',
    'VolumeRecoveryPointInfos': [
        {
            'VolumeARN': 'string',
            'VolumeSizeInBytes': 123,
            'VolumeUsageInBytes': 123,
            'VolumeRecoveryPointTime': '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.

    • VolumeRecoveryPointInfos (list) –

      An array of VolumeRecoveryPointInfo objects.

      • (dict) –

        Describes a storage volume recovery point object.

        • VolumeARN (string) –

          The Amazon Resource Name (ARN) of the volume target.

        • VolumeSizeInBytes (integer) –

          The size of the volume in bytes.

        • VolumeUsageInBytes (integer) –

          The size of the data stored on the volume in bytes.

          Note

          This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

        • VolumeRecoveryPointTime (string) –

          The time the recovery point was taken.

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException

  • StorageGateway.Client.exceptions.InternalServerError

Examples

Lists the recovery points for a specified gateway in which all data of the volume is consistent and can be used to create a snapshot.

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

print(response)

Expected Output:

{
    'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'VolumeRecoveryPointInfos': [
        {
            'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
            'VolumeRecoveryPointTime': '2012-09-04T21:08:44.627Z',
            'VolumeSizeInBytes': 536870912000,
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}