Skip to content

Describe Group Membership

quicksight_describe_group_membership R Documentation

Use the DescribeGroupMembership operation to determine if a user is a member of the specified group

Description

Use the describe_group_membership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.

Usage

quicksight_describe_group_membership(MemberName, GroupName,
  AwsAccountId, Namespace)

Arguments

MemberName

[required] The user name of the user that you want to search for.

GroupName

[required] The name of the group that you want to search.

AwsAccountId

[required] 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.

Namespace

[required] The namespace that includes the group you are searching within.

Value

A list with the following syntax:

list(
  GroupMember = list(
    Arn = "string",
    MemberName = "string"
  ),
  RequestId = "string",
  Status = 123
)

Request syntax

svc$describe_group_membership(
  MemberName = "string",
  GroupName = "string",
  AwsAccountId = "string",
  Namespace = "string"
)