QuickSight / Client / create_group_membership

create_group_membership

QuickSight.Client.create_group_membership(**kwargs)

Adds an Amazon QuickSight user to an Amazon QuickSight group.

See also: AWS API Documentation

Request Syntax

response = client.create_group_membership(
    MemberName='string',
    GroupName='string',
    AwsAccountId='string',
    Namespace='string'
)

Parameters:

• MemberName (string) –

  [REQUIRED]

  The name of the user that you want to add to the group membership.

• GroupName (string) –

  [REQUIRED]

  The name of the group that you want to add the user to.

• 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 you want the user to be a part of.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • GroupMember (dict) –

    The group member.

    • 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