aws_sdk_quicksight/client/
describe_group_membership.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 [`DescribeGroupMembership`](crate::operation::describe_group_membership::builders::DescribeGroupMembershipFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`member_name(impl Into<String>)`](crate::operation::describe_group_membership::builders::DescribeGroupMembershipFluentBuilder::member_name) / [`set_member_name(Option<String>)`](crate::operation::describe_group_membership::builders::DescribeGroupMembershipFluentBuilder::set_member_name):<br>required: **true**<br><p>The user name of the user that you want to search for.</p><br>
7    ///   - [`group_name(impl Into<String>)`](crate::operation::describe_group_membership::builders::DescribeGroupMembershipFluentBuilder::group_name) / [`set_group_name(Option<String>)`](crate::operation::describe_group_membership::builders::DescribeGroupMembershipFluentBuilder::set_group_name):<br>required: **true**<br><p>The name of the group that you want to search.</p><br>
8    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::describe_group_membership::builders::DescribeGroupMembershipFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::describe_group_membership::builders::DescribeGroupMembershipFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.</p><br>
9    ///   - [`namespace(impl Into<String>)`](crate::operation::describe_group_membership::builders::DescribeGroupMembershipFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::describe_group_membership::builders::DescribeGroupMembershipFluentBuilder::set_namespace):<br>required: **true**<br><p>The namespace that includes the group you are searching within.</p><br>
10    /// - On success, responds with [`DescribeGroupMembershipOutput`](crate::operation::describe_group_membership::DescribeGroupMembershipOutput) with field(s):
11    ///   - [`group_member(Option<GroupMember>)`](crate::operation::describe_group_membership::DescribeGroupMembershipOutput::group_member): <p>A member of an Amazon QuickSight group. Currently, group members must be users. Groups can't be members of another group. .</p>
12    ///   - [`request_id(Option<String>)`](crate::operation::describe_group_membership::DescribeGroupMembershipOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
13    ///   - [`status(i32)`](crate::operation::describe_group_membership::DescribeGroupMembershipOutput::status): <p>The HTTP status of the request.</p>
14    /// - On failure, responds with [`SdkError<DescribeGroupMembershipError>`](crate::operation::describe_group_membership::DescribeGroupMembershipError)
15    pub fn describe_group_membership(&self) -> crate::operation::describe_group_membership::builders::DescribeGroupMembershipFluentBuilder {
16        crate::operation::describe_group_membership::builders::DescribeGroupMembershipFluentBuilder::new(self.handle.clone())
17    }
18}