CodeCatalyst / Paginator / ListAccessTokens

ListAccessTokens#

class CodeCatalyst.Paginator.ListAccessTokens#
paginator = client.get_paginator('list_access_tokens')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from CodeCatalyst.Client.list_access_tokens().

See also: AWS API Documentation

Request Syntax

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

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

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'expiresTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      A list of personal access tokens (PATs) associated with the calling user identity.

      • (dict) –

        Information about a specified personal access token (PAT).

        • id (string) –

          The system-generated ID of the personal access token.

        • name (string) –

          The friendly name of the personal access token.

        • expiresTime (datetime) –

          The date and time when the personal access token will expire, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • NextToken (string) –

      A token to resume pagination.