AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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 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,
  engine_version: {
    selected_engine_version: "NameString",
    effective_engine_version: "NameString",
  },
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bytes_scanned_cutoff_per_queryInteger

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

Returns:

  • (Integer)


2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2849

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,
  :engine_version)
  SENSITIVE = []
  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)


2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2849

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,
  :engine_version)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionTypes::EngineVersion

The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.



2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2849

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,
  :engine_version)
  SENSITIVE = []
  include Aws::Structure
end

#publish_cloud_watch_metrics_enabledBoolean

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

Returns:

  • (Boolean)


2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2849

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,
  :engine_version)
  SENSITIVE = []
  include Aws::Structure
end

#remove_bytes_scanned_cutoff_per_queryBoolean

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

Returns:

  • (Boolean)


2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2849

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,
  :engine_version)
  SENSITIVE = []
  include Aws::Structure
end

#requester_pays_enabledBoolean

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.

Returns:

  • (Boolean)


2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2849

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,
  :engine_version)
  SENSITIVE = []
  include Aws::Structure
end

#result_configuration_updatesTypes::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.



2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 2849

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,
  :engine_version)
  SENSITIVE = []
  include Aws::Structure
end