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
# AthenaClient 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.
# Exceptions.exceptions usage example
client = boto3.client("athena")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.InternalServerException,
client.exceptions.InvalidRequestException,
client.exceptions.MetadataException,
client.exceptions.ResourceNotFoundException,
client.exceptions.SessionAlreadyExistsException,
client.exceptions.TooManyRequestsException,
) as e:
print(e)
# Exceptions.exceptions 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
# batch_get_named_query method definition
def batch_get_named_query(
self,
*,
NamedQueryIds: Sequence[str],
) -> BatchGetNamedQueryOutputTypeDef: # (1)
...
# batch_get_named_query method usage example with argument unpacking
kwargs: BatchGetNamedQueryInputRequestTypeDef = { # (1)
"NamedQueryIds": ...,
}
parent.batch_get_named_query(**kwargs)
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
# batch_get_prepared_statement method definition
def batch_get_prepared_statement(
self,
*,
PreparedStatementNames: Sequence[str],
WorkGroup: str,
) -> BatchGetPreparedStatementOutputTypeDef: # (1)
...
# batch_get_prepared_statement method usage example with argument unpacking
kwargs: BatchGetPreparedStatementInputRequestTypeDef = { # (1)
"PreparedStatementNames": ...,
"WorkGroup": ...,
}
parent.batch_get_prepared_statement(**kwargs)
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
# batch_get_query_execution method definition
def batch_get_query_execution(
self,
*,
QueryExecutionIds: Sequence[str],
) -> BatchGetQueryExecutionOutputTypeDef: # (1)
...
# batch_get_query_execution method usage example with argument unpacking
kwargs: BatchGetQueryExecutionInputRequestTypeDef = { # (1)
"QueryExecutionIds": ...,
}
parent.batch_get_query_execution(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("athena").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
cancel_capacity_reservation#
Cancels the capacity reservation with the specified name.
Type annotations and code completion for boto3.client("athena").cancel_capacity_reservation
method.
boto3 documentation
# cancel_capacity_reservation method definition
def cancel_capacity_reservation(
self,
*,
Name: str,
) -> Dict[str, Any]:
...
# cancel_capacity_reservation method usage example with argument unpacking
kwargs: CancelCapacityReservationInputRequestTypeDef = { # (1)
"Name": ...,
}
parent.cancel_capacity_reservation(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("athena").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_capacity_reservation#
Creates a capacity reservation with the specified name and number of requested data processing units.
Type annotations and code completion for boto3.client("athena").create_capacity_reservation
method.
boto3 documentation
# create_capacity_reservation method definition
def create_capacity_reservation(
self,
*,
TargetDpus: int,
Name: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# create_capacity_reservation method usage example with argument unpacking
kwargs: CreateCapacityReservationInputRequestTypeDef = { # (1)
"TargetDpus": ...,
"Name": ...,
}
parent.create_capacity_reservation(**kwargs)
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
# create_data_catalog 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]:
...
- See DataCatalogTypeType
- See TagTypeDef
# create_data_catalog method usage example with argument unpacking
kwargs: CreateDataCatalogInputRequestTypeDef = { # (1)
"Name": ...,
"Type": ...,
}
parent.create_data_catalog(**kwargs)
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
# create_named_query method definition
def create_named_query(
self,
*,
Name: str,
Database: str,
QueryString: str,
Description: str = ...,
ClientRequestToken: str = ...,
WorkGroup: str = ...,
) -> CreateNamedQueryOutputTypeDef: # (1)
...
# create_named_query method usage example with argument unpacking
kwargs: CreateNamedQueryInputRequestTypeDef = { # (1)
"Name": ...,
"Database": ...,
"QueryString": ...,
}
parent.create_named_query(**kwargs)
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
# create_notebook method definition
def create_notebook(
self,
*,
WorkGroup: str,
Name: str,
ClientRequestToken: str = ...,
) -> CreateNotebookOutputTypeDef: # (1)
...
# create_notebook method usage example with argument unpacking
kwargs: CreateNotebookInputRequestTypeDef = { # (1)
"WorkGroup": ...,
"Name": ...,
}
parent.create_notebook(**kwargs)
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
# create_prepared_statement method definition
def create_prepared_statement(
self,
*,
StatementName: str,
WorkGroup: str,
QueryStatement: str,
Description: str = ...,
) -> Dict[str, Any]:
...
# create_prepared_statement method usage example with argument unpacking
kwargs: CreatePreparedStatementInputRequestTypeDef = { # (1)
"StatementName": ...,
"WorkGroup": ...,
"QueryStatement": ...,
}
parent.create_prepared_statement(**kwargs)
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
# create_presigned_notebook_url method definition
def create_presigned_notebook_url(
self,
*,
SessionId: str,
) -> CreatePresignedNotebookUrlResponseTypeDef: # (1)
...
# create_presigned_notebook_url method usage example with argument unpacking
kwargs: CreatePresignedNotebookUrlRequestRequestTypeDef = { # (1)
"SessionId": ...,
}
parent.create_presigned_notebook_url(**kwargs)
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
# create_work_group method definition
def create_work_group(
self,
*,
Name: str,
Configuration: WorkGroupConfigurationTypeDef = ..., # (1)
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> Dict[str, Any]:
...
# create_work_group method usage example with argument unpacking
kwargs: CreateWorkGroupInputRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_work_group(**kwargs)
delete_capacity_reservation#
Deletes a cancelled capacity reservation.
Type annotations and code completion for boto3.client("athena").delete_capacity_reservation
method.
boto3 documentation
# delete_capacity_reservation method definition
def delete_capacity_reservation(
self,
*,
Name: str,
) -> Dict[str, Any]:
...
# delete_capacity_reservation method usage example with argument unpacking
kwargs: DeleteCapacityReservationInputRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_capacity_reservation(**kwargs)
delete_data_catalog#
Deletes a data catalog.
Type annotations and code completion for boto3.client("athena").delete_data_catalog
method.
boto3 documentation
# delete_data_catalog method definition
def delete_data_catalog(
self,
*,
Name: str,
) -> Dict[str, Any]:
...
# delete_data_catalog method usage example with argument unpacking
kwargs: DeleteDataCatalogInputRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_data_catalog(**kwargs)
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
# delete_named_query method definition
def delete_named_query(
self,
*,
NamedQueryId: str,
) -> Dict[str, Any]:
...
# delete_named_query method usage example with argument unpacking
kwargs: DeleteNamedQueryInputRequestTypeDef = { # (1)
"NamedQueryId": ...,
}
parent.delete_named_query(**kwargs)
delete_notebook#
Deletes the specified notebook.
Type annotations and code completion for boto3.client("athena").delete_notebook
method.
boto3 documentation
# delete_notebook method definition
def delete_notebook(
self,
*,
NotebookId: str,
) -> Dict[str, Any]:
...
# delete_notebook method usage example with argument unpacking
kwargs: DeleteNotebookInputRequestTypeDef = { # (1)
"NotebookId": ...,
}
parent.delete_notebook(**kwargs)
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
# delete_prepared_statement method definition
def delete_prepared_statement(
self,
*,
StatementName: str,
WorkGroup: str,
) -> Dict[str, Any]:
...
# delete_prepared_statement method usage example with argument unpacking
kwargs: DeletePreparedStatementInputRequestTypeDef = { # (1)
"StatementName": ...,
"WorkGroup": ...,
}
parent.delete_prepared_statement(**kwargs)
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
# delete_work_group method definition
def delete_work_group(
self,
*,
WorkGroup: str,
RecursiveDeleteOption: bool = ...,
) -> Dict[str, Any]:
...
# delete_work_group method usage example with argument unpacking
kwargs: DeleteWorkGroupInputRequestTypeDef = { # (1)
"WorkGroup": ...,
}
parent.delete_work_group(**kwargs)
export_notebook#
Exports the specified notebook and its metadata.
Type annotations and code completion for boto3.client("athena").export_notebook
method.
boto3 documentation
# export_notebook method definition
def export_notebook(
self,
*,
NotebookId: str,
) -> ExportNotebookOutputTypeDef: # (1)
...
# export_notebook method usage example with argument unpacking
kwargs: ExportNotebookInputRequestTypeDef = { # (1)
"NotebookId": ...,
}
parent.export_notebook(**kwargs)
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
# generate_presigned_url 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
# get_calculation_execution method definition
def get_calculation_execution(
self,
*,
CalculationExecutionId: str,
) -> GetCalculationExecutionResponseTypeDef: # (1)
...
# get_calculation_execution method usage example with argument unpacking
kwargs: GetCalculationExecutionRequestRequestTypeDef = { # (1)
"CalculationExecutionId": ...,
}
parent.get_calculation_execution(**kwargs)
get_calculation_execution_code#
Retrieves the unencrypted code that was executed for the calculation.
Type annotations and code completion for boto3.client("athena").get_calculation_execution_code
method.
boto3 documentation
# get_calculation_execution_code method definition
def get_calculation_execution_code(
self,
*,
CalculationExecutionId: str,
) -> GetCalculationExecutionCodeResponseTypeDef: # (1)
...
# get_calculation_execution_code method usage example with argument unpacking
kwargs: GetCalculationExecutionCodeRequestRequestTypeDef = { # (1)
"CalculationExecutionId": ...,
}
parent.get_calculation_execution_code(**kwargs)
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
# get_calculation_execution_status method definition
def get_calculation_execution_status(
self,
*,
CalculationExecutionId: str,
) -> GetCalculationExecutionStatusResponseTypeDef: # (1)
...
# get_calculation_execution_status method usage example with argument unpacking
kwargs: GetCalculationExecutionStatusRequestRequestTypeDef = { # (1)
"CalculationExecutionId": ...,
}
parent.get_calculation_execution_status(**kwargs)
get_capacity_assignment_configuration#
Gets the capacity assignment configuration for a capacity reservation, if one exists.
Type annotations and code completion for boto3.client("athena").get_capacity_assignment_configuration
method.
boto3 documentation
# get_capacity_assignment_configuration method definition
def get_capacity_assignment_configuration(
self,
*,
CapacityReservationName: str,
) -> GetCapacityAssignmentConfigurationOutputTypeDef: # (1)
...
# get_capacity_assignment_configuration method usage example with argument unpacking
kwargs: GetCapacityAssignmentConfigurationInputRequestTypeDef = { # (1)
"CapacityReservationName": ...,
}
parent.get_capacity_assignment_configuration(**kwargs)
get_capacity_reservation#
Returns information about the capacity reservation with the specified name.
Type annotations and code completion for boto3.client("athena").get_capacity_reservation
method.
boto3 documentation
# get_capacity_reservation method definition
def get_capacity_reservation(
self,
*,
Name: str,
) -> GetCapacityReservationOutputTypeDef: # (1)
...
# get_capacity_reservation method usage example with argument unpacking
kwargs: GetCapacityReservationInputRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_capacity_reservation(**kwargs)
get_data_catalog#
Returns the specified data catalog.
Type annotations and code completion for boto3.client("athena").get_data_catalog
method.
boto3 documentation
# get_data_catalog method definition
def get_data_catalog(
self,
*,
Name: str,
WorkGroup: str = ...,
) -> GetDataCatalogOutputTypeDef: # (1)
...
# get_data_catalog method usage example with argument unpacking
kwargs: GetDataCatalogInputRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_data_catalog(**kwargs)
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
# get_database method definition
def get_database(
self,
*,
CatalogName: str,
DatabaseName: str,
WorkGroup: str = ...,
) -> GetDatabaseOutputTypeDef: # (1)
...
# get_database method usage example with argument unpacking
kwargs: GetDatabaseInputRequestTypeDef = { # (1)
"CatalogName": ...,
"DatabaseName": ...,
}
parent.get_database(**kwargs)
get_named_query#
Returns information about a single query.
Type annotations and code completion for boto3.client("athena").get_named_query
method.
boto3 documentation
# get_named_query method definition
def get_named_query(
self,
*,
NamedQueryId: str,
) -> GetNamedQueryOutputTypeDef: # (1)
...
# get_named_query method usage example with argument unpacking
kwargs: GetNamedQueryInputRequestTypeDef = { # (1)
"NamedQueryId": ...,
}
parent.get_named_query(**kwargs)
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
# get_notebook_metadata method definition
def get_notebook_metadata(
self,
*,
NotebookId: str,
) -> GetNotebookMetadataOutputTypeDef: # (1)
...
# get_notebook_metadata method usage example with argument unpacking
kwargs: GetNotebookMetadataInputRequestTypeDef = { # (1)
"NotebookId": ...,
}
parent.get_notebook_metadata(**kwargs)
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
# get_prepared_statement method definition
def get_prepared_statement(
self,
*,
StatementName: str,
WorkGroup: str,
) -> GetPreparedStatementOutputTypeDef: # (1)
...
# get_prepared_statement method usage example with argument unpacking
kwargs: GetPreparedStatementInputRequestTypeDef = { # (1)
"StatementName": ...,
"WorkGroup": ...,
}
parent.get_prepared_statement(**kwargs)
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
# get_query_execution method definition
def get_query_execution(
self,
*,
QueryExecutionId: str,
) -> GetQueryExecutionOutputTypeDef: # (1)
...
# get_query_execution method usage example with argument unpacking
kwargs: GetQueryExecutionInputRequestTypeDef = { # (1)
"QueryExecutionId": ...,
}
parent.get_query_execution(**kwargs)
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
# get_query_results method definition
def get_query_results(
self,
*,
QueryExecutionId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> GetQueryResultsOutputTypeDef: # (1)
...
# get_query_results method usage example with argument unpacking
kwargs: GetQueryResultsInputRequestTypeDef = { # (1)
"QueryExecutionId": ...,
}
parent.get_query_results(**kwargs)
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
# get_query_runtime_statistics method definition
def get_query_runtime_statistics(
self,
*,
QueryExecutionId: str,
) -> GetQueryRuntimeStatisticsOutputTypeDef: # (1)
...
# get_query_runtime_statistics method usage example with argument unpacking
kwargs: GetQueryRuntimeStatisticsInputRequestTypeDef = { # (1)
"QueryExecutionId": ...,
}
parent.get_query_runtime_statistics(**kwargs)
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
# get_session method definition
def get_session(
self,
*,
SessionId: str,
) -> GetSessionResponseTypeDef: # (1)
...
# get_session method usage example with argument unpacking
kwargs: GetSessionRequestRequestTypeDef = { # (1)
"SessionId": ...,
}
parent.get_session(**kwargs)
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
# get_session_status method definition
def get_session_status(
self,
*,
SessionId: str,
) -> GetSessionStatusResponseTypeDef: # (1)
...
# get_session_status method usage example with argument unpacking
kwargs: GetSessionStatusRequestRequestTypeDef = { # (1)
"SessionId": ...,
}
parent.get_session_status(**kwargs)
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
# get_table_metadata method definition
def get_table_metadata(
self,
*,
CatalogName: str,
DatabaseName: str,
TableName: str,
WorkGroup: str = ...,
) -> GetTableMetadataOutputTypeDef: # (1)
...
# get_table_metadata method usage example with argument unpacking
kwargs: GetTableMetadataInputRequestTypeDef = { # (1)
"CatalogName": ...,
"DatabaseName": ...,
"TableName": ...,
}
parent.get_table_metadata(**kwargs)
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
# get_work_group method definition
def get_work_group(
self,
*,
WorkGroup: str,
) -> GetWorkGroupOutputTypeDef: # (1)
...
# get_work_group method usage example with argument unpacking
kwargs: GetWorkGroupInputRequestTypeDef = { # (1)
"WorkGroup": ...,
}
parent.get_work_group(**kwargs)
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
# import_notebook method definition
def import_notebook(
self,
*,
WorkGroup: str,
Name: str,
Type: NotebookTypeType, # (1)
Payload: str = ...,
NotebookS3LocationUri: str = ...,
ClientRequestToken: str = ...,
) -> ImportNotebookOutputTypeDef: # (2)
...
# import_notebook method usage example with argument unpacking
kwargs: ImportNotebookInputRequestTypeDef = { # (1)
"WorkGroup": ...,
"Name": ...,
"Type": ...,
}
parent.import_notebook(**kwargs)
list_application_dpu_sizes#
Returns the supported DPU sizes for the supported application runtimes (for
example, Athena notebook version 1
).
Type annotations and code completion for boto3.client("athena").list_application_dpu_sizes
method.
boto3 documentation
# list_application_dpu_sizes method definition
def list_application_dpu_sizes(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListApplicationDPUSizesOutputTypeDef: # (1)
...
# list_application_dpu_sizes method usage example with argument unpacking
kwargs: ListApplicationDPUSizesInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_application_dpu_sizes(**kwargs)
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
# list_calculation_executions method definition
def list_calculation_executions(
self,
*,
SessionId: str,
StateFilter: CalculationExecutionStateType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListCalculationExecutionsResponseTypeDef: # (2)
...
# list_calculation_executions method usage example with argument unpacking
kwargs: ListCalculationExecutionsRequestRequestTypeDef = { # (1)
"SessionId": ...,
}
parent.list_calculation_executions(**kwargs)
list_capacity_reservations#
Lists the capacity reservations for the current account.
Type annotations and code completion for boto3.client("athena").list_capacity_reservations
method.
boto3 documentation
# list_capacity_reservations method definition
def list_capacity_reservations(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListCapacityReservationsOutputTypeDef: # (1)
...
# list_capacity_reservations method usage example with argument unpacking
kwargs: ListCapacityReservationsInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_capacity_reservations(**kwargs)
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
# list_data_catalogs method definition
def list_data_catalogs(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
WorkGroup: str = ...,
) -> ListDataCatalogsOutputTypeDef: # (1)
...
# list_data_catalogs method usage example with argument unpacking
kwargs: ListDataCatalogsInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_data_catalogs(**kwargs)
list_databases#
Lists the databases in the specified data catalog.
Type annotations and code completion for boto3.client("athena").list_databases
method.
boto3 documentation
# list_databases method definition
def list_databases(
self,
*,
CatalogName: str,
NextToken: str = ...,
MaxResults: int = ...,
WorkGroup: str = ...,
) -> ListDatabasesOutputTypeDef: # (1)
...
# list_databases method usage example with argument unpacking
kwargs: ListDatabasesInputRequestTypeDef = { # (1)
"CatalogName": ...,
}
parent.list_databases(**kwargs)
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
# list_engine_versions method definition
def list_engine_versions(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListEngineVersionsOutputTypeDef: # (1)
...
# list_engine_versions method usage example with argument unpacking
kwargs: ListEngineVersionsInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_engine_versions(**kwargs)
list_executors#
Lists, in descending order, the executors that joined a session.
Type annotations and code completion for boto3.client("athena").list_executors
method.
boto3 documentation
# list_executors method definition
def list_executors(
self,
*,
SessionId: str,
ExecutorStateFilter: ExecutorStateType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListExecutorsResponseTypeDef: # (2)
...
# list_executors method usage example with argument unpacking
kwargs: ListExecutorsRequestRequestTypeDef = { # (1)
"SessionId": ...,
}
parent.list_executors(**kwargs)
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
# list_named_queries method definition
def list_named_queries(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
WorkGroup: str = ...,
) -> ListNamedQueriesOutputTypeDef: # (1)
...
# list_named_queries method usage example with argument unpacking
kwargs: ListNamedQueriesInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_named_queries(**kwargs)
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
# list_notebook_metadata method definition
def list_notebook_metadata(
self,
*,
WorkGroup: str,
Filters: FilterDefinitionTypeDef = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListNotebookMetadataOutputTypeDef: # (2)
...
# list_notebook_metadata method usage example with argument unpacking
kwargs: ListNotebookMetadataInputRequestTypeDef = { # (1)
"WorkGroup": ...,
}
parent.list_notebook_metadata(**kwargs)
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
# list_notebook_sessions method definition
def list_notebook_sessions(
self,
*,
NotebookId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListNotebookSessionsResponseTypeDef: # (1)
...
# list_notebook_sessions method usage example with argument unpacking
kwargs: ListNotebookSessionsRequestRequestTypeDef = { # (1)
"NotebookId": ...,
}
parent.list_notebook_sessions(**kwargs)
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
# list_prepared_statements method definition
def list_prepared_statements(
self,
*,
WorkGroup: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListPreparedStatementsOutputTypeDef: # (1)
...
# list_prepared_statements method usage example with argument unpacking
kwargs: ListPreparedStatementsInputRequestTypeDef = { # (1)
"WorkGroup": ...,
}
parent.list_prepared_statements(**kwargs)
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
# list_query_executions method definition
def list_query_executions(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
WorkGroup: str = ...,
) -> ListQueryExecutionsOutputTypeDef: # (1)
...
# list_query_executions method usage example with argument unpacking
kwargs: ListQueryExecutionsInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_query_executions(**kwargs)
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
# list_sessions method definition
def list_sessions(
self,
*,
WorkGroup: str,
StateFilter: SessionStateType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListSessionsResponseTypeDef: # (2)
...
# list_sessions method usage example with argument unpacking
kwargs: ListSessionsRequestRequestTypeDef = { # (1)
"WorkGroup": ...,
}
parent.list_sessions(**kwargs)
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
# list_table_metadata method definition
def list_table_metadata(
self,
*,
CatalogName: str,
DatabaseName: str,
Expression: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
WorkGroup: str = ...,
) -> ListTableMetadataOutputTypeDef: # (1)
...
# list_table_metadata method usage example with argument unpacking
kwargs: ListTableMetadataInputRequestTypeDef = { # (1)
"CatalogName": ...,
"DatabaseName": ...,
}
parent.list_table_metadata(**kwargs)
list_tags_for_resource#
Lists the tags associated with an Athena resource.
Type annotations and code completion for boto3.client("athena").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
ResourceARN: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
list_work_groups#
Lists available workgroups for the account.
Type annotations and code completion for boto3.client("athena").list_work_groups
method.
boto3 documentation
# list_work_groups method definition
def list_work_groups(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListWorkGroupsOutputTypeDef: # (1)
...
# list_work_groups method usage example with argument unpacking
kwargs: ListWorkGroupsInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_work_groups(**kwargs)
put_capacity_assignment_configuration#
Puts a new capacity assignment configuration for a specified capacity reservation.
Type annotations and code completion for boto3.client("athena").put_capacity_assignment_configuration
method.
boto3 documentation
# put_capacity_assignment_configuration method definition
def put_capacity_assignment_configuration(
self,
*,
CapacityReservationName: str,
CapacityAssignments: Sequence[CapacityAssignmentUnionTypeDef], # (1)
) -> Dict[str, Any]:
...
# put_capacity_assignment_configuration method usage example with argument unpacking
kwargs: PutCapacityAssignmentConfigurationInputRequestTypeDef = { # (1)
"CapacityReservationName": ...,
"CapacityAssignments": ...,
}
parent.put_capacity_assignment_configuration(**kwargs)
start_calculation_execution#
Submits calculations for execution within a session.
Type annotations and code completion for boto3.client("athena").start_calculation_execution
method.
boto3 documentation
# start_calculation_execution method definition
def start_calculation_execution(
self,
*,
SessionId: str,
Description: str = ...,
CalculationConfiguration: CalculationConfigurationTypeDef = ..., # (1)
CodeBlock: str = ...,
ClientRequestToken: str = ...,
) -> StartCalculationExecutionResponseTypeDef: # (2)
...
# start_calculation_execution method usage example with argument unpacking
kwargs: StartCalculationExecutionRequestRequestTypeDef = { # (1)
"SessionId": ...,
}
parent.start_calculation_execution(**kwargs)
start_query_execution#
Runs the SQL query statements contained in the Query
.
Type annotations and code completion for boto3.client("athena").start_query_execution
method.
boto3 documentation
# start_query_execution method definition
def start_query_execution(
self,
*,
QueryString: str,
ClientRequestToken: str = ...,
QueryExecutionContext: QueryExecutionContextTypeDef = ..., # (1)
ResultConfiguration: ResultConfigurationTypeDef = ..., # (2)
WorkGroup: str = ...,
ExecutionParameters: Sequence[str] = ...,
ResultReuseConfiguration: ResultReuseConfigurationTypeDef = ..., # (3)
) -> StartQueryExecutionOutputTypeDef: # (4)
...
- See QueryExecutionContextTypeDef
- See ResultConfigurationTypeDef
- See ResultReuseConfigurationTypeDef
- See StartQueryExecutionOutputTypeDef
# start_query_execution method usage example with argument unpacking
kwargs: StartQueryExecutionInputRequestTypeDef = { # (1)
"QueryString": ...,
}
parent.start_query_execution(**kwargs)
start_session#
Creates a session for running calculations within a workgroup.
Type annotations and code completion for boto3.client("athena").start_session
method.
boto3 documentation
# start_session method definition
def start_session(
self,
*,
WorkGroup: str,
EngineConfiguration: EngineConfigurationTypeDef, # (1)
Description: str = ...,
NotebookVersion: str = ...,
SessionIdleTimeoutInMinutes: int = ...,
ClientRequestToken: str = ...,
) -> StartSessionResponseTypeDef: # (2)
...
# start_session method usage example with argument unpacking
kwargs: StartSessionRequestRequestTypeDef = { # (1)
"WorkGroup": ...,
"EngineConfiguration": ...,
}
parent.start_session(**kwargs)
stop_calculation_execution#
Requests the cancellation of a calculation.
Type annotations and code completion for boto3.client("athena").stop_calculation_execution
method.
boto3 documentation
# stop_calculation_execution method definition
def stop_calculation_execution(
self,
*,
CalculationExecutionId: str,
) -> StopCalculationExecutionResponseTypeDef: # (1)
...
# stop_calculation_execution method usage example with argument unpacking
kwargs: StopCalculationExecutionRequestRequestTypeDef = { # (1)
"CalculationExecutionId": ...,
}
parent.stop_calculation_execution(**kwargs)
stop_query_execution#
Stops a query execution.
Type annotations and code completion for boto3.client("athena").stop_query_execution
method.
boto3 documentation
# stop_query_execution method definition
def stop_query_execution(
self,
*,
QueryExecutionId: str,
) -> Dict[str, Any]:
...
# stop_query_execution method usage example with argument unpacking
kwargs: StopQueryExecutionInputRequestTypeDef = { # (1)
"QueryExecutionId": ...,
}
parent.stop_query_execution(**kwargs)
tag_resource#
Adds one or more tags to an Athena resource.
Type annotations and code completion for boto3.client("athena").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceInputRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
terminate_session#
Terminates an active session.
Type annotations and code completion for boto3.client("athena").terminate_session
method.
boto3 documentation
# terminate_session method definition
def terminate_session(
self,
*,
SessionId: str,
) -> TerminateSessionResponseTypeDef: # (1)
...
# terminate_session method usage example with argument unpacking
kwargs: TerminateSessionRequestRequestTypeDef = { # (1)
"SessionId": ...,
}
parent.terminate_session(**kwargs)
untag_resource#
Removes one or more tags from an Athena resource.
Type annotations and code completion for boto3.client("athena").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_capacity_reservation#
Updates the number of requested data processing units for the capacity reservation with the specified name.
Type annotations and code completion for boto3.client("athena").update_capacity_reservation
method.
boto3 documentation
# update_capacity_reservation method definition
def update_capacity_reservation(
self,
*,
TargetDpus: int,
Name: str,
) -> Dict[str, Any]:
...
# update_capacity_reservation method usage example with argument unpacking
kwargs: UpdateCapacityReservationInputRequestTypeDef = { # (1)
"TargetDpus": ...,
"Name": ...,
}
parent.update_capacity_reservation(**kwargs)
update_data_catalog#
Updates the data catalog that has the specified name.
Type annotations and code completion for boto3.client("athena").update_data_catalog
method.
boto3 documentation
# update_data_catalog method definition
def update_data_catalog(
self,
*,
Name: str,
Type: DataCatalogTypeType, # (1)
Description: str = ...,
Parameters: Mapping[str, str] = ...,
) -> Dict[str, Any]:
...
# update_data_catalog method usage example with argument unpacking
kwargs: UpdateDataCatalogInputRequestTypeDef = { # (1)
"Name": ...,
"Type": ...,
}
parent.update_data_catalog(**kwargs)
update_named_query#
Updates a NamedQuery object.
Type annotations and code completion for boto3.client("athena").update_named_query
method.
boto3 documentation
# update_named_query method definition
def update_named_query(
self,
*,
NamedQueryId: str,
Name: str,
QueryString: str,
Description: str = ...,
) -> Dict[str, Any]:
...
# update_named_query method usage example with argument unpacking
kwargs: UpdateNamedQueryInputRequestTypeDef = { # (1)
"NamedQueryId": ...,
"Name": ...,
"QueryString": ...,
}
parent.update_named_query(**kwargs)
update_notebook#
Updates the contents of a Spark notebook.
Type annotations and code completion for boto3.client("athena").update_notebook
method.
boto3 documentation
# update_notebook method definition
def update_notebook(
self,
*,
NotebookId: str,
Payload: str,
Type: NotebookTypeType, # (1)
SessionId: str = ...,
ClientRequestToken: str = ...,
) -> Dict[str, Any]:
...
- See NotebookTypeType
# update_notebook method usage example with argument unpacking
kwargs: UpdateNotebookInputRequestTypeDef = { # (1)
"NotebookId": ...,
"Payload": ...,
"Type": ...,
}
parent.update_notebook(**kwargs)
update_notebook_metadata#
Updates the metadata for a notebook.
Type annotations and code completion for boto3.client("athena").update_notebook_metadata
method.
boto3 documentation
# update_notebook_metadata method definition
def update_notebook_metadata(
self,
*,
NotebookId: str,
Name: str,
ClientRequestToken: str = ...,
) -> Dict[str, Any]:
...
# update_notebook_metadata method usage example with argument unpacking
kwargs: UpdateNotebookMetadataInputRequestTypeDef = { # (1)
"NotebookId": ...,
"Name": ...,
}
parent.update_notebook_metadata(**kwargs)
update_prepared_statement#
Updates a prepared statement.
Type annotations and code completion for boto3.client("athena").update_prepared_statement
method.
boto3 documentation
# update_prepared_statement method definition
def update_prepared_statement(
self,
*,
StatementName: str,
WorkGroup: str,
QueryStatement: str,
Description: str = ...,
) -> Dict[str, Any]:
...
# update_prepared_statement method usage example with argument unpacking
kwargs: UpdatePreparedStatementInputRequestTypeDef = { # (1)
"StatementName": ...,
"WorkGroup": ...,
"QueryStatement": ...,
}
parent.update_prepared_statement(**kwargs)
update_work_group#
Updates the workgroup with the specified name.
Type annotations and code completion for boto3.client("athena").update_work_group
method.
boto3 documentation
# update_work_group method definition
def update_work_group(
self,
*,
WorkGroup: str,
Description: str = ...,
ConfigurationUpdates: WorkGroupConfigurationUpdatesTypeDef = ..., # (1)
State: WorkGroupStateType = ..., # (2)
) -> Dict[str, Any]:
...
# update_work_group method usage example with argument unpacking
kwargs: UpdateWorkGroupInputRequestTypeDef = { # (1)
"WorkGroup": ...,
}
parent.update_work_group(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("athena").get_paginator
method with overloads.
client.get_paginator("get_query_results")
-> GetQueryResultsPaginatorclient.get_paginator("list_data_catalogs")
-> ListDataCatalogsPaginatorclient.get_paginator("list_databases")
-> ListDatabasesPaginatorclient.get_paginator("list_named_queries")
-> ListNamedQueriesPaginatorclient.get_paginator("list_query_executions")
-> ListQueryExecutionsPaginatorclient.get_paginator("list_table_metadata")
-> ListTableMetadataPaginatorclient.get_paginator("list_tags_for_resource")
-> ListTagsForResourcePaginator