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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-athena/types.rb

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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#configuration ⇒ 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. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Returns:



1415
1416
1417
1418
1419
1420
1421
1422
 
# File 'lib/aws-sdk-athena/types.rb', line 1415

class WorkGroup < Struct.new(
  :name,
  :state,
  :configuration,
  :description,
  :creation_time)
  include Aws::Structure
end

#creation_time ⇒ Time

The date and time the workgroup was created.

Returns:

  • (Time) 


1415
1416
1417
1418
1419
1420
1421
1422
 
# File 'lib/aws-sdk-athena/types.rb', line 1415

class WorkGroup < Struct.new(
  :name,
  :state,
  :configuration,
  :description,
  :creation_time)
  include Aws::Structure
end

#description ⇒ String

The workgroup description.

Returns:

  • (String) 


1415
1416
1417
1418
1419
1420
1421
1422
 
# File 'lib/aws-sdk-athena/types.rb', line 1415

class WorkGroup < Struct.new(
  :name,
  :state,
  :configuration,
  :description,
  :creation_time)
  include Aws::Structure
end

#name ⇒ String

The workgroup name.

Returns:

  • (String) 


1415
1416
1417
1418
1419
1420
1421
1422
 
# File 'lib/aws-sdk-athena/types.rb', line 1415

class WorkGroup < Struct.new(
  :name,
  :state,
  :configuration,
  :description,
  :creation_time)
  include Aws::Structure
end

#state ⇒ String

The state of the workgroup: ENABLED or DISABLED.

Returns:

  • (String) 


1415
1416
1417
1418
1419
1420
1421
1422
 
# File 'lib/aws-sdk-athena/types.rb', line 1415

class WorkGroup < Struct.new(
  :name,
  :state,
  :configuration,
  :description,
  :creation_time)
  include Aws::Structure
end