AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy

System.Object
  Amazon.Athena.Model.WorkGroupConfigurationUpdates

Namespace: Amazon.Athena.Model
Assembly: AWSSDK.Athena.dll
Version: 3.x.y.z

Syntax

C#
public class WorkGroupConfigurationUpdates

The WorkGroupConfigurationUpdates type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AdditionalConfiguration System.String

Gets and sets the property AdditionalConfiguration.

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

Public Property BytesScannedCutoffPerQuery System.Int64

Gets and sets the property BytesScannedCutoffPerQuery.

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

Public Property CustomerContentEncryptionConfiguration Amazon.Athena.Model.CustomerContentEncryptionConfiguration

Gets and sets the property CustomerContentEncryptionConfiguration.

Public Property EnableMinimumEncryptionConfiguration System.Boolean

Gets and sets the property 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.

Public Property EnforceWorkGroupConfiguration System.Boolean

Gets and sets the property 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.

Public Property EngineVersion Amazon.Athena.Model.EngineVersion

Gets and sets the property 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.

Public Property ExecutionRole System.String

Gets and sets the property 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.

Public Property PublishCloudWatchMetricsEnabled System.Boolean

Gets and sets the property PublishCloudWatchMetricsEnabled.

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

Public Property QueryResultsS3AccessGrantsConfiguration Amazon.Athena.Model.QueryResultsS3AccessGrantsConfiguration

Gets and sets the property QueryResultsS3AccessGrantsConfiguration.

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

Public Property RemoveBytesScannedCutoffPerQuery System.Boolean

Gets and sets the property RemoveBytesScannedCutoffPerQuery.

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

Public Property RemoveCustomerContentEncryptionConfiguration System.Boolean

Gets and sets the property RemoveCustomerContentEncryptionConfiguration.

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

Public Property RequesterPaysEnabled System.Boolean

Gets and sets the property 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.

Public Property ResultConfigurationUpdates Amazon.Athena.Model.ResultConfigurationUpdates

Gets and sets the property 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5