Package-level declarations
Types
Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. 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.
Contains the application runtime IDs and their supported DPU sizes.
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.
Base class for all service related exceptions thrown by the Athena client
Contains an array of named query IDs.
Contains an array of query execution IDs.
Contains configuration information for the calculation.
Contains information about an application-specific calculation result.
Contains statistics for a notebook calculation.
Contains information about the status of a notebook calculation.
Summary information for a notebook calculation.
Contains the submission time of a single allocation request for a capacity reservation and the most recent status of the attempted allocation.
A mapping between one or more workgroups and a capacity reservation.
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.
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.
Information about the columns in a query execution result.
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.
Contains information about a data catalog in an Amazon Web Services account.
The summary information for the data catalog, which includes its name and type.
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.
Contains data processing unit (DPU) configuration settings and parameter mappings for a notebook engine.
The Athena engine version for running queries, or the PySpark engine version for running sessions.
Contains summary information about an executor.
A string for searching notebook names.
Specifies whether the workgroup is IAM Identity Center supported.
Indicates a platform issue, which may be due to a transient condition or outage.
Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.
A query, where QueryString contains the SQL statements that make up the query.
Contains metadata for notebook, including the notebook name, ID, workgroup, and time created.
Contains the notebook session ID and notebook session creation time.
A prepared SQL statement for use with Athena.
The name and last modified time of the prepared statement.
Information about a single instance of a query execution.
The database and data catalog context in which the query execution occurs.
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.
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
Specifies whether Amazon S3 access grants are enabled for query results.
The query execution timeline, statistics on input and output rows and bytes, and the different query stages that form the query execution plan.
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.
Timeline statistics such as query queue time, planning time, execution time, service processing time, and total execution time.
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.
Stage plan information such as name, identifier, sub plans, and remote sources.
A resource, such as a workgroup, was not found.
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.
The information about the updates in the query results, such as output location and encryption configuration for the query results.
Specifies whether previous query results are reused, and if so, their maximum age.
Specifies the query result reuse behavior for the query.
Contains information about whether the result of a previous query was reused.
The metadata that describes the column structure and data types of a table of query results. To return a ResultSetMetadata object, use GetQueryResults.
The specified session already exists.
Contains session configuration information.
Contains statistics for a session.
Contains information about the status of a session.
Contains summary information about a session.
Contains metadata for a table.
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.
The reason for the query throttling, for example, when it exceeds the concurrent query limit.
Indicates that the request was throttled.
Information about a named query ID that could not be processed.
The name of a prepared statement that could not be returned.
Describes a query execution that failed to process.
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.
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.
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.
The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.