aws_sdk_synthetics/client/
list_groups.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 [`ListGroups`](crate::operation::list_groups::builders::ListGroupsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::set_max_results):<br>required: **false**<br><p>Specify this parameter to limit how many groups are returned each time you use the <code>ListGroups</code> operation. If you omit this parameter, the default of 20 is used.</p><br>
9    /// - On success, responds with [`ListGroupsOutput`](crate::operation::list_groups::ListGroupsOutput) with field(s):
10    ///   - [`groups(Option<Vec::<GroupSummary>>)`](crate::operation::list_groups::ListGroupsOutput::groups): <p>An array of structures that each contain information about one group.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::list_groups::ListGroupsOutput::next_token): <p>A token that indicates that there is more data available. You can use this token in a subsequent <code>ListGroups</code> operation to retrieve the next set of results.</p>
12    /// - On failure, responds with [`SdkError<ListGroupsError>`](crate::operation::list_groups::ListGroupsError)
13    pub fn list_groups(&self) -> crate::operation::list_groups::builders::ListGroupsFluentBuilder {
14        crate::operation::list_groups::builders::ListGroupsFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_synthetics/client/list_groups.rs

aws_sdk_synthetics/client/
list_groups.rs
