You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Athena::Types::WorkGroupConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::Athena::Types::WorkGroupConfiguration
- Defined in:
- (unknown)
Overview
When passing WorkGroupConfiguration as input to an Aws::Client method, you can use a vanilla Hash:
{
result_configuration: {
output_location: "String",
encryption_configuration: {
encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
kms_key: "String",
},
},
enforce_work_group_configuration: false,
publish_cloud_watch_metrics_enabled: false,
bytes_scanned_cutoff_per_query: 1,
requester_pays_enabled: false,
}
The configuration of the 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 and whether workgroup settings override query 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.
Returned by:
Instance Attribute Summary collapse
-
#bytes_scanned_cutoff_per_query ⇒ Integer
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
-
#enforce_work_group_configuration ⇒ Boolean
If set to \"true\", the settings for the workgroup override client-side settings.
-
#publish_cloud_watch_metrics_enabled ⇒ Boolean
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
-
#requester_pays_enabled ⇒ Boolean
If set to
true
, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. -
#result_configuration ⇒ Types::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.
Instance Attribute Details
#bytes_scanned_cutoff_per_query ⇒ Integer
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
#enforce_work_group_configuration ⇒ Boolean
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.
#publish_cloud_watch_metrics_enabled ⇒ Boolean
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
#requester_pays_enabled ⇒ Boolean
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.
#result_configuration ⇒ Types::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.