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

Description

Synopsis

Documentation

data WorkGroupConfigurationUpdates Source #

The configuration information that will be updated for this 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, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

See: newWorkGroupConfigurationUpdates smart constructor.

Constructors

WorkGroupConfigurationUpdates'

Fields

additionalConfiguration :: Maybe Text
Contains a user defined string in JSON format for a Spark-enabled workgroup.
bytesScannedCutoffPerQuery :: Maybe Natural
The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
customerContentEncryptionConfiguration :: Maybe CustomerContentEncryptionConfiguration
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 requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.
executionRole :: Maybe Text
Contains the ARN of the execution role for the workgroup
publishCloudWatchMetricsEnabled :: Maybe Bool
Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
removeBytesScannedCutoffPerQuery :: Maybe Bool
Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
removeCustomerContentEncryptionConfiguration :: Maybe Bool
Removes content encryption configuration for a workgroup.
requesterPaysEnabled :: Maybe Bool
If set to true, allows members assigned to a workgroup to specify 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.
resultConfigurationUpdates :: Maybe ResultConfigurationUpdates
The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

Instances

Instances details

ToJSON WorkGroupConfigurationUpdates Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfigurationUpdates Methods toJSON :: WorkGroupConfigurationUpdates -> Value # toEncoding :: WorkGroupConfigurationUpdates -> Encoding # toJSONList :: [WorkGroupConfigurationUpdates] -> Value # toEncodingList :: [WorkGroupConfigurationUpdates] -> Encoding #
Generic WorkGroupConfigurationUpdates Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfigurationUpdates Associated Types type Rep WorkGroupConfigurationUpdates :: Type -> Type # Methods from :: WorkGroupConfigurationUpdates -> Rep WorkGroupConfigurationUpdates x # to :: Rep WorkGroupConfigurationUpdates x -> WorkGroupConfigurationUpdates #
Read WorkGroupConfigurationUpdates Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfigurationUpdates Methods readsPrec :: Int -> ReadS WorkGroupConfigurationUpdates # readList :: ReadS [WorkGroupConfigurationUpdates] # readPrec :: ReadPrec WorkGroupConfigurationUpdates # readListPrec :: ReadPrec [WorkGroupConfigurationUpdates] #
Show WorkGroupConfigurationUpdates Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfigurationUpdates Methods showsPrec :: Int -> WorkGroupConfigurationUpdates -> ShowS # show :: WorkGroupConfigurationUpdates -> String # showList :: [WorkGroupConfigurationUpdates] -> ShowS #
NFData WorkGroupConfigurationUpdates Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfigurationUpdates Methods rnf :: WorkGroupConfigurationUpdates -> () #
Eq WorkGroupConfigurationUpdates Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfigurationUpdates Methods (==) :: WorkGroupConfigurationUpdates -> WorkGroupConfigurationUpdates -> Bool # (/=) :: WorkGroupConfigurationUpdates -> WorkGroupConfigurationUpdates -> Bool #
Hashable WorkGroupConfigurationUpdates Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfigurationUpdates Methods hashWithSalt :: Int -> WorkGroupConfigurationUpdates -> Int # hash :: WorkGroupConfigurationUpdates -> Int #
type Rep WorkGroupConfigurationUpdates Source #
Instance details Defined in Amazonka.Athena.Types.WorkGroupConfigurationUpdates type Rep WorkGroupConfigurationUpdates = D1 ('MetaData "WorkGroupConfigurationUpdates" "Amazonka.Athena.Types.WorkGroupConfigurationUpdates" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "WorkGroupConfigurationUpdates'" '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 "removeBytesScannedCutoffPerQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "removeCustomerContentEncryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "requesterPaysEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "resultConfigurationUpdates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResultConfigurationUpdates)))))))

newWorkGroupConfigurationUpdates :: WorkGroupConfigurationUpdates Source #

Create a value of WorkGroupConfigurationUpdates 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:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_additionalConfiguration - Contains a user defined string in JSON format for a Spark-enabled workgroup.

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

$sel:customerContentEncryptionConfiguration:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_customerContentEncryptionConfiguration - Undocumented member.

$sel:enforceWorkGroupConfiguration:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_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:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_engineVersion - The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

$sel:executionRole:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_executionRole - Contains the ARN of the execution role for the workgroup

$sel:publishCloudWatchMetricsEnabled:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_publishCloudWatchMetricsEnabled - Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

$sel:removeBytesScannedCutoffPerQuery:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_removeBytesScannedCutoffPerQuery - Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

$sel:removeCustomerContentEncryptionConfiguration:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_removeCustomerContentEncryptionConfiguration - Removes content encryption configuration for a workgroup.

$sel:requesterPaysEnabled:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_requesterPaysEnabled - If set to true, allows members assigned to a workgroup to specify 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:resultConfigurationUpdates:WorkGroupConfigurationUpdates', workGroupConfigurationUpdates_resultConfigurationUpdates - The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

workGroupConfigurationUpdates_additionalConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe Text) Source #

Contains a user defined string in JSON format for a Spark-enabled workgroup.

workGroupConfigurationUpdates_bytesScannedCutoffPerQuery :: Lens' WorkGroupConfigurationUpdates (Maybe Natural) Source #

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

workGroupConfigurationUpdates_customerContentEncryptionConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe CustomerContentEncryptionConfiguration) Source #

Undocumented member.

workGroupConfigurationUpdates_enforceWorkGroupConfiguration :: Lens' WorkGroupConfigurationUpdates (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.

workGroupConfigurationUpdates_engineVersion :: Lens' WorkGroupConfigurationUpdates (Maybe EngineVersion) Source #

The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

workGroupConfigurationUpdates_executionRole :: Lens' WorkGroupConfigurationUpdates (Maybe Text) Source #

Contains the ARN of the execution role for the workgroup

workGroupConfigurationUpdates_publishCloudWatchMetricsEnabled :: Lens' WorkGroupConfigurationUpdates (Maybe Bool) Source #

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

workGroupConfigurationUpdates_removeBytesScannedCutoffPerQuery :: Lens' WorkGroupConfigurationUpdates (Maybe Bool) Source #

Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

workGroupConfigurationUpdates_removeCustomerContentEncryptionConfiguration :: Lens' WorkGroupConfigurationUpdates (Maybe Bool) Source #

Removes content encryption configuration for a workgroup.

workGroupConfigurationUpdates_requesterPaysEnabled :: Lens' WorkGroupConfigurationUpdates (Maybe Bool) Source #

If set to true, allows members assigned to a workgroup to specify 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.

workGroupConfigurationUpdates_resultConfigurationUpdates :: Lens' WorkGroupConfigurationUpdates (Maybe ResultConfigurationUpdates) Source #

The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.