aws_sdk_workspacesweb/client/
list_portals.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 [`ListPortals`](crate::operation::list_portals::builders::ListPortalsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_portals::builders::ListPortalsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_portals::builders::ListPortalsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_portals::builders::ListPortalsFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token used to retrieve the next page of results for this operation.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_portals::builders::ListPortalsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_portals::builders::ListPortalsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to be included in the next page.</p><br>
9    /// - On success, responds with [`ListPortalsOutput`](crate::operation::list_portals::ListPortalsOutput) with field(s):
10    ///   - [`portals(Option<Vec::<PortalSummary>>)`](crate::operation::list_portals::ListPortalsOutput::portals): <p>The portals in the list.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::list_portals::ListPortalsOutput::next_token): <p>The pagination token used to retrieve the next page of results for this operation.</p>
12    /// - On failure, responds with [`SdkError<ListPortalsError>`](crate::operation::list_portals::ListPortalsError)
13    pub fn list_portals(&self) -> crate::operation::list_portals::builders::ListPortalsFluentBuilder {
14        crate::operation::list_portals::builders::ListPortalsFluentBuilder::new(self.handle.clone())
15    }
16}