/AWS1/CL_ATHWORKGROUPCONFUPDS

The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query and calculation 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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_enforceworkgroupconf TYPE /AWS1/ATHBOXEDBOOLEAN /AWS1/ATHBOXEDBOOLEAN

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.

io_resultconfupdates TYPE REF TO /AWS1/CL_ATHRESULTCONFUPDATES /AWS1/CL_ATHRESULTCONFUPDATES

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.

io_managedqueryrsltsconfupds TYPE REF TO /AWS1/CL_ATHMANAGEDQUERYRSSC01 /AWS1/CL_ATHMANAGEDQUERYRSSC01

Updates configuration information for managed query results in the workgroup.

iv_pubcloudwatchmetenabled TYPE /AWS1/ATHBOXEDBOOLEAN /AWS1/ATHBOXEDBOOLEAN

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

iv_bytesscndcutoffperquery TYPE /AWS1/ATHBYTESSCNDCUTOFFVALUE /AWS1/ATHBYTESSCNDCUTOFFVALUE

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

iv_rembytesscndcutoffperqu00 TYPE /AWS1/ATHBOXEDBOOLEAN /AWS1/ATHBOXEDBOOLEAN

Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

iv_requesterpaysenabled TYPE /AWS1/ATHBOXEDBOOLEAN /AWS1/ATHBOXEDBOOLEAN

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.

io_engineversion TYPE REF TO /AWS1/CL_ATHENGINEVERSION /AWS1/CL_ATHENGINEVERSION

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.

iv_removecuscontentencconf TYPE /AWS1/ATHBOXEDBOOLEAN /AWS1/ATHBOXEDBOOLEAN

Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.

iv_additionalconfiguration TYPE /AWS1/ATHNAMESTRING /AWS1/ATHNAMESTRING

Contains a user defined string in JSON format for a Spark-enabled workgroup.

iv_executionrole TYPE /AWS1/ATHROLEARN /AWS1/ATHROLEARN

The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

io_customercontentencconf TYPE REF TO /AWS1/CL_ATHCUSCONTENTENCCONF /AWS1/CL_ATHCUSCONTENTENCCONF

CustomerContentEncryptionConfiguration

iv_enableminimumencconf TYPE /AWS1/ATHBOXEDBOOLEAN /AWS1/ATHBOXEDBOOLEAN

Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.

The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

io_queryrsltss3accgrantsconf TYPE REF TO /AWS1/CL_ATHQUERYRSSS3ACCGRA00 /AWS1/CL_ATHQUERYRSSS3ACCGRA00

Specifies whether Amazon S3 access grants are enabled for query results.

io_monitoringconfiguration TYPE REF TO /AWS1/CL_ATHMONITORINGCONF /AWS1/CL_ATHMONITORINGCONF

Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

io_engineconfiguration TYPE REF TO /AWS1/CL_ATHENGINECONF /AWS1/CL_ATHENGINECONF

EngineConfiguration

---

Queryable Attributes

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.

Accessible with the following methods

Method	Description
GET_ENFORCEWORKGROUPCONF()	Getter for ENFORCEWORKGROUPCONF, with configurable default
ASK_ENFORCEWORKGROUPCONF()	Getter for ENFORCEWORKGROUPCONF w/ exceptions if field has n
HAS_ENFORCEWORKGROUPCONF()	Determine if ENFORCEWORKGROUPCONF has a value

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.

Accessible with the following methods

Method	Description
GET_RESULTCONFUPDATES()	Getter for RESULTCONFIGURATIONUPDATES

ManagedQueryResultsConfigurationUpdates

Updates configuration information for managed query results in the workgroup.

Accessible with the following methods

Method	Description
GET_MANAGEDQUERYRSLTSCONFUPS()	Getter for MANAGEDQUERYRSLTSCONFUPDATES

PublishCloudWatchMetricsEnabled

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

Accessible with the following methods

Method	Description
GET_PUBCLOUDWATCHMETENABLED()	Getter for PUBLISHCLOUDWATCHMETENABLED, with configurable de
ASK_PUBCLOUDWATCHMETENABLED()	Getter for PUBLISHCLOUDWATCHMETENABLED w/ exceptions if fiel
HAS_PUBCLOUDWATCHMETENABLED()	Determine if PUBLISHCLOUDWATCHMETENABLED has a value

BytesScannedCutoffPerQuery

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

Accessible with the following methods

Method	Description
GET_BYTESSCNDCUTOFFPERQUERY()	Getter for BYTESSCANNEDCUTOFFPERQUERY, with configurable def
ASK_BYTESSCNDCUTOFFPERQUERY()	Getter for BYTESSCANNEDCUTOFFPERQUERY w/ exceptions if field
HAS_BYTESSCNDCUTOFFPERQUERY()	Determine if BYTESSCANNEDCUTOFFPERQUERY has a value

RemoveBytesScannedCutoffPerQuery

Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

Accessible with the following methods

Method	Description
GET_REMBYTESSCNDCUTOFFPERQ00()	Getter for REMBYTESSCNDCUTOFFPERQUERY, with configurable def
ASK_REMBYTESSCNDCUTOFFPERQ00()	Getter for REMBYTESSCNDCUTOFFPERQUERY w/ exceptions if field
HAS_REMBYTESSCNDCUTOFFPERQ00()	Determine if REMBYTESSCNDCUTOFFPERQUERY has a value

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.

Accessible with the following methods

Method	Description
GET_REQUESTERPAYSENABLED()	Getter for REQUESTERPAYSENABLED, with configurable default
ASK_REQUESTERPAYSENABLED()	Getter for REQUESTERPAYSENABLED w/ exceptions if field has n
HAS_REQUESTERPAYSENABLED()	Determine if REQUESTERPAYSENABLED has a value

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.

Accessible with the following methods

Method	Description
GET_ENGINEVERSION()	Getter for ENGINEVERSION

RemoveCustomerContentEncryptionConfiguration

Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.

Accessible with the following methods

Method	Description
GET_REMOVECUSCONTENTENCCONF()	Getter for REMOVECUSTOMERCONTENTENCCONF, with configurable d
ASK_REMOVECUSCONTENTENCCONF()	Getter for REMOVECUSTOMERCONTENTENCCONF w/ exceptions if fie
HAS_REMOVECUSCONTENTENCCONF()	Determine if REMOVECUSTOMERCONTENTENCCONF has a value

AdditionalConfiguration

Contains a user defined string in JSON format for a Spark-enabled workgroup.

Accessible with the following methods

Method	Description
GET_ADDITIONALCONFIGURATION()	Getter for ADDITIONALCONFIGURATION, with configurable defaul
ASK_ADDITIONALCONFIGURATION()	Getter for ADDITIONALCONFIGURATION w/ exceptions if field ha
HAS_ADDITIONALCONFIGURATION()	Determine if ADDITIONALCONFIGURATION has a value

ExecutionRole

The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.

Accessible with the following methods

Method	Description
GET_EXECUTIONROLE()	Getter for EXECUTIONROLE, with configurable default
ASK_EXECUTIONROLE()	Getter for EXECUTIONROLE w/ exceptions if field has no value
HAS_EXECUTIONROLE()	Determine if EXECUTIONROLE has a value

CustomerContentEncryptionConfiguration

CustomerContentEncryptionConfiguration

Accessible with the following methods

Method	Description
GET_CUSTOMERCONTENTENCCONF()	Getter for CUSTOMERCONTENTENCCONF

EnableMinimumEncryptionConfiguration

Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.

The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

Accessible with the following methods

Method	Description
GET_ENABLEMINIMUMENCCONF()	Getter for ENABLEMINIMUMENCRYPTIONCONF, with configurable de
ASK_ENABLEMINIMUMENCCONF()	Getter for ENABLEMINIMUMENCRYPTIONCONF w/ exceptions if fiel
HAS_ENABLEMINIMUMENCCONF()	Determine if ENABLEMINIMUMENCRYPTIONCONF has a value

QueryResultsS3AccessGrantsConfiguration

Specifies whether Amazon S3 access grants are enabled for query results.

Accessible with the following methods

Method	Description
GET_QUERYRSSS3ACCGRANTSCONF()	Getter for QUERYRESULTSS3ACCGRANTSCONF

MonitoringConfiguration

Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

Accessible with the following methods

Method	Description
GET_MONITORINGCONFIGURATION()	Getter for MONITORINGCONFIGURATION

EngineConfiguration

EngineConfiguration

Accessible with the following methods

Method	Description
GET_ENGINECONFIGURATION()	Getter for ENGINECONFIGURATION