Skip to content

list_volume_recovery_points

list_volume_recovery_points(
    gateway_arn: GatewayARN,
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> ListVolumeRecoveryPointsOutput

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.

Raises:

  • InternalServerError –

    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.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Examples:

To list recovery points for a gateway 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.

>>> client.list_volume_recovery_points(gateway_arn='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B')
Source code in docs_src/capo_storage_gateway/_services/storage_gateway.py
def list_volume_recovery_points(
    self,
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.list_volume_recovery_points_output.ListVolumeRecoveryPointsOutput":
    """<p>Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.</p> <p>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 <a>CreateSnapshotFromVolumeRecoveryPoint</a> operation.</p>

    Raises:
        capo_storage_gateway.errors.internal_server_error.InternalServerError: <p>An internal server error has occurred during the request. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.invalid_gateway_request_exception.InvalidGatewayRequestException: <p>An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To list recovery points for a gateway
        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.

        >>> client.list_volume_recovery_points(gateway_arn='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B')
    """

    def _handler(
        req: "OperationRequest[capo_storage_gateway.types.list_volume_recovery_points_input.ListVolumeRecoveryPointsInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.list_volume_recovery_points_output.ListVolumeRecoveryPointsOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.list_volume_recovery_points

        output, http_response = (
            capo_storage_gateway._operations.storage_gateway_20130630.list_volume_recovery_points.list_volume_recovery_points(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListVolumeRecoveryPoints")
    )
    input_: capo_storage_gateway.types.list_volume_recovery_points_input.ListVolumeRecoveryPointsInput = {
        "gateway_arn": gateway_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output