WorkMail / Paginator / ListPersonalAccessTokens

ListPersonalAccessTokens

class WorkMail.Paginator.ListPersonalAccessTokens

paginator = client.get_paginator('list_personal_access_tokens')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkMail.Client.list_personal_access_tokens().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• OrganizationId (string) –

  [REQUIRED]

  The Organization ID.

• UserId (string) – The WorkMail User ID.

• 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

{
    'PersonalAccessTokenSummaries': [
        {
            'PersonalAccessTokenId': 'string',
            'UserId': 'string',
            'Name': 'string',
            'DateCreated': datetime(2015, 1, 1),
            'DateLastUsed': datetime(2015, 1, 1),
            'ExpiresTime': datetime(2015, 1, 1),
            'Scopes': [
                'string',
            ]
        },
    ]
}

Response Structure

• (dict) –

  • PersonalAccessTokenSummaries (list) –

    Lists all the personal tokens in an organization or user, if user ID is provided.

    • (dict) –

      The summary of the Personal Access Token.

      • PersonalAccessTokenId (string) –

        The ID of the Personal Access Token.

      • UserId (string) –

        The user ID of the WorkMail user associated with the Personal Access Token.

      • Name (string) –

        The name of the Personal Access Token.

      • DateCreated (datetime) –

        The date when the Personal Access Token was created.

      • DateLastUsed (datetime) –

        The date when the Personal Access Token was last used.

      • ExpiresTime (datetime) –

        The date when the Personal Access Token will expire.

      • Scopes (list) –

        Lists all the Personal Access Token permissions for a mailbox.

        • (string) –