Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Athena.Types.WorkGroup

Description

Synopsis

Documentation

data WorkGroup Source #

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.

See: newWorkGroup smart constructor.

Constructors

WorkGroup'

Fields

creationTime :: Maybe POSIX
The date and time the workgroup was created.
state :: Maybe WorkGroupState
The state of the workgroup: ENABLED or DISABLED.
configuration :: Maybe WorkGroupConfiguration
The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query 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 :: Maybe Text
The workgroup description.
name :: Text
The workgroup name.

Instances

Instances details

Eq WorkGroup Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroup Methods (==) :: WorkGroup -> WorkGroup -> Bool # (/=) :: WorkGroup -> WorkGroup -> Bool #
Read WorkGroup Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroup Methods readsPrec :: Int -> ReadS WorkGroup # readList :: ReadS [WorkGroup] # readPrec :: ReadPrec WorkGroup # readListPrec :: ReadPrec [WorkGroup] #
Show WorkGroup Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroup Methods showsPrec :: Int -> WorkGroup -> ShowS # show :: WorkGroup -> String # showList :: [WorkGroup] -> ShowS #
Generic WorkGroup Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroup Associated Types type Rep WorkGroup :: Type -> Type # Methods from :: WorkGroup -> Rep WorkGroup x # to :: Rep WorkGroup x -> WorkGroup #
NFData WorkGroup Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroup Methods rnf :: WorkGroup -> () #
Hashable WorkGroup Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroup Methods hashWithSalt :: Int -> WorkGroup -> Int # hash :: WorkGroup -> Int #
FromJSON WorkGroup Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroup Methods parseJSON :: Value -> Parser WorkGroup # parseJSONList :: Value -> Parser [WorkGroup] #
type Rep WorkGroup Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroup type Rep WorkGroup = D1 ('MetaData "WorkGroup" "Amazonka.Athena.Types.WorkGroup" "libZSservicesZSamazonka-athenaZSamazonka-athena" 'False) (C1 ('MetaCons "WorkGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkGroupState))) :: (S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkGroupConfiguration)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newWorkGroup Source #

Arguments

:: Text	`$sel:name:WorkGroup'`
-> WorkGroup

Create a value of WorkGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTime:WorkGroup', workGroup_creationTime - The date and time the workgroup was created.

$sel:state:WorkGroup', workGroup_state - The state of the workgroup: ENABLED or DISABLED.

$sel:configuration:WorkGroup', workGroup_configuration - The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query 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.

$sel:description:WorkGroup', workGroup_description - The workgroup description.

$sel:name:WorkGroup', workGroup_name - The workgroup name.

workGroup_creationTime :: Lens' WorkGroup (Maybe UTCTime) Source #

The date and time the workgroup was created.

workGroup_state :: Lens' WorkGroup (Maybe WorkGroupState) Source #

The state of the workgroup: ENABLED or DISABLED.

workGroup_configuration :: Lens' WorkGroup (Maybe WorkGroupConfiguration) Source #

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query 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.

workGroup_description :: Lens' WorkGroup (Maybe Text) Source #

The workgroup description.

workGroup_name :: Lens' WorkGroup Text Source #

The workgroup name.