Module types 

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that Amazon Athena can respond with.

Structs

AclConfiguration

Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results, including data files inserted by Athena as the result of statements like CTAS or INSERT INTO. When Athena stores query results in Amazon S3, the canned ACL is set with the x-amz-acl request header. For more information about S3 Object Ownership, see Object Ownership settings in the Amazon S3 User Guide.

ApplicationDpuSizes

Contains the application runtime IDs and their supported DPU sizes.

AthenaError

Provides information about an Athena query error. The AthenaError feature provides standardized error information to help you understand failed queries and take steps after a query failure occurs. AthenaError includes an ErrorCategory field that specifies whether the cause of the failed query is due to system error, user error, or other error.

CalculationConfiguration

Contains configuration information for the calculation.

CalculationResult

Contains information about an application-specific calculation result.

CalculationStatistics

Contains statistics for a notebook calculation.

CalculationStatus

Contains information about the status of a notebook calculation.

CalculationSummary

Summary information for a notebook calculation.

CapacityAllocation

Contains the submission time of a single allocation request for a capacity reservation and the most recent status of the attempted allocation.

CapacityAssignment

A mapping between one or more workgroups and a capacity reservation.

CapacityAssignmentConfiguration

Assigns Athena workgroups (and hence their queries) to capacity reservations. A capacity reservation can have only one capacity assignment configuration, but the capacity assignment configuration can be made up of multiple individual assignments. Each assignment specifies how Athena queries can consume capacity from the capacity reservation that their workgroup is mapped to.

CapacityReservation

A reservation for a specified number of data processing units (DPUs). When a reservation is initially created, it has no DPUs. Athena allocates DPUs until the allocated amount equals the requested amount.

Column

Contains metadata for a column in a table.

ColumnInfo

Information about the columns in a query execution result.

CustomerContentEncryptionConfiguration

Specifies the customer managed KMS key that is used to encrypt the user's data stores in Athena. When an Amazon Web Services managed key is used, this value is null. This setting does not apply to Athena SQL workgroups.

DataCatalog

Contains information about a data catalog in an Amazon Web Services account.

In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.

DataCatalogSummary

The summary information for the data catalog, which includes its name and type.

Database

Contains metadata information for a database in a data catalog.

Datum

A piece of data (a field in the table).

EncryptionConfiguration

If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information.

EngineConfiguration

Contains data processing unit (DPU) configuration settings and parameter mappings for a notebook engine.

EngineVersion

The Athena engine version for running queries, or the PySpark engine version for running sessions.

ExecutorsSummary

Contains summary information about an executor.

FilterDefinition

A string for searching notebook names.

IdentityCenterConfiguration

Specifies whether the workgroup is IAM Identity Center supported.

ManagedQueryResultsConfiguration

The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.

ManagedQueryResultsConfigurationUpdates

Updates the configuration for managed query results.

ManagedQueryResultsEncryptionConfiguration

If you encrypt query and calculation results in Athena owned storage, this field indicates the encryption option (for example, SSE_KMS or CSE_KMS) and key information.

NamedQuery

A query, where QueryString contains the SQL statements that make up the query.

NotebookMetadata

Contains metadata for notebook, including the notebook name, ID, workgroup, and time created.

NotebookSessionSummary

Contains the notebook session ID and notebook session creation time.

PreparedStatement

A prepared SQL statement for use with Athena.

PreparedStatementSummary

The name and last modified time of the prepared statement.

QueryExecution

Information about a single instance of a query execution.

QueryExecutionContext

The database and data catalog context in which the query execution occurs.

QueryExecutionStatistics

The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.

QueryExecutionStatus

The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

QueryResultsS3AccessGrantsConfiguration

Specifies whether Amazon S3 access grants are enabled for query results.

QueryRuntimeStatistics

The query execution timeline, statistics on input and output rows and bytes, and the different query stages that form the query execution plan.

QueryRuntimeStatisticsRows

Statistics such as input rows and bytes read by the query, rows and bytes output by the query, and the number of rows written by the query.

QueryRuntimeStatisticsTimeline

Timeline statistics such as query queue time, planning time, execution time, service processing time, and total execution time.

QueryStage

Stage statistics such as input and output rows and bytes, execution time and stage state. This information also includes substages and the query stage plan.

QueryStagePlanNode

Stage plan information such as name, identifier, sub plans, and remote sources.

ResultConfiguration

The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the workgroup settings.

ResultConfigurationUpdates

The information about the updates in the query results, such as output location and encryption configuration for the query results.

ResultReuseByAgeConfiguration

Specifies whether previous query results are reused, and if so, their maximum age.

ResultReuseConfiguration

Specifies the query result reuse behavior for the query.

ResultReuseInformation

Contains information about whether the result of a previous query was reused.

ResultSet

The metadata and rows that make up a query result set. The metadata describes the column structure and data types. To return a ResultSet object, use GetQueryResults.

ResultSetMetadata

The metadata that describes the column structure and data types of a table of query results. To return a ResultSetMetadata object, use GetQueryResults.

Row

The rows that make up a query result table.

SessionConfiguration

Contains session configuration information.

SessionStatistics

Contains statistics for a session.

SessionStatus

Contains information about the status of a session.

SessionSummary

Contains summary information about a session.

TableMetadata

Contains metadata for a table.

Tag

A label that you assign to a resource. Athena resources include workgroups, data catalogs, and capacity reservations. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena resources by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

UnprocessedNamedQueryId

Information about a named query ID that could not be processed.

UnprocessedPreparedStatementName

The name of a prepared statement that could not be returned.

UnprocessedQueryExecutionId

Describes a query execution that failed to process.

WorkGroup

A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup$Configuration. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

WorkGroupConfiguration

The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption option, if any, used for query and calculation results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

WorkGroupConfigurationUpdates

The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

WorkGroupSummary

The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.

Enums

AuthenticationType

When writing a match expression against AuthenticationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CalculationExecutionState

When writing a match expression against CalculationExecutionState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CapacityAllocationStatus

When writing a match expression against CapacityAllocationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CapacityReservationStatus

When writing a match expression against CapacityReservationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ColumnNullable

When writing a match expression against ColumnNullable, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ConnectionType

When writing a match expression against ConnectionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DataCatalogStatus

When writing a match expression against DataCatalogStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DataCatalogType

When writing a match expression against DataCatalogType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EncryptionOption

When writing a match expression against EncryptionOption, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ExecutorState

When writing a match expression against ExecutorState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ExecutorType

When writing a match expression against ExecutorType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NotebookType

When writing a match expression against NotebookType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

QueryExecutionState

When writing a match expression against QueryExecutionState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

QueryResultType

When writing a match expression against QueryResultType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

S3AclOption

When writing a match expression against S3AclOption, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SessionState

When writing a match expression against SessionState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

StatementType

When writing a match expression against StatementType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ThrottleReason

When writing a match expression against ThrottleReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

WorkGroupState

When writing a match expression against WorkGroupState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.