AmplifyUIBuilder / Client / refresh_token

refresh_token#

AmplifyUIBuilder.Client.refresh_token(**kwargs)#

Note

This is for internal use.

Amplify uses this action to refresh a previously issued access token that might have expired.

See also: AWS API Documentation

Request Syntax

response = client.refresh_token(
    provider='figma',
    refreshTokenBody={
        'token': 'string',
        'clientId': 'string'
    }
)
Parameters:

  • provider (string) –

    [REQUIRED]

    The third-party provider for the token. The only valid value is figma.

  • refreshTokenBody (dict) –

    [REQUIRED]

    Information about the refresh token request.

    • token (string) – [REQUIRED]

      The token to use to refresh a previously issued access token that might have expired.

    • clientId (string) –

      The ID of the client to request the token from.

Return type:

dict

Returns:

Response Syntax

{
    'accessToken': 'string',
    'expiresIn': 123
}

Response Structure

  • (dict) –

    • accessToken (string) –

      The access token.

    • expiresIn (integer) –

      The date and time when the new access token expires.

Exceptions