Expand description
Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see What is Amazon Athena in the Amazon Athena User Guide.
If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see Accessing Amazon Athena with JDBC.
For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
If you’re using the service, you’re probably looking for AthenaClient and Athena.
Structs§
- Athena
Client - A client for the Amazon Athena API.
- Batch
GetNamed Query Input - Batch
GetNamed Query Output - Batch
GetQuery Execution Input - Batch
GetQuery Execution Output - Column
Contains metadata for a column in a table.
- Column
Info Information about the columns in a query execution result.
- Create
Data Catalog Input - Create
Data Catalog Output - Create
Named Query Input - Create
Named Query Output - Create
Work Group Input - Create
Work Group Output - Data
Catalog Contains information about a data catalog in an AWS account.
- Data
Catalog Summary 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).
- Delete
Data Catalog Input - Delete
Data Catalog Output - Delete
Named Query Input - Delete
Named Query Output - Delete
Work Group Input - Delete
Work Group Output - Encryption
Configuration If query results are encrypted in Amazon S3, indicates the encryption option used (for example,
SSE-KMSorCSE-KMS) and key information.- GetData
Catalog Input - GetData
Catalog Output - GetDatabase
Input - GetDatabase
Output - GetNamed
Query Input - GetNamed
Query Output - GetQuery
Execution Input - GetQuery
Execution Output - GetQuery
Results Input - GetQuery
Results Output - GetTable
Metadata Input - GetTable
Metadata Output - GetWork
Group Input - GetWork
Group Output - List
Data Catalogs Input - List
Data Catalogs Output - List
Databases Input - List
Databases Output - List
Named Queries Input - List
Named Queries Output - List
Query Executions Input - List
Query Executions Output - List
Table Metadata Input - List
Table Metadata Output - List
Tags ForResource Input - List
Tags ForResource Output - List
Work Groups Input - List
Work Groups Output - Named
Query A query, where
QueryStringis the list of SQL query statements that comprise the query.- Query
Execution Information about a single instance of a query execution.
- Query
Execution Context The database and data catalog context in which the query execution occurs.
- Query
Execution Statistics 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.
- Query
Execution Status The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
- Result
Configuration The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the workgroup settings.
- Result
Configuration Updates The information about the updates in the query results, such as output location and encryption configuration for the query results.
- Result
Set The metadata and rows that comprise a query result set. The metadata describes the column structure and data types. To return a
ResultSetobject, use GetQueryResults.- Result
SetMetadata The metadata that describes the column structure and data types of a table of query results. To return a
ResultSetMetadataobject, use GetQueryResults.- Row
The rows that comprise a query result table.
- Start
Query Execution Input - Start
Query Execution Output - Stop
Query Execution Input - Stop
Query Execution Output - Table
Metadata Contains metadata for a table.
- Tag
A label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs 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.
- TagResource
Input - TagResource
Output - Unprocessed
Named Query Id Information about a named query ID that could not be processed.
- Unprocessed
Query Execution Id Describes a query execution that failed to process.
- Untag
Resource Input - Untag
Resource Output - Update
Data Catalog Input - Update
Data Catalog Output - Update
Work Group Input - Update
Work Group Output - Work
Group 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.
- Work
Group Configuration The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query 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.
- Work
Group Configuration Updates The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query 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.
- Work
Group Summary The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.
Enums§
- Batch
GetNamed Query Error - Errors returned by BatchGetNamedQuery
- Batch
GetQuery Execution Error - Errors returned by BatchGetQueryExecution
- Create
Data Catalog Error - Errors returned by CreateDataCatalog
- Create
Named Query Error - Errors returned by CreateNamedQuery
- Create
Work Group Error - Errors returned by CreateWorkGroup
- Delete
Data Catalog Error - Errors returned by DeleteDataCatalog
- Delete
Named Query Error - Errors returned by DeleteNamedQuery
- Delete
Work Group Error - Errors returned by DeleteWorkGroup
- GetData
Catalog Error - Errors returned by GetDataCatalog
- GetDatabase
Error - Errors returned by GetDatabase
- GetNamed
Query Error - Errors returned by GetNamedQuery
- GetQuery
Execution Error - Errors returned by GetQueryExecution
- GetQuery
Results Error - Errors returned by GetQueryResults
- GetTable
Metadata Error - Errors returned by GetTableMetadata
- GetWork
Group Error - Errors returned by GetWorkGroup
- List
Data Catalogs Error - Errors returned by ListDataCatalogs
- List
Databases Error - Errors returned by ListDatabases
- List
Named Queries Error - Errors returned by ListNamedQueries
- List
Query Executions Error - Errors returned by ListQueryExecutions
- List
Table Metadata Error - Errors returned by ListTableMetadata
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Work Groups Error - Errors returned by ListWorkGroups
- Start
Query Execution Error - Errors returned by StartQueryExecution
- Stop
Query Execution Error - Errors returned by StopQueryExecution
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Data Catalog Error - Errors returned by UpdateDataCatalog
- Update
Work Group Error - Errors returned by UpdateWorkGroup
Traits§
- Athena
- Trait representing the capabilities of the Amazon Athena API. Amazon Athena clients implement this trait.