Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Athena.Types.WorkGroupConfiguration

Description

Synopsis

Documentation

data WorkGroupConfiguration Source #

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.

See: newWorkGroupConfiguration smart constructor.

Constructors

WorkGroupConfiguration'

Fields

additionalConfiguration :: Maybe Text
Specifies a user defined JSON string that is passed to the notebook engine.
bytesScannedCutoffPerQuery :: Maybe Natural
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
customerContentEncryptionConfiguration :: Maybe CustomerContentEncryptionConfiguration
Specifies the KMS key that is used to encrypt the user's data stores in Athena.
enforceWorkGroupConfiguration :: Maybe 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.
engineVersion :: Maybe 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.
executionRole :: Maybe Text
Role used in a notebook session for accessing the user's resources.
publishCloudWatchMetricsEnabled :: Maybe Bool
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
requesterPaysEnabled :: Maybe 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.
resultConfiguration :: Maybe 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.

Instances

Instances details

FromJSON WorkGroupConfiguration Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfiguration Methods parseJSON :: Value -> Parser WorkGroupConfiguration # parseJSONList :: Value -> Parser [WorkGroupConfiguration] #
ToJSON WorkGroupConfiguration Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfiguration Methods toJSON :: WorkGroupConfiguration -> Value # toEncoding :: WorkGroupConfiguration -> Encoding # toJSONList :: [WorkGroupConfiguration] -> Value # toEncodingList :: [WorkGroupConfiguration] -> Encoding #
Generic WorkGroupConfiguration Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfiguration Associated Types type Rep WorkGroupConfiguration :: Type -> Type # Methods from :: WorkGroupConfiguration -> Rep WorkGroupConfiguration x # to :: Rep WorkGroupConfiguration x -> WorkGroupConfiguration #
Read WorkGroupConfiguration Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfiguration Methods readsPrec :: Int -> ReadS WorkGroupConfiguration # readList :: ReadS [WorkGroupConfiguration] # readPrec :: ReadPrec WorkGroupConfiguration # readListPrec :: ReadPrec [WorkGroupConfiguration] #
Show WorkGroupConfiguration Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfiguration Methods showsPrec :: Int -> WorkGroupConfiguration -> ShowS # show :: WorkGroupConfiguration -> String # showList :: [WorkGroupConfiguration] -> ShowS #
NFData WorkGroupConfiguration Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfiguration Methods rnf :: WorkGroupConfiguration -> () #
Eq WorkGroupConfiguration Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfiguration Methods (==) :: WorkGroupConfiguration -> WorkGroupConfiguration -> Bool # (/=) :: WorkGroupConfiguration -> WorkGroupConfiguration -> Bool #
Hashable WorkGroupConfiguration Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfiguration Methods hashWithSalt :: Int -> WorkGroupConfiguration -> Int # hash :: WorkGroupConfiguration -> Int #
type Rep WorkGroupConfiguration Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfiguration type Rep WorkGroupConfiguration = D1 ('MetaData "WorkGroupConfiguration" "Amazonka.Athena.Types.WorkGroupConfiguration" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "WorkGroupConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "additionalConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "bytesScannedCutoffPerQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "customerContentEncryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomerContentEncryptionConfiguration)) :: S1 ('MetaSel ('Just "enforceWorkGroupConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EngineVersion)) :: S1 ('MetaSel ('Just "executionRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "publishCloudWatchMetricsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "requesterPaysEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "resultConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResultConfiguration)))))))

newWorkGroupConfiguration :: WorkGroupConfiguration Source #

Create a value of WorkGroupConfiguration 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:additionalConfiguration:WorkGroupConfiguration', workGroupConfiguration_additionalConfiguration - Specifies a user defined JSON string that is passed to the notebook engine.

$sel:bytesScannedCutoffPerQuery:WorkGroupConfiguration', workGroupConfiguration_bytesScannedCutoffPerQuery - The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

$sel:customerContentEncryptionConfiguration:WorkGroupConfiguration', workGroupConfiguration_customerContentEncryptionConfiguration - Specifies the KMS key that is used to encrypt the user's data stores in Athena.

$sel:enforceWorkGroupConfiguration:WorkGroupConfiguration', workGroupConfiguration_enforceWorkGroupConfiguration - 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.

$sel:engineVersion:WorkGroupConfiguration', workGroupConfiguration_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.

$sel:executionRole:WorkGroupConfiguration', workGroupConfiguration_executionRole - Role used in a notebook session for accessing the user's resources.

$sel:publishCloudWatchMetricsEnabled:WorkGroupConfiguration', workGroupConfiguration_publishCloudWatchMetricsEnabled - Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

$sel:requesterPaysEnabled:WorkGroupConfiguration', workGroupConfiguration_requesterPaysEnabled - 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.

$sel:resultConfiguration:WorkGroupConfiguration', workGroupConfiguration_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.

workGroupConfiguration_additionalConfiguration :: Lens' WorkGroupConfiguration (Maybe Text) Source #

Specifies a user defined JSON string that is passed to the notebook engine.

workGroupConfiguration_bytesScannedCutoffPerQuery :: Lens' WorkGroupConfiguration (Maybe Natural) Source #

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

workGroupConfiguration_customerContentEncryptionConfiguration :: Lens' WorkGroupConfiguration (Maybe CustomerContentEncryptionConfiguration) Source #

Specifies the KMS key that is used to encrypt the user's data stores in Athena.

workGroupConfiguration_enforceWorkGroupConfiguration :: Lens' WorkGroupConfiguration (Maybe Bool) Source #

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.

workGroupConfiguration_engineVersion :: Lens' WorkGroupConfiguration (Maybe EngineVersion) Source #

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.

workGroupConfiguration_executionRole :: Lens' WorkGroupConfiguration (Maybe Text) Source #

Role used in a notebook session for accessing the user's resources.

workGroupConfiguration_publishCloudWatchMetricsEnabled :: Lens' WorkGroupConfiguration (Maybe Bool) Source #

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

workGroupConfiguration_requesterPaysEnabled :: Lens' WorkGroupConfiguration (Maybe Bool) Source #

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.

workGroupConfiguration_resultConfiguration :: Lens' WorkGroupConfiguration (Maybe ResultConfiguration) Source #

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.