aws_sdk_opensearchserverless/client/
list_lifecycle_policies.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 [`ListLifecyclePolicies`](crate::operation::list_lifecycle_policies::builders::ListLifecyclePoliciesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_lifecycle_policies::builders::ListLifecyclePoliciesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`r#type(LifecyclePolicyType)`](crate::operation::list_lifecycle_policies::builders::ListLifecyclePoliciesFluentBuilder::type) / [`set_type(Option<LifecyclePolicyType>)`](crate::operation::list_lifecycle_policies::builders::ListLifecyclePoliciesFluentBuilder::set_type):<br>required: **true**<br><p>The type of lifecycle policy.</p><br>
8    ///   - [`resources(impl Into<String>)`](crate::operation::list_lifecycle_policies::builders::ListLifecyclePoliciesFluentBuilder::resources) / [`set_resources(Option<Vec::<String>>)`](crate::operation::list_lifecycle_policies::builders::ListLifecyclePoliciesFluentBuilder::set_resources):<br>required: **false**<br><p>Resource filters that policies can apply to. Currently, the only supported resource type is <code>index</code>.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_lifecycle_policies::builders::ListLifecyclePoliciesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_lifecycle_policies::builders::ListLifecyclePoliciesFluentBuilder::set_next_token):<br>required: **false**<br><p>If your initial <code>ListLifecyclePolicies</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListLifecyclePolicies</code> operations, which returns results in the next page.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_lifecycle_policies::builders::ListLifecyclePoliciesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_lifecycle_policies::builders::ListLifecyclePoliciesFluentBuilder::set_max_results):<br>required: **false**<br><p>An optional parameter that specifies the maximum number of results to return. You can use use <code>nextToken</code> to get the next page of results. The default is 10.</p><br>
11    /// - On success, responds with [`ListLifecyclePoliciesOutput`](crate::operation::list_lifecycle_policies::ListLifecyclePoliciesOutput) with field(s):
12    ///   - [`lifecycle_policy_summaries(Option<Vec::<LifecyclePolicySummary>>)`](crate::operation::list_lifecycle_policies::ListLifecyclePoliciesOutput::lifecycle_policy_summaries): <p>Details about the requested lifecycle policies.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_lifecycle_policies::ListLifecyclePoliciesOutput::next_token): <p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>
14    /// - On failure, responds with [`SdkError<ListLifecyclePoliciesError>`](crate::operation::list_lifecycle_policies::ListLifecyclePoliciesError)
15    pub fn list_lifecycle_policies(&self) -> crate::operation::list_lifecycle_policies::builders::ListLifecyclePoliciesFluentBuilder {
16        crate::operation::list_lifecycle_policies::builders::ListLifecyclePoliciesFluentBuilder::new(self.handle.clone())
17    }
18}