EncryptionConfiguration
If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information.
Contents
EncryptionOption
Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side encryption with managed keys (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is used.
If a query runs in a workgroup and the workgroup overrides client-side settings, then the
workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
Type: String
Valid Values: SSE_S3 | SSE_KMS | CSE_KMS Required: Yes
KmsKey
For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EngineVersion
EngineVersion
The Athena engine version for running queries.
Contents
EffectiveEngineVersion
Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No SelectedEngineVersion
The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including Auto. The default is Auto.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ListNamedQueriesInput
ListNamedQueriesInput
Contents
MaxResults
The maximum number of queries to return in this request.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 50.
Required: No NextToken
A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No WorkGroup
The name of the workgroup from which the named queries are being returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned.
Type: String
Pattern: [a-zA-Z0-9._-]{1,128}
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ListQueryExecutionsInput
ListQueryExecutionsInput
Contents
MaxResults
The maximum number of query executions to return in this request.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 50.
Required: No NextToken
A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No WorkGroup
The name of the workgroup from which queries are being returned. If a workgroup is not specified, a list of available query execution IDs for the queries in the primary workgroup is returned.
Type: String
Pattern: [a-zA-Z0-9._-]{1,128}
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
NamedQuery
NamedQuery
A query, where QueryString contains the SQL statements that make up the query.
Contents
Database
The database to which the query belongs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes Description
The query description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No Name
The query name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes NamedQueryId
The unique identifier of the query.
Type: String Required: No QueryString
The SQL statements that make up the query.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 262144.
Required: Yes WorkGroup
The name of the workgroup that contains the named query.
Type: String
Pattern: [a-zA-Z0-9._-]{1,128}
Required: No
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PreparedStatement
PreparedStatement
A prepared SQL statement for use with Athena.
Contents
Description
The description of the prepared statement.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No LastModifiedTime
The last modified time of the prepared statement.
Type: Timestamp Required: No QueryStatement
The query string for the prepared statement.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 262144.
Required: No StatementName
The name of the prepared statement.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [a-zA-Z_][a-zA-Z0-9_@:]{1,256}
Required: No WorkGroupName
The name of the workgroup to which the prepared statement belongs.
Type: String
Pattern: [a-zA-Z0-9._-]{1,128}
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
See Also
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PreparedStatementSummary
PreparedStatementSummary
The name and last modified time of the prepared statement.
Contents
LastModifiedTime
The last modified time of the prepared statement.
Type: Timestamp Required: No StatementName
The name of the prepared statement.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [a-zA-Z_][a-zA-Z0-9_@:]{1,256}
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
QueryExecution
QueryExecution
Information about a single instance of a query execution.
Contents
EngineVersion
The engine version that executed the query.
Type: EngineVersion (p. 104) object Required: No
Query
The SQL query statements which the query execution ran.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 262144.
Required: No QueryExecutionContext
The database in which the query execution occurred.
Type: QueryExecutionContext (p. 114) object Required: No
QueryExecutionId
The unique identifier for each query execution.
Type: String Required: No ResultConfiguration
The location in Amazon S3 where query results were 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 location for the query results and the encryption configuration that are specified for the workgroup.
Type: ResultConfiguration (p. 119) object Required: No
StatementType
See Also
Statistics
Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.
Type: QueryExecutionStatistics (p. 115) object Required: No
Status
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
Type: QueryExecutionStatus (p. 117) object Required: No
WorkGroup
The name of the workgroup in which the query ran.
Type: String
Pattern: [a-zA-Z0-9._-]{1,128}
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
QueryExecutionContext
QueryExecutionContext
The database and data catalog context in which the query execution occurs.
Contents
Catalog
The name of the data catalog used in the query execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: No Database
The name of the database used in the query execution. The database must exist in the catalog.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
QueryExecutionStatistics
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.
Contents
DataManifestLocation
The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3.
If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.
Type: String Required: No DataScannedInBytes
The number of bytes in the data that was queried.
Type: Long Required: No
EngineExecutionTimeInMillis
The number of milliseconds that the query took to execute.
Type: Long Required: No
QueryPlanningTimeInMillis
The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.
Type: Long Required: No
QueryQueueTimeInMillis
The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.
Type: Long Required: No
ServiceProcessingTimeInMillis
The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.
Type: Long Required: No
See Also
TotalExecutionTimeInMillis
The number of milliseconds that Athena took to run the query.
Type: Long Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
QueryExecutionStatus
QueryExecutionStatus
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
Contents
AthenaError
Provides information about an Athena query error.
Type: AthenaError (p. 92) object Required: No
CompletionDateTime
The date and time that the query completed.
Type: Timestamp Required: No State
The state of query execution. QUEUED indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. RUNNING indicates that the query is in execution phase. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution.
NoteAthena automatically retries your queries in cases of certain transient errors. As a result, you may see the query state transition from RUNNING or FAILED to QUEUED.
Type: String
Valid Values: QUEUED | RUNNING | SUCCEEDED | FAILED | CANCELLED Required: No
StateChangeReason
Further detail about the status of the query.
Type: String Required: No SubmissionDateTime
The date and time that the query was submitted.
Type: Timestamp Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3