Skip to content

Athena Classes

AclConfiguration

S3AclOption

  • Type: typing.Literal['BUCKET_OWNER_FULL_CONTROL']
  • Required: Yes

ApplicationDPUSizes

ApplicationRuntimeId

  • Type: typing.Optional[str]

SupportedDPUSizes

  • Type: typing.Optional[typing.List[int]]

AthenaError

ErrorCategory

  • Type: typing.Optional[int]

ErrorType

  • Type: typing.Optional[int]

Retryable

  • Type: typing.Optional[bool]

ErrorMessage

  • Type: typing.Optional[str]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BatchGetNamedQueryInput

NamedQueryIds

  • Type: typing.List[str]
  • Required: Yes

BatchGetNamedQueryOutput

NamedQueries

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.NamedQuery]
  • Required: Yes

UnprocessedNamedQueryIds

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.UnprocessedNamedQueryId]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchGetPreparedStatementInput

PreparedStatementNames

  • Type: typing.List[str]
  • Required: Yes

WorkGroup

  • Type:
  • Required: Yes

BatchGetPreparedStatementOutput

PreparedStatements

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.PreparedStatement]
  • Required: Yes

UnprocessedPreparedStatementNames

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.UnprocessedPreparedStatementName]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchGetQueryExecutionInput

QueryExecutionIds

  • Type: typing.List[str]
  • Required: Yes

BatchGetQueryExecutionOutput

QueryExecutions

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.QueryExecution]
  • Required: Yes

UnprocessedQueryExecutionIds

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.UnprocessedQueryExecutionId]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CalculationConfiguration

CodeBlock

  • Type: typing.Optional[str]

CalculationResult

StdOutS3Uri

  • Type: typing.Optional[str]

StdErrorS3Uri

  • Type: typing.Optional[str]

ResultS3Uri

  • Type: typing.Optional[str]

ResultType

  • Type: typing.Optional[str]

CalculationStatistics

DpuExecutionInMillis

  • Type: typing.Optional[int]

Progress

  • Type: typing.Optional[str]

CalculationStatus

SubmissionDateTime

  • Type: typing.Optional[datetime.datetime]

CompletionDateTime

  • Type: typing.Optional[datetime.datetime]

State

  • Type: typing.Optional[typing.Literal['CANCELED', 'CANCELING', 'COMPLETED', 'CREATED', 'CREATING', 'FAILED', 'QUEUED', 'RUNNING']]

StateChangeReason

  • Type: typing.Optional[str]

CalculationSummary

CalculationExecutionId

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.CalculationStatus]

CancelCapacityReservationInput

Name

  • Type:
  • Required: Yes

CapacityAllocation

Status

  • Type: typing.Literal['FAILED', 'PENDING', 'SUCCEEDED']
  • Required: Yes

RequestTime

  • Type:
  • Required: Yes

StatusMessage

  • Type: typing.Optional[str]

RequestCompletionTime

  • Type: typing.Optional[datetime.datetime]

CapacityAssignment

WorkGroupNames

  • Type: typing.Optional[typing.List[str]]

CapacityAssignmentConfiguration

CapacityReservationName

  • Type: typing.Optional[str]

CapacityAssignments

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.CapacityAssignmentOutput]]

CapacityAssignmentOutput

WorkGroupNames

  • Type: typing.Optional[typing.List[str]]

CapacityReservation

Name

  • Type:
  • Required: Yes

Status

  • Type: typing.Literal['ACTIVE', 'CANCELLED', 'CANCELLING', 'FAILED', 'PENDING', 'UPDATE_PENDING']
  • Required: Yes

TargetDpus

  • Type:
  • Required: Yes

AllocatedDpus

  • Type:
  • Required: Yes

CreationTime

  • Type:
  • Required: Yes

LastAllocation

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.CapacityAllocation]

LastSuccessfulAllocationTime

  • Type: typing.Optional[datetime.datetime]

Column

Name

  • Type:
  • Required: Yes

Type

  • Type: typing.Optional[str]

Comment

  • Type: typing.Optional[str]

ColumnInfo

Name

  • Type:
  • Required: Yes

Type

  • Type:
  • Required: Yes

CatalogName

  • Type: typing.Optional[str]

SchemaName

  • Type: typing.Optional[str]

TableName

  • Type: typing.Optional[str]

Label

  • Type: typing.Optional[str]

Precision

  • Type: typing.Optional[int]

Scale

  • Type: typing.Optional[int]

Nullable

  • Type: typing.Optional[typing.Literal['NOT_NULL', 'NULLABLE', 'UNKNOWN']]

CaseSensitive

  • Type: typing.Optional[bool]

CreateCapacityReservationInput

TargetDpus

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

Tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.Tag]]

CreateDataCatalogInput

Name

  • Type:
  • Required: Yes

Type

  • Type: typing.Literal['FEDERATED', 'GLUE', 'HIVE', 'LAMBDA']
  • Required: Yes

Description

  • Type: typing.Optional[str]

Parameters

  • Type: typing.Optional[typing.Dict[str, str]]

Tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.Tag]]

CreateDataCatalogOutput

DataCatalog

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateNamedQueryInput

Name

  • Type:
  • Required: Yes

Database

  • Type:
  • Required: Yes

QueryString

  • Type:
  • Required: Yes

Description

  • Type: typing.Optional[str]

ClientRequestToken

  • Type: typing.Optional[str]

WorkGroup

  • Type: typing.Optional[str]

CreateNamedQueryOutput

NamedQueryId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateNotebookInput

WorkGroup

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

ClientRequestToken

  • Type: typing.Optional[str]

CreateNotebookOutput

NotebookId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreatePreparedStatementInput

StatementName

  • Type:
  • Required: Yes

WorkGroup

  • Type:
  • Required: Yes

QueryStatement

  • Type:
  • Required: Yes

Description

  • Type: typing.Optional[str]

CreatePresignedNotebookUrlRequest

SessionId

  • Type:
  • Required: Yes

CreatePresignedNotebookUrlResponse

NotebookUrl

  • Type:
  • Required: Yes

AuthToken

  • Type:
  • Required: Yes

AuthTokenExpirationTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateWorkGroupInput

Name

  • Type:
  • Required: Yes

Configuration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.WorkGroupConfiguration]

Description

  • Type: typing.Optional[str]

Tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.Tag]]

CustomerContentEncryptionConfiguration

KmsKey

  • Type:
  • Required: Yes

DataCatalog

Name

  • Type:
  • Required: Yes

Type

  • Type: typing.Literal['FEDERATED', 'GLUE', 'HIVE', 'LAMBDA']
  • Required: Yes

Description

  • Type: typing.Optional[str]

Parameters

  • Type: typing.Optional[typing.Dict[str, str]]

Status

  • Type: typing.Optional[typing.Literal['CREATE_COMPLETE', 'CREATE_FAILED', 'CREATE_FAILED_CLEANUP_COMPLETE', 'CREATE_FAILED_CLEANUP_FAILED', 'CREATE_FAILED_CLEANUP_IN_PROGRESS', 'CREATE_IN_PROGRESS', 'DELETE_COMPLETE', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']]

ConnectionType

  • Type: typing.Optional[typing.Literal['BIGQUERY', 'CMDB', 'DATALAKEGEN2', 'DB2', 'DB2AS400', 'DOCUMENTDB', 'DYNAMODB', 'GOOGLECLOUDSTORAGE', 'HBASE', 'MYSQL', 'OPENSEARCH', 'ORACLE', 'POSTGRESQL', 'REDSHIFT', 'SAPHANA', 'SNOWFLAKE', 'SQLSERVER', 'SYNAPSE', 'TIMESTREAM', 'TPCDS']]

Error

  • Type: typing.Optional[str]

DataCatalogSummary

CatalogName

  • Type: typing.Optional[str]

Type

  • Type: typing.Optional[typing.Literal['FEDERATED', 'GLUE', 'HIVE', 'LAMBDA']]

Status

  • Type: typing.Optional[typing.Literal['CREATE_COMPLETE', 'CREATE_FAILED', 'CREATE_FAILED_CLEANUP_COMPLETE', 'CREATE_FAILED_CLEANUP_FAILED', 'CREATE_FAILED_CLEANUP_IN_PROGRESS', 'CREATE_IN_PROGRESS', 'DELETE_COMPLETE', 'DELETE_FAILED', 'DELETE_IN_PROGRESS']]

ConnectionType

  • Type: typing.Optional[typing.Literal['BIGQUERY', 'CMDB', 'DATALAKEGEN2', 'DB2', 'DB2AS400', 'DOCUMENTDB', 'DYNAMODB', 'GOOGLECLOUDSTORAGE', 'HBASE', 'MYSQL', 'OPENSEARCH', 'ORACLE', 'POSTGRESQL', 'REDSHIFT', 'SAPHANA', 'SNOWFLAKE', 'SQLSERVER', 'SYNAPSE', 'TIMESTREAM', 'TPCDS']]

Error

  • Type: typing.Optional[str]

Database

Name

  • Type:
  • Required: Yes

Description

  • Type: typing.Optional[str]

Parameters

  • Type: typing.Optional[typing.Dict[str, str]]

Datum

VarCharValue

  • Type: typing.Optional[str]

DeleteCapacityReservationInput

Name

  • Type:
  • Required: Yes

DeleteDataCatalogInput

Name

  • Type:
  • Required: Yes

DeleteCatalogOnly

  • Type: typing.Optional[bool]

DeleteDataCatalogOutput

DataCatalog

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteNamedQueryInput

NamedQueryId

  • Type:
  • Required: Yes

DeleteNotebookInput

NotebookId

  • Type:
  • Required: Yes

DeletePreparedStatementInput

StatementName

  • Type:
  • Required: Yes

WorkGroup

  • Type:
  • Required: Yes

DeleteWorkGroupInput

WorkGroup

  • Type:
  • Required: Yes

RecursiveDeleteOption

  • Type: typing.Optional[bool]

EncryptionConfiguration

EncryptionOption

  • Type: typing.Literal['CSE_KMS', 'SSE_KMS', 'SSE_S3']
  • Required: Yes

KmsKey

  • Type: typing.Optional[str]

EngineConfiguration

MaxConcurrentDpus

  • Type:
  • Required: Yes

CoordinatorDpuSize

  • Type: typing.Optional[int]

DefaultExecutorDpuSize

  • Type: typing.Optional[int]

AdditionalConfigs

  • Type: typing.Optional[typing.Dict[str, str]]

SparkProperties

  • Type: typing.Optional[typing.Dict[str, str]]

EngineConfigurationOutput

MaxConcurrentDpus

  • Type:
  • Required: Yes

CoordinatorDpuSize

  • Type: typing.Optional[int]

DefaultExecutorDpuSize

  • Type: typing.Optional[int]

AdditionalConfigs

  • Type: typing.Optional[typing.Dict[str, str]]

SparkProperties

  • Type: typing.Optional[typing.Dict[str, str]]

EngineVersion

SelectedEngineVersion

  • Type: typing.Optional[str]

EffectiveEngineVersion

  • Type: typing.Optional[str]

ExecutorsSummary

ExecutorId

  • Type:
  • Required: Yes

ExecutorType

  • Type: typing.Optional[typing.Literal['COORDINATOR', 'GATEWAY', 'WORKER']]

StartDateTime

  • Type: typing.Optional[int]

TerminationDateTime

  • Type: typing.Optional[int]

ExecutorState

  • Type: typing.Optional[typing.Literal['CREATED', 'CREATING', 'FAILED', 'REGISTERED', 'TERMINATED', 'TERMINATING']]

ExecutorSize

  • Type: typing.Optional[int]

ExportNotebookInput

NotebookId

  • Type:
  • Required: Yes

ExportNotebookOutput

NotebookMetadata

  • Type:
  • Required: Yes

Payload

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

FilterDefinition

Name

  • Type: typing.Optional[str]

GetCalculationExecutionCodeRequest

CalculationExecutionId

  • Type:
  • Required: Yes

GetCalculationExecutionCodeResponse

CodeBlock

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetCalculationExecutionRequest

CalculationExecutionId

  • Type:
  • Required: Yes

GetCalculationExecutionResponse

CalculationExecutionId

  • Type:
  • Required: Yes

SessionId

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

WorkingDirectory

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

Statistics

  • Type:
  • Required: Yes

Result

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetCalculationExecutionStatusRequest

CalculationExecutionId

  • Type:
  • Required: Yes

GetCalculationExecutionStatusResponse

Status

  • Type:
  • Required: Yes

Statistics

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetCapacityAssignmentConfigurationInput

CapacityReservationName

  • Type:
  • Required: Yes

GetCapacityAssignmentConfigurationOutput

CapacityAssignmentConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetCapacityReservationInput

Name

  • Type:
  • Required: Yes

GetCapacityReservationOutput

CapacityReservation

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDataCatalogInput

Name

  • Type:
  • Required: Yes

WorkGroup

  • Type: typing.Optional[str]

GetDataCatalogOutput

DataCatalog

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDatabaseInput

CatalogName

  • Type:
  • Required: Yes

DatabaseName

  • Type:
  • Required: Yes

WorkGroup

  • Type: typing.Optional[str]

GetDatabaseOutput

Database

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetNamedQueryInput

NamedQueryId

  • Type:
  • Required: Yes

GetNamedQueryOutput

NamedQuery

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetNotebookMetadataInput

NotebookId

  • Type:
  • Required: Yes

GetNotebookMetadataOutput

NotebookMetadata

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetPreparedStatementInput

StatementName

  • Type:
  • Required: Yes

WorkGroup

  • Type:
  • Required: Yes

GetPreparedStatementOutput

PreparedStatement

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetQueryExecutionInput

QueryExecutionId

  • Type:
  • Required: Yes

GetQueryExecutionOutput

QueryExecution

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetQueryResultsInput

QueryExecutionId

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

GetQueryResultsInputPaginate

QueryExecutionId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.PaginatorConfig]

GetQueryResultsOutput

UpdateCount

  • Type:
  • Required: Yes

ResultSet

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

GetQueryRuntimeStatisticsInput

QueryExecutionId

  • Type:
  • Required: Yes

GetQueryRuntimeStatisticsOutput

QueryRuntimeStatistics

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetSessionRequest

SessionId

  • Type:
  • Required: Yes

GetSessionResponse

SessionId

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

WorkGroup

  • Type:
  • Required: Yes

EngineVersion

  • Type:
  • Required: Yes

EngineConfiguration

  • Type:
  • Required: Yes

NotebookVersion

  • Type:
  • Required: Yes

SessionConfiguration

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

Statistics

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetSessionStatusRequest

SessionId

  • Type:
  • Required: Yes

GetSessionStatusResponse

SessionId

  • Type:
  • Required: Yes

Status

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetTableMetadataInput

CatalogName

  • Type:
  • Required: Yes

DatabaseName

  • Type:
  • Required: Yes

TableName

  • Type:
  • Required: Yes

WorkGroup

  • Type: typing.Optional[str]

GetTableMetadataOutput

TableMetadata

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetWorkGroupInput

WorkGroup

  • Type:
  • Required: Yes

GetWorkGroupOutput

WorkGroup

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

IdentityCenterConfiguration

EnableIdentityCenter

  • Type: typing.Optional[bool]

IdentityCenterInstanceArn

  • Type: typing.Optional[str]

ImportNotebookInput

WorkGroup

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

Type

  • Type: typing.Literal['IPYNB']
  • Required: Yes

Payload

  • Type: typing.Optional[str]

NotebookS3LocationUri

  • Type: typing.Optional[str]

ClientRequestToken

  • Type: typing.Optional[str]

ImportNotebookOutput

NotebookId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListApplicationDPUSizesInput

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListApplicationDPUSizesOutput

ApplicationDPUSizes

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.ApplicationDPUSizes]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListCalculationExecutionsRequest

SessionId

  • Type:
  • Required: Yes

StateFilter

  • Type: typing.Optional[typing.Literal['CANCELED', 'CANCELING', 'COMPLETED', 'CREATED', 'CREATING', 'FAILED', 'QUEUED', 'RUNNING']]

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListCalculationExecutionsResponse

Calculations

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.CalculationSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListCapacityReservationsInput

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListCapacityReservationsOutput

CapacityReservations

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.CapacityReservation]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListDataCatalogsInput

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

WorkGroup

  • Type: typing.Optional[str]

ListDataCatalogsInputPaginate

WorkGroup

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.PaginatorConfig]

ListDataCatalogsOutput

DataCatalogsSummary

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.DataCatalogSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListDatabasesInput

CatalogName

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

WorkGroup

  • Type: typing.Optional[str]

ListDatabasesInputPaginate

CatalogName

  • Type:
  • Required: Yes

WorkGroup

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.PaginatorConfig]

ListDatabasesOutput

DatabaseList

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.Database]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListEngineVersionsInput

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListEngineVersionsOutput

EngineVersions

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.EngineVersion]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListExecutorsRequest

SessionId

  • Type:
  • Required: Yes

ExecutorStateFilter

  • Type: typing.Optional[typing.Literal['CREATED', 'CREATING', 'FAILED', 'REGISTERED', 'TERMINATED', 'TERMINATING']]

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListExecutorsResponse

SessionId

  • Type:
  • Required: Yes

ExecutorsSummary

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.ExecutorsSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListNamedQueriesInput

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

WorkGroup

  • Type: typing.Optional[str]

ListNamedQueriesInputPaginate

WorkGroup

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.PaginatorConfig]

ListNamedQueriesOutput

NamedQueryIds

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListNotebookMetadataInput

WorkGroup

  • Type:
  • Required: Yes

Filters

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.FilterDefinition]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListNotebookMetadataOutput

NotebookMetadataList

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.NotebookMetadata]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListNotebookSessionsRequest

NotebookId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListNotebookSessionsResponse

NotebookSessionsList

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.NotebookSessionSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListPreparedStatementsInput

WorkGroup

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListPreparedStatementsOutput

PreparedStatements

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.PreparedStatementSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListQueryExecutionsInput

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

WorkGroup

  • Type: typing.Optional[str]

ListQueryExecutionsInputPaginate

WorkGroup

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.PaginatorConfig]

ListQueryExecutionsOutput

QueryExecutionIds

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListSessionsRequest

WorkGroup

  • Type:
  • Required: Yes

StateFilter

  • Type: typing.Optional[typing.Literal['BUSY', 'CREATED', 'CREATING', 'DEGRADED', 'FAILED', 'IDLE', 'TERMINATED', 'TERMINATING']]

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListSessionsResponse

Sessions

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.SessionSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListTableMetadataInput

CatalogName

  • Type:
  • Required: Yes

DatabaseName

  • Type:
  • Required: Yes

Expression

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

WorkGroup

  • Type: typing.Optional[str]

ListTableMetadataInputPaginate

CatalogName

  • Type:
  • Required: Yes

DatabaseName

  • Type:
  • Required: Yes

Expression

  • Type: typing.Optional[str]

WorkGroup

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.PaginatorConfig]

ListTableMetadataOutput

TableMetadataList

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.TableMetadata]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListTagsForResourceInput

ResourceARN

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListTagsForResourceInputPaginate

ResourceARN

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.PaginatorConfig]

ListTagsForResourceOutput

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.Tag]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListWorkGroupsInput

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListWorkGroupsOutput

WorkGroups

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.WorkGroupSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

NamedQuery

Name

  • Type:
  • Required: Yes

Database

  • Type:
  • Required: Yes

QueryString

  • Type:
  • Required: Yes

Description

  • Type: typing.Optional[str]

NamedQueryId

  • Type: typing.Optional[str]

WorkGroup

  • Type: typing.Optional[str]

NotebookMetadata

NotebookId

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

WorkGroup

  • Type: typing.Optional[str]

CreationTime

  • Type: typing.Optional[datetime.datetime]

Type

  • Type: typing.Optional[typing.Literal['IPYNB']]

LastModifiedTime

  • Type: typing.Optional[datetime.datetime]

NotebookSessionSummary

SessionId

  • Type: typing.Optional[str]

CreationTime

  • Type: typing.Optional[datetime.datetime]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PreparedStatement

StatementName

  • Type: typing.Optional[str]

QueryStatement

  • Type: typing.Optional[str]

WorkGroupName

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

LastModifiedTime

  • Type: typing.Optional[datetime.datetime]

PreparedStatementSummary

StatementName

  • Type: typing.Optional[str]

LastModifiedTime

  • Type: typing.Optional[datetime.datetime]

PutCapacityAssignmentConfigurationInput

CapacityReservationName

  • Type:
  • Required: Yes

CapacityAssignments

  • Type: typing.List[typing.Union[aws_resource_validator.pydantic_models.athena.athena_classes.CapacityAssignment, aws_resource_validator.pydantic_models.athena.athena_classes.CapacityAssignmentOutput]]
  • Required: Yes

QueryExecution

QueryExecutionId

  • Type: typing.Optional[str]

Query

  • Type: typing.Optional[str]

StatementType

  • Type: typing.Optional[typing.Literal['DDL', 'DML', 'UTILITY']]

ResultConfiguration

  • Type:

ResultReuseConfiguration

  • Type:

QueryExecutionContext

  • Type:

Status

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.QueryExecutionStatus]

Statistics

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.QueryExecutionStatistics]

WorkGroup

  • Type: typing.Optional[str]

EngineVersion

  • Type:

ExecutionParameters

  • Type: typing.Optional[typing.List[str]]

SubstatementType

  • Type: typing.Optional[str]

QueryResultsS3AccessGrantsConfiguration

  • Type:

QueryExecutionContext

Database

  • Type: typing.Optional[str]

Catalog

  • Type: typing.Optional[str]

QueryExecutionStatistics

EngineExecutionTimeInMillis

  • Type: typing.Optional[int]

DataScannedInBytes

  • Type: typing.Optional[int]

DataManifestLocation

  • Type: typing.Optional[str]

TotalExecutionTimeInMillis

  • Type: typing.Optional[int]

QueryQueueTimeInMillis

  • Type: typing.Optional[int]

ServicePreProcessingTimeInMillis

  • Type: typing.Optional[int]

QueryPlanningTimeInMillis

  • Type: typing.Optional[int]

ServiceProcessingTimeInMillis

  • Type: typing.Optional[int]

ResultReuseInformation

  • Type:

QueryExecutionStatus

State

  • Type: typing.Optional[typing.Literal['CANCELLED', 'FAILED', 'QUEUED', 'RUNNING', 'SUCCEEDED']]

StateChangeReason

  • Type: typing.Optional[str]

SubmissionDateTime

  • Type: typing.Optional[datetime.datetime]

CompletionDateTime

  • Type: typing.Optional[datetime.datetime]

AthenaError

  • Type:

QueryResultsS3AccessGrantsConfiguration

EnableS3AccessGrants

  • Type:
  • Required: Yes

AuthenticationType

  • Type: typing.Literal['DIRECTORY_IDENTITY']
  • Required: Yes

CreateUserLevelPrefix

  • Type: typing.Optional[bool]

QueryRuntimeStatistics

Timeline

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.QueryRuntimeStatisticsTimeline]

Rows

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.QueryRuntimeStatisticsRows]

OutputStage

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.QueryStage]

QueryRuntimeStatisticsRows

InputRows

  • Type: typing.Optional[int]

InputBytes

  • Type: typing.Optional[int]

OutputBytes

  • Type: typing.Optional[int]

OutputRows

  • Type: typing.Optional[int]

QueryRuntimeStatisticsTimeline

QueryQueueTimeInMillis

  • Type: typing.Optional[int]

ServicePreProcessingTimeInMillis

  • Type: typing.Optional[int]

QueryPlanningTimeInMillis

  • Type: typing.Optional[int]

EngineExecutionTimeInMillis

  • Type: typing.Optional[int]

ServiceProcessingTimeInMillis

  • Type: typing.Optional[int]

TotalExecutionTimeInMillis

  • Type: typing.Optional[int]

QueryStage

StageId

  • Type: typing.Optional[int]

State

  • Type: typing.Optional[str]

OutputBytes

  • Type: typing.Optional[int]

OutputRows

  • Type: typing.Optional[int]

InputBytes

  • Type: typing.Optional[int]

InputRows

  • Type: typing.Optional[int]

ExecutionTime

  • Type: typing.Optional[int]

QueryStagePlan

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.QueryStagePlanNode]

SubStages

  • Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]

QueryStagePlanNode

Name

  • Type: typing.Optional[str]

Identifier

  • Type: typing.Optional[str]

Children

  • Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]

RemoteSources

  • Type: typing.Optional[typing.List[str]]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

ResultConfiguration

OutputLocation

  • Type: typing.Optional[str]

EncryptionConfiguration

  • Type:

ExpectedBucketOwner

  • Type: typing.Optional[str]

AclConfiguration

  • Type:

ResultConfigurationUpdates

OutputLocation

  • Type: typing.Optional[str]

RemoveOutputLocation

  • Type: typing.Optional[bool]

EncryptionConfiguration

  • Type:

RemoveEncryptionConfiguration

  • Type: typing.Optional[bool]

ExpectedBucketOwner

  • Type: typing.Optional[str]

RemoveExpectedBucketOwner

  • Type: typing.Optional[bool]

AclConfiguration

  • Type:

RemoveAclConfiguration

  • Type: typing.Optional[bool]

ResultReuseByAgeConfiguration

Enabled

  • Type:
  • Required: Yes

MaxAgeInMinutes

  • Type: typing.Optional[int]

ResultReuseConfiguration

ResultReuseByAgeConfiguration

  • Type:

ResultReuseInformation

ReusedPreviousResult

  • Type:
  • Required: Yes

ResultSet

Rows

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.Row]]

ResultSetMetadata

  • Type:

ResultSetMetadata

ColumnInfo

  • Type: typing.Optional[typing.List[NoneType]]

Row

Data

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.Datum]]

SessionConfiguration

ExecutionRole

  • Type: typing.Optional[str]

WorkingDirectory

  • Type: typing.Optional[str]

IdleTimeoutSeconds

  • Type: typing.Optional[int]

EncryptionConfiguration

  • Type:

SessionStatistics

DpuExecutionInMillis

  • Type: typing.Optional[int]

SessionStatus

StartDateTime

  • Type: typing.Optional[datetime.datetime]

LastModifiedDateTime

  • Type: typing.Optional[datetime.datetime]

EndDateTime

  • Type: typing.Optional[datetime.datetime]

IdleSinceDateTime

  • Type: typing.Optional[datetime.datetime]

State

  • Type: typing.Optional[typing.Literal['BUSY', 'CREATED', 'CREATING', 'DEGRADED', 'FAILED', 'IDLE', 'TERMINATED', 'TERMINATING']]

StateChangeReason

  • Type: typing.Optional[str]

SessionSummary

SessionId

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

EngineVersion

  • Type:

NotebookVersion

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.SessionStatus]

StartCalculationExecutionRequest

SessionId

  • Type:
  • Required: Yes

Description

  • Type: typing.Optional[str]

CalculationConfiguration

  • Type:

CodeBlock

  • Type: typing.Optional[str]

ClientRequestToken

  • Type: typing.Optional[str]

StartCalculationExecutionResponse

CalculationExecutionId

  • Type:
  • Required: Yes

State

  • Type: typing.Literal['CANCELED', 'CANCELING', 'COMPLETED', 'CREATED', 'CREATING', 'FAILED', 'QUEUED', 'RUNNING']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartQueryExecutionInput

QueryString

  • Type:
  • Required: Yes

ClientRequestToken

  • Type: typing.Optional[str]

QueryExecutionContext

  • Type:

ResultConfiguration

  • Type:

WorkGroup

  • Type: typing.Optional[str]

ExecutionParameters

  • Type: typing.Optional[typing.List[str]]

ResultReuseConfiguration

  • Type:

StartQueryExecutionOutput

QueryExecutionId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StartSessionRequest

WorkGroup

  • Type:
  • Required: Yes

EngineConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.athena.athena_classes.EngineConfiguration, aws_resource_validator.pydantic_models.athena.athena_classes.EngineConfigurationOutput]
  • Required: Yes

Description

  • Type: typing.Optional[str]

NotebookVersion

  • Type: typing.Optional[str]

SessionIdleTimeoutInMinutes

  • Type: typing.Optional[int]

ClientRequestToken

  • Type: typing.Optional[str]

StartSessionResponse

SessionId

  • Type:
  • Required: Yes

State

  • Type: typing.Literal['BUSY', 'CREATED', 'CREATING', 'DEGRADED', 'FAILED', 'IDLE', 'TERMINATED', 'TERMINATING']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopCalculationExecutionRequest

CalculationExecutionId

  • Type:
  • Required: Yes

StopCalculationExecutionResponse

State

  • Type: typing.Literal['CANCELED', 'CANCELING', 'COMPLETED', 'CREATED', 'CREATING', 'FAILED', 'QUEUED', 'RUNNING']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopQueryExecutionInput

QueryExecutionId

  • Type:
  • Required: Yes

TableMetadata

Name

  • Type:
  • Required: Yes

CreateTime

  • Type: typing.Optional[datetime.datetime]

LastAccessTime

  • Type: typing.Optional[datetime.datetime]

TableType

  • Type: typing.Optional[str]

Columns

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.Column]]

PartitionKeys

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.Column]]

Parameters

  • Type: typing.Optional[typing.Dict[str, str]]

Tag

Key

  • Type: typing.Optional[str]

Value

  • Type: typing.Optional[str]

TagResourceInput

ResourceARN

  • Type:
  • Required: Yes

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.athena.athena_classes.Tag]
  • Required: Yes

TerminateSessionRequest

SessionId

  • Type:
  • Required: Yes

TerminateSessionResponse

State

  • Type: typing.Literal['BUSY', 'CREATED', 'CREATING', 'DEGRADED', 'FAILED', 'IDLE', 'TERMINATED', 'TERMINATING']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UnprocessedNamedQueryId

NamedQueryId

  • Type: typing.Optional[str]

ErrorCode

  • Type: typing.Optional[str]

ErrorMessage

  • Type: typing.Optional[str]

UnprocessedPreparedStatementName

StatementName

  • Type: typing.Optional[str]

ErrorCode

  • Type: typing.Optional[str]

ErrorMessage

  • Type: typing.Optional[str]

UnprocessedQueryExecutionId

QueryExecutionId

  • Type: typing.Optional[str]

ErrorCode

  • Type: typing.Optional[str]

ErrorMessage

  • Type: typing.Optional[str]

UntagResourceInput

ResourceARN

  • Type:
  • Required: Yes

TagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateCapacityReservationInput

TargetDpus

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

UpdateDataCatalogInput

Name

  • Type:
  • Required: Yes

Type

  • Type: typing.Literal['FEDERATED', 'GLUE', 'HIVE', 'LAMBDA']
  • Required: Yes

Description

  • Type: typing.Optional[str]

Parameters

  • Type: typing.Optional[typing.Dict[str, str]]

UpdateNamedQueryInput

NamedQueryId

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

QueryString

  • Type:
  • Required: Yes

Description

  • Type: typing.Optional[str]

UpdateNotebookInput

NotebookId

  • Type:
  • Required: Yes

Payload

  • Type:
  • Required: Yes

Type

  • Type: typing.Literal['IPYNB']
  • Required: Yes

SessionId

  • Type: typing.Optional[str]

ClientRequestToken

  • Type: typing.Optional[str]

UpdateNotebookMetadataInput

NotebookId

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

ClientRequestToken

  • Type: typing.Optional[str]

UpdatePreparedStatementInput

StatementName

  • Type:
  • Required: Yes

WorkGroup

  • Type:
  • Required: Yes

QueryStatement

  • Type:
  • Required: Yes

Description

  • Type: typing.Optional[str]

UpdateWorkGroupInput

WorkGroup

  • Type:
  • Required: Yes

Description

  • Type: typing.Optional[str]

ConfigurationUpdates

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.WorkGroupConfigurationUpdates]

State

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

WorkGroup

Name

  • Type:
  • Required: Yes

State

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

Configuration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.athena.athena_classes.WorkGroupConfiguration]

Description

  • Type: typing.Optional[str]

CreationTime

  • Type: typing.Optional[datetime.datetime]

IdentityCenterApplicationArn

  • Type: typing.Optional[str]

WorkGroupConfiguration

ResultConfiguration

  • Type:

EnforceWorkGroupConfiguration

  • Type: typing.Optional[bool]

PublishCloudWatchMetricsEnabled

  • Type: typing.Optional[bool]

BytesScannedCutoffPerQuery

  • Type: typing.Optional[int]

RequesterPaysEnabled

  • Type: typing.Optional[bool]

EngineVersion

  • Type:

AdditionalConfiguration

  • Type: typing.Optional[str]

ExecutionRole

  • Type: typing.Optional[str]

CustomerContentEncryptionConfiguration

  • Type:

EnableMinimumEncryptionConfiguration

  • Type: typing.Optional[bool]

IdentityCenterConfiguration

  • Type:

QueryResultsS3AccessGrantsConfiguration

  • Type:

WorkGroupConfigurationUpdates

EnforceWorkGroupConfiguration

  • Type: typing.Optional[bool]

ResultConfigurationUpdates

  • Type:

PublishCloudWatchMetricsEnabled

  • Type: typing.Optional[bool]

BytesScannedCutoffPerQuery

  • Type: typing.Optional[int]

RemoveBytesScannedCutoffPerQuery

  • Type: typing.Optional[bool]

RequesterPaysEnabled

  • Type: typing.Optional[bool]

EngineVersion

  • Type:

RemoveCustomerContentEncryptionConfiguration

  • Type: typing.Optional[bool]

AdditionalConfiguration

  • Type: typing.Optional[str]

ExecutionRole

  • Type: typing.Optional[str]

CustomerContentEncryptionConfiguration

  • Type:

EnableMinimumEncryptionConfiguration

  • Type: typing.Optional[bool]

QueryResultsS3AccessGrantsConfiguration

  • Type:

WorkGroupSummary

Name

  • Type: typing.Optional[str]

State

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

Description

  • Type: typing.Optional[str]

CreationTime

  • Type: typing.Optional[datetime.datetime]

EngineVersion

  • Type:

IdentityCenterApplicationArn

  • Type: typing.Optional[str]