list_permission_groups_by_user

FinSpaceData.Client.list_permission_groups_by_user(**kwargs)

Lists all the permission groups that are associated with a specific user account.

See also: AWS API Documentation

Request Syntax

response = client.list_permission_groups_by_user(
    userId='string',
    nextToken='string',
    maxResults=123
)

Parameters

• userId (string) --

  [REQUIRED]

  The unique identifier for the user.

• nextToken (string) -- A token that indicates where a results page should begin.
• maxResults (integer) --

  [REQUIRED]

  The maximum number of results per page.

Return type

dict

Returns

Response Syntax

{
    'permissionGroups': [
        {
            'permissionGroupId': 'string',
            'name': 'string',
            'membershipStatus': 'ADDITION_IN_PROGRESS'|'ADDITION_SUCCESS'|'REMOVAL_IN_PROGRESS'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • permissionGroups (list) --

    A list of returned permission groups.

    • (dict) --

      The structure of a permission group associated with a user account.

      • permissionGroupId (string) --

        The unique identifier for the permission group.

      • name (string) --

        The name of the permission group.

      • membershipStatus (string) --

        Indicates the status of the user account within a permission group.

        • ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
        • ADDITION_SUCCESS – The user account is successfully added to the permission group.
        • REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

  • nextToken (string) --

    A token that indicates where a results page should begin.

Exceptions

• FinSpaceData.Client.exceptions.InternalServerException
• FinSpaceData.Client.exceptions.ValidationException
• FinSpaceData.Client.exceptions.ThrottlingException
• FinSpaceData.Client.exceptions.AccessDeniedException
• FinSpaceData.Client.exceptions.ResourceNotFoundException