Athena / Client / batch_get_prepared_statement

batch_get_prepared_statement#

Athena.Client.batch_get_prepared_statement(**kwargs)#

Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed in UnprocessedPreparedStatementNames.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_prepared_statement(
    PreparedStatementNames=[
        'string',
    ],
    WorkGroup='string'
)

Parameters:

PreparedStatementNames (list) –
[REQUIRED]

A list of prepared statement names to return.
- (string) –
WorkGroup (string) –
[REQUIRED]

The name of the workgroup to which the prepared statements belong.

Return type:

dict

Returns:

Response Syntax

{
    'PreparedStatements': [
        {
            'StatementName': 'string',
            'QueryStatement': 'string',
            'WorkGroupName': 'string',
            'Description': 'string',
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'UnprocessedPreparedStatementNames': [
        {
            'StatementName': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) –
- PreparedStatements (list) –
  
  The list of prepared statements returned.
  - (dict) –
    
    A prepared SQL statement for use with Athena.
    - 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.
- UnprocessedPreparedStatementNames (list) –
  
  A list of one or more prepared statements that were requested but could not be returned.
  - (dict) –
    
    The name of a prepared statement that could not be returned.
    - StatementName (string) –
      
      The name of a prepared statement that could not be returned due to an error.
    - ErrorCode (string) –
      
      The error code returned when the request for the prepared statement failed.
    - ErrorMessage (string) –
      
      The error message containing the reason why the prepared statement could not be returned. The following error messages are possible:
      - INVALID_INPUT - The name of the prepared statement that was provided is not valid (for example, the name is too long).
      - STATEMENT_NOT_FOUND - A prepared statement with the name provided could not be found.
      - UNAUTHORIZED - The requester does not have permission to access the workgroup that contains the prepared statement.

Exceptions

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