aws_sdk_iotwireless/client/
list_multicast_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 [`ListMulticastGroups`](crate::operation::list_multicast_groups::builders::ListMulticastGroupsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_multicast_groups::builders::ListMulticastGroupsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_multicast_groups::builders::ListMulticastGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_multicast_groups::builders::ListMulticastGroupsFluentBuilder::set_next_token):<br>required: **false**<br><p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_multicast_groups::builders::ListMulticastGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_multicast_groups::builders::ListMulticastGroupsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in this operation.</p><br>
9    /// - On success, responds with [`ListMulticastGroupsOutput`](crate::operation::list_multicast_groups::ListMulticastGroupsOutput) with field(s):
10    ///   - [`next_token(Option<String>)`](crate::operation::list_multicast_groups::ListMulticastGroupsOutput::next_token): <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p>
11    ///   - [`multicast_group_list(Option<Vec::<MulticastGroup>>)`](crate::operation::list_multicast_groups::ListMulticastGroupsOutput::multicast_group_list): <p>List of multicast groups.</p>
12    /// - On failure, responds with [`SdkError<ListMulticastGroupsError>`](crate::operation::list_multicast_groups::ListMulticastGroupsError)
13    pub fn list_multicast_groups(&self) -> crate::operation::list_multicast_groups::builders::ListMulticastGroupsFluentBuilder {
14        crate::operation::list_multicast_groups::builders::ListMulticastGroupsFluentBuilder::new(self.handle.clone())
15    }
16}