ResultConfigurationUpdates
The information about the updates in the query results, such as output location and encryption configuration for the query results.
Contents
AclConfiguration
The ACL configuration for the query results.
Type: AclConfiguration (p. 91) object Required: No
EncryptionConfiguration
The encryption configuration for the query results.
Type: EncryptionConfiguration (p. 103) object Required: No
ExpectedBucketOwner
The AWS account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration:OutputLocation (p. 119). If set, Athena uses the value for
ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner AWS account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.
If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration:EnforceWorkGroupConfiguration (p. 133) and Workgroup Settings Override Client-Side Settings.
Type: String Required: No OutputLocation
The location in Amazon S3 where your query results are stored, such as s3://path/to/
query/bucket/. For more information, see Query Results 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. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration:EnforceWorkGroupConfiguration (p. 133).
Type: String Required: No
RemoveAclConfiguration
If set to true, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set to false or not set, and a value is present in the AclConfiguration of ResultConfigurationUpdates, the AclConfiguration in the workgroup's ResultConfiguration is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.
See Also
Type: Boolean Required: No
RemoveEncryptionConfiguration
If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null.
If set to "false" or not set, and a value is present in the EncryptionConfiguration in
ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.
Type: Boolean Required: No
RemoveExpectedBucketOwner
If set to "true", removes the AWS account ID previously specified for
ResultConfiguration:ExpectedBucketOwner (p. 119). If set to "false" or not set, and a value is present in the ExpectedBucketOwner in ResultConfigurationUpdates (the client-side setting), the ExpectedBucketOwner in the workgroup's ResultConfiguration is updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.
Type: Boolean Required: No RemoveOutputLocation
If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.
Type: Boolean 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
ResultSet
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 (p. 38).
Contents
ResultSetMetadata
The metadata that describes the column structure and data types of a table of query results.
Type: ResultSetMetadata (p. 124) object Required: No
Rows
The rows in the table.
Type: Array of Row (p. 125) objects 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
ResultSetMetadata
ResultSetMetadata
The metadata that describes the column structure and data types of a table of query results. To return a ResultSetMetadata object, use GetQueryResults (p. 38).
Contents
ColumnInfo
Information about the columns returned in a query result metadata.
Type: Array of ColumnInfo (p. 96) objects 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
Row
Row
The rows that make up a query result table.
Contents
Data
The data that populates a row in a query result table.
Type: Array of Datum (p. 102) objects 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
TableMetadata
TableMetadata
Contains metadata for a table.
Contents
Columns
A list of the columns in the table.
Type: Array of Column (p. 95) objects Required: No
CreateTime
The time that the table was created.
Type: Timestamp Required: No LastAccessTime
The last time the table was accessed.
Type: Timestamp Required: No Name
The name of the table.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes Parameters
A set of custom key/value pairs for table properties.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 255.
Key Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Value Length Constraints: Maximum length of 51200.
See Also
Type: String
Length Constraints: 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
Tag
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.
Contents
Key
A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No Value
A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 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
UnprocessedNamedQueryId
UnprocessedNamedQueryId
Information about a named query ID that could not be processed.
Contents
ErrorCode
The error code returned when the processing request for the named query failed, if applicable.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No ErrorMessage
The error message returned when the processing request for the named query failed, if applicable.
Type: String Required: No NamedQueryId
The unique identifier of the named query.
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
UnprocessedQueryExecutionId
UnprocessedQueryExecutionId
Describes a query execution that failed to process.
Contents
ErrorCode
The error code returned when the query execution failed to process, if applicable.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No ErrorMessage
The error message returned when the query execution failed to process, if applicable.
Type: String Required: No QueryExecutionId
The unique identifier of the query execution.
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
WorkGroup
WorkGroup
A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup:Configuration (p. 131). 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 (p. 133).
Contents
Configuration
The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side 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 (p. 133).
Type: WorkGroupConfiguration (p. 133) object Required: No
CreationTime
The date and time the workgroup was created.
Type: Timestamp Required: No Description
The workgroup description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
The state of the workgroup: ENABLED or DISABLED.
Type: String
Valid Values: ENABLED | DISABLED
See Also
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