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 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.

Inheritance Hierarchy

System.Object
  Amazon.Athena.Model.WorkGroupConfiguration

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

Syntax

C#
public class WorkGroupConfiguration

The WorkGroupConfiguration type exposes the following members

Constructors

NameDescription
Public Method WorkGroupConfiguration()

Properties

NameTypeDescription
Public Property BytesScannedCutoffPerQuery System.Int64

Gets and sets the property BytesScannedCutoffPerQuery.

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

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 PublishCloudWatchMetricsEnabled System.Boolean

Gets and sets the property PublishCloudWatchMetricsEnabled.

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

Public Property RequesterPaysEnabled System.Boolean

Gets and sets the property RequesterPaysEnabled.

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.

Public Property ResultConfiguration Amazon.Athena.Model.ResultConfiguration

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

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms