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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-athena/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.

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



1526
1527
1528
1529
1530
1531
1532
1533
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 1526

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

#creation_timeTime

The date and time the workgroup was created.

Returns:

  • (Time)


1526
1527
1528
1529
1530
1531
1532
1533
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 1526

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

#descriptionString

The workgroup description.

Returns:

  • (String)


1526
1527
1528
1529
1530
1531
1532
1533
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 1526

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

#nameString

The workgroup name.

Returns:

  • (String)


1526
1527
1528
1529
1530
1531
1532
1533
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 1526

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

#stateString

The state of the workgroup: ENABLED or DISABLED.

Returns:

  • (String)


1526
1527
1528
1529
1530
1531
1532
1533
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 1526

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