- conn
A dbConnect
object, as returned by dbConnect()
- work_group
The Athena workgroup name.
- enforce_work_group_config
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
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
- bytes_scanned_cut_off
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
- requester_pays
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.
- description
The workgroup description.
- tags
A tag that you can add to a resource. A tag is a label that you assign to an AWS Athena resource (a workgroup).
Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize workgroups in Athena, for example,
by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account.
The maximum tag key length is 128 Unicode characters in UTF-8. The maximum tag value length is 256 Unicode characters in UTF-8.
You 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. Please use the helper function tag_options()
to create tags for work group, if no tags are required please put NULL
for this parameter.
- 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.
- 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.
- recursive_delete_option
The option to delete the workgroup and its contents even if the workgroup contains any named queries
- remove_output_location
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
the out put location in the workgroup's result configuration will be updated with the new value.
For more information, see Workgroup Settings Override Client-Side Settings.
- state
The workgroup state that will be updated for the given workgroup.