CodeCatalyst / Client / list_access_tokens

list_access_tokens#

CodeCatalyst.Client.list_access_tokens(**kwargs)#

Lists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your user account.

See also: AWS API Documentation

Request Syntax

response = client.list_access_tokens(
    maxResults=123,
    nextToken='string'
)
Parameters:
  • maxResults (integer) – The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

  • nextToken (string) – A token returned from a call to this API to indicate the next batch of results to return, if any.

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.

      • (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 returned from a call to this API to indicate the next batch of results to return, if any.

Exceptions

  • CodeCatalyst.Client.exceptions.ThrottlingException

  • CodeCatalyst.Client.exceptions.ConflictException

  • CodeCatalyst.Client.exceptions.ValidationException

  • CodeCatalyst.Client.exceptions.ServiceQuotaExceededException

  • CodeCatalyst.Client.exceptions.ResourceNotFoundException

  • CodeCatalyst.Client.exceptions.AccessDeniedException