Skip to content

Athena module#

Index > Athena

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

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and Athena.

From PyPI with pip#

Install boto3-stubs for Athena service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[athena]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[athena]'


# standalone installation
python -m pip install mypy-boto3-athena

How to uninstall#

python -m pip uninstall -y mypy-boto3-athena

Usage#

Code samples can be found in Examples.

AthenaClient#

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

# AthenaClient usage example

from boto3.session import Session

from mypy_boto3_athena.client import AthenaClient

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

Paginators#

Type annotations and code completion for paginators from boto3.client("athena").get_paginator("...").

# GetQueryResultsPaginator usage example

from boto3.session import Session

from mypy_boto3_athena.paginator import GetQueryResultsPaginator

def get_get_query_results_paginator() -> GetQueryResultsPaginator:
    return Session().client("athena").get_paginator("get_query_results"))

Literals#

Type annotations for literals used in methods and schemas.

# CalculationExecutionStateType usage example

from mypy_boto3_athena.literals import CalculationExecutionStateType

def get_value() -> CalculationExecutionStateType:
    return "CANCELED"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AclConfigurationTypeDef usage example

from mypy_boto3_athena.type_defs import AclConfigurationTypeDef

def get_value() -> AclConfigurationTypeDef:
    return {
        "S3AclOption": ...,
    }