aws_sdk_arcregionswitch/client/
list_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 [`ListPlans`](crate::operation::list_plans::builders::ListPlansFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_plans::builders::ListPlansFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_plans::builders::ListPlansFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_plans::builders::ListPlansFluentBuilder::set_max_results):<br>required: **false**<br><p>The number of objects that you want to return with this call.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_plans::builders::ListPlansFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_plans::builders::ListPlansFluentBuilder::set_next_token):<br>required: **false**<br><p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>nextToken</code> response to request the next page of results.</p><br>
9    /// - On success, responds with [`ListPlansOutput`](crate::operation::list_plans::ListPlansOutput) with field(s):
10    ///   - [`plans(Option<Vec::<AbbreviatedPlan>>)`](crate::operation::list_plans::ListPlansOutput::plans): <p>The plans that were requested.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::list_plans::ListPlansOutput::next_token): <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>nextToken</code> response to request the next page of results.</p>
12    /// - On failure, responds with [`SdkError<ListPlansError>`](crate::operation::list_plans::ListPlansError)
13    pub fn list_plans(&self) -> crate::operation::list_plans::builders::ListPlansFluentBuilder {
14        crate::operation::list_plans::builders::ListPlansFluentBuilder::new(self.handle.clone())
15    }
16}