CloudWatchOmni / Paginator / SearchPrincipals

SearchPrincipals

class CloudWatchOmni.Paginator.SearchPrincipals

paginator = client.get_paginator('search_principals')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchOmni.Client.search_principals().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainId='string',
    searchQuery='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• domainId (string) –

  [REQUIRED]

  The ID of the domain to search within.

• searchQuery (string) –

  [REQUIRED]

  A search term to match against user names, display names, and IDs. Pass * to list all principals. Maximum 128 characters.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'results': [
        {
            'principalId': 'string',
            'principalType': 'USER'|'GROUP',
            'displayName': 'string',
            'userName': 'string',
            'description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • results (list) –

    The list of matching principals.

    • (dict) –

      A user or group matched by SearchPrincipals.

      • principalId (string) –

        The unique ID of the principal.

      • principalType (string) –

        Whether the principal is a user or a group.

      • displayName (string) –

        The display name of the principal.

      • userName (string) –

        The user name of the principal. Present for users only.

      • description (string) –

        An optional description of the principal.

  • NextToken (string) –

    A token to resume pagination.