Integer 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 - Unknown
String catalogName
The catalog to which the query results belong.
String schemaName
The schema name (database name) to which the query results belong.
String tableName
The table name for the query results.
String name
The name of the column.
String label
A column label.
String type
The data type of the column.
Integer precision
For DECIMAL data types, specifies the total number of digits, up to 38. For performance reasons, we
recommend up to 18 digits.
Integer scale
For DECIMAL data types, specifies the total number of digits in the fractional part of the value.
Defaults to 0.
String nullable
Indicates the column's nullable status.
Boolean caseSensitive
Indicates whether values in the column are case-sensitive.
String name
The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services 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.
String type
The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an
external hive metastore, or GLUE for an Glue Data Catalog.
String description
A description of the data catalog to be created.
Map<K,V> parameters
Specifies the Lambda function or functions to use for creating 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 Amazon Web Services account to which the Glue Data 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 Glue Data Catalog other than the default AwsDataCatalog must be run on Athena
engine version 2.
In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an
INVALID_INPUT error.
List<E> tags
A list of comma separated tags to add to the data catalog that is created.
String name
The query name.
String description
The query description.
String database
The database to which the query belongs.
String queryString
The contents of the query with all query statements.
String clientRequestToken
A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once).
If another CreateNamedQuery request is received, the same response is returned and another query is
not created. If a parameter has changed, for example, the QueryString, an error is returned.
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
String workGroup
The name of the workgroup in which the named query is being created.
String namedQueryId
The unique ID of the query.
String statementName
The name of the prepared statement.
String workGroup
The name of the workgroup to which the prepared statement belongs.
String queryStatement
The query string for the prepared statement.
String description
The description of the prepared statement.
String name
The workgroup name.
WorkGroupConfiguration configuration
The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored, the
encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are
enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and
whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the
WorkGroupConfiguration override client-side settings. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
String description
The workgroup description.
List<E> tags
A list of comma separated tags to add to the workgroup that is created.
String name
The name of the data catalog. The catalog name must be unique for the Amazon Web Services 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.
String description
An optional description of the data catalog.
String type
The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an
external hive metastore, or GLUE for an Glue Data Catalog.
Map<K,V> 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 Amazon Web Services account to which the 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 Glue Data Catalog other than the default AwsDataCatalog must be run on Athena
engine version 2.
String catalogName
The name of the data catalog. The catalog name is unique for the Amazon Web Services 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.
String type
The data catalog type.
String varCharValue
The value of the datum.
String name
The name of the data catalog to delete.
String namedQueryId
The unique ID of the query to delete.
String encryptionOption
Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side
encryption with KMS-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.
String kmsKey
For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.
String selectedEngineVersion
The engine version requested by the user. Possible values are determined by the output of
ListEngineVersions, including Auto. The default is Auto.
String 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.
Database database
The database returned.
String name
The name of the data catalog to return.
DataCatalog dataCatalog
The data catalog returned.
String namedQueryId
The unique ID of the query. Use ListNamedQueries to get query IDs.
NamedQuery namedQuery
Information about the query.
PreparedStatement preparedStatement
The name of the prepared statement that was retrieved.
String queryExecutionId
The unique ID of the query execution.
QueryExecution queryExecution
Information about the query execution.
String queryExecutionId
The unique ID of the query execution.
String 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.
Integer maxResults
The maximum number of results (rows) to return in this request.
Long updateCount
The number of rows inserted with a CREATE TABLE AS SELECT statement.
ResultSet resultSet
The results of the query execution.
String 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.
TableMetadata tableMetadata
An object that contains table metadata.
String workGroup
The name of the workgroup.
WorkGroup workGroup
Information about the workgroup.
String athenaErrorCode
String catalogName
The name of the data catalog that contains the databases to return.
String 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.
Integer maxResults
Specifies the maximum number of results to return.
List<E> databaseList
A list of databases from a data catalog.
String 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.
String 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.
Integer maxResults
Specifies the maximum number of data catalogs to return.
List<E> dataCatalogsSummary
A summary list of data catalogs.
String 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.
String 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.
Integer maxResults
The maximum number of engine versions to return in this request.
List<E> engineVersions
A list of engine versions that are available to choose from.
String 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.
String 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.
Integer maxResults
The maximum number of queries to return in this request.
String 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.
List<E> namedQueryIds
The list of unique query IDs.
String 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.
String workGroup
The workgroup to list the prepared statements for.
String 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.
Integer maxResults
The maximum number of results to return in this request.
List<E> preparedStatements
The list of prepared statements for the workgroup.
String 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.
String 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.
Integer maxResults
The maximum number of query executions to return in this request.
String 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.
String catalogName
The name of the data catalog for which table metadata should be returned.
String databaseName
The name of the database for which table metadata should be returned.
String expression
A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.
String 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.
Integer maxResults
Specifies the maximum number of results to return.
List<E> tableMetadataList
A list of table metadata.
String 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.
String resourceARN
Lists the tags for the resource with the specified ARN.
String nextToken
The token for the next set of results, or null if there are no additional results for this request, where the request lists the tags for the resource with the specified ARN.
Integer maxResults
The maximum number of results to be returned per request that lists the tags for the resource.
String 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.
Integer maxResults
The maximum number of workgroups to return in this request.
List<E> workGroups
A list of WorkGroupSummary objects that include the names, descriptions, creation times, and states for each workgroup.
String 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.
String name
The query name.
String description
The query description.
String database
The database to which the query belongs.
String queryString
The SQL query statements that comprise the query.
String namedQueryId
The unique identifier of the query.
String workGroup
The name of the workgroup that contains the named query.
String statementName
The name of the prepared statement.
String queryStatement
The query string for the prepared statement.
String workGroupName
The name of the workgroup to which the prepared statement belongs.
String description
The description of the prepared statement.
Date lastModifiedTime
The last modified time of the prepared statement.
String queryExecutionId
The unique identifier for each query execution.
String query
The SQL query statements which the query execution ran.
String statementType
The type of query statement that was run. DDL indicates DDL query statements. DML
indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT.
UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE,
or DESCRIBE TABLE.
ResultConfiguration 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.
QueryExecutionContext queryExecutionContext
The database in which the query execution occurred.
QueryExecutionStatus status
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
QueryExecutionStatistics 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.
String workGroup
The name of the workgroup in which the query ran.
EngineVersion engineVersion
The engine version that executed the query.
Long engineExecutionTimeInMillis
The number of milliseconds that the query took to execute.
Long dataScannedInBytes
The number of bytes in the data that was queried.
String 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.
Long totalExecutionTimeInMillis
The number of milliseconds that Athena took to run the query.
Long 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.
Long 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.
Long serviceProcessingTimeInMillis
The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.
String 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.
Athena 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.
String stateChangeReason
Further detail about the status of the query.
Date submissionDateTime
The date and time that the query was submitted.
Date completionDateTime
The date and time that the query completed.
AthenaError athenaError
Provides information about an Athena query error.
String resourceName
String outputLocation
The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/.
To run the query, you must specify the query results location using one of the ways: either for individual
queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If
none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results. If workgroup settings
override client-side settings, then the query uses the settings specified for the workgroup. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration.
EncryptionConfiguration encryptionConfiguration
If query results are encrypted in Amazon S3, indicates the encryption option used (for example,
SSE-KMS or CSE-KMS) and key information. This is a client-side setting. If workgroup
settings override client-side settings, then the query uses the encryption configuration that is specified for
the workgroup, and also uses the location for storing query results specified in the workgroup. See
WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override
Client-Side Settings.
String expectedBucketOwner
The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by
ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner
when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon
Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a
permissions error.
This is a client-side setting. 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
and Workgroup Settings
Override Client-Side Settings.
String 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.
Boolean 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 is updated with the
new value. For more information, see Workgroup Settings Override
Client-Side Settings.
EncryptionConfiguration encryptionConfiguration
The encryption configuration for the query results.
Boolean 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 is updated with the new value. For more information, see Workgroup Settings Override
Client-Side Settings.
String expectedBucketOwner
The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by
ResultConfiguration$OutputLocation. If set, Athena uses the value for ExpectedBucketOwner
when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon
Web Services 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 and Workgroup Settings Override
Client-Side Settings.
Boolean removeExpectedBucketOwner
If set to "true", removes the Amazon Web Services account ID previously specified for
ResultConfiguration$ExpectedBucketOwner. 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.
List<E> rows
The rows in the table.
ResultSetMetadata resultSetMetadata
The metadata that describes the column structure and data types of a table of query results.
String queryString
The SQL query statements to be executed.
String clientRequestToken
A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once).
If another StartQueryExecution request is received, the same response is returned and another query
is not created. If a parameter has changed, for example, the QueryString, an error is returned.
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
QueryExecutionContext queryExecutionContext
The database within which the query executes.
ResultConfiguration resultConfiguration
Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
String workGroup
The name of the workgroup in which the query is being started.
String queryExecutionId
The unique ID of the query that ran as a result of this request.
String queryExecutionId
The unique ID of the query execution to stop.
String name
The name of the table.
Date createTime
The time that the table was created.
Date lastAccessTime
The last time the table was accessed.
String tableType
The type of table. In Athena, only EXTERNAL_TABLE is supported.
List<E> columns
A list of the columns in the table.
List<E> partitionKeys
A list of the partition keys in the table.
Map<K,V> parameters
A set of custom key/value pairs for table properties.
String 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.
String 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.
String reason
String namedQueryId
The unique identifier of the named query.
String errorCode
The error code returned when the processing request for the named query failed, if applicable.
String errorMessage
The error message returned when the processing request for the named query failed, if applicable.
String queryExecutionId
The unique identifier of the query execution.
String errorCode
The error code returned when the query execution failed to process, if applicable.
String errorMessage
The error message returned when the query execution failed to process, if applicable.
String name
The name of the data catalog to update. The catalog name must be unique for the Amazon Web Services 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.
String type
Specifies the type of data catalog to update. Specify LAMBDA for a federated catalog,
HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.
String description
New or modified text that describes the data catalog.
Map<K,V> parameters
Specifies the Lambda function or functions to use for updating 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
String workGroup
The specified workgroup that will be updated.
String description
The workgroup description.
WorkGroupConfigurationUpdates configurationUpdates
The workgroup configuration that will be updated for the given workgroup.
String state
The workgroup state that will be updated for the given workgroup.
String name
The workgroup name.
String state
The state of the workgroup: ENABLED or DISABLED.
WorkGroupConfiguration 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.
String description
The workgroup description.
Date creationTime
The date and time the workgroup was created.
ResultConfiguration resultConfiguration
The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.
Boolean enforceWorkGroupConfiguration
If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.
Boolean publishCloudWatchMetricsEnabled
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
Long bytesScannedCutoffPerQuery
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
Boolean requesterPaysEnabled
If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets
in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and
queries that retrieve data from Requester Pays buckets cause an error. The default is false. For
more information about Requester Pays buckets, see Requester Pays Buckets in
the Amazon Simple Storage Service Developer Guide.
EngineVersion engineVersion
The engine version that all queries running on the workgroup use. Queries on the
AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.
Boolean enforceWorkGroupConfiguration
If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.
ResultConfigurationUpdates resultConfigurationUpdates
The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.
Boolean publishCloudWatchMetricsEnabled
Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
Long bytesScannedCutoffPerQuery
The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
Boolean removeBytesScannedCutoffPerQuery
Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
Boolean requesterPaysEnabled
If set to true, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets
in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and
queries that retrieve data from Requester Pays buckets cause an error. The default is false. For
more information about Requester Pays buckets, see Requester Pays Buckets in
the Amazon Simple Storage Service Developer Guide.
EngineVersion engineVersion
The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on
the requested engine version. If no value was previously set, the default is Auto. Queries on the
AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.
String name
The name of the workgroup.
String state
The state of the workgroup.
String description
The workgroup description.
Date creationTime
The workgroup creation date and time.
EngineVersion engineVersion
The engine version setting for all queries on the workgroup. Queries on the
AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.
Copyright © 2022. All rights reserved.