describe_tape_recovery_points `async` ¶

describe_tape_recovery_points(
    gateway_arn: GatewayARN,
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
    marker: Optional[Marker] = None,
    limit: Optional[PositiveIntObject] = None,
) -> DescribeTapeRecoveryPointsOutput

Returns a list of virtual tape recovery points that are available for the specified tape gateway.

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

Parameters:

marker (Optional[Marker], default: None ) –

An opaque string that indicates the position at which to begin describing the virtual tape recovery points.
limit (Optional[PositiveIntObject], default: None ) –

Specifies that the number of virtual tape recovery points that are described be limited to the specified number.

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.

Source code in docs_src/capo_storage_gateway/_services/async_storage_gateway.py

async def describe_tape_recovery_points(
    self,
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
    marker: Optional["capo_storage_gateway.types.marker.Marker"] = None,
    limit: Optional[
        "capo_storage_gateway.types.positive_int_object.PositiveIntObject"
    ] = None,
) -> "capo_storage_gateway.types.describe_tape_recovery_points_output.DescribeTapeRecoveryPointsOutput":
    """<p>Returns a list of virtual tape recovery points that are available for the specified tape gateway.</p> <p>A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type.</p>

    Args:
        marker: <p>An opaque string that indicates the position at which to begin describing the virtual tape recovery points.</p>
        limit: <p>Specifies that the number of virtual tape recovery points that are described be limited to the specified number.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_storage_gateway.types.describe_tape_recovery_points_input.DescribeTapeRecoveryPointsInput]",
    ) -> AsyncOperationResponse[
        "capo_storage_gateway.types.describe_tape_recovery_points_output.DescribeTapeRecoveryPointsOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.describe_tape_recovery_points

        (
            output,
            http_response,
        ) = await capo_storage_gateway._operations.storage_gateway_20130630.describe_tape_recovery_points.async_describe_tape_recovery_points(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTapeRecoveryPoints")
    )
    input_: capo_storage_gateway.types.describe_tape_recovery_points_input.DescribeTapeRecoveryPointsInput = {
        "gateway_arn": gateway_arn
    }
    if marker is not None:
        input_["marker"] = marker
    if limit is not None:
        input_["limit"] = limit

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_tape_recovery_points async ¶

describe_tape_recovery_points `async` ¶