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

Class: Aws::Athena::Types::WorkGroupConfiguration

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

Overview

Note:

When making an API call, you may pass WorkGroupConfiguration data as a hash:

{
  result_configuration: {
    output_location: "String",
    encryption_configuration: {
      encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
      kms_key: "String",
    },
  },
  enforce_work_group_configuration: false,
  publish_cloud_watch_metrics_enabled: false,
  bytes_scanned_cutoff_per_query: 1,
  requester_pays_enabled: false,
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#bytes_scanned_cutoff_per_queryInteger

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

Returns:

  • (Integer)


1571
1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 1571

class WorkGroupConfiguration < Struct.new(
  :result_configuration,
  :enforce_work_group_configuration,
  :publish_cloud_watch_metrics_enabled,
  :bytes_scanned_cutoff_per_query,
  :requester_pays_enabled)
  include Aws::Structure
end

#enforce_work_group_configurationBoolean

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.

Returns:

  • (Boolean)


1571
1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 1571

class WorkGroupConfiguration < Struct.new(
  :result_configuration,
  :enforce_work_group_configuration,
  :publish_cloud_watch_metrics_enabled,
  :bytes_scanned_cutoff_per_query,
  :requester_pays_enabled)
  include Aws::Structure
end

#publish_cloud_watch_metrics_enabledBoolean

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

Returns:

  • (Boolean)


1571
1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 1571

class WorkGroupConfiguration < Struct.new(
  :result_configuration,
  :enforce_work_group_configuration,
  :publish_cloud_watch_metrics_enabled,
  :bytes_scanned_cutoff_per_query,
  :requester_pays_enabled)
  include Aws::Structure
end

#requester_pays_enabledBoolean

If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

Returns:

  • (Boolean)


1571
1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 1571

class WorkGroupConfiguration < Struct.new(
  :result_configuration,
  :enforce_work_group_configuration,
  :publish_cloud_watch_metrics_enabled,
  :bytes_scanned_cutoff_per_query,
  :requester_pays_enabled)
  include Aws::Structure
end

#result_configurationTypes::ResultConfiguration

The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.



1571
1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 1571

class WorkGroupConfiguration < Struct.new(
  :result_configuration,
  :enforce_work_group_configuration,
  :publish_cloud_watch_metrics_enabled,
  :bytes_scanned_cutoff_per_query,
  :requester_pays_enabled)
  include Aws::Structure
end