Amazonka.Athena.Types.WorkGroup

Documentation

data WorkGroup

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

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

• creationTime :: Maybe POSIX

  The date and time the workgroup was created.

• description :: Maybe Text

  The workgroup description.

• state :: Maybe WorkGroupState

  The state of the workgroup: ENABLED or DISABLED.

• name :: Text

  The workgroup name.

Instances

FromJSON WorkGroup

Defined in Amazonka.Athena.Types.WorkGroup

Methods

parseJSON :: Value -> Parser WorkGroup

parseJSONList :: Value -> Parser [WorkGroup]

Generic WorkGroup

Defined in Amazonka.Athena.Types.WorkGroup

Associated Types

type Rep WorkGroup :: Type -> Type

Methods

from :: WorkGroup -> Rep WorkGroup x

to :: Rep WorkGroup x -> WorkGroup

Read WorkGroup

Defined in Amazonka.Athena.Types.WorkGroup

Methods

readsPrec :: Int -> ReadS WorkGroup

readList :: ReadS [WorkGroup]

readPrec :: ReadPrec WorkGroup

readListPrec :: ReadPrec [WorkGroup]

Show WorkGroup

Defined in Amazonka.Athena.Types.WorkGroup

Methods

showsPrec :: Int -> WorkGroup -> ShowS

show :: WorkGroup -> String

showList :: [WorkGroup] -> ShowS

NFData WorkGroup

Defined in Amazonka.Athena.Types.WorkGroup

Methods

rnf :: WorkGroup -> ()

Eq WorkGroup

Defined in Amazonka.Athena.Types.WorkGroup

Methods

(==) :: WorkGroup -> WorkGroup -> Bool

(/=) :: WorkGroup -> WorkGroup -> Bool

Hashable WorkGroup

Defined in Amazonka.Athena.Types.WorkGroup

Methods

hashWithSalt :: Int -> WorkGroup -> Int

hash :: WorkGroup -> Int

type Rep WorkGroup

Defined in Amazonka.Athena.Types.WorkGroup

type Rep WorkGroup = D1 ('MetaData "WorkGroup" "Amazonka.Athena.Types.WorkGroup" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "WorkGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkGroupConfiguration)) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkGroupState)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newWorkGroup

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: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:creationTime:WorkGroup', workGroup_creationTime - The date and time the workgroup was created.

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

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

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

workGroup_configuration :: Lens' WorkGroup (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.

workGroup_creationTime :: Lens' WorkGroup (Maybe UTCTime)

The date and time the workgroup was created.

workGroup_description :: Lens' WorkGroup (Maybe Text)

The workgroup description.

workGroup_state :: Lens' WorkGroup (Maybe WorkGroupState)

The state of the workgroup: ENABLED or DISABLED.

workGroup_name :: Lens' WorkGroup Text

The workgroup name.