You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Athena::Types::WorkGroup

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#configurationTypes::WorkGroupConfiguration

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

Returns:

  • (Types::WorkGroupConfiguration)

    The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limit for the amount of data scanned per query, if it is specified.

#creation_timeTime

The date and time the workgroup was created.

Returns:

  • (Time)

    The date and time the workgroup was created.

#descriptionString

The workgroup description.

Returns:

  • (String)

    The workgroup description.

#nameString

The workgroup name.

Returns:

  • (String)

    The workgroup name.

#stateString

The state of the workgroup: ENABLED or DISABLED.

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String)

    The state of the workgroup: ENABLED or DISABLED.