list_indexed_recovery_points ¶

def list_indexed_recovery_points(
    self,
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    next_token: Optional["capo_backup.types.string.string"] = None,
    max_results: Optional["capo_backup.types.max_results.MaxResults"] = None,
    source_resource_arn: Optional["capo_backup.types.arn.ARN"] = None,
    created_before: Optional["capo_backup.types.timestamp.timestamp"] = None,
    created_after: Optional["capo_backup.types.timestamp.timestamp"] = None,
    resource_type: Optional["capo_backup.types.resource_type.ResourceType"] = None,
    index_status: Optional["capo_backup.types.index_status.IndexStatus"] = None,
) -> "capo_backup.types.list_indexed_recovery_points_output.ListIndexedRecoveryPointsOutput":
    """<p>This operation returns a list of recovery points that have an associated index, belonging to the specified account.</p> <p>Optional parameters you can include are: MaxResults; NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; and ResourceType.</p>

    Args:
        next_token: <p>The next item following a partial list of returned recovery points.</p> <p>For example, if a request is made to return <code>MaxResults</code> number of indexed recovery points, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>
        max_results: <p>The maximum number of resource list items to be returned.</p>
        source_resource_arn: <p>A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.</p>
        created_before: <p>Returns only indexed recovery points that were created before the specified date.</p>
        created_after: <p>Returns only indexed recovery points that were created after the specified date.</p>
        resource_type: <p>Returns a list of indexed recovery points for the specified resource type(s).</p> <p>Accepted values include:</p> <ul> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>S3</code> for Amazon Simple Storage Service (Amazon S3)</p> </li> </ul>
        index_status: <p>Include this parameter to filter the returned list by the indicated statuses.</p> <p>Accepted values: <code>PENDING</code> | <code>ACTIVE</code> | <code>FAILED</code> | <code>DELETING</code> </p> <p>A recovery point with an index that has the status of <code>ACTIVE</code> can be included in a search.</p>

    Raises:
        capo_backup.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
        capo_backup.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action doesn't exist.</p>
        capo_backup.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request failed due to a temporary failure of the server.</p>
        capo_backup.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_backup.types.list_indexed_recovery_points_input.ListIndexedRecoveryPointsInput]",
    ) -> OperationResponse[
        "capo_backup.types.list_indexed_recovery_points_output.ListIndexedRecoveryPointsOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.list_indexed_recovery_points

        output, http_response = (
            capo_backup._operations.cryo_controller_user_manager.list_indexed_recovery_points.list_indexed_recovery_points(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListIndexedRecoveryPoints")
    )
    input_: capo_backup.types.list_indexed_recovery_points_input.ListIndexedRecoveryPointsInput = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if source_resource_arn is not None:
        input_["source_resource_arn"] = source_resource_arn
    if created_before is not None:
        input_["created_before"] = created_before
    if created_after is not None:
        input_["created_after"] = created_after
    if resource_type is not None:
        input_["resource_type"] = resource_type
    if index_status is not None:
        input_["index_status"] = index_status

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