Class: Aws::Athena::Types::WorkGroupConfigurationUpdates

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

Overview

Note:

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

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

The configuration information that will be updated for this 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, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bytes_scanned_cutoff_per_query ⇒ Integer

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

Returns:

  • (Integer) 


1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/aws-sdk-athena/types.rb', line 1671

class WorkGroupConfigurationUpdates < Struct.new(
  :enforce_work_group_configuration,
  :result_configuration_updates,
  :publish_cloud_watch_metrics_enabled,
  :bytes_scanned_cutoff_per_query,
  :remove_bytes_scanned_cutoff_per_query,
  :requester_pays_enabled)
  include Aws::Structure
end

#enforce_work_group_configuration ⇒ Boolean

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

[1]: docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html

Returns:

  • (Boolean) 


1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/aws-sdk-athena/types.rb', line 1671

class WorkGroupConfigurationUpdates < Struct.new(
  :enforce_work_group_configuration,
  :result_configuration_updates,
  :publish_cloud_watch_metrics_enabled,
  :bytes_scanned_cutoff_per_query,
  :remove_bytes_scanned_cutoff_per_query,
  :requester_pays_enabled)
  include Aws::Structure
end

#publish_cloud_watch_metrics_enabled ⇒ Boolean

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

Returns:

  • (Boolean) 


1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/aws-sdk-athena/types.rb', line 1671

class WorkGroupConfigurationUpdates < Struct.new(
  :enforce_work_group_configuration,
  :result_configuration_updates,
  :publish_cloud_watch_metrics_enabled,
  :bytes_scanned_cutoff_per_query,
  :remove_bytes_scanned_cutoff_per_query,
  :requester_pays_enabled)
  include Aws::Structure
end

#remove_bytes_scanned_cutoff_per_query ⇒ Boolean

Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

Returns:

  • (Boolean) 


1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/aws-sdk-athena/types.rb', line 1671

class WorkGroupConfigurationUpdates < Struct.new(
  :enforce_work_group_configuration,
  :result_configuration_updates,
  :publish_cloud_watch_metrics_enabled,
  :bytes_scanned_cutoff_per_query,
  :remove_bytes_scanned_cutoff_per_query,
  :requester_pays_enabled)
  include Aws::Structure
end

#requester_pays_enabled ⇒ Boolean

If set to ‘true`, allows members assigned to a workgroup to specify 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*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html

Returns:

  • (Boolean) 


1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/aws-sdk-athena/types.rb', line 1671

class WorkGroupConfigurationUpdates < Struct.new(
  :enforce_work_group_configuration,
  :result_configuration_updates,
  :publish_cloud_watch_metrics_enabled,
  :bytes_scanned_cutoff_per_query,
  :remove_bytes_scanned_cutoff_per_query,
  :requester_pays_enabled)
  include Aws::Structure
end

#result_configuration_updates ⇒ Types::ResultConfigurationUpdates

The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

Returns:



1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/aws-sdk-athena/types.rb', line 1671

class WorkGroupConfigurationUpdates < Struct.new(
  :enforce_work_group_configuration,
  :result_configuration_updates,
  :publish_cloud_watch_metrics_enabled,
  :bytes_scanned_cutoff_per_query,
  :remove_bytes_scanned_cutoff_per_query,
  :requester_pays_enabled)
  include Aws::Structure
end