Crate rusoto_athena
source · [−]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
A client for the Amazon Athena API.
Contains metadata for a column in a table.
Information about the columns in a query execution result.
Contains information about a data catalog in an AWS account.
The summary information for the data catalog, which includes its name and type.
Contains metadata information for a database in a data catalog.
A piece of data (a field in the table).
If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS
or CSE-KMS
) and key information.
The Athena engine version for running queries.
A query, where QueryString
is the list of SQL query statements that comprise the query.
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.
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.
The information about the updates in the query results, such as output location and encryption configuration for the query results.
The metadata and rows that comprise a query result set. The metadata describes the column structure and data types. To return a ResultSet
object, use GetQueryResults.
The metadata that describes the column structure and data types of a table of query results. To return a ResultSetMetadata
object, use GetQueryResults.
The rows that comprise a query result table.
Contains metadata for a table.
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.
Information about a named query ID that could not be processed.
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 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.
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.
The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.
Enums
Errors returned by BatchGetNamedQuery
Errors returned by BatchGetQueryExecution
Errors returned by CreateDataCatalog
Errors returned by CreateNamedQuery
Errors returned by CreatePreparedStatement
Errors returned by CreateWorkGroup
Errors returned by DeleteDataCatalog
Errors returned by DeleteNamedQuery
Errors returned by DeletePreparedStatement
Errors returned by DeleteWorkGroup
Errors returned by GetDataCatalog
Errors returned by GetDatabase
Errors returned by GetNamedQuery
Errors returned by GetPreparedStatement
Errors returned by GetQueryExecution
Errors returned by GetQueryResults
Errors returned by GetTableMetadata
Errors returned by GetWorkGroup
Errors returned by ListDataCatalogs
Errors returned by ListDatabases
Errors returned by ListEngineVersions
Errors returned by ListNamedQueries
Errors returned by ListPreparedStatements
Errors returned by ListQueryExecutions
Errors returned by ListTableMetadata
Errors returned by ListTagsForResource
Errors returned by ListWorkGroups
Errors returned by StartQueryExecution
Errors returned by StopQueryExecution
Errors returned by TagResource
Errors returned by UntagResource
Errors returned by UpdateDataCatalog
Errors returned by UpdatePreparedStatement
Errors returned by UpdateWorkGroup
Traits
Trait representing the capabilities of the Amazon Athena API. Amazon Athena clients implement this trait.