aws_sdk_backup/client/
list_backup_plans.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ListBackupPlans`](crate::operation::list_backup_plans::builders::ListBackupPlansFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_backup_plans::builders::ListBackupPlansFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_backup_plans::builders::ListBackupPlansFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_backup_plans::builders::ListBackupPlansFluentBuilder::set_next_token):<br>required: **false**<br><p>The next item following a partial list of returned items. For example, if a request is made to return <code>MaxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_backup_plans::builders::ListBackupPlansFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_backup_plans::builders::ListBackupPlansFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to be returned.</p><br>
9    ///   - [`include_deleted(bool)`](crate::operation::list_backup_plans::builders::ListBackupPlansFluentBuilder::include_deleted) / [`set_include_deleted(Option<bool>)`](crate::operation::list_backup_plans::builders::ListBackupPlansFluentBuilder::set_include_deleted):<br>required: **false**<br><p>A Boolean value with a default value of <code>FALSE</code> that returns deleted backup plans when set to <code>TRUE</code>.</p><br>
10    /// - On success, responds with [`ListBackupPlansOutput`](crate::operation::list_backup_plans::ListBackupPlansOutput) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::list_backup_plans::ListBackupPlansOutput::next_token): <p>The next item following a partial list of returned items. For example, if a request is made to return <code>MaxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>
12    ///   - [`backup_plans_list(Option<Vec::<BackupPlansListMember>>)`](crate::operation::list_backup_plans::ListBackupPlansOutput::backup_plans_list): <p>Information about the backup plans.</p>
13    /// - On failure, responds with [`SdkError<ListBackupPlansError>`](crate::operation::list_backup_plans::ListBackupPlansError)
14    pub fn list_backup_plans(&self) -> crate::operation::list_backup_plans::builders::ListBackupPlansFluentBuilder {
15        crate::operation::list_backup_plans::builders::ListBackupPlansFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_backup/client/list_backup_plans.rs

aws_sdk_backup/client/
list_backup_plans.rs
