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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#configuration ⇒ Types::WorkGroupConfiguration

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.

Returns:



5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
 
# File 'lib/aws-sdk-athena/types.rb', line 5023

class WorkGroup < Struct.new(
  :name,
  :state,
  :configuration,
  :description,
  :creation_time,
  :identity_center_application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The date and time the workgroup was created.

Returns:

  • (Time) 


5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
 
# File 'lib/aws-sdk-athena/types.rb', line 5023

class WorkGroup < Struct.new(
  :name,
  :state,
  :configuration,
  :description,
  :creation_time,
  :identity_center_application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The workgroup description.

Returns:

  • (String) 


5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
 
# File 'lib/aws-sdk-athena/types.rb', line 5023

class WorkGroup < Struct.new(
  :name,
  :state,
  :configuration,
  :description,
  :creation_time,
  :identity_center_application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#identity_center_application_arn ⇒ String

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

Returns:

  • (String) 


5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
 
# File 'lib/aws-sdk-athena/types.rb', line 5023

class WorkGroup < Struct.new(
  :name,
  :state,
  :configuration,
  :description,
  :creation_time,
  :identity_center_application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The workgroup name.

Returns:

  • (String) 


5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
 
# File 'lib/aws-sdk-athena/types.rb', line 5023

class WorkGroup < Struct.new(
  :name,
  :state,
  :configuration,
  :description,
  :creation_time,
  :identity_center_application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The state of the workgroup: ENABLED or DISABLED.

Returns:

  • (String) 


5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
 
# File 'lib/aws-sdk-athena/types.rb', line 5023

class WorkGroup < Struct.new(
  :name,
  :state,
  :configuration,
  :description,
  :creation_time,
  :identity_center_application_arn)
  SENSITIVE = []
  include Aws::Structure
end