Skip to content

AthenaClient

Index > Athena > AthenaClient

Auto-generated documentation for Athena type annotations stubs module mypy-boto3-athena.

AthenaClient

Type annotations and code completion for boto3.client("athena"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_athena.client import AthenaClient

def get_athena_client() -> AthenaClient:
    return Session().client("athena")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("athena").exceptions structure.

Usage example
client = boto3.client("athena")

try:
    do_something(client)
except (
    client.ClientError,
    client.InternalServerException,
    client.InvalidRequestException,
    client.MetadataException,
    client.ResourceNotFoundException,
    client.SessionAlreadyExistsException,
    client.TooManyRequestsException,
) as e:
    print(e)
Type checking example
from mypy_boto3_athena.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

batch_get_named_query

Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings.

Type annotations and code completion for boto3.client("athena").batch_get_named_query method. boto3 documentation

Method definition
def batch_get_named_query(
    self,
    *,
    NamedQueryIds: Sequence[str],
) -> BatchGetNamedQueryOutputTypeDef:  # (1)
    ...
  1. See BatchGetNamedQueryOutputTypeDef
Usage example with kwargs
kwargs: BatchGetNamedQueryInputRequestTypeDef = {  # (1)
    "NamedQueryIds": ...,
}

parent.batch_get_named_query(**kwargs)
  1. See BatchGetNamedQueryInputRequestTypeDef

batch_get_prepared_statement

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.

Type annotations and code completion for boto3.client("athena").batch_get_prepared_statement method. boto3 documentation

Method definition
def batch_get_prepared_statement(
    self,
    *,
    PreparedStatementNames: Sequence[str],
    WorkGroup: str,
) -> BatchGetPreparedStatementOutputTypeDef:  # (1)
    ...
  1. See BatchGetPreparedStatementOutputTypeDef
Usage example with kwargs
kwargs: BatchGetPreparedStatementInputRequestTypeDef = {  # (1)
    "PreparedStatementNames": ...,
    "WorkGroup": ...,
}

parent.batch_get_prepared_statement(**kwargs)
  1. See BatchGetPreparedStatementInputRequestTypeDef

batch_get_query_execution

Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings.

Type annotations and code completion for boto3.client("athena").batch_get_query_execution method. boto3 documentation

Method definition
def batch_get_query_execution(
    self,
    *,
    QueryExecutionIds: Sequence[str],
) -> BatchGetQueryExecutionOutputTypeDef:  # (1)
    ...
  1. See BatchGetQueryExecutionOutputTypeDef
Usage example with kwargs
kwargs: BatchGetQueryExecutionInputRequestTypeDef = {  # (1)
    "QueryExecutionIds": ...,
}

parent.batch_get_query_execution(**kwargs)
  1. See BatchGetQueryExecutionInputRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("athena").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("athena").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_data_catalog

Creates (registers) a data catalog with the specified name and properties.

Type annotations and code completion for boto3.client("athena").create_data_catalog method. boto3 documentation

Method definition
def create_data_catalog(
    self,
    *,
    Name: str,
    Type: DataCatalogTypeType,  # (1)
    Description: str = ...,
    Parameters: Mapping[str, str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See DataCatalogTypeType
  2. See TagTypeDef
Usage example with kwargs
kwargs: CreateDataCatalogInputRequestTypeDef = {  # (1)
    "Name": ...,
    "Type": ...,
}

parent.create_data_catalog(**kwargs)
  1. See CreateDataCatalogInputRequestTypeDef

create_named_query

Creates a named query in the specified workgroup.

Type annotations and code completion for boto3.client("athena").create_named_query method. boto3 documentation

Method definition
def create_named_query(
    self,
    *,
    Name: str,
    Database: str,
    QueryString: str,
    Description: str = ...,
    ClientRequestToken: str = ...,
    WorkGroup: str = ...,
) -> CreateNamedQueryOutputTypeDef:  # (1)
    ...
  1. See CreateNamedQueryOutputTypeDef
Usage example with kwargs
kwargs: CreateNamedQueryInputRequestTypeDef = {  # (1)
    "Name": ...,
    "Database": ...,
    "QueryString": ...,
}

parent.create_named_query(**kwargs)
  1. See CreateNamedQueryInputRequestTypeDef

create_notebook

Creates an empty ipynb file in the specified Apache Spark enabled workgroup.

Type annotations and code completion for boto3.client("athena").create_notebook method. boto3 documentation

Method definition
def create_notebook(
    self,
    *,
    WorkGroup: str,
    Name: str,
    ClientRequestToken: str = ...,
) -> CreateNotebookOutputTypeDef:  # (1)
    ...
  1. See CreateNotebookOutputTypeDef
Usage example with kwargs
kwargs: CreateNotebookInputRequestTypeDef = {  # (1)
    "WorkGroup": ...,
    "Name": ...,
}

parent.create_notebook(**kwargs)
  1. See CreateNotebookInputRequestTypeDef

create_prepared_statement

Creates a prepared statement for use with SQL queries in Athena.

Type annotations and code completion for boto3.client("athena").create_prepared_statement method. boto3 documentation

Method definition
def create_prepared_statement(
    self,
    *,
    StatementName: str,
    WorkGroup: str,
    QueryStatement: str,
    Description: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CreatePreparedStatementInputRequestTypeDef = {  # (1)
    "StatementName": ...,
    "WorkGroup": ...,
    "QueryStatement": ...,
}

parent.create_prepared_statement(**kwargs)
  1. See CreatePreparedStatementInputRequestTypeDef

create_presigned_notebook_url

Gets an authentication token and the URL at which the notebook can be accessed.

Type annotations and code completion for boto3.client("athena").create_presigned_notebook_url method. boto3 documentation

Method definition
def create_presigned_notebook_url(
    self,
    *,
    SessionId: str,
) -> CreatePresignedNotebookUrlResponseTypeDef:  # (1)
    ...
  1. See CreatePresignedNotebookUrlResponseTypeDef
Usage example with kwargs
kwargs: CreatePresignedNotebookUrlRequestRequestTypeDef = {  # (1)
    "SessionId": ...,
}

parent.create_presigned_notebook_url(**kwargs)
  1. See CreatePresignedNotebookUrlRequestRequestTypeDef

create_work_group

Creates a workgroup with the specified name.

Type annotations and code completion for boto3.client("athena").create_work_group method. boto3 documentation

Method definition
def create_work_group(
    self,
    *,
    Name: str,
    Configuration: WorkGroupConfigurationTypeDef = ...,  # (1)
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See WorkGroupConfigurationTypeDef
  2. See TagTypeDef
Usage example with kwargs
kwargs: CreateWorkGroupInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_work_group(**kwargs)
  1. See CreateWorkGroupInputRequestTypeDef

delete_data_catalog

Deletes a data catalog.

Type annotations and code completion for boto3.client("athena").delete_data_catalog method. boto3 documentation

Method definition
def delete_data_catalog(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteDataCatalogInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_data_catalog(**kwargs)
  1. See DeleteDataCatalogInputRequestTypeDef

delete_named_query

Deletes the named query if you have access to the workgroup in which the query was saved.

Type annotations and code completion for boto3.client("athena").delete_named_query method. boto3 documentation

Method definition
def delete_named_query(
    self,
    *,
    NamedQueryId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteNamedQueryInputRequestTypeDef = {  # (1)
    "NamedQueryId": ...,
}

parent.delete_named_query(**kwargs)
  1. See DeleteNamedQueryInputRequestTypeDef

delete_notebook

Deletes the specified notebook.

Type annotations and code completion for boto3.client("athena").delete_notebook method. boto3 documentation

Method definition
def delete_notebook(
    self,
    *,
    NotebookId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteNotebookInputRequestTypeDef = {  # (1)
    "NotebookId": ...,
}

parent.delete_notebook(**kwargs)
  1. See DeleteNotebookInputRequestTypeDef

delete_prepared_statement

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

Type annotations and code completion for boto3.client("athena").delete_prepared_statement method. boto3 documentation

Method definition
def delete_prepared_statement(
    self,
    *,
    StatementName: str,
    WorkGroup: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeletePreparedStatementInputRequestTypeDef = {  # (1)
    "StatementName": ...,
    "WorkGroup": ...,
}

parent.delete_prepared_statement(**kwargs)
  1. See DeletePreparedStatementInputRequestTypeDef

delete_work_group

Deletes the workgroup with the specified name.

Type annotations and code completion for boto3.client("athena").delete_work_group method. boto3 documentation

Method definition
def delete_work_group(
    self,
    *,
    WorkGroup: str,
    RecursiveDeleteOption: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteWorkGroupInputRequestTypeDef = {  # (1)
    "WorkGroup": ...,
}

parent.delete_work_group(**kwargs)
  1. See DeleteWorkGroupInputRequestTypeDef

export_notebook

Exports the specified notebook and its metadata.

Type annotations and code completion for boto3.client("athena").export_notebook method. boto3 documentation

Method definition
def export_notebook(
    self,
    *,
    NotebookId: str,
) -> ExportNotebookOutputTypeDef:  # (1)
    ...
  1. See ExportNotebookOutputTypeDef
Usage example with kwargs
kwargs: ExportNotebookInputRequestTypeDef = {  # (1)
    "NotebookId": ...,
}

parent.export_notebook(**kwargs)
  1. See ExportNotebookInputRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("athena").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_calculation_execution

Describes a previously submitted calculation execution.

Type annotations and code completion for boto3.client("athena").get_calculation_execution method. boto3 documentation

Method definition
def get_calculation_execution(
    self,
    *,
    CalculationExecutionId: str,
) -> GetCalculationExecutionResponseTypeDef:  # (1)
    ...
  1. See GetCalculationExecutionResponseTypeDef
Usage example with kwargs
kwargs: GetCalculationExecutionRequestRequestTypeDef = {  # (1)
    "CalculationExecutionId": ...,
}

parent.get_calculation_execution(**kwargs)
  1. See GetCalculationExecutionRequestRequestTypeDef

get_calculation_execution_code

Retrieves a pre-signed URL to a copy of the code that was executed for the calculation.

Type annotations and code completion for boto3.client("athena").get_calculation_execution_code method. boto3 documentation

Method definition
def get_calculation_execution_code(
    self,
    *,
    CalculationExecutionId: str,
) -> GetCalculationExecutionCodeResponseTypeDef:  # (1)
    ...
  1. See GetCalculationExecutionCodeResponseTypeDef
Usage example with kwargs
kwargs: GetCalculationExecutionCodeRequestRequestTypeDef = {  # (1)
    "CalculationExecutionId": ...,
}

parent.get_calculation_execution_code(**kwargs)
  1. See GetCalculationExecutionCodeRequestRequestTypeDef

get_calculation_execution_status

Gets the status of a current calculation.

Type annotations and code completion for boto3.client("athena").get_calculation_execution_status method. boto3 documentation

Method definition
def get_calculation_execution_status(
    self,
    *,
    CalculationExecutionId: str,
) -> GetCalculationExecutionStatusResponseTypeDef:  # (1)
    ...
  1. See GetCalculationExecutionStatusResponseTypeDef
Usage example with kwargs
kwargs: GetCalculationExecutionStatusRequestRequestTypeDef = {  # (1)
    "CalculationExecutionId": ...,
}

parent.get_calculation_execution_status(**kwargs)
  1. See GetCalculationExecutionStatusRequestRequestTypeDef

get_data_catalog

Returns the specified data catalog.

Type annotations and code completion for boto3.client("athena").get_data_catalog method. boto3 documentation

Method definition
def get_data_catalog(
    self,
    *,
    Name: str,
) -> GetDataCatalogOutputTypeDef:  # (1)
    ...
  1. See GetDataCatalogOutputTypeDef
Usage example with kwargs
kwargs: GetDataCatalogInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_data_catalog(**kwargs)
  1. See GetDataCatalogInputRequestTypeDef

get_database

Returns a database object for the specified database and data catalog.

Type annotations and code completion for boto3.client("athena").get_database method. boto3 documentation

Method definition
def get_database(
    self,
    *,
    CatalogName: str,
    DatabaseName: str,
) -> GetDatabaseOutputTypeDef:  # (1)
    ...
  1. See GetDatabaseOutputTypeDef
Usage example with kwargs
kwargs: GetDatabaseInputRequestTypeDef = {  # (1)
    "CatalogName": ...,
    "DatabaseName": ...,
}

parent.get_database(**kwargs)
  1. See GetDatabaseInputRequestTypeDef

get_named_query

Returns information about a single query.

Type annotations and code completion for boto3.client("athena").get_named_query method. boto3 documentation

Method definition
def get_named_query(
    self,
    *,
    NamedQueryId: str,
) -> GetNamedQueryOutputTypeDef:  # (1)
    ...
  1. See GetNamedQueryOutputTypeDef
Usage example with kwargs
kwargs: GetNamedQueryInputRequestTypeDef = {  # (1)
    "NamedQueryId": ...,
}

parent.get_named_query(**kwargs)
  1. See GetNamedQueryInputRequestTypeDef

get_notebook_metadata

Retrieves notebook metadata for the specified notebook ID.

Type annotations and code completion for boto3.client("athena").get_notebook_metadata method. boto3 documentation

Method definition
def get_notebook_metadata(
    self,
    *,
    NotebookId: str,
) -> GetNotebookMetadataOutputTypeDef:  # (1)
    ...
  1. See GetNotebookMetadataOutputTypeDef
Usage example with kwargs
kwargs: GetNotebookMetadataInputRequestTypeDef = {  # (1)
    "NotebookId": ...,
}

parent.get_notebook_metadata(**kwargs)
  1. See GetNotebookMetadataInputRequestTypeDef

get_prepared_statement

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

Type annotations and code completion for boto3.client("athena").get_prepared_statement method. boto3 documentation

Method definition
def get_prepared_statement(
    self,
    *,
    StatementName: str,
    WorkGroup: str,
) -> GetPreparedStatementOutputTypeDef:  # (1)
    ...
  1. See GetPreparedStatementOutputTypeDef
Usage example with kwargs
kwargs: GetPreparedStatementInputRequestTypeDef = {  # (1)
    "StatementName": ...,
    "WorkGroup": ...,
}

parent.get_prepared_statement(**kwargs)
  1. See GetPreparedStatementInputRequestTypeDef

get_query_execution

Returns information about a single execution of a query if you have access to the workgroup in which the query ran.

Type annotations and code completion for boto3.client("athena").get_query_execution method. boto3 documentation

Method definition
def get_query_execution(
    self,
    *,
    QueryExecutionId: str,
) -> GetQueryExecutionOutputTypeDef:  # (1)
    ...
  1. See GetQueryExecutionOutputTypeDef
Usage example with kwargs
kwargs: GetQueryExecutionInputRequestTypeDef = {  # (1)
    "QueryExecutionId": ...,
}

parent.get_query_execution(**kwargs)
  1. See GetQueryExecutionInputRequestTypeDef

get_query_results

Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3.

Type annotations and code completion for boto3.client("athena").get_query_results method. boto3 documentation

Method definition
def get_query_results(
    self,
    *,
    QueryExecutionId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetQueryResultsOutputTypeDef:  # (1)
    ...
  1. See GetQueryResultsOutputTypeDef
Usage example with kwargs
kwargs: GetQueryResultsInputRequestTypeDef = {  # (1)
    "QueryExecutionId": ...,
}

parent.get_query_results(**kwargs)
  1. See GetQueryResultsInputRequestTypeDef

get_query_runtime_statistics

Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran.

Type annotations and code completion for boto3.client("athena").get_query_runtime_statistics method. boto3 documentation

Method definition
def get_query_runtime_statistics(
    self,
    *,
    QueryExecutionId: str,
) -> GetQueryRuntimeStatisticsOutputTypeDef:  # (1)
    ...
  1. See GetQueryRuntimeStatisticsOutputTypeDef
Usage example with kwargs
kwargs: GetQueryRuntimeStatisticsInputRequestTypeDef = {  # (1)
    "QueryExecutionId": ...,
}

parent.get_query_runtime_statistics(**kwargs)
  1. See GetQueryRuntimeStatisticsInputRequestTypeDef

get_session

Gets the full details of a previously created session, including the session status and configuration.

Type annotations and code completion for boto3.client("athena").get_session method. boto3 documentation

Method definition
def get_session(
    self,
    *,
    SessionId: str,
) -> GetSessionResponseTypeDef:  # (1)
    ...
  1. See GetSessionResponseTypeDef
Usage example with kwargs
kwargs: GetSessionRequestRequestTypeDef = {  # (1)
    "SessionId": ...,
}

parent.get_session(**kwargs)
  1. See GetSessionRequestRequestTypeDef

get_session_status

Gets the current status of a session.

Type annotations and code completion for boto3.client("athena").get_session_status method. boto3 documentation

Method definition
def get_session_status(
    self,
    *,
    SessionId: str,
) -> GetSessionStatusResponseTypeDef:  # (1)
    ...
  1. See GetSessionStatusResponseTypeDef
Usage example with kwargs
kwargs: GetSessionStatusRequestRequestTypeDef = {  # (1)
    "SessionId": ...,
}

parent.get_session_status(**kwargs)
  1. See GetSessionStatusRequestRequestTypeDef

get_table_metadata

Returns table metadata for the specified catalog, database, and table.

Type annotations and code completion for boto3.client("athena").get_table_metadata method. boto3 documentation

Method definition
def get_table_metadata(
    self,
    *,
    CatalogName: str,
    DatabaseName: str,
    TableName: str,
) -> GetTableMetadataOutputTypeDef:  # (1)
    ...
  1. See GetTableMetadataOutputTypeDef
Usage example with kwargs
kwargs: GetTableMetadataInputRequestTypeDef = {  # (1)
    "CatalogName": ...,
    "DatabaseName": ...,
    "TableName": ...,
}

parent.get_table_metadata(**kwargs)
  1. See GetTableMetadataInputRequestTypeDef

get_work_group

Returns information about the workgroup with the specified name.

Type annotations and code completion for boto3.client("athena").get_work_group method. boto3 documentation

Method definition
def get_work_group(
    self,
    *,
    WorkGroup: str,
) -> GetWorkGroupOutputTypeDef:  # (1)
    ...
  1. See GetWorkGroupOutputTypeDef
Usage example with kwargs
kwargs: GetWorkGroupInputRequestTypeDef = {  # (1)
    "WorkGroup": ...,
}

parent.get_work_group(**kwargs)
  1. See GetWorkGroupInputRequestTypeDef

import_notebook

Imports a single ipynb file to a Spark enabled workgroup.

Type annotations and code completion for boto3.client("athena").import_notebook method. boto3 documentation

Method definition
def import_notebook(
    self,
    *,
    WorkGroup: str,
    Name: str,
    Payload: str,
    Type: NotebookTypeType,  # (1)
    ClientRequestToken: str = ...,
) -> ImportNotebookOutputTypeDef:  # (2)
    ...
  1. See NotebookTypeType
  2. See ImportNotebookOutputTypeDef
Usage example with kwargs
kwargs: ImportNotebookInputRequestTypeDef = {  # (1)
    "WorkGroup": ...,
    "Name": ...,
    "Payload": ...,
    "Type": ...,
}

parent.import_notebook(**kwargs)
  1. See ImportNotebookInputRequestTypeDef

list_application_dpu_sizes

Returns the supported DPU sizes for the supported application runtimes (for example, Jupyter 1.0 ).

Type annotations and code completion for boto3.client("athena").list_application_dpu_sizes method. boto3 documentation

Method definition
def list_application_dpu_sizes(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListApplicationDPUSizesOutputTypeDef:  # (1)
    ...
  1. See ListApplicationDPUSizesOutputTypeDef
Usage example with kwargs
kwargs: ListApplicationDPUSizesInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_application_dpu_sizes(**kwargs)
  1. See ListApplicationDPUSizesInputRequestTypeDef

list_calculation_executions

Lists the calculations that have been submitted to a session in descending order.

Type annotations and code completion for boto3.client("athena").list_calculation_executions method. boto3 documentation

Method definition
def list_calculation_executions(
    self,
    *,
    SessionId: str,
    StateFilter: CalculationExecutionStateType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCalculationExecutionsResponseTypeDef:  # (2)
    ...
  1. See CalculationExecutionStateType
  2. See ListCalculationExecutionsResponseTypeDef
Usage example with kwargs
kwargs: ListCalculationExecutionsRequestRequestTypeDef = {  # (1)
    "SessionId": ...,
}

parent.list_calculation_executions(**kwargs)
  1. See ListCalculationExecutionsRequestRequestTypeDef

list_data_catalogs

Lists the data catalogs in the current Amazon Web Services account.

Type annotations and code completion for boto3.client("athena").list_data_catalogs method. boto3 documentation

Method definition
def list_data_catalogs(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDataCatalogsOutputTypeDef:  # (1)
    ...
  1. See ListDataCatalogsOutputTypeDef
Usage example with kwargs
kwargs: ListDataCatalogsInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_data_catalogs(**kwargs)
  1. See ListDataCatalogsInputRequestTypeDef

list_databases

Lists the databases in the specified data catalog.

Type annotations and code completion for boto3.client("athena").list_databases method. boto3 documentation

Method definition
def list_databases(
    self,
    *,
    CatalogName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDatabasesOutputTypeDef:  # (1)
    ...
  1. See ListDatabasesOutputTypeDef
Usage example with kwargs
kwargs: ListDatabasesInputRequestTypeDef = {  # (1)
    "CatalogName": ...,
}

parent.list_databases(**kwargs)
  1. See ListDatabasesInputRequestTypeDef

list_engine_versions

Returns a list of engine versions that are available to choose from, including the Auto option.

Type annotations and code completion for boto3.client("athena").list_engine_versions method. boto3 documentation

Method definition
def list_engine_versions(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEngineVersionsOutputTypeDef:  # (1)
    ...
  1. See ListEngineVersionsOutputTypeDef
Usage example with kwargs
kwargs: ListEngineVersionsInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_engine_versions(**kwargs)
  1. See ListEngineVersionsInputRequestTypeDef

list_executors

Lists, in descending order, the executors that have been submitted to a session.

Type annotations and code completion for boto3.client("athena").list_executors method. boto3 documentation

Method definition
def list_executors(
    self,
    *,
    SessionId: str,
    ExecutorStateFilter: ExecutorStateType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListExecutorsResponseTypeDef:  # (2)
    ...
  1. See ExecutorStateType
  2. See ListExecutorsResponseTypeDef
Usage example with kwargs
kwargs: ListExecutorsRequestRequestTypeDef = {  # (1)
    "SessionId": ...,
}

parent.list_executors(**kwargs)
  1. See ListExecutorsRequestRequestTypeDef

list_named_queries

Provides a list of available query IDs only for queries saved in the specified workgroup.

Type annotations and code completion for boto3.client("athena").list_named_queries method. boto3 documentation

Method definition
def list_named_queries(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    WorkGroup: str = ...,
) -> ListNamedQueriesOutputTypeDef:  # (1)
    ...
  1. See ListNamedQueriesOutputTypeDef
Usage example with kwargs
kwargs: ListNamedQueriesInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_named_queries(**kwargs)
  1. See ListNamedQueriesInputRequestTypeDef

list_notebook_metadata

Displays the notebook files for the specified workgroup in paginated format.

Type annotations and code completion for boto3.client("athena").list_notebook_metadata method. boto3 documentation

Method definition
def list_notebook_metadata(
    self,
    *,
    WorkGroup: str,
    Filters: FilterDefinitionTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListNotebookMetadataOutputTypeDef:  # (2)
    ...
  1. See FilterDefinitionTypeDef
  2. See ListNotebookMetadataOutputTypeDef
Usage example with kwargs
kwargs: ListNotebookMetadataInputRequestTypeDef = {  # (1)
    "WorkGroup": ...,
}

parent.list_notebook_metadata(**kwargs)
  1. See ListNotebookMetadataInputRequestTypeDef

list_notebook_sessions

Lists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING , CREATED , IDLE or BUSY.

Type annotations and code completion for boto3.client("athena").list_notebook_sessions method. boto3 documentation

Method definition
def list_notebook_sessions(
    self,
    *,
    NotebookId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListNotebookSessionsResponseTypeDef:  # (1)
    ...
  1. See ListNotebookSessionsResponseTypeDef
Usage example with kwargs
kwargs: ListNotebookSessionsRequestRequestTypeDef = {  # (1)
    "NotebookId": ...,
}

parent.list_notebook_sessions(**kwargs)
  1. See ListNotebookSessionsRequestRequestTypeDef

list_prepared_statements

Lists the prepared statements in the specified workgroup.

Type annotations and code completion for boto3.client("athena").list_prepared_statements method. boto3 documentation

Method definition
def list_prepared_statements(
    self,
    *,
    WorkGroup: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPreparedStatementsOutputTypeDef:  # (1)
    ...
  1. See ListPreparedStatementsOutputTypeDef
Usage example with kwargs
kwargs: ListPreparedStatementsInputRequestTypeDef = {  # (1)
    "WorkGroup": ...,
}

parent.list_prepared_statements(**kwargs)
  1. See ListPreparedStatementsInputRequestTypeDef

list_query_executions

Provides a list of available query execution IDs for the queries in the specified workgroup.

Type annotations and code completion for boto3.client("athena").list_query_executions method. boto3 documentation

Method definition
def list_query_executions(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    WorkGroup: str = ...,
) -> ListQueryExecutionsOutputTypeDef:  # (1)
    ...
  1. See ListQueryExecutionsOutputTypeDef
Usage example with kwargs
kwargs: ListQueryExecutionsInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_query_executions(**kwargs)
  1. See ListQueryExecutionsInputRequestTypeDef

list_sessions

Lists the sessions in a workgroup that are in an active state like CREATING , CREATED , IDLE , or BUSY.

Type annotations and code completion for boto3.client("athena").list_sessions method. boto3 documentation

Method definition
def list_sessions(
    self,
    *,
    WorkGroup: str,
    StateFilter: SessionStateType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSessionsResponseTypeDef:  # (2)
    ...
  1. See SessionStateType
  2. See ListSessionsResponseTypeDef
Usage example with kwargs
kwargs: ListSessionsRequestRequestTypeDef = {  # (1)
    "WorkGroup": ...,
}

parent.list_sessions(**kwargs)
  1. See ListSessionsRequestRequestTypeDef

list_table_metadata

Lists the metadata for the tables in the specified data catalog database.

Type annotations and code completion for boto3.client("athena").list_table_metadata method. boto3 documentation

Method definition
def list_table_metadata(
    self,
    *,
    CatalogName: str,
    DatabaseName: str,
    Expression: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTableMetadataOutputTypeDef:  # (1)
    ...
  1. See ListTableMetadataOutputTypeDef
Usage example with kwargs
kwargs: ListTableMetadataInputRequestTypeDef = {  # (1)
    "CatalogName": ...,
    "DatabaseName": ...,
}

parent.list_table_metadata(**kwargs)
  1. See ListTableMetadataInputRequestTypeDef

list_tags_for_resource

Lists the tags associated with an Athena workgroup or data catalog resource.

Type annotations and code completion for boto3.client("athena").list_tags_for_resource method. boto3 documentation

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceInputRequestTypeDef

list_work_groups

Lists available workgroups for the account.

Type annotations and code completion for boto3.client("athena").list_w