Skip to content

Type definitions#

Index > Athena > Type definitions

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

CapacityAssignmentUnionTypeDef#

# CapacityAssignmentUnionTypeDef Union usage example

from types_boto3_athena.type_defs import CapacityAssignmentUnionTypeDef


def get_value() -> CapacityAssignmentUnionTypeDef:
    return ...


# CapacityAssignmentUnionTypeDef definition

CapacityAssignmentUnionTypeDef = Union[
    CapacityAssignmentTypeDef,  # (1)
    CapacityAssignmentOutputTypeDef,  # (2)
]
  1. See CapacityAssignmentTypeDef
  2. See CapacityAssignmentOutputTypeDef

EngineConfigurationUnionTypeDef#

# EngineConfigurationUnionTypeDef Union usage example

from types_boto3_athena.type_defs import EngineConfigurationUnionTypeDef


def get_value() -> EngineConfigurationUnionTypeDef:
    return ...


# EngineConfigurationUnionTypeDef definition

EngineConfigurationUnionTypeDef = Union[
    EngineConfigurationTypeDef,  # (1)
    EngineConfigurationOutputTypeDef,  # (2)
]
  1. See EngineConfigurationTypeDef
  2. See EngineConfigurationOutputTypeDef

AclConfigurationTypeDef#

# AclConfigurationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import AclConfigurationTypeDef


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


# AclConfigurationTypeDef definition

class AclConfigurationTypeDef(TypedDict):
    S3AclOption: S3AclOptionType,  # (1)
  1. See S3AclOptionType

ApplicationDPUSizesTypeDef#

# ApplicationDPUSizesTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ApplicationDPUSizesTypeDef


def get_value() -> ApplicationDPUSizesTypeDef:
    return {
        "ApplicationRuntimeId": ...,
    }


# ApplicationDPUSizesTypeDef definition

class ApplicationDPUSizesTypeDef(TypedDict):
    ApplicationRuntimeId: NotRequired[str],
    SupportedDPUSizes: NotRequired[List[int]],

AthenaErrorTypeDef#

# AthenaErrorTypeDef TypedDict usage example

from types_boto3_athena.type_defs import AthenaErrorTypeDef


def get_value() -> AthenaErrorTypeDef:
    return {
        "ErrorCategory": ...,
    }


# AthenaErrorTypeDef definition

class AthenaErrorTypeDef(TypedDict):
    ErrorCategory: NotRequired[int],
    ErrorType: NotRequired[int],
    Retryable: NotRequired[bool],
    ErrorMessage: NotRequired[str],

BatchGetNamedQueryInputTypeDef#

# BatchGetNamedQueryInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import BatchGetNamedQueryInputTypeDef


def get_value() -> BatchGetNamedQueryInputTypeDef:
    return {
        "NamedQueryIds": ...,
    }


# BatchGetNamedQueryInputTypeDef definition

class BatchGetNamedQueryInputTypeDef(TypedDict):
    NamedQueryIds: Sequence[str],

NamedQueryTypeDef#

# NamedQueryTypeDef TypedDict usage example

from types_boto3_athena.type_defs import NamedQueryTypeDef


def get_value() -> NamedQueryTypeDef:
    return {
        "Name": ...,
    }


# NamedQueryTypeDef definition

class NamedQueryTypeDef(TypedDict):
    Name: str,
    Database: str,
    QueryString: str,
    Description: NotRequired[str],
    NamedQueryId: NotRequired[str],
    WorkGroup: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

UnprocessedNamedQueryIdTypeDef#

# UnprocessedNamedQueryIdTypeDef TypedDict usage example

from types_boto3_athena.type_defs import UnprocessedNamedQueryIdTypeDef


def get_value() -> UnprocessedNamedQueryIdTypeDef:
    return {
        "NamedQueryId": ...,
    }


# UnprocessedNamedQueryIdTypeDef definition

class UnprocessedNamedQueryIdTypeDef(TypedDict):
    NamedQueryId: NotRequired[str],
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],

BatchGetPreparedStatementInputTypeDef#

# BatchGetPreparedStatementInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import BatchGetPreparedStatementInputTypeDef


def get_value() -> BatchGetPreparedStatementInputTypeDef:
    return {
        "PreparedStatementNames": ...,
    }


# BatchGetPreparedStatementInputTypeDef definition

class BatchGetPreparedStatementInputTypeDef(TypedDict):
    PreparedStatementNames: Sequence[str],
    WorkGroup: str,

PreparedStatementTypeDef#

# PreparedStatementTypeDef TypedDict usage example

from types_boto3_athena.type_defs import PreparedStatementTypeDef


def get_value() -> PreparedStatementTypeDef:
    return {
        "StatementName": ...,
    }


# PreparedStatementTypeDef definition

class PreparedStatementTypeDef(TypedDict):
    StatementName: NotRequired[str],
    QueryStatement: NotRequired[str],
    WorkGroupName: NotRequired[str],
    Description: NotRequired[str],
    LastModifiedTime: NotRequired[datetime],

UnprocessedPreparedStatementNameTypeDef#

# UnprocessedPreparedStatementNameTypeDef TypedDict usage example

from types_boto3_athena.type_defs import UnprocessedPreparedStatementNameTypeDef


def get_value() -> UnprocessedPreparedStatementNameTypeDef:
    return {
        "StatementName": ...,
    }


# UnprocessedPreparedStatementNameTypeDef definition

class UnprocessedPreparedStatementNameTypeDef(TypedDict):
    StatementName: NotRequired[str],
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],

BatchGetQueryExecutionInputTypeDef#

# BatchGetQueryExecutionInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import BatchGetQueryExecutionInputTypeDef


def get_value() -> BatchGetQueryExecutionInputTypeDef:
    return {
        "QueryExecutionIds": ...,
    }


# BatchGetQueryExecutionInputTypeDef definition

class BatchGetQueryExecutionInputTypeDef(TypedDict):
    QueryExecutionIds: Sequence[str],

UnprocessedQueryExecutionIdTypeDef#

# UnprocessedQueryExecutionIdTypeDef TypedDict usage example

from types_boto3_athena.type_defs import UnprocessedQueryExecutionIdTypeDef


def get_value() -> UnprocessedQueryExecutionIdTypeDef:
    return {
        "QueryExecutionId": ...,
    }


# UnprocessedQueryExecutionIdTypeDef definition

class UnprocessedQueryExecutionIdTypeDef(TypedDict):
    QueryExecutionId: NotRequired[str],
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],

CalculationConfigurationTypeDef#

# CalculationConfigurationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CalculationConfigurationTypeDef


def get_value() -> CalculationConfigurationTypeDef:
    return {
        "CodeBlock": ...,
    }


# CalculationConfigurationTypeDef definition

class CalculationConfigurationTypeDef(TypedDict):
    CodeBlock: NotRequired[str],

CalculationResultTypeDef#

# CalculationResultTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CalculationResultTypeDef


def get_value() -> CalculationResultTypeDef:
    return {
        "StdOutS3Uri": ...,
    }


# CalculationResultTypeDef definition

class CalculationResultTypeDef(TypedDict):
    StdOutS3Uri: NotRequired[str],
    StdErrorS3Uri: NotRequired[str],
    ResultS3Uri: NotRequired[str],
    ResultType: NotRequired[str],

CalculationStatisticsTypeDef#

# CalculationStatisticsTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CalculationStatisticsTypeDef


def get_value() -> CalculationStatisticsTypeDef:
    return {
        "DpuExecutionInMillis": ...,
    }


# CalculationStatisticsTypeDef definition

class CalculationStatisticsTypeDef(TypedDict):
    DpuExecutionInMillis: NotRequired[int],
    Progress: NotRequired[str],

CalculationStatusTypeDef#

# CalculationStatusTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CalculationStatusTypeDef


def get_value() -> CalculationStatusTypeDef:
    return {
        "SubmissionDateTime": ...,
    }


# CalculationStatusTypeDef definition

class CalculationStatusTypeDef(TypedDict):
    SubmissionDateTime: NotRequired[datetime],
    CompletionDateTime: NotRequired[datetime],
    State: NotRequired[CalculationExecutionStateType],  # (1)
    StateChangeReason: NotRequired[str],
  1. See CalculationExecutionStateType

CancelCapacityReservationInputTypeDef#

# CancelCapacityReservationInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CancelCapacityReservationInputTypeDef


def get_value() -> CancelCapacityReservationInputTypeDef:
    return {
        "Name": ...,
    }


# CancelCapacityReservationInputTypeDef definition

class CancelCapacityReservationInputTypeDef(TypedDict):
    Name: str,

CapacityAllocationTypeDef#

# CapacityAllocationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CapacityAllocationTypeDef


def get_value() -> CapacityAllocationTypeDef:
    return {
        "Status": ...,
    }


# CapacityAllocationTypeDef definition

class CapacityAllocationTypeDef(TypedDict):
    Status: CapacityAllocationStatusType,  # (1)
    RequestTime: datetime,
    StatusMessage: NotRequired[str],
    RequestCompletionTime: NotRequired[datetime],
  1. See CapacityAllocationStatusType

CapacityAssignmentOutputTypeDef#

# CapacityAssignmentOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CapacityAssignmentOutputTypeDef


def get_value() -> CapacityAssignmentOutputTypeDef:
    return {
        "WorkGroupNames": ...,
    }


# CapacityAssignmentOutputTypeDef definition

class CapacityAssignmentOutputTypeDef(TypedDict):
    WorkGroupNames: NotRequired[List[str]],

CapacityAssignmentTypeDef#

# CapacityAssignmentTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CapacityAssignmentTypeDef


def get_value() -> CapacityAssignmentTypeDef:
    return {
        "WorkGroupNames": ...,
    }


# CapacityAssignmentTypeDef definition

class CapacityAssignmentTypeDef(TypedDict):
    WorkGroupNames: NotRequired[Sequence[str]],

ColumnInfoTypeDef#

# ColumnInfoTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ColumnInfoTypeDef


def get_value() -> ColumnInfoTypeDef:
    return {
        "CatalogName": ...,
    }


# ColumnInfoTypeDef definition

class ColumnInfoTypeDef(TypedDict):
    Name: str,
    Type: str,
    CatalogName: NotRequired[str],
    SchemaName: NotRequired[str],
    TableName: NotRequired[str],
    Label: NotRequired[str],
    Precision: NotRequired[int],
    Scale: NotRequired[int],
    Nullable: NotRequired[ColumnNullableType],  # (1)
    CaseSensitive: NotRequired[bool],
  1. See ColumnNullableType

ColumnTypeDef#

# ColumnTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ColumnTypeDef


def get_value() -> ColumnTypeDef:
    return {
        "Name": ...,
    }


# ColumnTypeDef definition

class ColumnTypeDef(TypedDict):
    Name: str,
    Type: NotRequired[str],
    Comment: NotRequired[str],

TagTypeDef#

# TagTypeDef TypedDict usage example

from types_boto3_athena.type_defs import TagTypeDef


def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }


# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

DataCatalogTypeDef#

# DataCatalogTypeDef TypedDict usage example

from types_boto3_athena.type_defs import DataCatalogTypeDef


def get_value() -> DataCatalogTypeDef:
    return {
        "Name": ...,
    }


# DataCatalogTypeDef definition

class DataCatalogTypeDef(TypedDict):
    Name: str,
    Type: DataCatalogTypeType,  # (1)
    Description: NotRequired[str],
    Parameters: NotRequired[Dict[str, str]],
    Status: NotRequired[DataCatalogStatusType],  # (2)
    ConnectionType: NotRequired[ConnectionTypeType],  # (3)
    Error: NotRequired[str],
  1. See DataCatalogTypeType
  2. See DataCatalogStatusType
  3. See ConnectionTypeType

CreateNamedQueryInputTypeDef#

# CreateNamedQueryInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CreateNamedQueryInputTypeDef


def get_value() -> CreateNamedQueryInputTypeDef:
    return {
        "Name": ...,
    }


# CreateNamedQueryInputTypeDef definition

class CreateNamedQueryInputTypeDef(TypedDict):
    Name: str,
    Database: str,
    QueryString: str,
    Description: NotRequired[str],
    ClientRequestToken: NotRequired[str],
    WorkGroup: NotRequired[str],

CreateNotebookInputTypeDef#

# CreateNotebookInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CreateNotebookInputTypeDef


def get_value() -> CreateNotebookInputTypeDef:
    return {
        "WorkGroup": ...,
    }


# CreateNotebookInputTypeDef definition

class CreateNotebookInputTypeDef(TypedDict):
    WorkGroup: str,
    Name: str,
    ClientRequestToken: NotRequired[str],

CreatePreparedStatementInputTypeDef#

# CreatePreparedStatementInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CreatePreparedStatementInputTypeDef


def get_value() -> CreatePreparedStatementInputTypeDef:
    return {
        "StatementName": ...,
    }


# CreatePreparedStatementInputTypeDef definition

class CreatePreparedStatementInputTypeDef(TypedDict):
    StatementName: str,
    WorkGroup: str,
    QueryStatement: str,
    Description: NotRequired[str],

CreatePresignedNotebookUrlRequestTypeDef#

# CreatePresignedNotebookUrlRequestTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CreatePresignedNotebookUrlRequestTypeDef


def get_value() -> CreatePresignedNotebookUrlRequestTypeDef:
    return {
        "SessionId": ...,
    }


# CreatePresignedNotebookUrlRequestTypeDef definition

class CreatePresignedNotebookUrlRequestTypeDef(TypedDict):
    SessionId: str,

CustomerContentEncryptionConfigurationTypeDef#

# CustomerContentEncryptionConfigurationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CustomerContentEncryptionConfigurationTypeDef


def get_value() -> CustomerContentEncryptionConfigurationTypeDef:
    return {
        "KmsKey": ...,
    }


# CustomerContentEncryptionConfigurationTypeDef definition

class CustomerContentEncryptionConfigurationTypeDef(TypedDict):
    KmsKey: str,

DataCatalogSummaryTypeDef#

# DataCatalogSummaryTypeDef TypedDict usage example

from types_boto3_athena.type_defs import DataCatalogSummaryTypeDef


def get_value() -> DataCatalogSummaryTypeDef:
    return {
        "CatalogName": ...,
    }


# DataCatalogSummaryTypeDef definition

class DataCatalogSummaryTypeDef(TypedDict):
    CatalogName: NotRequired[str],
    Type: NotRequired[DataCatalogTypeType],  # (1)
    Status: NotRequired[DataCatalogStatusType],  # (2)
    ConnectionType: NotRequired[ConnectionTypeType],  # (3)
    Error: NotRequired[str],
  1. See DataCatalogTypeType
  2. See DataCatalogStatusType
  3. See ConnectionTypeType

DatabaseTypeDef#

# DatabaseTypeDef TypedDict usage example

from types_boto3_athena.type_defs import DatabaseTypeDef


def get_value() -> DatabaseTypeDef:
    return {
        "Name": ...,
    }


# DatabaseTypeDef definition

class DatabaseTypeDef(TypedDict):
    Name: str,
    Description: NotRequired[str],
    Parameters: NotRequired[Dict[str, str]],

DatumTypeDef#

# DatumTypeDef TypedDict usage example

from types_boto3_athena.type_defs import DatumTypeDef


def get_value() -> DatumTypeDef:
    return {
        "VarCharValue": ...,
    }


# DatumTypeDef definition

class DatumTypeDef(TypedDict):
    VarCharValue: NotRequired[str],

DeleteCapacityReservationInputTypeDef#

# DeleteCapacityReservationInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import DeleteCapacityReservationInputTypeDef


def get_value() -> DeleteCapacityReservationInputTypeDef:
    return {
        "Name": ...,
    }


# DeleteCapacityReservationInputTypeDef definition

class DeleteCapacityReservationInputTypeDef(TypedDict):
    Name: str,

DeleteDataCatalogInputTypeDef#

# DeleteDataCatalogInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import DeleteDataCatalogInputTypeDef


def get_value() -> DeleteDataCatalogInputTypeDef:
    return {
        "Name": ...,
    }


# DeleteDataCatalogInputTypeDef definition

class DeleteDataCatalogInputTypeDef(TypedDict):
    Name: str,
    DeleteCatalogOnly: NotRequired[bool],

DeleteNamedQueryInputTypeDef#

# DeleteNamedQueryInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import DeleteNamedQueryInputTypeDef


def get_value() -> DeleteNamedQueryInputTypeDef:
    return {
        "NamedQueryId": ...,
    }


# DeleteNamedQueryInputTypeDef definition

class DeleteNamedQueryInputTypeDef(TypedDict):
    NamedQueryId: str,

DeleteNotebookInputTypeDef#

# DeleteNotebookInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import DeleteNotebookInputTypeDef


def get_value() -> DeleteNotebookInputTypeDef:
    return {
        "NotebookId": ...,
    }


# DeleteNotebookInputTypeDef definition

class DeleteNotebookInputTypeDef(TypedDict):
    NotebookId: str,

DeletePreparedStatementInputTypeDef#

# DeletePreparedStatementInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import DeletePreparedStatementInputTypeDef


def get_value() -> DeletePreparedStatementInputTypeDef:
    return {
        "StatementName": ...,
    }


# DeletePreparedStatementInputTypeDef definition

class DeletePreparedStatementInputTypeDef(TypedDict):
    StatementName: str,
    WorkGroup: str,

DeleteWorkGroupInputTypeDef#

# DeleteWorkGroupInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import DeleteWorkGroupInputTypeDef


def get_value() -> DeleteWorkGroupInputTypeDef:
    return {
        "WorkGroup": ...,
    }


# DeleteWorkGroupInputTypeDef definition

class DeleteWorkGroupInputTypeDef(TypedDict):
    WorkGroup: str,
    RecursiveDeleteOption: NotRequired[bool],

EncryptionConfigurationTypeDef#

# EncryptionConfigurationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import EncryptionConfigurationTypeDef


def get_value() -> EncryptionConfigurationTypeDef:
    return {
        "EncryptionOption": ...,
    }


# EncryptionConfigurationTypeDef definition

class EncryptionConfigurationTypeDef(TypedDict):
    EncryptionOption: EncryptionOptionType,  # (1)
    KmsKey: NotRequired[str],
  1. See EncryptionOptionType

EngineConfigurationOutputTypeDef#

# EngineConfigurationOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import EngineConfigurationOutputTypeDef


def get_value() -> EngineConfigurationOutputTypeDef:
    return {
        "CoordinatorDpuSize": ...,
    }


# EngineConfigurationOutputTypeDef definition

class EngineConfigurationOutputTypeDef(TypedDict):
    MaxConcurrentDpus: int,
    CoordinatorDpuSize: NotRequired[int],
    DefaultExecutorDpuSize: NotRequired[int],
    AdditionalConfigs: NotRequired[Dict[str, str]],
    SparkProperties: NotRequired[Dict[str, str]],

EngineConfigurationTypeDef#

# EngineConfigurationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import EngineConfigurationTypeDef


def get_value() -> EngineConfigurationTypeDef:
    return {
        "CoordinatorDpuSize": ...,
    }


# EngineConfigurationTypeDef definition

class EngineConfigurationTypeDef(TypedDict):
    MaxConcurrentDpus: int,
    CoordinatorDpuSize: NotRequired[int],
    DefaultExecutorDpuSize: NotRequired[int],
    AdditionalConfigs: NotRequired[Mapping[str, str]],
    SparkProperties: NotRequired[Mapping[str, str]],

EngineVersionTypeDef#

# EngineVersionTypeDef TypedDict usage example

from types_boto3_athena.type_defs import EngineVersionTypeDef


def get_value() -> EngineVersionTypeDef:
    return {
        "SelectedEngineVersion": ...,
    }


# EngineVersionTypeDef definition

class EngineVersionTypeDef(TypedDict):
    SelectedEngineVersion: NotRequired[str],
    EffectiveEngineVersion: NotRequired[str],

ExecutorsSummaryTypeDef#

# ExecutorsSummaryTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ExecutorsSummaryTypeDef


def get_value() -> ExecutorsSummaryTypeDef:
    return {
        "ExecutorId": ...,
    }


# ExecutorsSummaryTypeDef definition

class ExecutorsSummaryTypeDef(TypedDict):
    ExecutorId: str,
    ExecutorType: NotRequired[ExecutorTypeType],  # (1)
    StartDateTime: NotRequired[int],
    TerminationDateTime: NotRequired[int],
    ExecutorState: NotRequired[ExecutorStateType],  # (2)
    ExecutorSize: NotRequired[int],
  1. See ExecutorTypeType
  2. See ExecutorStateType

ExportNotebookInputTypeDef#

# ExportNotebookInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ExportNotebookInputTypeDef


def get_value() -> ExportNotebookInputTypeDef:
    return {
        "NotebookId": ...,
    }


# ExportNotebookInputTypeDef definition

class ExportNotebookInputTypeDef(TypedDict):
    NotebookId: str,

NotebookMetadataTypeDef#

# NotebookMetadataTypeDef TypedDict usage example

from types_boto3_athena.type_defs import NotebookMetadataTypeDef


def get_value() -> NotebookMetadataTypeDef:
    return {
        "NotebookId": ...,
    }


# NotebookMetadataTypeDef definition

class NotebookMetadataTypeDef(TypedDict):
    NotebookId: NotRequired[str],
    Name: NotRequired[str],
    WorkGroup: NotRequired[str],
    CreationTime: NotRequired[datetime],
    Type: NotRequired[NotebookTypeType],  # (1)
    LastModifiedTime: NotRequired[datetime],
  1. See NotebookTypeType

FilterDefinitionTypeDef#

# FilterDefinitionTypeDef TypedDict usage example

from types_boto3_athena.type_defs import FilterDefinitionTypeDef


def get_value() -> FilterDefinitionTypeDef:
    return {
        "Name": ...,
    }


# FilterDefinitionTypeDef definition

class FilterDefinitionTypeDef(TypedDict):
    Name: NotRequired[str],

GetCalculationExecutionCodeRequestTypeDef#

# GetCalculationExecutionCodeRequestTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetCalculationExecutionCodeRequestTypeDef


def get_value() -> GetCalculationExecutionCodeRequestTypeDef:
    return {
        "CalculationExecutionId": ...,
    }


# GetCalculationExecutionCodeRequestTypeDef definition

class GetCalculationExecutionCodeRequestTypeDef(TypedDict):
    CalculationExecutionId: str,

GetCalculationExecutionRequestTypeDef#

# GetCalculationExecutionRequestTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetCalculationExecutionRequestTypeDef


def get_value() -> GetCalculationExecutionRequestTypeDef:
    return {
        "CalculationExecutionId": ...,
    }


# GetCalculationExecutionRequestTypeDef definition

class GetCalculationExecutionRequestTypeDef(TypedDict):
    CalculationExecutionId: str,

GetCalculationExecutionStatusRequestTypeDef#

# GetCalculationExecutionStatusRequestTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetCalculationExecutionStatusRequestTypeDef


def get_value() -> GetCalculationExecutionStatusRequestTypeDef:
    return {
        "CalculationExecutionId": ...,
    }


# GetCalculationExecutionStatusRequestTypeDef definition

class GetCalculationExecutionStatusRequestTypeDef(TypedDict):
    CalculationExecutionId: str,

GetCapacityAssignmentConfigurationInputTypeDef#

# GetCapacityAssignmentConfigurationInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetCapacityAssignmentConfigurationInputTypeDef


def get_value() -> GetCapacityAssignmentConfigurationInputTypeDef:
    return {
        "CapacityReservationName": ...,
    }


# GetCapacityAssignmentConfigurationInputTypeDef definition

class GetCapacityAssignmentConfigurationInputTypeDef(TypedDict):
    CapacityReservationName: str,

GetCapacityReservationInputTypeDef#

# GetCapacityReservationInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetCapacityReservationInputTypeDef


def get_value() -> GetCapacityReservationInputTypeDef:
    return {
        "Name": ...,
    }


# GetCapacityReservationInputTypeDef definition

class GetCapacityReservationInputTypeDef(TypedDict):
    Name: str,

GetDataCatalogInputTypeDef#

# GetDataCatalogInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetDataCatalogInputTypeDef


def get_value() -> GetDataCatalogInputTypeDef:
    return {
        "Name": ...,
    }


# GetDataCatalogInputTypeDef definition

class GetDataCatalogInputTypeDef(TypedDict):
    Name: str,
    WorkGroup: NotRequired[str],

GetDatabaseInputTypeDef#

# GetDatabaseInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetDatabaseInputTypeDef


def get_value() -> GetDatabaseInputTypeDef:
    return {
        "CatalogName": ...,
    }


# GetDatabaseInputTypeDef definition

class GetDatabaseInputTypeDef(TypedDict):
    CatalogName: str,
    DatabaseName: str,
    WorkGroup: NotRequired[str],

GetNamedQueryInputTypeDef#

# GetNamedQueryInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetNamedQueryInputTypeDef


def get_value() -> GetNamedQueryInputTypeDef:
    return {
        "NamedQueryId": ...,
    }


# GetNamedQueryInputTypeDef definition

class GetNamedQueryInputTypeDef(TypedDict):
    NamedQueryId: str,

GetNotebookMetadataInputTypeDef#

# GetNotebookMetadataInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetNotebookMetadataInputTypeDef


def get_value() -> GetNotebookMetadataInputTypeDef:
    return {
        "NotebookId": ...,
    }


# GetNotebookMetadataInputTypeDef definition

class GetNotebookMetadataInputTypeDef(TypedDict):
    NotebookId: str,

GetPreparedStatementInputTypeDef#

# GetPreparedStatementInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetPreparedStatementInputTypeDef


def get_value() -> GetPreparedStatementInputTypeDef:
    return {
        "StatementName": ...,
    }


# GetPreparedStatementInputTypeDef definition

class GetPreparedStatementInputTypeDef(TypedDict):
    StatementName: str,
    WorkGroup: str,

GetQueryExecutionInputTypeDef#

# GetQueryExecutionInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetQueryExecutionInputTypeDef


def get_value() -> GetQueryExecutionInputTypeDef:
    return {
        "QueryExecutionId": ...,
    }


# GetQueryExecutionInputTypeDef definition

class GetQueryExecutionInputTypeDef(TypedDict):
    QueryExecutionId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_boto3_athena.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetQueryResultsInputTypeDef#

# GetQueryResultsInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetQueryResultsInputTypeDef


def get_value() -> GetQueryResultsInputTypeDef:
    return {
        "QueryExecutionId": ...,
    }


# GetQueryResultsInputTypeDef definition

class GetQueryResultsInputTypeDef(TypedDict):
    QueryExecutionId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

GetQueryRuntimeStatisticsInputTypeDef#

# GetQueryRuntimeStatisticsInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetQueryRuntimeStatisticsInputTypeDef


def get_value() -> GetQueryRuntimeStatisticsInputTypeDef:
    return {
        "QueryExecutionId": ...,
    }


# GetQueryRuntimeStatisticsInputTypeDef definition

class GetQueryRuntimeStatisticsInputTypeDef(TypedDict):
    QueryExecutionId: str,

GetSessionRequestTypeDef#

# GetSessionRequestTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetSessionRequestTypeDef


def get_value() -> GetSessionRequestTypeDef:
    return {
        "SessionId": ...,
    }


# GetSessionRequestTypeDef definition

class GetSessionRequestTypeDef(TypedDict):
    SessionId: str,

SessionStatisticsTypeDef#

# SessionStatisticsTypeDef TypedDict usage example

from types_boto3_athena.type_defs import SessionStatisticsTypeDef


def get_value() -> SessionStatisticsTypeDef:
    return {
        "DpuExecutionInMillis": ...,
    }


# SessionStatisticsTypeDef definition

class SessionStatisticsTypeDef(TypedDict):
    DpuExecutionInMillis: NotRequired[int],

SessionStatusTypeDef#

# SessionStatusTypeDef TypedDict usage example

from types_boto3_athena.type_defs import SessionStatusTypeDef


def get_value() -> SessionStatusTypeDef:
    return {
        "StartDateTime": ...,
    }


# SessionStatusTypeDef definition

class SessionStatusTypeDef(TypedDict):
    StartDateTime: NotRequired[datetime],
    LastModifiedDateTime: NotRequired[datetime],
    EndDateTime: NotRequired[datetime],
    IdleSinceDateTime: NotRequired[datetime],
    State: NotRequired[SessionStateType],  # (1)
    StateChangeReason: NotRequired[str],
  1. See SessionStateType

GetSessionStatusRequestTypeDef#

# GetSessionStatusRequestTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetSessionStatusRequestTypeDef


def get_value() -> GetSessionStatusRequestTypeDef:
    return {
        "SessionId": ...,
    }


# GetSessionStatusRequestTypeDef definition

class GetSessionStatusRequestTypeDef(TypedDict):
    SessionId: str,

GetTableMetadataInputTypeDef#

# GetTableMetadataInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetTableMetadataInputTypeDef


def get_value() -> GetTableMetadataInputTypeDef:
    return {
        "CatalogName": ...,
    }


# GetTableMetadataInputTypeDef definition

class GetTableMetadataInputTypeDef(TypedDict):
    CatalogName: str,
    DatabaseName: str,
    TableName: str,
    WorkGroup: NotRequired[str],

GetWorkGroupInputTypeDef#

# GetWorkGroupInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetWorkGroupInputTypeDef


def get_value() -> GetWorkGroupInputTypeDef:
    return {
        "WorkGroup": ...,
    }


# GetWorkGroupInputTypeDef definition

class GetWorkGroupInputTypeDef(TypedDict):
    WorkGroup: str,

IdentityCenterConfigurationTypeDef#

# IdentityCenterConfigurationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import IdentityCenterConfigurationTypeDef


def get_value() -> IdentityCenterConfigurationTypeDef:
    return {
        "EnableIdentityCenter": ...,
    }


# IdentityCenterConfigurationTypeDef definition

class IdentityCenterConfigurationTypeDef(TypedDict):
    EnableIdentityCenter: NotRequired[bool],
    IdentityCenterInstanceArn: NotRequired[str],

ImportNotebookInputTypeDef#

# ImportNotebookInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ImportNotebookInputTypeDef


def get_value() -> ImportNotebookInputTypeDef:
    return {
        "WorkGroup": ...,
    }


# ImportNotebookInputTypeDef definition

class ImportNotebookInputTypeDef(TypedDict):
    WorkGroup: str,
    Name: str,
    Type: NotebookTypeType,  # (1)
    Payload: NotRequired[str],
    NotebookS3LocationUri: NotRequired[str],
    ClientRequestToken: NotRequired[str],
  1. See NotebookTypeType

ListApplicationDPUSizesInputTypeDef#

# ListApplicationDPUSizesInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListApplicationDPUSizesInputTypeDef


def get_value() -> ListApplicationDPUSizesInputTypeDef:
    return {
        "MaxResults": ...,
    }


# ListApplicationDPUSizesInputTypeDef definition

class ListApplicationDPUSizesInputTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListCalculationExecutionsRequestTypeDef#

# ListCalculationExecutionsRequestTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListCalculationExecutionsRequestTypeDef


def get_value() -> ListCalculationExecutionsRequestTypeDef:
    return {
        "SessionId": ...,
    }


# ListCalculationExecutionsRequestTypeDef definition

class ListCalculationExecutionsRequestTypeDef(TypedDict):
    SessionId: str,
    StateFilter: NotRequired[CalculationExecutionStateType],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See CalculationExecutionStateType

ListCapacityReservationsInputTypeDef#

# ListCapacityReservationsInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListCapacityReservationsInputTypeDef


def get_value() -> ListCapacityReservationsInputTypeDef:
    return {
        "NextToken": ...,
    }


# ListCapacityReservationsInputTypeDef definition

class ListCapacityReservationsInputTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListDataCatalogsInputTypeDef#

# ListDataCatalogsInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListDataCatalogsInputTypeDef


def get_value() -> ListDataCatalogsInputTypeDef:
    return {
        "NextToken": ...,
    }


# ListDataCatalogsInputTypeDef definition

class ListDataCatalogsInputTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    WorkGroup: NotRequired[str],

ListDatabasesInputTypeDef#

# ListDatabasesInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListDatabasesInputTypeDef


def get_value() -> ListDatabasesInputTypeDef:
    return {
        "CatalogName": ...,
    }


# ListDatabasesInputTypeDef definition

class ListDatabasesInputTypeDef(TypedDict):
    CatalogName: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    WorkGroup: NotRequired[str],

ListEngineVersionsInputTypeDef#

# ListEngineVersionsInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListEngineVersionsInputTypeDef


def get_value() -> ListEngineVersionsInputTypeDef:
    return {
        "NextToken": ...,
    }


# ListEngineVersionsInputTypeDef definition

class ListEngineVersionsInputTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListExecutorsRequestTypeDef#

# ListExecutorsRequestTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListExecutorsRequestTypeDef


def get_value() -> ListExecutorsRequestTypeDef:
    return {
        "SessionId": ...,
    }


# ListExecutorsRequestTypeDef definition

class ListExecutorsRequestTypeDef(TypedDict):
    SessionId: str,
    ExecutorStateFilter: NotRequired[ExecutorStateType],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See ExecutorStateType

ListNamedQueriesInputTypeDef#

# ListNamedQueriesInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListNamedQueriesInputTypeDef


def get_value() -> ListNamedQueriesInputTypeDef:
    return {
        "NextToken": ...,
    }


# ListNamedQueriesInputTypeDef definition

class ListNamedQueriesInputTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    WorkGroup: NotRequired[str],

ListNotebookSessionsRequestTypeDef#

# ListNotebookSessionsRequestTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListNotebookSessionsRequestTypeDef


def get_value() -> ListNotebookSessionsRequestTypeDef:
    return {
        "NotebookId": ...,
    }


# ListNotebookSessionsRequestTypeDef definition

class ListNotebookSessionsRequestTypeDef(TypedDict):
    NotebookId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

NotebookSessionSummaryTypeDef#

# NotebookSessionSummaryTypeDef TypedDict usage example

from types_boto3_athena.type_defs import NotebookSessionSummaryTypeDef


def get_value() -> NotebookSessionSummaryTypeDef:
    return {
        "SessionId": ...,
    }


# NotebookSessionSummaryTypeDef definition

class NotebookSessionSummaryTypeDef(TypedDict):
    SessionId: NotRequired[str],
    CreationTime: NotRequired[datetime],

ListPreparedStatementsInputTypeDef#

# ListPreparedStatementsInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListPreparedStatementsInputTypeDef


def get_value() -> ListPreparedStatementsInputTypeDef:
    return {
        "WorkGroup": ...,
    }


# ListPreparedStatementsInputTypeDef definition

class ListPreparedStatementsInputTypeDef(TypedDict):
    WorkGroup: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

PreparedStatementSummaryTypeDef#

# PreparedStatementSummaryTypeDef TypedDict usage example

from types_boto3_athena.type_defs import PreparedStatementSummaryTypeDef


def get_value() -> PreparedStatementSummaryTypeDef:
    return {
        "StatementName": ...,
    }


# PreparedStatementSummaryTypeDef definition

class PreparedStatementSummaryTypeDef(TypedDict):
    StatementName: NotRequired[str],
    LastModifiedTime: NotRequired[datetime],

ListQueryExecutionsInputTypeDef#

# ListQueryExecutionsInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListQueryExecutionsInputTypeDef


def get_value() -> ListQueryExecutionsInputTypeDef:
    return {
        "NextToken": ...,
    }


# ListQueryExecutionsInputTypeDef definition

class ListQueryExecutionsInputTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    WorkGroup: NotRequired[str],

ListSessionsRequestTypeDef#

# ListSessionsRequestTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListSessionsRequestTypeDef


def get_value() -> ListSessionsRequestTypeDef:
    return {
        "WorkGroup": ...,
    }


# ListSessionsRequestTypeDef definition

class ListSessionsRequestTypeDef(TypedDict):
    WorkGroup: str,
    StateFilter: NotRequired[SessionStateType],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See SessionStateType

ListTableMetadataInputTypeDef#

# ListTableMetadataInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListTableMetadataInputTypeDef


def get_value() -> ListTableMetadataInputTypeDef:
    return {
        "CatalogName": ...,
    }


# ListTableMetadataInputTypeDef definition

class ListTableMetadataInputTypeDef(TypedDict):
    CatalogName: str,
    DatabaseName: str,
    Expression: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    WorkGroup: NotRequired[str],

ListTagsForResourceInputTypeDef#

# ListTagsForResourceInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListTagsForResourceInputTypeDef


def get_value() -> ListTagsForResourceInputTypeDef:
    return {
        "ResourceARN": ...,
    }


# ListTagsForResourceInputTypeDef definition

class ListTagsForResourceInputTypeDef(TypedDict):
    ResourceARN: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListWorkGroupsInputTypeDef#

# ListWorkGroupsInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListWorkGroupsInputTypeDef


def get_value() -> ListWorkGroupsInputTypeDef:
    return {
        "NextToken": ...,
    }


# ListWorkGroupsInputTypeDef definition

class ListWorkGroupsInputTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

QueryExecutionContextTypeDef#

# QueryExecutionContextTypeDef TypedDict usage example

from types_boto3_athena.type_defs import QueryExecutionContextTypeDef


def get_value() -> QueryExecutionContextTypeDef:
    return {
        "Database": ...,
    }


# QueryExecutionContextTypeDef definition

class QueryExecutionContextTypeDef(TypedDict):
    Database: NotRequired[str],
    Catalog: NotRequired[str],

ResultReuseInformationTypeDef#

# ResultReuseInformationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ResultReuseInformationTypeDef


def get_value() -> ResultReuseInformationTypeDef:
    return {
        "ReusedPreviousResult": ...,
    }


# ResultReuseInformationTypeDef definition

class ResultReuseInformationTypeDef(TypedDict):
    ReusedPreviousResult: bool,

QueryResultsS3AccessGrantsConfigurationTypeDef#

# QueryResultsS3AccessGrantsConfigurationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import QueryResultsS3AccessGrantsConfigurationTypeDef


def get_value() -> QueryResultsS3AccessGrantsConfigurationTypeDef:
    return {
        "EnableS3AccessGrants": ...,
    }


# QueryResultsS3AccessGrantsConfigurationTypeDef definition

class QueryResultsS3AccessGrantsConfigurationTypeDef(TypedDict):
    EnableS3AccessGrants: bool,
    AuthenticationType: AuthenticationTypeType,  # (1)
    CreateUserLevelPrefix: NotRequired[bool],
  1. See AuthenticationTypeType

QueryRuntimeStatisticsRowsTypeDef#

# QueryRuntimeStatisticsRowsTypeDef TypedDict usage example

from types_boto3_athena.type_defs import QueryRuntimeStatisticsRowsTypeDef


def get_value() -> QueryRuntimeStatisticsRowsTypeDef:
    return {
        "InputRows": ...,
    }


# QueryRuntimeStatisticsRowsTypeDef definition

class QueryRuntimeStatisticsRowsTypeDef(TypedDict):
    InputRows: NotRequired[int],
    InputBytes: NotRequired[int],
    OutputBytes: NotRequired[int],
    OutputRows: NotRequired[int],

QueryRuntimeStatisticsTimelineTypeDef#

# QueryRuntimeStatisticsTimelineTypeDef TypedDict usage example

from types_boto3_athena.type_defs import QueryRuntimeStatisticsTimelineTypeDef


def get_value() -> QueryRuntimeStatisticsTimelineTypeDef:
    return {
        "QueryQueueTimeInMillis": ...,
    }


# QueryRuntimeStatisticsTimelineTypeDef definition

class QueryRuntimeStatisticsTimelineTypeDef(TypedDict):
    QueryQueueTimeInMillis: NotRequired[int],
    ServicePreProcessingTimeInMillis: NotRequired[int],
    QueryPlanningTimeInMillis: NotRequired[int],
    EngineExecutionTimeInMillis: NotRequired[int],
    ServiceProcessingTimeInMillis: NotRequired[int],
    TotalExecutionTimeInMillis: NotRequired[int],

QueryStagePlanNodeTypeDef#

# QueryStagePlanNodeTypeDef TypedDict usage example

from types_boto3_athena.type_defs import QueryStagePlanNodeTypeDef


def get_value() -> QueryStagePlanNodeTypeDef:
    return {
        "Name": ...,
    }


# QueryStagePlanNodeTypeDef definition

class QueryStagePlanNodeTypeDef(TypedDict):
    Name: NotRequired[str],
    Identifier: NotRequired[str],
    Children: NotRequired[List[Dict[str, Any]]],
    RemoteSources: NotRequired[List[str]],

ResultReuseByAgeConfigurationTypeDef#

# ResultReuseByAgeConfigurationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ResultReuseByAgeConfigurationTypeDef


def get_value() -> ResultReuseByAgeConfigurationTypeDef:
    return {
        "Enabled": ...,
    }


# ResultReuseByAgeConfigurationTypeDef definition

class ResultReuseByAgeConfigurationTypeDef(TypedDict):
    Enabled: bool,
    MaxAgeInMinutes: NotRequired[int],

StopCalculationExecutionRequestTypeDef#

# StopCalculationExecutionRequestTypeDef TypedDict usage example

from types_boto3_athena.type_defs import StopCalculationExecutionRequestTypeDef


def get_value() -> StopCalculationExecutionRequestTypeDef:
    return {
        "CalculationExecutionId": ...,
    }


# StopCalculationExecutionRequestTypeDef definition

class StopCalculationExecutionRequestTypeDef(TypedDict):
    CalculationExecutionId: str,

StopQueryExecutionInputTypeDef#

# StopQueryExecutionInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import StopQueryExecutionInputTypeDef


def get_value() -> StopQueryExecutionInputTypeDef:
    return {
        "QueryExecutionId": ...,
    }


# StopQueryExecutionInputTypeDef definition

class StopQueryExecutionInputTypeDef(TypedDict):
    QueryExecutionId: str,

TerminateSessionRequestTypeDef#

# TerminateSessionRequestTypeDef TypedDict usage example

from types_boto3_athena.type_defs import TerminateSessionRequestTypeDef


def get_value() -> TerminateSessionRequestTypeDef:
    return {
        "SessionId": ...,
    }


# TerminateSessionRequestTypeDef definition

class TerminateSessionRequestTypeDef(TypedDict):
    SessionId: str,

UntagResourceInputTypeDef#

# UntagResourceInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import UntagResourceInputTypeDef


def get_value() -> UntagResourceInputTypeDef:
    return {
        "ResourceARN": ...,
    }


# UntagResourceInputTypeDef definition

class UntagResourceInputTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

UpdateCapacityReservationInputTypeDef#

# UpdateCapacityReservationInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import UpdateCapacityReservationInputTypeDef


def get_value() -> UpdateCapacityReservationInputTypeDef:
    return {
        "TargetDpus": ...,
    }


# UpdateCapacityReservationInputTypeDef definition

class UpdateCapacityReservationInputTypeDef(TypedDict):
    TargetDpus: int,
    Name: str,

UpdateDataCatalogInputTypeDef#

# UpdateDataCatalogInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import UpdateDataCatalogInputTypeDef


def get_value() -> UpdateDataCatalogInputTypeDef:
    return {
        "Name": ...,
    }


# UpdateDataCatalogInputTypeDef definition

class UpdateDataCatalogInputTypeDef(TypedDict):
    Name: str,
    Type: DataCatalogTypeType,  # (1)
    Description: NotRequired[str],
    Parameters: NotRequired[Mapping[str, str]],
  1. See DataCatalogTypeType

UpdateNamedQueryInputTypeDef#

# UpdateNamedQueryInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import UpdateNamedQueryInputTypeDef


def get_value() -> UpdateNamedQueryInputTypeDef:
    return {
        "NamedQueryId": ...,
    }


# UpdateNamedQueryInputTypeDef definition

class UpdateNamedQueryInputTypeDef(TypedDict):
    NamedQueryId: str,
    Name: str,
    QueryString: str,
    Description: NotRequired[str],

UpdateNotebookInputTypeDef#

# UpdateNotebookInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import UpdateNotebookInputTypeDef


def get_value() -> UpdateNotebookInputTypeDef:
    return {
        "NotebookId": ...,
    }


# UpdateNotebookInputTypeDef definition

class UpdateNotebookInputTypeDef(TypedDict):
    NotebookId: str,
    Payload: str,
    Type: NotebookTypeType,  # (1)
    SessionId: NotRequired[str],
    ClientRequestToken: NotRequired[str],
  1. See NotebookTypeType

UpdateNotebookMetadataInputTypeDef#

# UpdateNotebookMetadataInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import UpdateNotebookMetadataInputTypeDef


def get_value() -> UpdateNotebookMetadataInputTypeDef:
    return {
        "NotebookId": ...,
    }


# UpdateNotebookMetadataInputTypeDef definition

class UpdateNotebookMetadataInputTypeDef(TypedDict):
    NotebookId: str,
    Name: str,
    ClientRequestToken: NotRequired[str],

UpdatePreparedStatementInputTypeDef#

# UpdatePreparedStatementInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import UpdatePreparedStatementInputTypeDef


def get_value() -> UpdatePreparedStatementInputTypeDef:
    return {
        "StatementName": ...,
    }


# UpdatePreparedStatementInputTypeDef definition

class UpdatePreparedStatementInputTypeDef(TypedDict):
    StatementName: str,
    WorkGroup: str,
    QueryStatement: str,
    Description: NotRequired[str],

QueryExecutionStatusTypeDef#

# QueryExecutionStatusTypeDef TypedDict usage example

from types_boto3_athena.type_defs import QueryExecutionStatusTypeDef


def get_value() -> QueryExecutionStatusTypeDef:
    return {
        "State": ...,
    }


# QueryExecutionStatusTypeDef definition

class QueryExecutionStatusTypeDef(TypedDict):
    State: NotRequired[QueryExecutionStateType],  # (1)
    StateChangeReason: NotRequired[str],
    SubmissionDateTime: NotRequired[datetime],
    CompletionDateTime: NotRequired[datetime],
    AthenaError: NotRequired[AthenaErrorTypeDef],  # (2)
  1. See QueryExecutionStateType
  2. See AthenaErrorTypeDef

CreateNamedQueryOutputTypeDef#

# CreateNamedQueryOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CreateNamedQueryOutputTypeDef


def get_value() -> CreateNamedQueryOutputTypeDef:
    return {
        "NamedQueryId": ...,
    }


# CreateNamedQueryOutputTypeDef definition

class CreateNamedQueryOutputTypeDef(TypedDict):
    NamedQueryId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateNotebookOutputTypeDef#

# CreateNotebookOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CreateNotebookOutputTypeDef


def get_value() -> CreateNotebookOutputTypeDef:
    return {
        "NotebookId": ...,
    }


# CreateNotebookOutputTypeDef definition

class CreateNotebookOutputTypeDef(TypedDict):
    NotebookId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreatePresignedNotebookUrlResponseTypeDef#

# CreatePresignedNotebookUrlResponseTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CreatePresignedNotebookUrlResponseTypeDef


def get_value() -> CreatePresignedNotebookUrlResponseTypeDef:
    return {
        "NotebookUrl": ...,
    }


# CreatePresignedNotebookUrlResponseTypeDef definition

class CreatePresignedNotebookUrlResponseTypeDef(TypedDict):
    NotebookUrl: str,
    AuthToken: str,
    AuthTokenExpirationTime: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetCalculationExecutionCodeResponseTypeDef#

# GetCalculationExecutionCodeResponseTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetCalculationExecutionCodeResponseTypeDef


def get_value() -> GetCalculationExecutionCodeResponseTypeDef:
    return {
        "CodeBlock": ...,
    }


# GetCalculationExecutionCodeResponseTypeDef definition

class GetCalculationExecutionCodeResponseTypeDef(TypedDict):
    CodeBlock: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetNamedQueryOutputTypeDef#

# GetNamedQueryOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetNamedQueryOutputTypeDef


def get_value() -> GetNamedQueryOutputTypeDef:
    return {
        "NamedQuery": ...,
    }


# GetNamedQueryOutputTypeDef definition

class GetNamedQueryOutputTypeDef(TypedDict):
    NamedQuery: NamedQueryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NamedQueryTypeDef
  2. See ResponseMetadataTypeDef

ImportNotebookOutputTypeDef#

# ImportNotebookOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ImportNotebookOutputTypeDef


def get_value() -> ImportNotebookOutputTypeDef:
    return {
        "NotebookId": ...,
    }


# ImportNotebookOutputTypeDef definition

class ImportNotebookOutputTypeDef(TypedDict):
    NotebookId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListApplicationDPUSizesOutputTypeDef#

# ListApplicationDPUSizesOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListApplicationDPUSizesOutputTypeDef


def get_value() -> ListApplicationDPUSizesOutputTypeDef:
    return {
        "ApplicationDPUSizes": ...,
    }


# ListApplicationDPUSizesOutputTypeDef definition

class ListApplicationDPUSizesOutputTypeDef(TypedDict):
    ApplicationDPUSizes: List[ApplicationDPUSizesTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ApplicationDPUSizesTypeDef
  2. See ResponseMetadataTypeDef

ListNamedQueriesOutputTypeDef#

# ListNamedQueriesOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListNamedQueriesOutputTypeDef


def get_value() -> ListNamedQueriesOutputTypeDef:
    return {
        "NamedQueryIds": ...,
    }


# ListNamedQueriesOutputTypeDef definition

class ListNamedQueriesOutputTypeDef(TypedDict):
    NamedQueryIds: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    NextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

ListQueryExecutionsOutputTypeDef#

# ListQueryExecutionsOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListQueryExecutionsOutputTypeDef


def get_value() -> ListQueryExecutionsOutputTypeDef:
    return {
        "QueryExecutionIds": ...,
    }


# ListQueryExecutionsOutputTypeDef definition

class ListQueryExecutionsOutputTypeDef(TypedDict):
    QueryExecutionIds: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    NextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

StartCalculationExecutionResponseTypeDef#

# StartCalculationExecutionResponseTypeDef TypedDict usage example

from types_boto3_athena.type_defs import StartCalculationExecutionResponseTypeDef


def get_value() -> StartCalculationExecutionResponseTypeDef:
    return {
        "CalculationExecutionId": ...,
    }


# StartCalculationExecutionResponseTypeDef definition

class StartCalculationExecutionResponseTypeDef(TypedDict):
    CalculationExecutionId: str,
    State: CalculationExecutionStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CalculationExecutionStateType
  2. See ResponseMetadataTypeDef

StartQueryExecutionOutputTypeDef#

# StartQueryExecutionOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import StartQueryExecutionOutputTypeDef


def get_value() -> StartQueryExecutionOutputTypeDef:
    return {
        "QueryExecutionId": ...,
    }


# StartQueryExecutionOutputTypeDef definition

class StartQueryExecutionOutputTypeDef(TypedDict):
    QueryExecutionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartSessionResponseTypeDef#

# StartSessionResponseTypeDef TypedDict usage example

from types_boto3_athena.type_defs import StartSessionResponseTypeDef


def get_value() -> StartSessionResponseTypeDef:
    return {
        "SessionId": ...,
    }


# StartSessionResponseTypeDef definition

class StartSessionResponseTypeDef(TypedDict):
    SessionId: str,
    State: SessionStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SessionStateType
  2. See ResponseMetadataTypeDef

StopCalculationExecutionResponseTypeDef#

# StopCalculationExecutionResponseTypeDef TypedDict usage example

from types_boto3_athena.type_defs import StopCalculationExecutionResponseTypeDef


def get_value() -> StopCalculationExecutionResponseTypeDef:
    return {
        "State": ...,
    }


# StopCalculationExecutionResponseTypeDef definition

class StopCalculationExecutionResponseTypeDef(TypedDict):
    State: CalculationExecutionStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CalculationExecutionStateType
  2. See ResponseMetadataTypeDef

TerminateSessionResponseTypeDef#

# TerminateSessionResponseTypeDef TypedDict usage example

from types_boto3_athena.type_defs import TerminateSessionResponseTypeDef


def get_value() -> TerminateSessionResponseTypeDef:
    return {
        "State": ...,
    }


# TerminateSessionResponseTypeDef definition

class TerminateSessionResponseTypeDef(TypedDict):
    State: SessionStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SessionStateType
  2. See ResponseMetadataTypeDef

BatchGetNamedQueryOutputTypeDef#

# BatchGetNamedQueryOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import BatchGetNamedQueryOutputTypeDef


def get_value() -> BatchGetNamedQueryOutputTypeDef:
    return {
        "NamedQueries": ...,
    }


# BatchGetNamedQueryOutputTypeDef definition

class BatchGetNamedQueryOutputTypeDef(TypedDict):
    NamedQueries: List[NamedQueryTypeDef],  # (1)
    UnprocessedNamedQueryIds: List[UnprocessedNamedQueryIdTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See NamedQueryTypeDef
  2. See UnprocessedNamedQueryIdTypeDef
  3. See ResponseMetadataTypeDef

GetPreparedStatementOutputTypeDef#

# GetPreparedStatementOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetPreparedStatementOutputTypeDef


def get_value() -> GetPreparedStatementOutputTypeDef:
    return {
        "PreparedStatement": ...,
    }


# GetPreparedStatementOutputTypeDef definition

class GetPreparedStatementOutputTypeDef(TypedDict):
    PreparedStatement: PreparedStatementTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PreparedStatementTypeDef
  2. See ResponseMetadataTypeDef

BatchGetPreparedStatementOutputTypeDef#

# BatchGetPreparedStatementOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import BatchGetPreparedStatementOutputTypeDef


def get_value() -> BatchGetPreparedStatementOutputTypeDef:
    return {
        "PreparedStatements": ...,
    }


# BatchGetPreparedStatementOutputTypeDef definition

class BatchGetPreparedStatementOutputTypeDef(TypedDict):
    PreparedStatements: List[PreparedStatementTypeDef],  # (1)
    UnprocessedPreparedStatementNames: List[UnprocessedPreparedStatementNameTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PreparedStatementTypeDef
  2. See UnprocessedPreparedStatementNameTypeDef
  3. See ResponseMetadataTypeDef

StartCalculationExecutionRequestTypeDef#

# StartCalculationExecutionRequestTypeDef TypedDict usage example

from types_boto3_athena.type_defs import StartCalculationExecutionRequestTypeDef


def get_value() -> StartCalculationExecutionRequestTypeDef:
    return {
        "SessionId": ...,
    }


# StartCalculationExecutionRequestTypeDef definition

class StartCalculationExecutionRequestTypeDef(TypedDict):
    SessionId: str,
    Description: NotRequired[str],
    CalculationConfiguration: NotRequired[CalculationConfigurationTypeDef],  # (1)
    CodeBlock: NotRequired[str],
    ClientRequestToken: NotRequired[str],
  1. See CalculationConfigurationTypeDef

CalculationSummaryTypeDef#

# CalculationSummaryTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CalculationSummaryTypeDef


def get_value() -> CalculationSummaryTypeDef:
    return {
        "CalculationExecutionId": ...,
    }


# CalculationSummaryTypeDef definition

class CalculationSummaryTypeDef(TypedDict):
    CalculationExecutionId: NotRequired[str],
    Description: NotRequired[str],
    Status: NotRequired[CalculationStatusTypeDef],  # (1)
  1. See CalculationStatusTypeDef

GetCalculationExecutionResponseTypeDef#

# GetCalculationExecutionResponseTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetCalculationExecutionResponseTypeDef


def get_value() -> GetCalculationExecutionResponseTypeDef:
    return {
        "CalculationExecutionId": ...,
    }


# GetCalculationExecutionResponseTypeDef definition

class GetCalculationExecutionResponseTypeDef(TypedDict):
    CalculationExecutionId: str,
    SessionId: str,
    Description: str,
    WorkingDirectory: str,
    Status: CalculationStatusTypeDef,  # (1)
    Statistics: CalculationStatisticsTypeDef,  # (2)
    Result: CalculationResultTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See CalculationStatusTypeDef
  2. See CalculationStatisticsTypeDef
  3. See CalculationResultTypeDef
  4. See ResponseMetadataTypeDef

GetCalculationExecutionStatusResponseTypeDef#

# GetCalculationExecutionStatusResponseTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetCalculationExecutionStatusResponseTypeDef


def get_value() -> GetCalculationExecutionStatusResponseTypeDef:
    return {
        "Status": ...,
    }


# GetCalculationExecutionStatusResponseTypeDef definition

class GetCalculationExecutionStatusResponseTypeDef(TypedDict):
    Status: CalculationStatusTypeDef,  # (1)
    Statistics: CalculationStatisticsTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See CalculationStatusTypeDef
  2. See CalculationStatisticsTypeDef
  3. See ResponseMetadataTypeDef

CapacityReservationTypeDef#

# CapacityReservationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CapacityReservationTypeDef


def get_value() -> CapacityReservationTypeDef:
    return {
        "Name": ...,
    }


# CapacityReservationTypeDef definition

class CapacityReservationTypeDef(TypedDict):
    Name: str,
    Status: CapacityReservationStatusType,  # (1)
    TargetDpus: int,
    AllocatedDpus: int,
    CreationTime: datetime,
    LastAllocation: NotRequired[CapacityAllocationTypeDef],  # (2)
    LastSuccessfulAllocationTime: NotRequired[datetime],
  1. See CapacityReservationStatusType
  2. See CapacityAllocationTypeDef

CapacityAssignmentConfigurationTypeDef#

# CapacityAssignmentConfigurationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CapacityAssignmentConfigurationTypeDef


def get_value() -> CapacityAssignmentConfigurationTypeDef:
    return {
        "CapacityReservationName": ...,
    }


# CapacityAssignmentConfigurationTypeDef definition

class CapacityAssignmentConfigurationTypeDef(TypedDict):
    CapacityReservationName: NotRequired[str],
    CapacityAssignments: NotRequired[List[CapacityAssignmentOutputTypeDef]],  # (1)
  1. See CapacityAssignmentOutputTypeDef

ResultSetMetadataTypeDef#

# ResultSetMetadataTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ResultSetMetadataTypeDef


def get_value() -> ResultSetMetadataTypeDef:
    return {
        "ColumnInfo": ...,
    }


# ResultSetMetadataTypeDef definition

class ResultSetMetadataTypeDef(TypedDict):
    ColumnInfo: NotRequired[List[ColumnInfoTypeDef]],  # (1)
  1. See ColumnInfoTypeDef

TableMetadataTypeDef#

# TableMetadataTypeDef TypedDict usage example

from types_boto3_athena.type_defs import TableMetadataTypeDef


def get_value() -> TableMetadataTypeDef:
    return {
        "Name": ...,
    }


# TableMetadataTypeDef definition

class TableMetadataTypeDef(TypedDict):
    Name: str,
    CreateTime: NotRequired[datetime],
    LastAccessTime: NotRequired[datetime],
    TableType: NotRequired[str],
    Columns: NotRequired[List[ColumnTypeDef]],  # (1)
    PartitionKeys: NotRequired[List[ColumnTypeDef]],  # (1)
    Parameters: NotRequired[Dict[str, str]],
  1. See ColumnTypeDef
  2. See ColumnTypeDef

CreateCapacityReservationInputTypeDef#

# CreateCapacityReservationInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CreateCapacityReservationInputTypeDef


def get_value() -> CreateCapacityReservationInputTypeDef:
    return {
        "TargetDpus": ...,
    }


# CreateCapacityReservationInputTypeDef definition

class CreateCapacityReservationInputTypeDef(TypedDict):
    TargetDpus: int,
    Name: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateDataCatalogInputTypeDef#

# CreateDataCatalogInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CreateDataCatalogInputTypeDef


def get_value() -> CreateDataCatalogInputTypeDef:
    return {
        "Name": ...,
    }


# CreateDataCatalogInputTypeDef definition

class CreateDataCatalogInputTypeDef(TypedDict):
    Name: str,
    Type: DataCatalogTypeType,  # (1)
    Description: NotRequired[str],
    Parameters: NotRequired[Mapping[str, str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See DataCatalogTypeType
  2. See TagTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListTagsForResourceOutputTypeDef


def get_value() -> ListTagsForResourceOutputTypeDef:
    return {
        "Tags": ...,
    }


# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceInputTypeDef#

# TagResourceInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import TagResourceInputTypeDef


def get_value() -> TagResourceInputTypeDef:
    return {
        "ResourceARN": ...,
    }


# TagResourceInputTypeDef definition

class TagResourceInputTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateDataCatalogOutputTypeDef#

# CreateDataCatalogOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CreateDataCatalogOutputTypeDef


def get_value() -> CreateDataCatalogOutputTypeDef:
    return {
        "DataCatalog": ...,
    }


# CreateDataCatalogOutputTypeDef definition

class CreateDataCatalogOutputTypeDef(TypedDict):
    DataCatalog: DataCatalogTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataCatalogTypeDef
  2. See ResponseMetadataTypeDef

DeleteDataCatalogOutputTypeDef#

# DeleteDataCatalogOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import DeleteDataCatalogOutputTypeDef


def get_value() -> DeleteDataCatalogOutputTypeDef:
    return {
        "DataCatalog": ...,
    }


# DeleteDataCatalogOutputTypeDef definition

class DeleteDataCatalogOutputTypeDef(TypedDict):
    DataCatalog: DataCatalogTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataCatalogTypeDef
  2. See ResponseMetadataTypeDef

GetDataCatalogOutputTypeDef#

# GetDataCatalogOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetDataCatalogOutputTypeDef


def get_value() -> GetDataCatalogOutputTypeDef:
    return {
        "DataCatalog": ...,
    }


# GetDataCatalogOutputTypeDef definition

class GetDataCatalogOutputTypeDef(TypedDict):
    DataCatalog: DataCatalogTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataCatalogTypeDef
  2. See ResponseMetadataTypeDef

ListDataCatalogsOutputTypeDef#

# ListDataCatalogsOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListDataCatalogsOutputTypeDef


def get_value() -> ListDataCatalogsOutputTypeDef:
    return {
        "DataCatalogsSummary": ...,
    }


# ListDataCatalogsOutputTypeDef definition

class ListDataCatalogsOutputTypeDef(TypedDict):
    DataCatalogsSummary: List[DataCatalogSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See DataCatalogSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetDatabaseOutputTypeDef#

# GetDatabaseOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetDatabaseOutputTypeDef


def get_value() -> GetDatabaseOutputTypeDef:
    return {
        "Database": ...,
    }


# GetDatabaseOutputTypeDef definition

class GetDatabaseOutputTypeDef(TypedDict):
    Database: DatabaseTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatabaseTypeDef
  2. See ResponseMetadataTypeDef

ListDatabasesOutputTypeDef#

# ListDatabasesOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListDatabasesOutputTypeDef


def get_value() -> ListDatabasesOutputTypeDef:
    return {
        "DatabaseList": ...,
    }


# ListDatabasesOutputTypeDef definition

class ListDatabasesOutputTypeDef(TypedDict):
    DatabaseList: List[DatabaseTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See DatabaseTypeDef
  2. See ResponseMetadataTypeDef

RowTypeDef#

# RowTypeDef TypedDict usage example

from types_boto3_athena.type_defs import RowTypeDef


def get_value() -> RowTypeDef:
    return {
        "Data": ...,
    }


# RowTypeDef definition

class RowTypeDef(TypedDict):
    Data: NotRequired[List[DatumTypeDef]],  # (1)
  1. See DatumTypeDef

ResultConfigurationTypeDef#

# ResultConfigurationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ResultConfigurationTypeDef


def get_value() -> ResultConfigurationTypeDef:
    return {
        "OutputLocation": ...,
    }


# ResultConfigurationTypeDef definition

class ResultConfigurationTypeDef(TypedDict):
    OutputLocation: NotRequired[str],
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (1)
    ExpectedBucketOwner: NotRequired[str],
    AclConfiguration: NotRequired[AclConfigurationTypeDef],  # (2)
  1. See EncryptionConfigurationTypeDef
  2. See AclConfigurationTypeDef

ResultConfigurationUpdatesTypeDef#

# ResultConfigurationUpdatesTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ResultConfigurationUpdatesTypeDef


def get_value() -> ResultConfigurationUpdatesTypeDef:
    return {
        "OutputLocation": ...,
    }


# ResultConfigurationUpdatesTypeDef definition

class ResultConfigurationUpdatesTypeDef(TypedDict):
    OutputLocation: NotRequired[str],
    RemoveOutputLocation: NotRequired[bool],
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (1)
    RemoveEncryptionConfiguration: NotRequired[bool],
    ExpectedBucketOwner: NotRequired[str],
    RemoveExpectedBucketOwner: NotRequired[bool],
    AclConfiguration: NotRequired[AclConfigurationTypeDef],  # (2)
    RemoveAclConfiguration: NotRequired[bool],
  1. See EncryptionConfigurationTypeDef
  2. See AclConfigurationTypeDef

SessionConfigurationTypeDef#

# SessionConfigurationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import SessionConfigurationTypeDef


def get_value() -> SessionConfigurationTypeDef:
    return {
        "ExecutionRole": ...,
    }


# SessionConfigurationTypeDef definition

class SessionConfigurationTypeDef(TypedDict):
    ExecutionRole: NotRequired[str],
    WorkingDirectory: NotRequired[str],
    IdleTimeoutSeconds: NotRequired[int],
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (1)
  1. See EncryptionConfigurationTypeDef

ListEngineVersionsOutputTypeDef#

# ListEngineVersionsOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListEngineVersionsOutputTypeDef


def get_value() -> ListEngineVersionsOutputTypeDef:
    return {
        "EngineVersions": ...,
    }


# ListEngineVersionsOutputTypeDef definition

class ListEngineVersionsOutputTypeDef(TypedDict):
    EngineVersions: List[EngineVersionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See EngineVersionTypeDef
  2. See ResponseMetadataTypeDef

WorkGroupSummaryTypeDef#

# WorkGroupSummaryTypeDef TypedDict usage example

from types_boto3_athena.type_defs import WorkGroupSummaryTypeDef


def get_value() -> WorkGroupSummaryTypeDef:
    return {
        "Name": ...,
    }


# WorkGroupSummaryTypeDef definition

class WorkGroupSummaryTypeDef(TypedDict):
    Name: NotRequired[str],
    State: NotRequired[WorkGroupStateType],  # (1)
    Description: NotRequired[str],
    CreationTime: NotRequired[datetime],
    EngineVersion: NotRequired[EngineVersionTypeDef],  # (2)
    IdentityCenterApplicationArn: NotRequired[str],
  1. See WorkGroupStateType
  2. See EngineVersionTypeDef

ListExecutorsResponseTypeDef#

# ListExecutorsResponseTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListExecutorsResponseTypeDef


def get_value() -> ListExecutorsResponseTypeDef:
    return {
        "SessionId": ...,
    }


# ListExecutorsResponseTypeDef definition

class ListExecutorsResponseTypeDef(TypedDict):
    SessionId: str,
    ExecutorsSummary: List[ExecutorsSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ExecutorsSummaryTypeDef
  2. See ResponseMetadataTypeDef

ExportNotebookOutputTypeDef#

# ExportNotebookOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ExportNotebookOutputTypeDef


def get_value() -> ExportNotebookOutputTypeDef:
    return {
        "NotebookMetadata": ...,
    }


# ExportNotebookOutputTypeDef definition

class ExportNotebookOutputTypeDef(TypedDict):
    NotebookMetadata: NotebookMetadataTypeDef,  # (1)
    Payload: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NotebookMetadataTypeDef
  2. See ResponseMetadataTypeDef

GetNotebookMetadataOutputTypeDef#

# GetNotebookMetadataOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetNotebookMetadataOutputTypeDef


def get_value() -> GetNotebookMetadataOutputTypeDef:
    return {
        "NotebookMetadata": ...,
    }


# GetNotebookMetadataOutputTypeDef definition

class GetNotebookMetadataOutputTypeDef(TypedDict):
    NotebookMetadata: NotebookMetadataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NotebookMetadataTypeDef
  2. See ResponseMetadataTypeDef

ListNotebookMetadataOutputTypeDef#

# ListNotebookMetadataOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListNotebookMetadataOutputTypeDef


def get_value() -> ListNotebookMetadataOutputTypeDef:
    return {
        "NextToken": ...,
    }


# ListNotebookMetadataOutputTypeDef definition

class ListNotebookMetadataOutputTypeDef(TypedDict):
    NotebookMetadataList: List[NotebookMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See NotebookMetadataTypeDef
  2. See ResponseMetadataTypeDef

ListNotebookMetadataInputTypeDef#

# ListNotebookMetadataInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListNotebookMetadataInputTypeDef


def get_value() -> ListNotebookMetadataInputTypeDef:
    return {
        "WorkGroup": ...,
    }


# ListNotebookMetadataInputTypeDef definition

class ListNotebookMetadataInputTypeDef(TypedDict):
    WorkGroup: str,
    Filters: NotRequired[FilterDefinitionTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See FilterDefinitionTypeDef

GetQueryResultsInputPaginateTypeDef#

# GetQueryResultsInputPaginateTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetQueryResultsInputPaginateTypeDef


def get_value() -> GetQueryResultsInputPaginateTypeDef:
    return {
        "QueryExecutionId": ...,
    }


# GetQueryResultsInputPaginateTypeDef definition

class GetQueryResultsInputPaginateTypeDef(TypedDict):
    QueryExecutionId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDataCatalogsInputPaginateTypeDef#

# ListDataCatalogsInputPaginateTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListDataCatalogsInputPaginateTypeDef


def get_value() -> ListDataCatalogsInputPaginateTypeDef:
    return {
        "WorkGroup": ...,
    }


# ListDataCatalogsInputPaginateTypeDef definition

class ListDataCatalogsInputPaginateTypeDef(TypedDict):
    WorkGroup: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDatabasesInputPaginateTypeDef#

# ListDatabasesInputPaginateTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListDatabasesInputPaginateTypeDef


def get_value() -> ListDatabasesInputPaginateTypeDef:
    return {
        "CatalogName": ...,
    }


# ListDatabasesInputPaginateTypeDef definition

class ListDatabasesInputPaginateTypeDef(TypedDict):
    CatalogName: str,
    WorkGroup: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListNamedQueriesInputPaginateTypeDef#

# ListNamedQueriesInputPaginateTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListNamedQueriesInputPaginateTypeDef


def get_value() -> ListNamedQueriesInputPaginateTypeDef:
    return {
        "WorkGroup": ...,
    }


# ListNamedQueriesInputPaginateTypeDef definition

class ListNamedQueriesInputPaginateTypeDef(TypedDict):
    WorkGroup: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQueryExecutionsInputPaginateTypeDef#

# ListQueryExecutionsInputPaginateTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListQueryExecutionsInputPaginateTypeDef


def get_value() -> ListQueryExecutionsInputPaginateTypeDef:
    return {
        "WorkGroup": ...,
    }


# ListQueryExecutionsInputPaginateTypeDef definition

class ListQueryExecutionsInputPaginateTypeDef(TypedDict):
    WorkGroup: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTableMetadataInputPaginateTypeDef#

# ListTableMetadataInputPaginateTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListTableMetadataInputPaginateTypeDef


def get_value() -> ListTableMetadataInputPaginateTypeDef:
    return {
        "CatalogName": ...,
    }


# ListTableMetadataInputPaginateTypeDef definition

class ListTableMetadataInputPaginateTypeDef(TypedDict):
    CatalogName: str,
    DatabaseName: str,
    Expression: NotRequired[str],
    WorkGroup: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTagsForResourceInputPaginateTypeDef#

# ListTagsForResourceInputPaginateTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListTagsForResourceInputPaginateTypeDef


def get_value() -> ListTagsForResourceInputPaginateTypeDef:
    return {
        "ResourceARN": ...,
    }


# ListTagsForResourceInputPaginateTypeDef definition

class ListTagsForResourceInputPaginateTypeDef(TypedDict):
    ResourceARN: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetSessionStatusResponseTypeDef#

# GetSessionStatusResponseTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetSessionStatusResponseTypeDef


def get_value() -> GetSessionStatusResponseTypeDef:
    return {
        "SessionId": ...,
    }


# GetSessionStatusResponseTypeDef definition

class GetSessionStatusResponseTypeDef(TypedDict):
    SessionId: str,
    Status: SessionStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SessionStatusTypeDef
  2. See ResponseMetadataTypeDef

SessionSummaryTypeDef#

# SessionSummaryTypeDef TypedDict usage example

from types_boto3_athena.type_defs import SessionSummaryTypeDef


def get_value() -> SessionSummaryTypeDef:
    return {
        "SessionId": ...,
    }


# SessionSummaryTypeDef definition

class SessionSummaryTypeDef(TypedDict):
    SessionId: NotRequired[str],
    Description: NotRequired[str],
    EngineVersion: NotRequired[EngineVersionTypeDef],  # (1)
    NotebookVersion: NotRequired[str],
    Status: NotRequired[SessionStatusTypeDef],  # (2)
  1. See EngineVersionTypeDef
  2. See SessionStatusTypeDef

ListNotebookSessionsResponseTypeDef#

# ListNotebookSessionsResponseTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListNotebookSessionsResponseTypeDef


def get_value() -> ListNotebookSessionsResponseTypeDef:
    return {
        "NotebookSessionsList": ...,
    }


# ListNotebookSessionsResponseTypeDef definition

class ListNotebookSessionsResponseTypeDef(TypedDict):
    NotebookSessionsList: List[NotebookSessionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See NotebookSessionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListPreparedStatementsOutputTypeDef#

# ListPreparedStatementsOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListPreparedStatementsOutputTypeDef


def get_value() -> ListPreparedStatementsOutputTypeDef:
    return {
        "PreparedStatements": ...,
    }


# ListPreparedStatementsOutputTypeDef definition

class ListPreparedStatementsOutputTypeDef(TypedDict):
    PreparedStatements: List[PreparedStatementSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See PreparedStatementSummaryTypeDef
  2. See ResponseMetadataTypeDef

QueryExecutionStatisticsTypeDef#

# QueryExecutionStatisticsTypeDef TypedDict usage example

from types_boto3_athena.type_defs import QueryExecutionStatisticsTypeDef


def get_value() -> QueryExecutionStatisticsTypeDef:
    return {
        "EngineExecutionTimeInMillis": ...,
    }


# QueryExecutionStatisticsTypeDef definition

class QueryExecutionStatisticsTypeDef(TypedDict):
    EngineExecutionTimeInMillis: NotRequired[int],
    DataScannedInBytes: NotRequired[int],
    DataManifestLocation: NotRequired[str],
    TotalExecutionTimeInMillis: NotRequired[int],
    QueryQueueTimeInMillis: NotRequired[int],
    ServicePreProcessingTimeInMillis: NotRequired[int],
    QueryPlanningTimeInMillis: NotRequired[int],
    ServiceProcessingTimeInMillis: NotRequired[int],
    ResultReuseInformation: NotRequired[ResultReuseInformationTypeDef],  # (1)
  1. See ResultReuseInformationTypeDef

QueryStageTypeDef#

# QueryStageTypeDef TypedDict usage example

from types_boto3_athena.type_defs import QueryStageTypeDef


def get_value() -> QueryStageTypeDef:
    return {
        "StageId": ...,
    }


# QueryStageTypeDef definition

class QueryStageTypeDef(TypedDict):
    StageId: NotRequired[int],
    State: NotRequired[str],
    OutputBytes: NotRequired[int],
    OutputRows: NotRequired[int],
    InputBytes: NotRequired[int],
    InputRows: NotRequired[int],
    ExecutionTime: NotRequired[int],
    QueryStagePlan: NotRequired[QueryStagePlanNodeTypeDef],  # (1)
    SubStages: NotRequired[List[Dict[str, Any]]],
  1. See QueryStagePlanNodeTypeDef

ResultReuseConfigurationTypeDef#

# ResultReuseConfigurationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ResultReuseConfigurationTypeDef


def get_value() -> ResultReuseConfigurationTypeDef:
    return {
        "ResultReuseByAgeConfiguration": ...,
    }


# ResultReuseConfigurationTypeDef definition

class ResultReuseConfigurationTypeDef(TypedDict):
    ResultReuseByAgeConfiguration: NotRequired[ResultReuseByAgeConfigurationTypeDef],  # (1)
  1. See ResultReuseByAgeConfigurationTypeDef

ListCalculationExecutionsResponseTypeDef#

# ListCalculationExecutionsResponseTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListCalculationExecutionsResponseTypeDef


def get_value() -> ListCalculationExecutionsResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListCalculationExecutionsResponseTypeDef definition

class ListCalculationExecutionsResponseTypeDef(TypedDict):
    Calculations: List[CalculationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See CalculationSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetCapacityReservationOutputTypeDef#

# GetCapacityReservationOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetCapacityReservationOutputTypeDef


def get_value() -> GetCapacityReservationOutputTypeDef:
    return {
        "CapacityReservation": ...,
    }


# GetCapacityReservationOutputTypeDef definition

class GetCapacityReservationOutputTypeDef(TypedDict):
    CapacityReservation: CapacityReservationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CapacityReservationTypeDef
  2. See ResponseMetadataTypeDef

ListCapacityReservationsOutputTypeDef#

# ListCapacityReservationsOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListCapacityReservationsOutputTypeDef


def get_value() -> ListCapacityReservationsOutputTypeDef:
    return {
        "NextToken": ...,
    }


# ListCapacityReservationsOutputTypeDef definition

class ListCapacityReservationsOutputTypeDef(TypedDict):
    CapacityReservations: List[CapacityReservationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See CapacityReservationTypeDef
  2. See ResponseMetadataTypeDef

GetCapacityAssignmentConfigurationOutputTypeDef#

# GetCapacityAssignmentConfigurationOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetCapacityAssignmentConfigurationOutputTypeDef


def get_value() -> GetCapacityAssignmentConfigurationOutputTypeDef:
    return {
        "CapacityAssignmentConfiguration": ...,
    }


# GetCapacityAssignmentConfigurationOutputTypeDef definition

class GetCapacityAssignmentConfigurationOutputTypeDef(TypedDict):
    CapacityAssignmentConfiguration: CapacityAssignmentConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CapacityAssignmentConfigurationTypeDef
  2. See ResponseMetadataTypeDef

PutCapacityAssignmentConfigurationInputTypeDef#

# PutCapacityAssignmentConfigurationInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import PutCapacityAssignmentConfigurationInputTypeDef


def get_value() -> PutCapacityAssignmentConfigurationInputTypeDef:
    return {
        "CapacityReservationName": ...,
    }


# PutCapacityAssignmentConfigurationInputTypeDef definition

class PutCapacityAssignmentConfigurationInputTypeDef(TypedDict):
    CapacityReservationName: str,
    CapacityAssignments: Sequence[CapacityAssignmentUnionTypeDef],  # (1)
  1. See CapacityAssignmentTypeDef CapacityAssignmentOutputTypeDef

GetTableMetadataOutputTypeDef#

# GetTableMetadataOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetTableMetadataOutputTypeDef


def get_value() -> GetTableMetadataOutputTypeDef:
    return {
        "TableMetadata": ...,
    }


# GetTableMetadataOutputTypeDef definition

class GetTableMetadataOutputTypeDef(TypedDict):
    TableMetadata: TableMetadataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TableMetadataTypeDef
  2. See ResponseMetadataTypeDef

ListTableMetadataOutputTypeDef#

# ListTableMetadataOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListTableMetadataOutputTypeDef


def get_value() -> ListTableMetadataOutputTypeDef:
    return {
        "TableMetadataList": ...,
    }


# ListTableMetadataOutputTypeDef definition

class ListTableMetadataOutputTypeDef(TypedDict):
    TableMetadataList: List[TableMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See TableMetadataTypeDef
  2. See ResponseMetadataTypeDef

ResultSetTypeDef#

# ResultSetTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ResultSetTypeDef


def get_value() -> ResultSetTypeDef:
    return {
        "Rows": ...,
    }


# ResultSetTypeDef definition

class ResultSetTypeDef(TypedDict):
    Rows: NotRequired[List[RowTypeDef]],  # (1)
    ResultSetMetadata: NotRequired[ResultSetMetadataTypeDef],  # (2)
  1. See RowTypeDef
  2. See ResultSetMetadataTypeDef

WorkGroupConfigurationTypeDef#

# WorkGroupConfigurationTypeDef TypedDict usage example

from types_boto3_athena.type_defs import WorkGroupConfigurationTypeDef


def get_value() -> WorkGroupConfigurationTypeDef:
    return {
        "ResultConfiguration": ...,
    }


# WorkGroupConfigurationTypeDef definition

class WorkGroupConfigurationTypeDef(TypedDict):
    ResultConfiguration: NotRequired[ResultConfigurationTypeDef],  # (1)
    EnforceWorkGroupConfiguration: NotRequired[bool],
    PublishCloudWatchMetricsEnabled: NotRequired[bool],
    BytesScannedCutoffPerQuery: NotRequired[int],
    RequesterPaysEnabled: NotRequired[bool],
    EngineVersion: NotRequired[EngineVersionTypeDef],  # (2)
    AdditionalConfiguration: NotRequired[str],
    ExecutionRole: NotRequired[str],
    CustomerContentEncryptionConfiguration: NotRequired[CustomerContentEncryptionConfigurationTypeDef],  # (3)
    EnableMinimumEncryptionConfiguration: NotRequired[bool],
    IdentityCenterConfiguration: NotRequired[IdentityCenterConfigurationTypeDef],  # (4)
    QueryResultsS3AccessGrantsConfiguration: NotRequired[QueryResultsS3AccessGrantsConfigurationTypeDef],  # (5)
  1. See ResultConfigurationTypeDef
  2. See EngineVersionTypeDef
  3. See CustomerContentEncryptionConfigurationTypeDef
  4. See IdentityCenterConfigurationTypeDef
  5. See QueryResultsS3AccessGrantsConfigurationTypeDef

WorkGroupConfigurationUpdatesTypeDef#

# WorkGroupConfigurationUpdatesTypeDef TypedDict usage example

from types_boto3_athena.type_defs import WorkGroupConfigurationUpdatesTypeDef


def get_value() -> WorkGroupConfigurationUpdatesTypeDef:
    return {
        "EnforceWorkGroupConfiguration": ...,
    }


# WorkGroupConfigurationUpdatesTypeDef definition

class WorkGroupConfigurationUpdatesTypeDef(TypedDict):
    EnforceWorkGroupConfiguration: NotRequired[bool],
    ResultConfigurationUpdates: NotRequired[ResultConfigurationUpdatesTypeDef],  # (1)
    PublishCloudWatchMetricsEnabled: NotRequired[bool],
    BytesScannedCutoffPerQuery: NotRequired[int],
    RemoveBytesScannedCutoffPerQuery: NotRequired[bool],
    RequesterPaysEnabled: NotRequired[bool],
    EngineVersion: NotRequired[EngineVersionTypeDef],  # (2)
    RemoveCustomerContentEncryptionConfiguration: NotRequired[bool],
    AdditionalConfiguration: NotRequired[str],
    ExecutionRole: NotRequired[str],
    CustomerContentEncryptionConfiguration: NotRequired[CustomerContentEncryptionConfigurationTypeDef],  # (3)
    EnableMinimumEncryptionConfiguration: NotRequired[bool],
    QueryResultsS3AccessGrantsConfiguration: NotRequired[QueryResultsS3AccessGrantsConfigurationTypeDef],  # (4)
  1. See ResultConfigurationUpdatesTypeDef
  2. See EngineVersionTypeDef
  3. See CustomerContentEncryptionConfigurationTypeDef
  4. See QueryResultsS3AccessGrantsConfigurationTypeDef

GetSessionResponseTypeDef#

# GetSessionResponseTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetSessionResponseTypeDef


def get_value() -> GetSessionResponseTypeDef:
    return {
        "SessionId": ...,
    }


# GetSessionResponseTypeDef definition

class GetSessionResponseTypeDef(TypedDict):
    SessionId: str,
    Description: str,
    WorkGroup: str,
    EngineVersion: str,
    EngineConfiguration: EngineConfigurationOutputTypeDef,  # (1)
    NotebookVersion: str,
    SessionConfiguration: SessionConfigurationTypeDef,  # (2)
    Status: SessionStatusTypeDef,  # (3)
    Statistics: SessionStatisticsTypeDef,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See EngineConfigurationOutputTypeDef
  2. See SessionConfigurationTypeDef
  3. See SessionStatusTypeDef
  4. See SessionStatisticsTypeDef
  5. See ResponseMetadataTypeDef

StartSessionRequestTypeDef#

# StartSessionRequestTypeDef TypedDict usage example

from types_boto3_athena.type_defs import StartSessionRequestTypeDef


def get_value() -> StartSessionRequestTypeDef:
    return {
        "WorkGroup": ...,
    }


# StartSessionRequestTypeDef definition

class StartSessionRequestTypeDef(TypedDict):
    WorkGroup: str,
    EngineConfiguration: EngineConfigurationUnionTypeDef,  # (1)
    Description: NotRequired[str],
    NotebookVersion: NotRequired[str],
    SessionIdleTimeoutInMinutes: NotRequired[int],
    ClientRequestToken: NotRequired[str],
  1. See EngineConfigurationTypeDef EngineConfigurationOutputTypeDef

ListWorkGroupsOutputTypeDef#

# ListWorkGroupsOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListWorkGroupsOutputTypeDef


def get_value() -> ListWorkGroupsOutputTypeDef:
    return {
        "WorkGroups": ...,
    }


# ListWorkGroupsOutputTypeDef definition

class ListWorkGroupsOutputTypeDef(TypedDict):
    WorkGroups: List[WorkGroupSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See WorkGroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListSessionsResponseTypeDef#

# ListSessionsResponseTypeDef TypedDict usage example

from types_boto3_athena.type_defs import ListSessionsResponseTypeDef


def get_value() -> ListSessionsResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListSessionsResponseTypeDef definition

class ListSessionsResponseTypeDef(TypedDict):
    Sessions: List[SessionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See SessionSummaryTypeDef
  2. See ResponseMetadataTypeDef

QueryRuntimeStatisticsTypeDef#

# QueryRuntimeStatisticsTypeDef TypedDict usage example

from types_boto3_athena.type_defs import QueryRuntimeStatisticsTypeDef


def get_value() -> QueryRuntimeStatisticsTypeDef:
    return {
        "Timeline": ...,
    }


# QueryRuntimeStatisticsTypeDef definition

class QueryRuntimeStatisticsTypeDef(TypedDict):
    Timeline: NotRequired[QueryRuntimeStatisticsTimelineTypeDef],  # (1)
    Rows: NotRequired[QueryRuntimeStatisticsRowsTypeDef],  # (2)
    OutputStage: NotRequired[QueryStageTypeDef],  # (3)
  1. See QueryRuntimeStatisticsTimelineTypeDef
  2. See QueryRuntimeStatisticsRowsTypeDef
  3. See QueryStageTypeDef

QueryExecutionTypeDef#

# QueryExecutionTypeDef TypedDict usage example

from types_boto3_athena.type_defs import QueryExecutionTypeDef


def get_value() -> QueryExecutionTypeDef:
    return {
        "QueryExecutionId": ...,
    }


# QueryExecutionTypeDef definition

class QueryExecutionTypeDef(TypedDict):
    QueryExecutionId: NotRequired[str],
    Query: NotRequired[str],
    StatementType: NotRequired[StatementTypeType],  # (1)
    ResultConfiguration: NotRequired[ResultConfigurationTypeDef],  # (2)
    ResultReuseConfiguration: NotRequired[ResultReuseConfigurationTypeDef],  # (3)
    QueryExecutionContext: NotRequired[QueryExecutionContextTypeDef],  # (4)
    Status: NotRequired[QueryExecutionStatusTypeDef],  # (5)
    Statistics: NotRequired[QueryExecutionStatisticsTypeDef],  # (6)
    WorkGroup: NotRequired[str],
    EngineVersion: NotRequired[EngineVersionTypeDef],  # (7)
    ExecutionParameters: NotRequired[List[str]],
    SubstatementType: NotRequired[str],
    QueryResultsS3AccessGrantsConfiguration: NotRequired[QueryResultsS3AccessGrantsConfigurationTypeDef],  # (8)
  1. See StatementTypeType
  2. See ResultConfigurationTypeDef
  3. See ResultReuseConfigurationTypeDef
  4. See QueryExecutionContextTypeDef
  5. See QueryExecutionStatusTypeDef
  6. See QueryExecutionStatisticsTypeDef
  7. See EngineVersionTypeDef
  8. See QueryResultsS3AccessGrantsConfigurationTypeDef

StartQueryExecutionInputTypeDef#

# StartQueryExecutionInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import StartQueryExecutionInputTypeDef


def get_value() -> StartQueryExecutionInputTypeDef:
    return {
        "QueryString": ...,
    }


# StartQueryExecutionInputTypeDef definition

class StartQueryExecutionInputTypeDef(TypedDict):
    QueryString: str,
    ClientRequestToken: NotRequired[str],
    QueryExecutionContext: NotRequired[QueryExecutionContextTypeDef],  # (1)
    ResultConfiguration: NotRequired[ResultConfigurationTypeDef],  # (2)
    WorkGroup: NotRequired[str],
    ExecutionParameters: NotRequired[Sequence[str]],
    ResultReuseConfiguration: NotRequired[ResultReuseConfigurationTypeDef],  # (3)
  1. See QueryExecutionContextTypeDef
  2. See ResultConfigurationTypeDef
  3. See ResultReuseConfigurationTypeDef

GetQueryResultsOutputTypeDef#

# GetQueryResultsOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetQueryResultsOutputTypeDef


def get_value() -> GetQueryResultsOutputTypeDef:
    return {
        "UpdateCount": ...,
    }


# GetQueryResultsOutputTypeDef definition

class GetQueryResultsOutputTypeDef(TypedDict):
    UpdateCount: int,
    ResultSet: ResultSetTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ResultSetTypeDef
  2. See ResponseMetadataTypeDef

CreateWorkGroupInputTypeDef#

# CreateWorkGroupInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import CreateWorkGroupInputTypeDef


def get_value() -> CreateWorkGroupInputTypeDef:
    return {
        "Name": ...,
    }


# CreateWorkGroupInputTypeDef definition

class CreateWorkGroupInputTypeDef(TypedDict):
    Name: str,
    Configuration: NotRequired[WorkGroupConfigurationTypeDef],  # (1)
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See WorkGroupConfigurationTypeDef
  2. See TagTypeDef

WorkGroupTypeDef#

# WorkGroupTypeDef TypedDict usage example

from types_boto3_athena.type_defs import WorkGroupTypeDef


def get_value() -> WorkGroupTypeDef:
    return {
        "Name": ...,
    }


# WorkGroupTypeDef definition

class WorkGroupTypeDef(TypedDict):
    Name: str,
    State: NotRequired[WorkGroupStateType],  # (1)
    Configuration: NotRequired[WorkGroupConfigurationTypeDef],  # (2)
    Description: NotRequired[str],
    CreationTime: NotRequired[datetime],
    IdentityCenterApplicationArn: NotRequired[str],
  1. See WorkGroupStateType
  2. See WorkGroupConfigurationTypeDef

UpdateWorkGroupInputTypeDef#

# UpdateWorkGroupInputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import UpdateWorkGroupInputTypeDef


def get_value() -> UpdateWorkGroupInputTypeDef:
    return {
        "WorkGroup": ...,
    }


# UpdateWorkGroupInputTypeDef definition

class UpdateWorkGroupInputTypeDef(TypedDict):
    WorkGroup: str,
    Description: NotRequired[str],
    ConfigurationUpdates: NotRequired[WorkGroupConfigurationUpdatesTypeDef],  # (1)
    State: NotRequired[WorkGroupStateType],  # (2)
  1. See WorkGroupConfigurationUpdatesTypeDef
  2. See WorkGroupStateType

GetQueryRuntimeStatisticsOutputTypeDef#

# GetQueryRuntimeStatisticsOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetQueryRuntimeStatisticsOutputTypeDef


def get_value() -> GetQueryRuntimeStatisticsOutputTypeDef:
    return {
        "QueryRuntimeStatistics": ...,
    }


# GetQueryRuntimeStatisticsOutputTypeDef definition

class GetQueryRuntimeStatisticsOutputTypeDef(TypedDict):
    QueryRuntimeStatistics: QueryRuntimeStatisticsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueryRuntimeStatisticsTypeDef
  2. See ResponseMetadataTypeDef

BatchGetQueryExecutionOutputTypeDef#

# BatchGetQueryExecutionOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import BatchGetQueryExecutionOutputTypeDef


def get_value() -> BatchGetQueryExecutionOutputTypeDef:
    return {
        "QueryExecutions": ...,
    }


# BatchGetQueryExecutionOutputTypeDef definition

class BatchGetQueryExecutionOutputTypeDef(TypedDict):
    QueryExecutions: List[QueryExecutionTypeDef],  # (1)
    UnprocessedQueryExecutionIds: List[UnprocessedQueryExecutionIdTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See QueryExecutionTypeDef
  2. See UnprocessedQueryExecutionIdTypeDef
  3. See ResponseMetadataTypeDef

GetQueryExecutionOutputTypeDef#

# GetQueryExecutionOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetQueryExecutionOutputTypeDef


def get_value() -> GetQueryExecutionOutputTypeDef:
    return {
        "QueryExecution": ...,
    }


# GetQueryExecutionOutputTypeDef definition

class GetQueryExecutionOutputTypeDef(TypedDict):
    QueryExecution: QueryExecutionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueryExecutionTypeDef
  2. See ResponseMetadataTypeDef

GetWorkGroupOutputTypeDef#

# GetWorkGroupOutputTypeDef TypedDict usage example

from types_boto3_athena.type_defs import GetWorkGroupOutputTypeDef


def get_value() -> GetWorkGroupOutputTypeDef:
    return {
        "WorkGroup": ...,
    }


# GetWorkGroupOutputTypeDef definition

class GetWorkGroupOutputTypeDef(TypedDict):
    WorkGroup: WorkGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkGroupTypeDef
  2. See ResponseMetadataTypeDef