aws_sdk_backup/client/

list_indexed_recovery_points.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListIndexedRecoveryPoints`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::set_next_token):<br>required: **false**<br><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><br>
    ///   - [`max_results(i32)`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of resource list items to be returned.</p><br>
    ///   - [`source_resource_arn(impl Into<String>)`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::source_resource_arn) / [`set_source_resource_arn(Option<String>)`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::set_source_resource_arn):<br>required: **false**<br><p>A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.</p><br>
    ///   - [`created_before(DateTime)`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::created_before) / [`set_created_before(Option<DateTime>)`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::set_created_before):<br>required: **false**<br><p>Returns only indexed recovery points that were created before the specified date.</p><br>
    ///   - [`created_after(DateTime)`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::created_after) / [`set_created_after(Option<DateTime>)`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::set_created_after):<br>required: **false**<br><p>Returns only indexed recovery points that were created after the specified date.</p><br>
    ///   - [`resource_type(impl Into<String>)`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::resource_type) / [`set_resource_type(Option<String>)`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::set_resource_type):<br>required: **false**<br><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><br>
    ///   - [`index_status(IndexStatus)`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::index_status) / [`set_index_status(Option<IndexStatus>)`](crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::set_index_status):<br>required: **false**<br><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><br>
    /// - On success, responds with [`ListIndexedRecoveryPointsOutput`](crate::operation::list_indexed_recovery_points::ListIndexedRecoveryPointsOutput) with field(s):
    ///   - [`indexed_recovery_points(Option<Vec::<IndexedRecoveryPoint>>)`](crate::operation::list_indexed_recovery_points::ListIndexedRecoveryPointsOutput::indexed_recovery_points): <p>This is a list of recovery points that have an associated index, belonging to the specified account.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_indexed_recovery_points::ListIndexedRecoveryPointsOutput::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>
    /// - On failure, responds with [`SdkError<ListIndexedRecoveryPointsError>`](crate::operation::list_indexed_recovery_points::ListIndexedRecoveryPointsError)
    pub fn list_indexed_recovery_points(&self) -> crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder {
        crate::operation::list_indexed_recovery_points::builders::ListIndexedRecoveryPointsFluentBuilder::new(self.handle.clone())
    }
}