aws_sdk_backup/client/list_legal_holds.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 [`ListLegalHolds`](crate::operation::list_legal_holds::builders::ListLegalHoldsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_legal_holds::builders::ListLegalHoldsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`next_token(impl Into<String>)`](crate::operation::list_legal_holds::builders::ListLegalHoldsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_legal_holds::builders::ListLegalHoldsFluentBuilder::set_next_token):<br>required: **false**<br><p>The next item following a partial list of returned resources. For example, if a request is made to return <code>MaxResults</code> number of resources, <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_legal_holds::builders::ListLegalHoldsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_legal_holds::builders::ListLegalHoldsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of resource list items to be returned.</p><br>
9 /// - On success, responds with [`ListLegalHoldsOutput`](crate::operation::list_legal_holds::ListLegalHoldsOutput) with field(s):
10 /// - [`next_token(Option<String>)`](crate::operation::list_legal_holds::ListLegalHoldsOutput::next_token): <p>The next item following a partial list of returned resources. For example, if a request is made to return <code>MaxResults</code> number of resources, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>
11 /// - [`legal_holds(Option<Vec::<LegalHold>>)`](crate::operation::list_legal_holds::ListLegalHoldsOutput::legal_holds): <p>This is an array of returned legal holds, both active and previous.</p>
12 /// - On failure, responds with [`SdkError<ListLegalHoldsError>`](crate::operation::list_legal_holds::ListLegalHoldsError)
13 pub fn list_legal_holds(&self) -> crate::operation::list_legal_holds::builders::ListLegalHoldsFluentBuilder {
14 crate::operation::list_legal_holds::builders::ListLegalHoldsFluentBuilder::new(self.handle.clone())
15 }
16}