QuickSight / Client / describe_group_membership

describe_group_membership#

QuickSight.Client.describe_group_membership(**kwargs)#

Use the DescribeGroupMembership 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.

See also: AWS API Documentation

Request Syntax

response = client.describe_group_membership(
    MemberName='string',
    GroupName='string',
    AwsAccountId='string',
    Namespace='string'
)
Parameters:

  • MemberName (string) –

    [REQUIRED]

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

  • GroupName (string) –

    [REQUIRED]

    The name of the group that you want to search.

  • AwsAccountId (string) –

    [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 (string) –

    [REQUIRED]

    The namespace that includes the group you are searching within.

Return type:

dict

Returns:

Response Syntax

{
    'GroupMember': {
        'Arn': 'string',
        'MemberName': 'string'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • GroupMember (dict) –

      A member of an Amazon QuickSight group. Currently, group members must be users. Groups can’t be members of another group. .

      • Arn (string) –

        The Amazon Resource Name (ARN) for the group member (user).

      • MemberName (string) –

        The name of the group member (user).

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.PreconditionNotMetException

  • QuickSight.Client.exceptions.InternalFailureException

  • QuickSight.Client.exceptions.ResourceUnavailableException