:doc:`GameLift <../../gamelift>` / Client / get_compute_auth_token

**********************
get_compute_auth_token
**********************



.. py:method:: GameLift.Client.get_compute_auth_token(**kwargs)

  

  **This API works with the following fleet types:** EC2, Anywhere, Container

   

  Requests an authentication token from Amazon GameLift Servers for a compute resource in an Amazon GameLift Servers fleet. Game servers that are running on the compute use this token to communicate with the Amazon GameLift Servers service, such as when calling the Amazon GameLift Servers server SDK action ``InitSDK()``. Authentication tokens are valid for a limited time span, so you need to request a fresh token before the current token expires.

   

  **Request options**

   

  
  * For managed EC2 fleets (compute type ``EC2``), auth token retrieval and refresh is handled automatically. All game servers that are running on all fleet instances have access to a valid auth token.
   
  * For Anywhere fleets (compute type ``ANYWHERE``), if you're using the Amazon GameLift Servers Agent, auth token retrieval and refresh is handled automatically for any compute where the Agent is running. If you're not using the Agent, create a mechanism to retrieve and refresh auth tokens for computes that are running game server processes.
  

   

  **Learn more**

   

  
  * `Create an Anywhere fleet <https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-anywhere.html>`__
   
  * `Test your integration <https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing.html>`__
   
  * `Server SDK reference guides <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html>`__ (for version 5.x)
  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GetComputeAuthToken>`_  


  **Request Syntax**
  ::

    response = client.get_compute_auth_token(
        FleetId='string',
        ComputeName='string'
    )
    
  :type FleetId: string
  :param FleetId: **[REQUIRED]** 

    A unique identifier for the fleet that the compute is registered to.

    

  
  :type ComputeName: string
  :param ComputeName: **[REQUIRED]** 

    The name of the compute resource you are requesting the authentication token for. For an Anywhere fleet compute, use the registered compute name. For an EC2 fleet instance, use the instance ID.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'FleetId': 'string',
          'FleetArn': 'string',
          'ComputeName': 'string',
          'ComputeArn': 'string',
          'AuthToken': 'string',
          'ExpirationTimestamp': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **FleetId** *(string) --* 

        A unique identifier for the fleet that the compute is registered to.

        
      

      - **FleetArn** *(string) --* 

        The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`__) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is ``arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912``.

        
      

      - **ComputeName** *(string) --* 

        The name of the compute resource that the authentication token is issued to.

        
      

      - **ComputeArn** *(string) --* 

        The Amazon Resource Name ( `ARN <https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html>`__) that is assigned to an Amazon GameLift Servers compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is ``arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912``.

        
      

      - **AuthToken** *(string) --* 

        A valid temporary authentication token.

        
      

      - **ExpirationTimestamp** *(datetime) --* 

        The amount of time until the authentication token is no longer valid.

        
  
  **Exceptions**
  
  *   :py:class:`GameLift.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`GameLift.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`GameLift.Client.exceptions.NotFoundException`

  
  *   :py:class:`GameLift.Client.exceptions.InternalServiceException`

  
  *   :py:class:`GameLift.Client.exceptions.UnsupportedRegionException`

  