Athena / Client / get_prepared_statement

get_prepared_statement¶

Athena.Client.get_prepared_statement(**kwargs)¶

Retrieves the prepared statement with the specified name from the specified workgroup.

Request Syntax

response = client.get_prepared_statement(
    StatementName='string',
    WorkGroup='string'
)

Parameters:

StatementName (string) –
[REQUIRED]

The name of the prepared statement to retrieve.
WorkGroup (string) –
[REQUIRED]

The workgroup to which the statement to be retrieved belongs.

Return type:

dict

Returns:

Response Syntax

{
    'PreparedStatement': {
        'StatementName': 'string',
        'QueryStatement': 'string',
        'WorkGroupName': 'string',
        'Description': 'string',
        'LastModifiedTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –
- PreparedStatement (dict) –
  
  The name of the prepared statement that was retrieved.
  - StatementName (string) –
    
    The name of the prepared statement.
  - QueryStatement (string) –
    
    The query string for the prepared statement.
  - WorkGroupName (string) –
    
    The name of the workgroup to which the prepared statement belongs.
  - Description (string) –
    
    The description of the prepared statement.
  - LastModifiedTime (datetime) –
    
    The last modified time of the prepared statement.

Exceptions

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