WorkGroupConfigurationUpdates
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.
Contents
- BytesScannedCutoffPerQuery
-
The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
Type: Long
Valid Range: Minimum value of 10000000.
Required: No
- 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.
Type: Boolean
Required: No
- 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.Type: EngineVersion object
Required: No
- PublishCloudWatchMetricsEnabled
-
Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
Type: Boolean
Required: No
- RemoveBytesScannedCutoffPerQuery
-
Indicates that the data usage control limit per query is removed. WorkGroupConfiguration:BytesScannedCutoffPerQuery
Type: Boolean
Required: No
- RequesterPaysEnabled
-
If set to
true
, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set tofalse
, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default isfalse
. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.Type: Boolean
Required: No
- 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.
Type: ResultConfigurationUpdates object
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: