Skip to content

list_recovery_points

list_recovery_points(
    *,
    config_overrides: Optional[RedshiftServerlessClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
    start_time: Optional[datetime] = None,
    end_time: Optional[datetime] = None,
    namespace_name: Optional[NamespaceName] = None,
    namespace_arn: Optional[str] = None,
) -> ListRecoveryPointsResponse

Returns an array of recovery points.

Parameters:

  • next_token (Optional[str], default: None ) –

    If your initial ListRecoveryPoints operation returns a nextToken, you can include the returned nextToken in following ListRecoveryPoints operations, which returns results in the next page.

  • max_results (Optional[int], default: None ) –

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

  • start_time (Optional[datetime], default: None ) –

    The time when the recovery point's creation was initiated.

  • end_time (Optional[datetime], default: None ) –

    The time when creation of the recovery point finished.

  • namespace_name (Optional[NamespaceName], default: None ) –

    The name of the namespace to list recovery points for.

  • namespace_arn (Optional[str], default: None ) –

    The Amazon Resource Name (ARN) of the namespace from which to list recovery points.

Raises:

  • InternalServerException –

    The request processing has failed because of an unknown error, exception or failure.

  • ValidationException –

    The input failed to satisfy the constraints specified by an Amazon Web Services service.

  • UnknownServiceError –

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

Source code in docs_src/capo_redshift_serverless/_services/redshift_serverless.py
def list_recovery_points(
    self,
    *,
    config_overrides: Optional[RedshiftServerlessClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
    start_time: Optional[datetime.datetime] = None,
    end_time: Optional[datetime.datetime] = None,
    namespace_name: Optional[
        "capo_redshift_serverless.types.namespace_name.NamespaceName"
    ] = None,
    namespace_arn: Optional[str] = None,
) -> "capo_redshift_serverless.types.list_recovery_points_response.ListRecoveryPointsResponse":
    """<p>Returns an array of recovery points.</p>

    Args:
        next_token: <p>If your initial <code>ListRecoveryPoints</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in following <code>ListRecoveryPoints</code> operations, which returns results in the next page.</p>
        max_results: <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to display the next page of results.</p>
        start_time: <p>The time when the recovery point's creation was initiated.</p>
        end_time: <p>The time when creation of the recovery point finished.</p>
        namespace_name: <p>The name of the namespace to list recovery points for.</p>
        namespace_arn: <p>The Amazon Resource Name (ARN) of the namespace from which to list recovery points.</p>

    Raises:
        capo_redshift_serverless.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_redshift_serverless.errors.validation_exception.ValidationException: <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_redshift_serverless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_redshift_serverless.types.list_recovery_points_request.ListRecoveryPointsRequest]",
    ) -> OperationResponse[
        "capo_redshift_serverless.types.list_recovery_points_response.ListRecoveryPointsResponse"
    ]:
        import capo_redshift_serverless._operations.redshift_serverless.list_recovery_points

        output, http_response = (
            capo_redshift_serverless._operations.redshift_serverless.list_recovery_points.list_recovery_points(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRecoveryPoints")
    )
    input_: capo_redshift_serverless.types.list_recovery_points_request.ListRecoveryPointsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if start_time is not None:
        input_["start_time"] = start_time
    if end_time is not None:
        input_["end_time"] = end_time
    if namespace_name is not None:
        input_["namespace_name"] = namespace_name
    if namespace_arn is not None:
        input_["namespace_arn"] = namespace_arn

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