Skip to content

retrieve_tape_recovery_point

retrieve_tape_recovery_point(
    tape_arn: TapeARN,
    gateway_arn: GatewayARN,
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> RetrieveTapeRecoveryPointOutput

Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type.

A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points.

Parameters:

  • tape_arn (TapeARN) –

    The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.

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 retrieve the recovery point of a virtual tape Retrieves the recovery point for the specified virtual tape.

>>> client.retrieve_tape_recovery_point(tape_arn='arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF', gateway_arn='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B')
Source code in docs_src/capo_storage_gateway/_services/storage_gateway.py
def retrieve_tape_recovery_point(
    self,
    tape_arn: "capo_storage_gateway.types.tape_arn.TapeARN",
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.retrieve_tape_recovery_point_output.RetrieveTapeRecoveryPointOutput":
    """<p>Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type.</p> <p>A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.</p> <note> <p>The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points.</p> </note>

    Args:
        tape_arn: <p>The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.</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 retrieve the recovery point of a virtual tape
        Retrieves the recovery point for the specified virtual tape.

        >>> client.retrieve_tape_recovery_point(tape_arn='arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF', gateway_arn='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B')
    """

    def _handler(
        req: "OperationRequest[capo_storage_gateway.types.retrieve_tape_recovery_point_input.RetrieveTapeRecoveryPointInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.retrieve_tape_recovery_point_output.RetrieveTapeRecoveryPointOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.retrieve_tape_recovery_point

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RetrieveTapeRecoveryPoint")
    )
    input_: capo_storage_gateway.types.retrieve_tape_recovery_point_input.RetrieveTapeRecoveryPointInput = {
        "tape_arn": tape_arn,
        "gateway_arn": gateway_arn,
    }

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