aws_sdk_mq/client/
describe_user.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 [`DescribeUser`](crate::operation::describe_user::builders::DescribeUserFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`broker_id(impl Into<String>)`](crate::operation::describe_user::builders::DescribeUserFluentBuilder::broker_id) / [`set_broker_id(Option<String>)`](crate::operation::describe_user::builders::DescribeUserFluentBuilder::set_broker_id):<br>required: **true**<br><p>The unique ID that Amazon MQ generates for the broker.</p><br>
7    ///   - [`username(impl Into<String>)`](crate::operation::describe_user::builders::DescribeUserFluentBuilder::username) / [`set_username(Option<String>)`](crate::operation::describe_user::builders::DescribeUserFluentBuilder::set_username):<br>required: **true**<br><p>The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.</p><br>
8    /// - On success, responds with [`DescribeUserOutput`](crate::operation::describe_user::DescribeUserOutput) with field(s):
9    ///   - [`broker_id(Option<String>)`](crate::operation::describe_user::DescribeUserOutput::broker_id): <p>Required. The unique ID that Amazon MQ generates for the broker.</p>
10    ///   - [`console_access(Option<bool>)`](crate::operation::describe_user::DescribeUserOutput::console_access): <p>Enables access to the the ActiveMQ Web Console for the ActiveMQ user.</p>
11    ///   - [`groups(Option<Vec::<String>>)`](crate::operation::describe_user::DescribeUserOutput::groups): <p>The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.</p>
12    ///   - [`pending(Option<UserPendingChanges>)`](crate::operation::describe_user::DescribeUserOutput::pending): <p>The status of the changes pending for the ActiveMQ user.</p>
13    ///   - [`username(Option<String>)`](crate::operation::describe_user::DescribeUserOutput::username): <p>Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.</p>
14    ///   - [`replication_user(Option<bool>)`](crate::operation::describe_user::DescribeUserOutput::replication_user): <p>Describes whether the user is intended for data replication</p>
15    /// - On failure, responds with [`SdkError<DescribeUserError>`](crate::operation::describe_user::DescribeUserError)
16    pub fn describe_user(&self) -> crate::operation::describe_user::builders::DescribeUserFluentBuilder {
17        crate::operation::describe_user::builders::DescribeUserFluentBuilder::new(self.handle.clone())
18    }
19}