AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

WorkGroupConfiguration

import "github.com/aws/aws-sdk-go/service/athena"

type WorkGroupConfiguration struct { BytesScannedCutoffPerQuery *int64 `min:"1e+07" type:"long"` EnforceWorkGroupConfiguration *bool `type:"boolean"` PublishCloudWatchMetricsEnabled *bool `type:"boolean"` ResultConfiguration *ResultConfiguration `type:"structure"` }

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 limit for the amount of data scanned per query, if it is specified. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

BytesScannedCutoffPerQuery

Type: *int64

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

EnforceWorkGroupConfiguration

Type: *bool

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 (https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).

PublishCloudWatchMetricsEnabled

Type: *bool

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

ResultConfiguration

The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.

Method

GoString

func (s WorkGroupConfiguration) GoString() string

GoString returns the string representation

SetBytesScannedCutoffPerQuery

func (s *WorkGroupConfiguration) SetBytesScannedCutoffPerQuery(v int64) *WorkGroupConfiguration

SetBytesScannedCutoffPerQuery sets the BytesScannedCutoffPerQuery field's value.

SetEnforceWorkGroupConfiguration

func (s *WorkGroupConfiguration) SetEnforceWorkGroupConfiguration(v bool) *WorkGroupConfiguration

SetEnforceWorkGroupConfiguration sets the EnforceWorkGroupConfiguration field's value.

SetPublishCloudWatchMetricsEnabled

func (s *WorkGroupConfiguration) SetPublishCloudWatchMetricsEnabled(v bool) *WorkGroupConfiguration

SetPublishCloudWatchMetricsEnabled sets the PublishCloudWatchMetricsEnabled field's value.

SetResultConfiguration

func (s *WorkGroupConfiguration) SetResultConfiguration(v *ResultConfiguration) *WorkGroupConfiguration

SetResultConfiguration sets the ResultConfiguration field's value.

String

func (s WorkGroupConfiguration) String() string

String returns the string representation

Validate

func (s *WorkGroupConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: