aws_sdk_mq/client/
list_users.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 [`ListUsers`](crate::operation::list_users::builders::ListUsersFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`broker_id(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::broker_id) / [`set_broker_id(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_broker_id):<br>required: **true**<br><p>The unique ID that Amazon MQ generates for the broker.</p><br>
7    ///   - [`max_results(i32)`](crate::operation::list_users::builders::ListUsersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_next_token):<br>required: **false**<br><p>The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.</p><br>
9    /// - On success, responds with [`ListUsersOutput`](crate::operation::list_users::ListUsersOutput) with field(s):
10    ///   - [`broker_id(Option<String>)`](crate::operation::list_users::ListUsersOutput::broker_id): <p>Required. The unique ID that Amazon MQ generates for the broker.</p>
11    ///   - [`max_results(Option<i32>)`](crate::operation::list_users::ListUsersOutput::max_results): <p>Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_users::ListUsersOutput::next_token): <p>The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.</p>
13    ///   - [`users(Option<Vec::<UserSummary>>)`](crate::operation::list_users::ListUsersOutput::users): <p>Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.</p>
14    /// - On failure, responds with [`SdkError<ListUsersError>`](crate::operation::list_users::ListUsersError)
15    pub fn list_users(&self) -> crate::operation::list_users::builders::ListUsersFluentBuilder {
16        crate::operation::list_users::builders::ListUsersFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_mq/client/list_users.rs

aws_sdk_mq/client/
list_users.rs
