Struct aws_sdk_athena::types::WorkGroup

#[non_exhaustive]
pub struct WorkGroup {
    pub name: String,
    pub state: Option<WorkGroupState>,
    pub configuration: Option<WorkGroupConfiguration>,
    pub description: Option<String>,
    pub creation_time: Option<DateTime>,
    pub identity_center_application_arn: Option<String>,
}

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.

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.

name: String

The workgroup name.

state: Option<WorkGroupState>

The state of the workgroup: ENABLED or DISABLED.

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

description: Option<String>

The workgroup description.

creation_time: Option<DateTime>

The date and time the workgroup was created.

identity_center_application_arn: Option<String>

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

Implementations

impl WorkGroup

pub fn name(&self) -> &str

The workgroup name.

pub fn state(&self) -> Option<&WorkGroupState>

The state of the workgroup: ENABLED or DISABLED.

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

pub fn description(&self) -> Option<&str>

The workgroup description.

pub fn creation_time(&self) -> Option<&DateTime>

The date and time the workgroup was created.

pub fn identity_center_application_arn(&self) -> Option<&str>

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

impl WorkGroup

pub fn builder() -> WorkGroupBuilder

Creates a new builder-style object to manufacture WorkGroup.

Trait Implementations

impl Clone for WorkGroup

fn clone(&self) -> WorkGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorkGroup

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

Formats the value using the given formatter.

impl PartialEq for WorkGroup

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WorkGroup