Amazon QuickSight

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

See also: AWS API Documentation

Request Syntax

client.search_groups(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123,
    Namespace='string',
    Filters=[
        {
            'Operator': 'StartsWith',
            'Name': 'GROUP_NAME',
            'Value': 'string'
        },
    ]
)

type AwsAccountId:

string

param 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.

type NextToken:

string

param NextToken:

A pagination token that can be used in a subsequent request.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return from this request.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace that you want to search.

type Filters:

list

param Filters:

[REQUIRED]

The structure for the search filters that you want to apply to your search.

• (dict) --

  A GroupSearchFilter object that you want to apply to your search.

  • Operator (string) -- [REQUIRED]

    The comparison operator that you want to use as a filter, for example "Operator": "StartsWith". Currently, the only supported operator is StartsWith.

  • Name (string) -- [REQUIRED]

    The name of the value that you want to use as a filter, for example "Name": "GROUP_NAME". Currently, the only supported name is GROUP_NAME.

  • Value (string) -- [REQUIRED]

    The value of the named item, in this case GROUP_NAME, that you want to use as a filter.

rtype:

dict

returns:

Response Syntax

{
    'GroupList': [
        {
            'Arn': 'string',
            'GroupName': 'string',
            'Description': 'string',
            'PrincipalId': 'string'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) --

  • GroupList (list) --

    A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

    • (dict) --

      A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security.

      • Arn (string) --

        The Amazon Resource Name (ARN) for the group.

      • GroupName (string) --

        The name of the group.

      • Description (string) --

        The group description.

      • PrincipalId (string) --

        The principal ID of the group.

  • NextToken (string) --

    A pagination token that can be used in a subsequent request.

  • RequestId (string) --

    The Amazon Web Services request ID for this operation.

  • Status (integer) --

    The HTTP status of the request.

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

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

type MemberName:

string

param MemberName:

[REQUIRED]

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

type GroupName:

string

param GroupName:

[REQUIRED]

The name of the group that you want to search.

type AwsAccountId:

string

param 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.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace that includes the group you are searching within.

rtype:

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.