WorkMail / Client / get_personal_access_token_metadata

get_personal_access_token_metadata

WorkMail.Client.get_personal_access_token_metadata(**kwargs)

Requests details of a specific Personal Access Token within the WorkMail organization.

See also: AWS API Documentation

Request Syntax

response = client.get_personal_access_token_metadata(
    OrganizationId='string',
    PersonalAccessTokenId='string'
)
Parameters:

  • OrganizationId (string) –

    [REQUIRED]

    The Organization ID.

  • PersonalAccessTokenId (string) –

    [REQUIRED]

    The Personal Access Token ID.

Return type:

dict

Returns:

Response Syntax

{
    '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) –

    • PersonalAccessTokenId (string) –

      The Personal Access Token ID.

    • UserId (string) –

      The WorkMail User ID.

    • Name (string) –

      The Personal Access Token name.

    • DateCreated (datetime) –

      The date when the Personal Access Token ID was created.

    • DateLastUsed (datetime) –

      The date when the Personal Access Token ID was last used.

    • ExpiresTime (datetime) –

      The time when the Personal Access Token ID will expire.

    • Scopes (list) –

      Lists all the Personal Access Token permissions for a mailbox.

      • (string) –

Exceptions