Athena / Client / get_session_endpoint

get_session_endpoint¶

Athena.Client.get_session_endpoint(**kwargs)¶

Gets a connection endpoint and authentication token for a given session Id.

See also: AWS API Documentation

Request Syntax

response = client.get_session_endpoint(
    SessionId='string'
)

Parameters:

SessionId (string) –

[REQUIRED]

The session ID.

Return type:

dict

Returns:

Response Syntax

{
    'EndpointUrl': 'string',
    'AuthToken': 'string',
    'AuthTokenExpirationTime': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- EndpointUrl (string) –
  
  The endpoint for connecting to the session.
- AuthToken (string) –
  
  Authentication token for the connection
- AuthTokenExpirationTime (datetime) –
  
  Expiration time of the auth token.

Exceptions

Athena.Client.exceptions.InternalServerException
Athena.Client.exceptions.InvalidRequestException
Athena.Client.exceptions.ResourceNotFoundException