Struct aws_sdk_athena::model::WorkGroupConfiguration

#[non_exhaustive]
pub struct WorkGroupConfiguration {
    pub result_configuration: Option<ResultConfiguration>,
    pub enforce_work_group_configuration: Option<bool>,
    pub publish_cloud_watch_metrics_enabled: Option<bool>,
    pub bytes_scanned_cutoff_per_query: Option<i64>,
    pub requester_pays_enabled: Option<bool>,
    pub engine_version: Option<EngineVersion>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

result_configuration: Option<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.

enforce_work_group_configuration: Option<bool>

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.

publish_cloud_watch_metrics_enabled: Option<bool>

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

bytes_scanned_cutoff_per_query: Option<i64>

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

requester_pays_enabled: Option<bool>

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.

engine_version: Option<EngineVersion>

The engine version that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

Implementations

impl WorkGroupConfiguration

pub fn result_configuration(&self) -> Option<&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.

pub fn enforce_work_group_configuration(&self) -> Option<bool>

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.

pub fn publish_cloud_watch_metrics_enabled(&self) -> Option<bool>

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

pub fn bytes_scanned_cutoff_per_query(&self) -> Option<i64>

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

pub fn requester_pays_enabled(&self) -> Option<bool>

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.

pub fn engine_version(&self) -> Option<&EngineVersion>

The engine version that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

impl WorkGroupConfiguration

pub fn builder() -> Builder

Creates a new builder-style object to manufacture WorkGroupConfiguration

Trait Implementations

impl Clone for WorkGroupConfiguration

fn clone(&self) -> WorkGroupConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WorkGroupConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<WorkGroupConfiguration> for WorkGroupConfiguration

fn eq(&self, other: &WorkGroupConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &WorkGroupConfiguration) -> bool

This method tests for !=.

impl StructuralPartialEq for WorkGroupConfiguration