AmplifyBackend / Client / get_token

get_token#

AmplifyBackend.Client.get_token(**kwargs)#

Gets the challenge token based on the given appId and sessionId.

See also: AWS API Documentation

Request Syntax

response = client.get_token(
    AppId='string',
    SessionId='string'
)
Parameters:

  • AppId (string) –

    [REQUIRED]

    The app ID.

  • SessionId (string) –

    [REQUIRED]

    The session ID.

Return type:

dict

Returns:

Response Syntax

{
    'AppId': 'string',
    'ChallengeCode': 'string',
    'SessionId': 'string',
    'Ttl': 'string'
}

Response Structure

  • (dict) –

    200 response

    • AppId (string) –

      The app ID.

    • ChallengeCode (string) –

      The one-time challenge code for authenticating into the Amplify Admin UI.

    • SessionId (string) –

      A unique ID provided when creating a new challenge token.

    • Ttl (string) –

      The expiry time for the one-time generated token code.

Exceptions