Typed dictionaries
Auto-generated documentation for Athena type annotations stubs module mypy-boto3-athena.
AclConfigurationTypeDef
Usage Example
from mypy_boto3_athena.type_defs import AclConfigurationTypeDef
def get_value() -> AclConfigurationTypeDef:
return {
"S3AclOption": ...,
}
- See S3AclOptionType
ApplicationDPUSizesTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ApplicationDPUSizesTypeDef
def get_value() -> ApplicationDPUSizesTypeDef:
return {
"ApplicationRuntimeId": ...,
}
Definition
class ApplicationDPUSizesTypeDef(TypedDict):
ApplicationRuntimeId: NotRequired[str],
SupportedDPUSizes: NotRequired[List[int]],
AthenaErrorTypeDef
Usage Example
from mypy_boto3_athena.type_defs import AthenaErrorTypeDef
def get_value() -> AthenaErrorTypeDef:
return {
"ErrorCategory": ...,
}
Definition
class AthenaErrorTypeDef(TypedDict):
ErrorCategory: NotRequired[int],
ErrorType: NotRequired[int],
Retryable: NotRequired[bool],
ErrorMessage: NotRequired[str],
BatchGetNamedQueryInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import BatchGetNamedQueryInputRequestTypeDef
def get_value() -> BatchGetNamedQueryInputRequestTypeDef:
return {
"NamedQueryIds": ...,
}
NamedQueryTypeDef
Usage Example
from mypy_boto3_athena.type_defs import NamedQueryTypeDef
def get_value() -> NamedQueryTypeDef:
return {
"Name": ...,
"Database": ...,
"QueryString": ...,
}
Definition
class NamedQueryTypeDef(TypedDict):
Name: str,
Database: str,
QueryString: str,
Description: NotRequired[str],
NamedQueryId: NotRequired[str],
WorkGroup: NotRequired[str],
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
UnprocessedNamedQueryIdTypeDef
Usage Example
from mypy_boto3_athena.type_defs import UnprocessedNamedQueryIdTypeDef
def get_value() -> UnprocessedNamedQueryIdTypeDef:
return {
"NamedQueryId": ...,
}
Definition
class UnprocessedNamedQueryIdTypeDef(TypedDict):
NamedQueryId: NotRequired[str],
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
BatchGetPreparedStatementInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import BatchGetPreparedStatementInputRequestTypeDef
def get_value() -> BatchGetPreparedStatementInputRequestTypeDef:
return {
"PreparedStatementNames": ...,
"WorkGroup": ...,
}
Definition
class BatchGetPreparedStatementInputRequestTypeDef(TypedDict):
PreparedStatementNames: Sequence[str],
WorkGroup: str,
PreparedStatementTypeDef
Usage Example
from mypy_boto3_athena.type_defs import PreparedStatementTypeDef
def get_value() -> PreparedStatementTypeDef:
return {
"StatementName": ...,
}
Definition
class PreparedStatementTypeDef(TypedDict):
StatementName: NotRequired[str],
QueryStatement: NotRequired[str],
WorkGroupName: NotRequired[str],
Description: NotRequired[str],
LastModifiedTime: NotRequired[datetime],
UnprocessedPreparedStatementNameTypeDef
Usage Example
from mypy_boto3_athena.type_defs import UnprocessedPreparedStatementNameTypeDef
def get_value() -> UnprocessedPreparedStatementNameTypeDef:
return {
"StatementName": ...,
}
Definition
class UnprocessedPreparedStatementNameTypeDef(TypedDict):
StatementName: NotRequired[str],
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
BatchGetQueryExecutionInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import BatchGetQueryExecutionInputRequestTypeDef
def get_value() -> BatchGetQueryExecutionInputRequestTypeDef:
return {
"QueryExecutionIds": ...,
}
Definition
class BatchGetQueryExecutionInputRequestTypeDef(TypedDict):
QueryExecutionIds: Sequence[str],
UnprocessedQueryExecutionIdTypeDef
Usage Example
from mypy_boto3_athena.type_defs import UnprocessedQueryExecutionIdTypeDef
def get_value() -> UnprocessedQueryExecutionIdTypeDef:
return {
"QueryExecutionId": ...,
}
Definition
class UnprocessedQueryExecutionIdTypeDef(TypedDict):
QueryExecutionId: NotRequired[str],
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
CalculationConfigurationTypeDef
Usage Example
from mypy_boto3_athena.type_defs import CalculationConfigurationTypeDef
def get_value() -> CalculationConfigurationTypeDef:
return {
"CodeBlock": ...,
}
CalculationResultTypeDef
Usage Example
from mypy_boto3_athena.type_defs import CalculationResultTypeDef
def get_value() -> CalculationResultTypeDef:
return {
"StdOutS3Uri": ...,
}
Definition
class CalculationResultTypeDef(TypedDict):
StdOutS3Uri: NotRequired[str],
StdErrorS3Uri: NotRequired[str],
ResultS3Uri: NotRequired[str],
ResultType: NotRequired[str],
CalculationStatisticsTypeDef
Usage Example
from mypy_boto3_athena.type_defs import CalculationStatisticsTypeDef
def get_value() -> CalculationStatisticsTypeDef:
return {
"DpuExecutionInMillis": ...,
}
Definition
class CalculationStatisticsTypeDef(TypedDict):
DpuExecutionInMillis: NotRequired[int],
Progress: NotRequired[str],
CalculationStatusTypeDef
Usage Example
from mypy_boto3_athena.type_defs import CalculationStatusTypeDef
def get_value() -> CalculationStatusTypeDef:
return {
"SubmissionDateTime": ...,
}
Definition
class CalculationStatusTypeDef(TypedDict):
SubmissionDateTime: NotRequired[datetime],
CompletionDateTime: NotRequired[datetime],
State: NotRequired[CalculationExecutionStateType], # (1)
StateChangeReason: NotRequired[str],
ColumnInfoTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ColumnInfoTypeDef
def get_value() -> ColumnInfoTypeDef:
return {
"Name": ...,
"Type": ...,
}
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],
ColumnTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ColumnTypeDef
def get_value() -> ColumnTypeDef:
return {
"Name": ...,
}
Definition
class ColumnTypeDef(TypedDict):
Name: str,
Type: NotRequired[str],
Comment: NotRequired[str],
TagTypeDef
Usage Example
from mypy_boto3_athena.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
CreateNamedQueryInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import CreateNamedQueryInputRequestTypeDef
def get_value() -> CreateNamedQueryInputRequestTypeDef:
return {
"Name": ...,
"Database": ...,
"QueryString": ...,
}
Definition
class CreateNamedQueryInputRequestTypeDef(TypedDict):
Name: str,
Database: str,
QueryString: str,
Description: NotRequired[str],
ClientRequestToken: NotRequired[str],
WorkGroup: NotRequired[str],
CreateNotebookInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import CreateNotebookInputRequestTypeDef
def get_value() -> CreateNotebookInputRequestTypeDef:
return {
"WorkGroup": ...,
"Name": ...,
}
Definition
class CreateNotebookInputRequestTypeDef(TypedDict):
WorkGroup: str,
Name: str,
ClientRequestToken: NotRequired[str],
CreatePreparedStatementInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import CreatePreparedStatementInputRequestTypeDef
def get_value() -> CreatePreparedStatementInputRequestTypeDef:
return {
"StatementName": ...,
"WorkGroup": ...,
"QueryStatement": ...,
}
Definition
class CreatePreparedStatementInputRequestTypeDef(TypedDict):
StatementName: str,
WorkGroup: str,
QueryStatement: str,
Description: NotRequired[str],
CreatePresignedNotebookUrlRequestRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import CreatePresignedNotebookUrlRequestRequestTypeDef
def get_value() -> CreatePresignedNotebookUrlRequestRequestTypeDef:
return {
"SessionId": ...,
}
CustomerContentEncryptionConfigurationTypeDef
Usage Example
from mypy_boto3_athena.type_defs import CustomerContentEncryptionConfigurationTypeDef
def get_value() -> CustomerContentEncryptionConfigurationTypeDef:
return {
"KmsKey": ...,
}
DataCatalogSummaryTypeDef
Usage Example
from mypy_boto3_athena.type_defs import DataCatalogSummaryTypeDef
def get_value() -> DataCatalogSummaryTypeDef:
return {
"CatalogName": ...,
}
Definition
class DataCatalogSummaryTypeDef(TypedDict):
CatalogName: NotRequired[str],
Type: NotRequired[DataCatalogTypeType], # (1)
DataCatalogTypeDef
Usage Example
from mypy_boto3_athena.type_defs import DataCatalogTypeDef
def get_value() -> DataCatalogTypeDef:
return {
"Name": ...,
"Type": ...,
}
Definition
class DataCatalogTypeDef(TypedDict):
Name: str,
Type: DataCatalogTypeType, # (1)
Description: NotRequired[str],
Parameters: NotRequired[Dict[str, str]],
DatabaseTypeDef
Usage Example
from mypy_boto3_athena.type_defs import DatabaseTypeDef
def get_value() -> DatabaseTypeDef:
return {
"Name": ...,
}
Definition
class DatabaseTypeDef(TypedDict):
Name: str,
Description: NotRequired[str],
Parameters: NotRequired[Dict[str, str]],
DatumTypeDef
Usage Example
from mypy_boto3_athena.type_defs import DatumTypeDef
def get_value() -> DatumTypeDef:
return {
"VarCharValue": ...,
}
DeleteDataCatalogInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import DeleteDataCatalogInputRequestTypeDef
def get_value() -> DeleteDataCatalogInputRequestTypeDef:
return {
"Name": ...,
}
DeleteNamedQueryInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import DeleteNamedQueryInputRequestTypeDef
def get_value() -> DeleteNamedQueryInputRequestTypeDef:
return {
"NamedQueryId": ...,
}
DeleteNotebookInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import DeleteNotebookInputRequestTypeDef
def get_value() -> DeleteNotebookInputRequestTypeDef:
return {
"NotebookId": ...,
}
DeletePreparedStatementInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import DeletePreparedStatementInputRequestTypeDef
def get_value() -> DeletePreparedStatementInputRequestTypeDef:
return {
"StatementName": ...,
"WorkGroup": ...,
}
Definition
class DeletePreparedStatementInputRequestTypeDef(TypedDict):
StatementName: str,
WorkGroup: str,
DeleteWorkGroupInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import DeleteWorkGroupInputRequestTypeDef
def get_value() -> DeleteWorkGroupInputRequestTypeDef:
return {
"WorkGroup": ...,
}
Definition
class DeleteWorkGroupInputRequestTypeDef(TypedDict):
WorkGroup: str,
RecursiveDeleteOption: NotRequired[bool],
EncryptionConfigurationTypeDef
Usage Example
from mypy_boto3_athena.type_defs import EncryptionConfigurationTypeDef
def get_value() -> EncryptionConfigurationTypeDef:
return {
"EncryptionOption": ...,
}
Definition
class EncryptionConfigurationTypeDef(TypedDict):
EncryptionOption: EncryptionOptionType, # (1)
KmsKey: NotRequired[str],
EngineConfigurationTypeDef
Usage Example
from mypy_boto3_athena.type_defs import EngineConfigurationTypeDef
def get_value() -> EngineConfigurationTypeDef:
return {
"MaxConcurrentDpus": ...,
}
Definition
class EngineConfigurationTypeDef(TypedDict):
MaxConcurrentDpus: int,
CoordinatorDpuSize: NotRequired[int],
DefaultExecutorDpuSize: NotRequired[int],
AdditionalConfigs: NotRequired[Dict[str, str]],
EngineVersionTypeDef
Usage Example
from mypy_boto3_athena.type_defs import EngineVersionTypeDef
def get_value() -> EngineVersionTypeDef:
return {
"SelectedEngineVersion": ...,
}
Definition
class EngineVersionTypeDef(TypedDict):
SelectedEngineVersion: NotRequired[str],
EffectiveEngineVersion: NotRequired[str],
ExecutorsSummaryTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ExecutorsSummaryTypeDef
def get_value() -> ExecutorsSummaryTypeDef:
return {
"ExecutorId": ...,
}
Definition
class ExecutorsSummaryTypeDef(TypedDict):
ExecutorId: str,
ExecutorType: NotRequired[ExecutorTypeType], # (1)
StartDateTime: NotRequired[int],
TerminationDateTime: NotRequired[int],
ExecutorState: NotRequired[ExecutorStateType], # (2)
ExecutorSize: NotRequired[int],
- See ExecutorTypeType
- See ExecutorStateType
ExportNotebookInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ExportNotebookInputRequestTypeDef
def get_value() -> ExportNotebookInputRequestTypeDef:
return {
"NotebookId": ...,
}
NotebookMetadataTypeDef
Usage Example
from mypy_boto3_athena.type_defs import NotebookMetadataTypeDef
def get_value() -> NotebookMetadataTypeDef:
return {
"NotebookId": ...,
}
Definition
class NotebookMetadataTypeDef(TypedDict):
NotebookId: NotRequired[str],
Name: NotRequired[str],
WorkGroup: NotRequired[str],
CreationTime: NotRequired[datetime],
Type: NotRequired[NotebookTypeType], # (1)
LastModifiedTime: NotRequired[datetime],
- See NotebookTypeType
FilterDefinitionTypeDef
Usage Example
from mypy_boto3_athena.type_defs import FilterDefinitionTypeDef
def get_value() -> FilterDefinitionTypeDef:
return {
"Name": ...,
}
GetCalculationExecutionCodeRequestRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetCalculationExecutionCodeRequestRequestTypeDef
def get_value() -> GetCalculationExecutionCodeRequestRequestTypeDef:
return {
"CalculationExecutionId": ...,
}
Definition
class GetCalculationExecutionCodeRequestRequestTypeDef(TypedDict):
CalculationExecutionId: str,
GetCalculationExecutionRequestRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetCalculationExecutionRequestRequestTypeDef
def get_value() -> GetCalculationExecutionRequestRequestTypeDef:
return {
"CalculationExecutionId": ...,
}
Definition
class GetCalculationExecutionRequestRequestTypeDef(TypedDict):
CalculationExecutionId: str,
GetCalculationExecutionStatusRequestRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetCalculationExecutionStatusRequestRequestTypeDef
def get_value() -> GetCalculationExecutionStatusRequestRequestTypeDef:
return {
"CalculationExecutionId": ...,
}
Definition
class GetCalculationExecutionStatusRequestRequestTypeDef(TypedDict):
CalculationExecutionId: str,
GetDataCatalogInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetDataCatalogInputRequestTypeDef
def get_value() -> GetDataCatalogInputRequestTypeDef:
return {
"Name": ...,
}
GetDatabaseInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetDatabaseInputRequestTypeDef
def get_value() -> GetDatabaseInputRequestTypeDef:
return {
"CatalogName": ...,
"DatabaseName": ...,
}
GetNamedQueryInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetNamedQueryInputRequestTypeDef
def get_value() -> GetNamedQueryInputRequestTypeDef:
return {
"NamedQueryId": ...,
}
GetNotebookMetadataInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetNotebookMetadataInputRequestTypeDef
def get_value() -> GetNotebookMetadataInputRequestTypeDef:
return {
"NotebookId": ...,
}
GetPreparedStatementInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetPreparedStatementInputRequestTypeDef
def get_value() -> GetPreparedStatementInputRequestTypeDef:
return {
"StatementName": ...,
"WorkGroup": ...,
}
Definition
class GetPreparedStatementInputRequestTypeDef(TypedDict):
StatementName: str,
WorkGroup: str,
GetQueryExecutionInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetQueryExecutionInputRequestTypeDef
def get_value() -> GetQueryExecutionInputRequestTypeDef:
return {
"QueryExecutionId": ...,
}
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_athena.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
GetQueryResultsInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetQueryResultsInputRequestTypeDef
def get_value() -> GetQueryResultsInputRequestTypeDef:
return {
"QueryExecutionId": ...,
}
Definition
class GetQueryResultsInputRequestTypeDef(TypedDict):
QueryExecutionId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
GetQueryRuntimeStatisticsInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetQueryRuntimeStatisticsInputRequestTypeDef
def get_value() -> GetQueryRuntimeStatisticsInputRequestTypeDef:
return {
"QueryExecutionId": ...,
}
GetSessionRequestRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetSessionRequestRequestTypeDef
def get_value() -> GetSessionRequestRequestTypeDef:
return {
"SessionId": ...,
}
SessionStatisticsTypeDef
Usage Example
from mypy_boto3_athena.type_defs import SessionStatisticsTypeDef
def get_value() -> SessionStatisticsTypeDef:
return {
"DpuExecutionInMillis": ...,
}
SessionStatusTypeDef
Usage Example
from mypy_boto3_athena.type_defs import SessionStatusTypeDef
def get_value() -> SessionStatusTypeDef:
return {
"StartDateTime": ...,
}
Definition
class SessionStatusTypeDef(TypedDict):
StartDateTime: NotRequired[datetime],
LastModifiedDateTime: NotRequired[datetime],
EndDateTime: NotRequired[datetime],
IdleSinceDateTime: NotRequired[datetime],
State: NotRequired[SessionStateType], # (1)
StateChangeReason: NotRequired[str],
- See SessionStateType
GetSessionStatusRequestRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetSessionStatusRequestRequestTypeDef
def get_value() -> GetSessionStatusRequestRequestTypeDef:
return {
"SessionId": ...,
}
GetTableMetadataInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetTableMetadataInputRequestTypeDef
def get_value() -> GetTableMetadataInputRequestTypeDef:
return {
"CatalogName": ...,
"DatabaseName": ...,
"TableName": ...,
}
Definition
class GetTableMetadataInputRequestTypeDef(TypedDict):
CatalogName: str,
DatabaseName: str,
TableName: str,
GetWorkGroupInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetWorkGroupInputRequestTypeDef
def get_value() -> GetWorkGroupInputRequestTypeDef:
return {
"WorkGroup": ...,
}
ImportNotebookInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ImportNotebookInputRequestTypeDef
def get_value() -> ImportNotebookInputRequestTypeDef:
return {
"WorkGroup": ...,
"Name": ...,
"Payload": ...,
"Type": ...,
}
Definition
class ImportNotebookInputRequestTypeDef(TypedDict):
WorkGroup: str,
Name: str,
Payload: str,
Type: NotebookTypeType, # (1)
ClientRequestToken: NotRequired[str],
- See NotebookTypeType
ListApplicationDPUSizesInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListApplicationDPUSizesInputRequestTypeDef
def get_value() -> ListApplicationDPUSizesInputRequestTypeDef:
return {
"MaxResults": ...,
}
Definition
class ListApplicationDPUSizesInputRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListCalculationExecutionsRequestRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListCalculationExecutionsRequestRequestTypeDef
def get_value() -> ListCalculationExecutionsRequestRequestTypeDef:
return {
"SessionId": ...,
}
Definition
class ListCalculationExecutionsRequestRequestTypeDef(TypedDict):
SessionId: str,
StateFilter: NotRequired[CalculationExecutionStateType], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListDataCatalogsInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListDataCatalogsInputRequestTypeDef
def get_value() -> ListDataCatalogsInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListDataCatalogsInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListDatabasesInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListDatabasesInputRequestTypeDef
def get_value() -> ListDatabasesInputRequestTypeDef:
return {
"CatalogName": ...,
}
Definition
class ListDatabasesInputRequestTypeDef(TypedDict):
CatalogName: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListEngineVersionsInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListEngineVersionsInputRequestTypeDef
def get_value() -> ListEngineVersionsInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListEngineVersionsInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListExecutorsRequestRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListExecutorsRequestRequestTypeDef
def get_value() -> ListExecutorsRequestRequestTypeDef:
return {
"SessionId": ...,
}
Definition
class ListExecutorsRequestRequestTypeDef(TypedDict):
SessionId: str,
ExecutorStateFilter: NotRequired[ExecutorStateType], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListNamedQueriesInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListNamedQueriesInputRequestTypeDef
def get_value() -> ListNamedQueriesInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListNamedQueriesInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
WorkGroup: NotRequired[str],
ListNotebookSessionsRequestRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListNotebookSessionsRequestRequestTypeDef
def get_value() -> ListNotebookSessionsRequestRequestTypeDef:
return {
"NotebookId": ...,
}
Definition
class ListNotebookSessionsRequestRequestTypeDef(TypedDict):
NotebookId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
NotebookSessionSummaryTypeDef
Usage Example
from mypy_boto3_athena.type_defs import NotebookSessionSummaryTypeDef
def get_value() -> NotebookSessionSummaryTypeDef:
return {
"SessionId": ...,
}
Definition
class NotebookSessionSummaryTypeDef(TypedDict):
SessionId: NotRequired[str],
CreationTime: NotRequired[datetime],
ListPreparedStatementsInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListPreparedStatementsInputRequestTypeDef
def get_value() -> ListPreparedStatementsInputRequestTypeDef:
return {
"WorkGroup": ...,
}
Definition
class ListPreparedStatementsInputRequestTypeDef(TypedDict):
WorkGroup: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
PreparedStatementSummaryTypeDef
Usage Example
from mypy_boto3_athena.type_defs import PreparedStatementSummaryTypeDef
def get_value() -> PreparedStatementSummaryTypeDef:
return {
"StatementName": ...,
}
Definition
class PreparedStatementSummaryTypeDef(TypedDict):
StatementName: NotRequired[str],
LastModifiedTime: NotRequired[datetime],
ListQueryExecutionsInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListQueryExecutionsInputRequestTypeDef
def get_value() -> ListQueryExecutionsInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListQueryExecutionsInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
WorkGroup: NotRequired[str],
ListSessionsRequestRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListSessionsRequestRequestTypeDef
def get_value() -> ListSessionsRequestRequestTypeDef:
return {
"WorkGroup": ...,
}
Definition
class ListSessionsRequestRequestTypeDef(TypedDict):
WorkGroup: str,
StateFilter: NotRequired[SessionStateType], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
- See SessionStateType
ListTableMetadataInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListTableMetadataInputRequestTypeDef
def get_value() -> ListTableMetadataInputRequestTypeDef:
return {
"CatalogName": ...,
"DatabaseName": ...,
}
Definition
class ListTableMetadataInputRequestTypeDef(TypedDict):
CatalogName: str,
DatabaseName: str,
Expression: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListTagsForResourceInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListTagsForResourceInputRequestTypeDef
def get_value() -> ListTagsForResourceInputRequestTypeDef:
return {
"ResourceARN": ...,
}
Definition
class ListTagsForResourceInputRequestTypeDef(TypedDict):
ResourceARN: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListWorkGroupsInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListWorkGroupsInputRequestTypeDef
def get_value() -> ListWorkGroupsInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListWorkGroupsInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
QueryExecutionContextTypeDef
Usage Example
from mypy_boto3_athena.type_defs import QueryExecutionContextTypeDef
def get_value() -> QueryExecutionContextTypeDef:
return {
"Database": ...,
}
Definition
class QueryExecutionContextTypeDef(TypedDict):
Database: NotRequired[str],
Catalog: NotRequired[str],
ResultReuseInformationTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ResultReuseInformationTypeDef
def get_value() -> ResultReuseInformationTypeDef:
return {
"ReusedPreviousResult": ...,
}
QueryRuntimeStatisticsRowsTypeDef
Usage Example
from mypy_boto3_athena.type_defs import QueryRuntimeStatisticsRowsTypeDef
def get_value() -> QueryRuntimeStatisticsRowsTypeDef:
return {
"InputRows": ...,
}
Definition
class QueryRuntimeStatisticsRowsTypeDef(TypedDict):
InputRows: NotRequired[int],
InputBytes: NotRequired[int],
OutputBytes: NotRequired[int],
OutputRows: NotRequired[int],
QueryRuntimeStatisticsTimelineTypeDef
Usage Example
from mypy_boto3_athena.type_defs import QueryRuntimeStatisticsTimelineTypeDef
def get_value() -> QueryRuntimeStatisticsTimelineTypeDef:
return {
"QueryQueueTimeInMillis": ...,
}
Definition
class QueryRuntimeStatisticsTimelineTypeDef(TypedDict):
QueryQueueTimeInMillis: NotRequired[int],
QueryPlanningTimeInMillis: NotRequired[int],
EngineExecutionTimeInMillis: NotRequired[int],
ServiceProcessingTimeInMillis: NotRequired[int],
TotalExecutionTimeInMillis: NotRequired[int],
QueryStagePlanNodeTypeDef
Usage Example
from mypy_boto3_athena.type_defs import QueryStagePlanNodeTypeDef
def get_value() -> QueryStagePlanNodeTypeDef:
return {
"Name": ...,
}
Definition
class QueryStagePlanNodeTypeDef(TypedDict):
Name: NotRequired[str],
Identifier: NotRequired[str],
Children: NotRequired[List[QueryStagePlanNodeTypeDef]], # (1)
RemoteSources: NotRequired[List[str]],
QueryStageTypeDef
Usage Example
from mypy_boto3_athena.type_defs import QueryStageTypeDef
def get_value() -> QueryStageTypeDef:
return {
"StageId": ...,
}
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[QueryStageTypeDef]], # (2)
ResultReuseByAgeConfigurationTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ResultReuseByAgeConfigurationTypeDef
def get_value() -> ResultReuseByAgeConfigurationTypeDef:
return {
"Enabled": ...,
}
Definition
class ResultReuseByAgeConfigurationTypeDef(TypedDict):
Enabled: bool,
MaxAgeInMinutes: NotRequired[int],
StopCalculationExecutionRequestRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import StopCalculationExecutionRequestRequestTypeDef
def get_value() -> StopCalculationExecutionRequestRequestTypeDef:
return {
"CalculationExecutionId": ...,
}
Definition
class StopCalculationExecutionRequestRequestTypeDef(TypedDict):
CalculationExecutionId: str,
StopQueryExecutionInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import StopQueryExecutionInputRequestTypeDef
def get_value() -> StopQueryExecutionInputRequestTypeDef:
return {
"QueryExecutionId": ...,
}
TerminateSessionRequestRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import TerminateSessionRequestRequestTypeDef
def get_value() -> TerminateSessionRequestRequestTypeDef:
return {
"SessionId": ...,
}
UntagResourceInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import UntagResourceInputRequestTypeDef
def get_value() -> UntagResourceInputRequestTypeDef:
return {
"ResourceARN": ...,
"TagKeys": ...,
}
Definition
class UntagResourceInputRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateDataCatalogInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import UpdateDataCatalogInputRequestTypeDef
def get_value() -> UpdateDataCatalogInputRequestTypeDef:
return {
"Name": ...,
"Type": ...,
}
Definition
class UpdateDataCatalogInputRequestTypeDef(TypedDict):
Name: str,
Type: DataCatalogTypeType, # (1)
Description: NotRequired[str],
Parameters: NotRequired[Mapping[str, str]],
UpdateNamedQueryInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import UpdateNamedQueryInputRequestTypeDef
def get_value() -> UpdateNamedQueryInputRequestTypeDef:
return {
"NamedQueryId": ...,
"Name": ...,
"QueryString": ...,
}
Definition
class UpdateNamedQueryInputRequestTypeDef(TypedDict):
NamedQueryId: str,
Name: str,
QueryString: str,
Description: NotRequired[str],
UpdateNotebookInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import UpdateNotebookInputRequestTypeDef
def get_value() -> UpdateNotebookInputRequestTypeDef:
return {
"NotebookId": ...,
"Payload": ...,
"Type": ...,
}
Definition
class UpdateNotebookInputRequestTypeDef(TypedDict):
NotebookId: str,
Payload: str,
Type: NotebookTypeType, # (1)
SessionId: NotRequired[str],
ClientRequestToken: NotRequired[str],
- See NotebookTypeType
UpdateNotebookMetadataInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import UpdateNotebookMetadataInputRequestTypeDef
def get_value() -> UpdateNotebookMetadataInputRequestTypeDef:
return {
"NotebookId": ...,
"Name": ...,
}
Definition
class UpdateNotebookMetadataInputRequestTypeDef(TypedDict):
NotebookId: str,
Name: str,
ClientRequestToken: NotRequired[str],
UpdatePreparedStatementInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import UpdatePreparedStatementInputRequestTypeDef
def get_value() -> UpdatePreparedStatementInputRequestTypeDef:
return {
"StatementName": ...,
"WorkGroup": ...,
"QueryStatement": ...,
}
Definition
class UpdatePreparedStatementInputRequestTypeDef(TypedDict):
StatementName: str,
WorkGroup: str,
QueryStatement: str,
Description: NotRequired[str],
QueryExecutionStatusTypeDef
Usage Example
from mypy_boto3_athena.type_defs import QueryExecutionStatusTypeDef
def get_value() -> QueryExecutionStatusTypeDef:
return {
"State": ...,
}
Definition
class QueryExecutionStatusTypeDef(TypedDict):
State: NotRequired[QueryExecutionStateType], # (1)
StateChangeReason: NotRequired[str],
SubmissionDateTime: NotRequired[datetime],
CompletionDateTime: NotRequired[datetime],
AthenaError: NotRequired[AthenaErrorTypeDef], # (2)
CreateNamedQueryOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import CreateNamedQueryOutputTypeDef
def get_value() -> CreateNamedQueryOutputTypeDef:
return {
"NamedQueryId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateNamedQueryOutputTypeDef(TypedDict):
NamedQueryId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateNotebookOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import CreateNotebookOutputTypeDef
def get_value() -> CreateNotebookOutputTypeDef:
return {
"NotebookId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateNotebookOutputTypeDef(TypedDict):
NotebookId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreatePresignedNotebookUrlResponseTypeDef
Usage Example
from mypy_boto3_athena.type_defs import CreatePresignedNotebookUrlResponseTypeDef
def get_value() -> CreatePresignedNotebookUrlResponseTypeDef:
return {
"NotebookUrl": ...,
"AuthToken": ...,
"AuthTokenExpirationTime": ...,
"ResponseMetadata": ...,
}
Definition
class CreatePresignedNotebookUrlResponseTypeDef(TypedDict):
NotebookUrl: str,
AuthToken: str,
AuthTokenExpirationTime: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetCalculationExecutionCodeResponseTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetCalculationExecutionCodeResponseTypeDef
def get_value() -> GetCalculationExecutionCodeResponseTypeDef:
return {
"CodeBlock": ...,
"ResponseMetadata": ...,
}
Definition
class GetCalculationExecutionCodeResponseTypeDef(TypedDict):
CodeBlock: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetNamedQueryOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetNamedQueryOutputTypeDef
def get_value() -> GetNamedQueryOutputTypeDef:
return {
"NamedQuery": ...,
"ResponseMetadata": ...,
}
Definition
class GetNamedQueryOutputTypeDef(TypedDict):
NamedQuery: NamedQueryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ImportNotebookOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ImportNotebookOutputTypeDef
def get_value() -> ImportNotebookOutputTypeDef:
return {
"NotebookId": ...,
"ResponseMetadata": ...,
}
Definition
class ImportNotebookOutputTypeDef(TypedDict):
NotebookId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListApplicationDPUSizesOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListApplicationDPUSizesOutputTypeDef
def get_value() -> ListApplicationDPUSizesOutputTypeDef:
return {
"ApplicationDPUSizes": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListApplicationDPUSizesOutputTypeDef(TypedDict):
ApplicationDPUSizes: List[ApplicationDPUSizesTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListNamedQueriesOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListNamedQueriesOutputTypeDef
def get_value() -> ListNamedQueriesOutputTypeDef:
return {
"NamedQueryIds": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListNamedQueriesOutputTypeDef(TypedDict):
NamedQueryIds: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListQueryExecutionsOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListQueryExecutionsOutputTypeDef
def get_value() -> ListQueryExecutionsOutputTypeDef:
return {
"QueryExecutionIds": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListQueryExecutionsOutputTypeDef(TypedDict):
QueryExecutionIds: List[str],
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartCalculationExecutionResponseTypeDef
Usage Example
from mypy_boto3_athena.type_defs import StartCalculationExecutionResponseTypeDef
def get_value() -> StartCalculationExecutionResponseTypeDef:
return {
"CalculationExecutionId": ...,
"State": ...,
"ResponseMetadata": ...,
}
Definition
class StartCalculationExecutionResponseTypeDef(TypedDict):
CalculationExecutionId: str,
State: CalculationExecutionStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartQueryExecutionOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import StartQueryExecutionOutputTypeDef
def get_value() -> StartQueryExecutionOutputTypeDef:
return {
"QueryExecutionId": ...,
"ResponseMetadata": ...,
}
Definition
class StartQueryExecutionOutputTypeDef(TypedDict):
QueryExecutionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartSessionResponseTypeDef
Usage Example
from mypy_boto3_athena.type_defs import StartSessionResponseTypeDef
def get_value() -> StartSessionResponseTypeDef:
return {
"SessionId": ...,
"State": ...,
"ResponseMetadata": ...,
}
Definition
class StartSessionResponseTypeDef(TypedDict):
SessionId: str,
State: SessionStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StopCalculationExecutionResponseTypeDef
Usage Example
from mypy_boto3_athena.type_defs import StopCalculationExecutionResponseTypeDef
def get_value() -> StopCalculationExecutionResponseTypeDef:
return {
"State": ...,
"ResponseMetadata": ...,
}
Definition
class StopCalculationExecutionResponseTypeDef(TypedDict):
State: CalculationExecutionStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TerminateSessionResponseTypeDef
Usage Example
from mypy_boto3_athena.type_defs import TerminateSessionResponseTypeDef
def get_value() -> TerminateSessionResponseTypeDef:
return {
"State": ...,
"ResponseMetadata": ...,
}
Definition
class TerminateSessionResponseTypeDef(TypedDict):
State: SessionStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchGetNamedQueryOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import BatchGetNamedQueryOutputTypeDef
def get_value() -> BatchGetNamedQueryOutputTypeDef:
return {
"NamedQueries": ...,
"UnprocessedNamedQueryIds": ...,
"ResponseMetadata": ...,
}
Definition
class BatchGetNamedQueryOutputTypeDef(TypedDict):
NamedQueries: List[NamedQueryTypeDef], # (1)
UnprocessedNamedQueryIds: List[UnprocessedNamedQueryIdTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetPreparedStatementOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetPreparedStatementOutputTypeDef
def get_value() -> GetPreparedStatementOutputTypeDef:
return {
"PreparedStatement": ...,
"ResponseMetadata": ...,
}
Definition
class GetPreparedStatementOutputTypeDef(TypedDict):
PreparedStatement: PreparedStatementTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchGetPreparedStatementOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import BatchGetPreparedStatementOutputTypeDef
def get_value() -> BatchGetPreparedStatementOutputTypeDef:
return {
"PreparedStatements": ...,
"UnprocessedPreparedStatementNames": ...,
"ResponseMetadata": ...,
}
Definition
class BatchGetPreparedStatementOutputTypeDef(TypedDict):
PreparedStatements: List[PreparedStatementTypeDef], # (1)
UnprocessedPreparedStatementNames: List[UnprocessedPreparedStatementNameTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See PreparedStatementTypeDef
- See UnprocessedPreparedStatementNameTypeDef
- See ResponseMetadataTypeDef
StartCalculationExecutionRequestRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import StartCalculationExecutionRequestRequestTypeDef
def get_value() -> StartCalculationExecutionRequestRequestTypeDef:
return {
"SessionId": ...,
}
Definition
class StartCalculationExecutionRequestRequestTypeDef(TypedDict):
SessionId: str,
Description: NotRequired[str],
CalculationConfiguration: NotRequired[CalculationConfigurationTypeDef], # (1)
CodeBlock: NotRequired[str],
ClientRequestToken: NotRequired[str],
CalculationSummaryTypeDef
Usage Example
from mypy_boto3_athena.type_defs import CalculationSummaryTypeDef
def get_value() -> CalculationSummaryTypeDef:
return {
"CalculationExecutionId": ...,
}
Definition
class CalculationSummaryTypeDef(TypedDict):
CalculationExecutionId: NotRequired[str],
Description: NotRequired[str],
Status: NotRequired[CalculationStatusTypeDef], # (1)
GetCalculationExecutionResponseTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetCalculationExecutionResponseTypeDef
def get_value() -> GetCalculationExecutionResponseTypeDef:
return {
"CalculationExecutionId": ...,
"SessionId": ...,
"Description": ...,
"WorkingDirectory": ...,
"Status": ...,
"Statistics": ...,
"Result": ...,
"ResponseMetadata": ...,
}
Definition
class GetCalculationExecutionResponseTypeDef(TypedDict):
CalculationExecutionId: str,
SessionId: str,
Description: str,
WorkingDirectory: str,
Status: CalculationStatusTypeDef, # (1)
Statistics: CalculationStatisticsTypeDef, # (2)
Result: CalculationResultTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See CalculationStatusTypeDef
- See CalculationStatisticsTypeDef
- See CalculationResultTypeDef
- See ResponseMetadataTypeDef
GetCalculationExecutionStatusResponseTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetCalculationExecutionStatusResponseTypeDef
def get_value() -> GetCalculationExecutionStatusResponseTypeDef:
return {
"Status": ...,
"Statistics": ...,
"ResponseMetadata": ...,
}
Definition
class GetCalculationExecutionStatusResponseTypeDef(TypedDict):
Status: CalculationStatusTypeDef, # (1)
Statistics: CalculationStatisticsTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ResultSetMetadataTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ResultSetMetadataTypeDef
def get_value() -> ResultSetMetadataTypeDef:
return {
"ColumnInfo": ...,
}
Definition
class ResultSetMetadataTypeDef(TypedDict):
ColumnInfo: NotRequired[List[ColumnInfoTypeDef]], # (1)
TableMetadataTypeDef
Usage Example
from mypy_boto3_athena.type_defs import TableMetadataTypeDef
def get_value() -> TableMetadataTypeDef:
return {
"Name": ...,
}
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]],
- See ColumnTypeDef
- See ColumnTypeDef
CreateDataCatalogInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import CreateDataCatalogInputRequestTypeDef
def get_value() -> CreateDataCatalogInputRequestTypeDef:
return {
"Name": ...,
"Type": ...,
}
Definition
class CreateDataCatalogInputRequestTypeDef(TypedDict):
Name: str,
Type: DataCatalogTypeType, # (1)
Description: NotRequired[str],
Parameters: NotRequired[Mapping[str, str]],
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See DataCatalogTypeType
- See TagTypeDef
ListTagsForResourceOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListTagsForResourceOutputTypeDef
def get_value() -> ListTagsForResourceOutputTypeDef:
return {
"Tags": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceOutputTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import TagResourceInputRequestTypeDef
def get_value() -> TagResourceInputRequestTypeDef:
return {
"ResourceARN": ...,
"Tags": ...,
}
Definition
class TagResourceInputRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
ListDataCatalogsOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListDataCatalogsOutputTypeDef
def get_value() -> ListDataCatalogsOutputTypeDef:
return {
"DataCatalogsSummary": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListDataCatalogsOutputTypeDef(TypedDict):
DataCatalogsSummary: List[DataCatalogSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetDataCatalogOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetDataCatalogOutputTypeDef
def get_value() -> GetDataCatalogOutputTypeDef:
return {
"DataCatalog": ...,
"ResponseMetadata": ...,
}
Definition
class GetDataCatalogOutputTypeDef(TypedDict):
DataCatalog: DataCatalogTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetDatabaseOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetDatabaseOutputTypeDef
def get_value() -> GetDatabaseOutputTypeDef:
return {
"Database": ...,
"ResponseMetadata": ...,
}
Definition
class GetDatabaseOutputTypeDef(TypedDict):
Database: DatabaseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDatabasesOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListDatabasesOutputTypeDef
def get_value() -> ListDatabasesOutputTypeDef:
return {
"DatabaseList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListDatabasesOutputTypeDef(TypedDict):
DatabaseList: List[DatabaseTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RowTypeDef
Usage Example
from mypy_boto3_athena.type_defs import RowTypeDef
def get_value() -> RowTypeDef:
return {
"Data": ...,
}
- See DatumTypeDef
ResultConfigurationTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ResultConfigurationTypeDef
def get_value() -> ResultConfigurationTypeDef:
return {
"OutputLocation": ...,
}
Definition
class ResultConfigurationTypeDef(TypedDict):
OutputLocation: NotRequired[str],
EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef], # (1)
ExpectedBucketOwner: NotRequired[str],
AclConfiguration: NotRequired[AclConfigurationTypeDef], # (2)
ResultConfigurationUpdatesTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ResultConfigurationUpdatesTypeDef
def get_value() -> ResultConfigurationUpdatesTypeDef:
return {
"OutputLocation": ...,
}
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],
SessionConfigurationTypeDef
Usage Example
from mypy_boto3_athena.type_defs import SessionConfigurationTypeDef
def get_value() -> SessionConfigurationTypeDef:
return {
"ExecutionRole": ...,
}
Definition
class SessionConfigurationTypeDef(TypedDict):
ExecutionRole: NotRequired[str],
WorkingDirectory: NotRequired[str],
IdleTimeoutSeconds: NotRequired[int],
EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef], # (1)
StartSessionRequestRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import StartSessionRequestRequestTypeDef
def get_value() -> StartSessionRequestRequestTypeDef:
return {
"WorkGroup": ...,
"EngineConfiguration": ...,
}
Definition
class StartSessionRequestRequestTypeDef(TypedDict):
WorkGroup: str,
EngineConfiguration: EngineConfigurationTypeDef, # (1)
Description: NotRequired[str],
NotebookVersion: NotRequired[str],
SessionIdleTimeoutInMinutes: NotRequired[int],
ClientRequestToken: NotRequired[str],
ListEngineVersionsOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListEngineVersionsOutputTypeDef
def get_value() -> ListEngineVersionsOutputTypeDef:
return {
"EngineVersions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListEngineVersionsOutputTypeDef(TypedDict):
EngineVersions: List[EngineVersionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
WorkGroupSummaryTypeDef
Usage Example
from mypy_boto3_athena.type_defs import WorkGroupSummaryTypeDef
def get_value() -> WorkGroupSummaryTypeDef:
return {
"Name": ...,
}
Definition
class WorkGroupSummaryTypeDef(TypedDict):
Name: NotRequired[str],
State: NotRequired[WorkGroupStateType], # (1)
Description: NotRequired[str],
CreationTime: NotRequired[datetime],
EngineVersion: NotRequired[EngineVersionTypeDef], # (2)
ListExecutorsResponseTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListExecutorsResponseTypeDef
def get_value() -> ListExecutorsResponseTypeDef:
return {
"SessionId": ...,
"NextToken": ...,
"ExecutorsSummary": ...,
"ResponseMetadata": ...,
}
Definition
class ListExecutorsResponseTypeDef(TypedDict):
SessionId: str,
NextToken: str,
ExecutorsSummary: List[ExecutorsSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ExportNotebookOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ExportNotebookOutputTypeDef
def get_value() -> ExportNotebookOutputTypeDef:
return {
"NotebookMetadata": ...,
"Payload": ...,
"ResponseMetadata": ...,
}
Definition
class ExportNotebookOutputTypeDef(TypedDict):
NotebookMetadata: NotebookMetadataTypeDef, # (1)
Payload: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetNotebookMetadataOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetNotebookMetadataOutputTypeDef
def get_value() -> GetNotebookMetadataOutputTypeDef:
return {
"NotebookMetadata": ...,
"ResponseMetadata": ...,
}
Definition
class GetNotebookMetadataOutputTypeDef(TypedDict):
NotebookMetadata: NotebookMetadataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListNotebookMetadataOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListNotebookMetadataOutputTypeDef
def get_value() -> ListNotebookMetadataOutputTypeDef:
return {
"NextToken": ...,
"NotebookMetadataList": ...,
"ResponseMetadata": ...,
}
Definition
class ListNotebookMetadataOutputTypeDef(TypedDict):
NextToken: str,
NotebookMetadataList: List[NotebookMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListNotebookMetadataInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListNotebookMetadataInputRequestTypeDef
def get_value() -> ListNotebookMetadataInputRequestTypeDef:
return {
"WorkGroup": ...,
}
Definition
class ListNotebookMetadataInputRequestTypeDef(TypedDict):
WorkGroup: str,
Filters: NotRequired[FilterDefinitionTypeDef], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
GetQueryResultsInputGetQueryResultsPaginateTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetQueryResultsInputGetQueryResultsPaginateTypeDef
def get_value() -> GetQueryResultsInputGetQueryResultsPaginateTypeDef:
return {
"QueryExecutionId": ...,
}
Definition
class GetQueryResultsInputGetQueryResultsPaginateTypeDef(TypedDict):
QueryExecutionId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDataCatalogsInputListDataCatalogsPaginateTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListDataCatalogsInputListDataCatalogsPaginateTypeDef
def get_value() -> ListDataCatalogsInputListDataCatalogsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListDataCatalogsInputListDataCatalogsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDatabasesInputListDatabasesPaginateTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListDatabasesInputListDatabasesPaginateTypeDef
def get_value() -> ListDatabasesInputListDatabasesPaginateTypeDef:
return {
"CatalogName": ...,
}
Definition
class ListDatabasesInputListDatabasesPaginateTypeDef(TypedDict):
CatalogName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListNamedQueriesInputListNamedQueriesPaginateTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListNamedQueriesInputListNamedQueriesPaginateTypeDef
def get_value() -> ListNamedQueriesInputListNamedQueriesPaginateTypeDef:
return {
"WorkGroup": ...,
}
Definition
class ListNamedQueriesInputListNamedQueriesPaginateTypeDef(TypedDict):
WorkGroup: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListQueryExecutionsInputListQueryExecutionsPaginateTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListQueryExecutionsInputListQueryExecutionsPaginateTypeDef
def get_value() -> ListQueryExecutionsInputListQueryExecutionsPaginateTypeDef:
return {
"WorkGroup": ...,
}
Definition
class ListQueryExecutionsInputListQueryExecutionsPaginateTypeDef(TypedDict):
WorkGroup: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTableMetadataInputListTableMetadataPaginateTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListTableMetadataInputListTableMetadataPaginateTypeDef
def get_value() -> ListTableMetadataInputListTableMetadataPaginateTypeDef:
return {
"CatalogName": ...,
"DatabaseName": ...,
}
Definition
class ListTableMetadataInputListTableMetadataPaginateTypeDef(TypedDict):
CatalogName: str,
DatabaseName: str,
Expression: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTagsForResourceInputListTagsForResourcePaginateTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListTagsForResourceInputListTagsForResourcePaginateTypeDef
def get_value() -> ListTagsForResourceInputListTagsForResourcePaginateTypeDef:
return {
"ResourceARN": ...,
}
Definition
class ListTagsForResourceInputListTagsForResourcePaginateTypeDef(TypedDict):
ResourceARN: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetSessionStatusResponseTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetSessionStatusResponseTypeDef
def get_value() -> GetSessionStatusResponseTypeDef:
return {
"SessionId": ...,
"Status": ...,
"ResponseMetadata": ...,
}
Definition
class GetSessionStatusResponseTypeDef(TypedDict):
SessionId: str,
Status: SessionStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SessionSummaryTypeDef
Usage Example
from mypy_boto3_athena.type_defs import SessionSummaryTypeDef
def get_value() -> SessionSummaryTypeDef:
return {
"SessionId": ...,
}
Definition
class SessionSummaryTypeDef(TypedDict):
SessionId: NotRequired[str],
Description: NotRequired[str],
EngineVersion: NotRequired[EngineVersionTypeDef], # (1)
NotebookVersion: NotRequired[str],
Status: NotRequired[SessionStatusTypeDef], # (2)
ListNotebookSessionsResponseTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListNotebookSessionsResponseTypeDef
def get_value() -> ListNotebookSessionsResponseTypeDef:
return {
"NotebookSessionsList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListNotebookSessionsResponseTypeDef(TypedDict):
NotebookSessionsList: List[NotebookSessionSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListPreparedStatementsOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListPreparedStatementsOutputTypeDef
def get_value() -> ListPreparedStatementsOutputTypeDef:
return {
"PreparedStatements": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListPreparedStatementsOutputTypeDef(TypedDict):
PreparedStatements: List[PreparedStatementSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
QueryExecutionStatisticsTypeDef
Usage Example
from mypy_boto3_athena.type_defs import QueryExecutionStatisticsTypeDef
def get_value() -> QueryExecutionStatisticsTypeDef:
return {
"EngineExecutionTimeInMillis": ...,
}
Definition
class QueryExecutionStatisticsTypeDef(TypedDict):
EngineExecutionTimeInMillis: NotRequired[int],
DataScannedInBytes: NotRequired[int],
DataManifestLocation: NotRequired[str],
TotalExecutionTimeInMillis: NotRequired[int],
QueryQueueTimeInMillis: NotRequired[int],
QueryPlanningTimeInMillis: NotRequired[int],
ServiceProcessingTimeInMillis: NotRequired[int],
ResultReuseInformation: NotRequired[ResultReuseInformationTypeDef], # (1)
QueryRuntimeStatisticsTypeDef
Usage Example
from mypy_boto3_athena.type_defs import QueryRuntimeStatisticsTypeDef
def get_value() -> QueryRuntimeStatisticsTypeDef:
return {
"Timeline": ...,
}
Definition
class QueryRuntimeStatisticsTypeDef(TypedDict):
Timeline: NotRequired[QueryRuntimeStatisticsTimelineTypeDef], # (1)
Rows: NotRequired[QueryRuntimeStatisticsRowsTypeDef], # (2)
OutputStage: NotRequired[QueryStageTypeDef], # (3)
- See QueryRuntimeStatisticsTimelineTypeDef
- See QueryRuntimeStatisticsRowsTypeDef
- See QueryStageTypeDef
ResultReuseConfigurationTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ResultReuseConfigurationTypeDef
def get_value() -> ResultReuseConfigurationTypeDef:
return {
"ResultReuseByAgeConfiguration": ...,
}
Definition
class ResultReuseConfigurationTypeDef(TypedDict):
ResultReuseByAgeConfiguration: NotRequired[ResultReuseByAgeConfigurationTypeDef], # (1)
ListCalculationExecutionsResponseTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListCalculationExecutionsResponseTypeDef
def get_value() -> ListCalculationExecutionsResponseTypeDef:
return {
"NextToken": ...,
"Calculations": ...,
"ResponseMetadata": ...,
}
Definition
class ListCalculationExecutionsResponseTypeDef(TypedDict):
NextToken: str,
Calculations: List[CalculationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetTableMetadataOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetTableMetadataOutputTypeDef
def get_value() -> GetTableMetadataOutputTypeDef:
return {
"TableMetadata": ...,
"ResponseMetadata": ...,
}
Definition
class GetTableMetadataOutputTypeDef(TypedDict):
TableMetadata: TableMetadataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTableMetadataOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListTableMetadataOutputTypeDef
def get_value() -> ListTableMetadataOutputTypeDef:
return {
"TableMetadataList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListTableMetadataOutputTypeDef(TypedDict):
TableMetadataList: List[TableMetadataTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ResultSetTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ResultSetTypeDef
def get_value() -> ResultSetTypeDef:
return {
"Rows": ...,
}
Definition
class ResultSetTypeDef(TypedDict):
Rows: NotRequired[List[RowTypeDef]], # (1)
ResultSetMetadata: NotRequired[ResultSetMetadataTypeDef], # (2)
- See RowTypeDef
- See ResultSetMetadataTypeDef
WorkGroupConfigurationTypeDef
Usage Example
from mypy_boto3_athena.type_defs import WorkGroupConfigurationTypeDef
def get_value() -> WorkGroupConfigurationTypeDef:
return {
"ResultConfiguration": ...,
}
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)
- See ResultConfigurationTypeDef
- See EngineVersionTypeDef
- See CustomerContentEncryptionConfigurationTypeDef
WorkGroupConfigurationUpdatesTypeDef
Usage Example
from mypy_boto3_athena.type_defs import WorkGroupConfigurationUpdatesTypeDef
def get_value() -> WorkGroupConfigurationUpdatesTypeDef:
return {
"EnforceWorkGroupConfiguration": ...,
}
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)
- See ResultConfigurationUpdatesTypeDef
- See EngineVersionTypeDef
- See CustomerContentEncryptionConfigurationTypeDef
GetSessionResponseTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetSessionResponseTypeDef
def get_value() -> GetSessionResponseTypeDef:
return {
"SessionId": ...,
"Description": ...,
"WorkGroup": ...,
"EngineVersion": ...,
"EngineConfiguration": ...,
"NotebookVersion": ...,
"SessionConfiguration": ...,
"Status": ...,
"Statistics": ...,
"ResponseMetadata": ...,
}
Definition
class GetSessionResponseTypeDef(TypedDict):
SessionId: str,
Description: str,
WorkGroup: str,
EngineVersion: str,
EngineConfiguration: EngineConfigurationTypeDef, # (1)
NotebookVersion: str,
SessionConfiguration: SessionConfigurationTypeDef, # (2)
Status: SessionStatusTypeDef, # (3)
Statistics: SessionStatisticsTypeDef, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See EngineConfigurationTypeDef
- See SessionConfigurationTypeDef
- See SessionStatusTypeDef
- See SessionStatisticsTypeDef
- See ResponseMetadataTypeDef
ListWorkGroupsOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListWorkGroupsOutputTypeDef
def get_value() -> ListWorkGroupsOutputTypeDef:
return {
"WorkGroups": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListWorkGroupsOutputTypeDef(TypedDict):
WorkGroups: List[WorkGroupSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSessionsResponseTypeDef
Usage Example
from mypy_boto3_athena.type_defs import ListSessionsResponseTypeDef
def get_value() -> ListSessionsResponseTypeDef:
return {
"NextToken": ...,
"Sessions": ...,
"ResponseMetadata": ...,
}
Definition
class ListSessionsResponseTypeDef(TypedDict):
NextToken: str,
Sessions: List[SessionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetQueryRuntimeStatisticsOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetQueryRuntimeStatisticsOutputTypeDef
def get_value() -> GetQueryRuntimeStatisticsOutputTypeDef:
return {
"QueryRuntimeStatistics": ...,
"ResponseMetadata": ...,
}
Definition
class GetQueryRuntimeStatisticsOutputTypeDef(TypedDict):
QueryRuntimeStatistics: QueryRuntimeStatisticsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
QueryExecutionTypeDef
Usage Example
from mypy_boto3_athena.type_defs import QueryExecutionTypeDef
def get_value() -> QueryExecutionTypeDef:
return {
"QueryExecutionId": ...,
}
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],
- See StatementTypeType
- See ResultConfigurationTypeDef
- See ResultReuseConfigurationTypeDef
- See QueryExecutionContextTypeDef
- See QueryExecutionStatusTypeDef
- See QueryExecutionStatisticsTypeDef
- See EngineVersionTypeDef
StartQueryExecutionInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import StartQueryExecutionInputRequestTypeDef
def get_value() -> StartQueryExecutionInputRequestTypeDef:
return {
"QueryString": ...,
}
Definition
class StartQueryExecutionInputRequestTypeDef(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)
GetQueryResultsOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetQueryResultsOutputTypeDef
def get_value() -> GetQueryResultsOutputTypeDef:
return {
"UpdateCount": ...,
"ResultSet": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class GetQueryResultsOutputTypeDef(TypedDict):
UpdateCount: int,
ResultSet: ResultSetTypeDef, # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateWorkGroupInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import CreateWorkGroupInputRequestTypeDef
def get_value() -> CreateWorkGroupInputRequestTypeDef:
return {
"Name": ...,
}
Definition
class CreateWorkGroupInputRequestTypeDef(TypedDict):
Name: str,
Configuration: NotRequired[WorkGroupConfigurationTypeDef], # (1)
Description: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
WorkGroupTypeDef
Usage Example
from mypy_boto3_athena.type_defs import WorkGroupTypeDef
def get_value() -> WorkGroupTypeDef:
return {
"Name": ...,
}
Definition
class WorkGroupTypeDef(TypedDict):
Name: str,
State: NotRequired[WorkGroupStateType], # (1)
Configuration: NotRequired[WorkGroupConfigurationTypeDef], # (2)
Description: NotRequired[str],
CreationTime: NotRequired[datetime],
UpdateWorkGroupInputRequestTypeDef
Usage Example
from mypy_boto3_athena.type_defs import UpdateWorkGroupInputRequestTypeDef
def get_value() -> UpdateWorkGroupInputRequestTypeDef:
return {
"WorkGroup": ...,
}
Definition
class UpdateWorkGroupInputRequestTypeDef(TypedDict):
WorkGroup: str,
Description: NotRequired[str],
ConfigurationUpdates: NotRequired[WorkGroupConfigurationUpdatesTypeDef], # (1)
State: NotRequired[WorkGroupStateType], # (2)
BatchGetQueryExecutionOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import BatchGetQueryExecutionOutputTypeDef
def get_value() -> BatchGetQueryExecutionOutputTypeDef:
return {
"QueryExecutions": ...,
"UnprocessedQueryExecutionIds": ...,
"ResponseMetadata": ...,
}
Definition
class BatchGetQueryExecutionOutputTypeDef(TypedDict):
QueryExecutions: List[QueryExecutionTypeDef], # (1)
UnprocessedQueryExecutionIds: List[UnprocessedQueryExecutionIdTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetQueryExecutionOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetQueryExecutionOutputTypeDef
def get_value() -> GetQueryExecutionOutputTypeDef:
return {
"QueryExecution": ...,
"ResponseMetadata": ...,
}
Definition
class GetQueryExecutionOutputTypeDef(TypedDict):
QueryExecution: QueryExecutionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetWorkGroupOutputTypeDef
Usage Example
from mypy_boto3_athena.type_defs import GetWorkGroupOutputTypeDef
def get_value() -> GetWorkGroupOutputTypeDef:
return {
"WorkGroup": ...,
"ResponseMetadata": ...,
}