AclConfiguration
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.
Contents
S3AclOption
The Amazon S3 canned ACL that Athena should specify when storing query results. Currently the only supported canned ACL is BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the workgroup overrides client-side settings, then the Amazon S3 canned ACL specified in the workgroup's settings is used for all queries that run in the workgroup. For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide.
Type: String
Valid Values: BUCKET_OWNER_FULL_CONTROL Required: Yes
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
AthenaError
AthenaError
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.
Contents
ErrorCategory
An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.
1 - System 2 - User 3 - Other Type: Integer
Valid Range: Minimum value of 1. Maximum value of 3.
Required: No ErrorType
An integer value that provides specific information about an Athena query error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User Guide.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 9999.
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
BatchGetNamedQueryInput
BatchGetNamedQueryInput
Contents
NamedQueryIds
An array of query IDs.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: Yes
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
BatchGetQueryExecutionInput
BatchGetQueryExecutionInput
Contents
QueryExecutionIds
An array of query execution IDs.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: Yes
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
Column
Column
Contains metadata for a column in a table.
Contents
Comment
Optional information about the column.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: No Name
The name of the column.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes Type
The data type of the column.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4096.
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
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
ColumnInfo
ColumnInfo
Information about the columns in a query execution result.
Contents
CaseSensitive
Indicates whether values in the column are case-sensitive.
Type: Boolean Required: No CatalogName
The catalog to which the query results belong.
Type: String Required: No Label
A column label.
Type: String Required: No Name
The name of the column.
Type: String Required: Yes Nullable
Indicates the column's nullable status.
Type: String
Valid Values: NOT_NULL | NULLABLE | UNKNOWN Required: No
Precision
For DECIMAL data types, specifies the total number of digits, up to 38. For performance reasons, we
See Also
Required: No SchemaName
The schema name (database name) to which the query results belong.
Type: String Required: No TableName
The table name for the query results.
Type: String Required: No Type
The data type of the column.
Type: String Required: Yes
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
Database
Database
Contains metadata information for a database in a data catalog.
Contents
Description
An optional description of the database.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No Name
The name of the database.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes Parameters
A set of custom key/value pairs.
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.
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
DataCatalog
DataCatalog
Contains information about a data catalog in an AWS account.
Contents
Description
An optional description of the data catalog.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No Name
The name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: Yes Parameters
Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type.
• For the HIVE data catalog type, use the following syntax. The metadata-function parameter is required. The sdk-version parameter is optional and defaults to the currently supported version.
metadata-function=lambda_arn, sdk-version=version_number
• For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both.
• If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.
metadata-function=lambda_arn, record-function=lambda_arn
• If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.
function=lambda_arn
• The GLUE type takes a catalog ID parameter and is required. The catalog_id is the account ID of the AWS account to which the AWS Glue catalog belongs.
catalog-id=catalog_id
• The GLUE data catalog type also applies to the default AwsDataCatalog that already exists in your account, of which you can have only one and cannot modify.
• Queries that specify a AWS Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2.
See Also
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.
Required: No Type
The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an AWS Glue Data Catalog.
Type: String
Valid Values: LAMBDA | GLUE | HIVE Required: Yes
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
DataCatalogSummary
DataCatalogSummary
The summary information for the data catalog, which includes its name and type.
Contents
CatalogName
The name of the data catalog. The catalog name is unique for the AWS account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: No Type
The data catalog type.
Type: String
Valid Values: LAMBDA | GLUE | HIVE 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
Datum
Datum
A piece of data (a field in the table).
Contents
VarCharValue
The value of the datum.
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