:doc:`AmplifyUIBuilder <../../amplifyuibuilder>` / Client / refresh_token

*************
refresh_token
*************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/RefreshToken>`_  


  **Request Syntax**
  ::

    response = client.refresh_token(
        provider='figma',
        refreshTokenBody={
            'token': 'string',
            'clientId': 'string'
        }
    )
    
  :type provider: string
  :param provider: **[REQUIRED]** 

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

    

  
  :type refreshTokenBody: dict
  :param refreshTokenBody: **[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.

      

    
  
  
  :rtype: 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**
  
  *   :py:class:`AmplifyUIBuilder.Client.exceptions.InvalidParameterException`

  