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.

A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup$Configuration. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Inheritance Hierarchy

System.Object
  Amazon.Athena.Model.WorkGroup

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

Syntax

C#
public class WorkGroup

The WorkGroup type exposes the following members

Constructors

NameDescription
Public Method WorkGroup()

Properties

NameTypeDescription
Public Property Configuration Amazon.Athena.Model.WorkGroupConfiguration

Gets and sets the property Configuration.

The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for query and calculation results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side 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.

Public Property CreationTime System.DateTime

Gets and sets the property CreationTime.

The date and time the workgroup was created.

Public Property Description System.String

Gets and sets the property Description.

The workgroup description.

Public Property IdentityCenterApplicationArn System.String

Gets and sets the property IdentityCenterApplicationArn.

The ARN of the IAM Identity Center enabled application associated with the workgroup.

Public Property Name System.String

Gets and sets the property Name.

The workgroup name.

Public Property State Amazon.Athena.WorkGroupState

Gets and sets the property State.

The state of the workgroup: ENABLED or DISABLED.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5