awscc.athena_workgroup¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - athena:DeleteWorkGroup, athena:UntagResource
update¶
Parent base class for filters and actions.
definitions:
BytesScannedCutoffPerQuery:
description: The upper data usage limit (cutoff) for the amount of bytes a single
query in a workgroup is allowed to scan.
format: int64
minimum: 10000000
type: integer
EffectiveEngineVersion:
description: Read only. The engine version on which the query runs. If the user
requests a valid engine version other than Auto, the effective engine version
is the same as the engine version that the user requested. If the user requests
Auto, the effective engine version is chosen by Athena. When a request to update
the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation,
the EffectiveEngineVersion field is ignored.
type: string
EncryptionConfiguration:
additionalProperties: false
description: If query results are encrypted in Amazon S3, indicates the encryption
option used (for example, SSE-KMS or CSE-KMS) and key information.
properties:
EncryptionOption:
description: Indicates whether Amazon S3 server-side encryption with Amazon
S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS),
or client-side encryption with KMS-managed keys (CSE-KMS) is used.
enum:
- SSE_S3
- SSE_KMS
- CSE_KMS
type: string
KmsKey:
description: 'For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID. '
type: string
required:
- EncryptionOption
type: object
EncryptionOption:
description: Indicates whether Amazon S3 server-side encryption with Amazon S3-managed
keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or client-side
encryption with KMS-managed keys (CSE-KMS) is used.
enum:
- SSE_S3
- SSE_KMS
- CSE_KMS
type: string
EnforceWorkGroupConfiguration:
description: If set to "true", the settings for the workgroup override client-side
settings. If set to "false", client-side settings are used
type: boolean
EngineVersion:
additionalProperties: false
description: The Athena engine version for running queries.
properties:
EffectiveEngineVersion:
description: Read only. The engine version on which the query runs. If the
user requests a valid engine version other than Auto, the effective engine
version is the same as the engine version that the user requested. If the
user requests Auto, the effective engine version is chosen by Athena. When
a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup
operation, the EffectiveEngineVersion field is ignored.
type: string
SelectedEngineVersion:
description: The engine version requested by the user. Possible values are
determined by the output of ListEngineVersions, including Auto. The default
is Auto.
type: string
type: object
KmsKey:
description: 'For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID. '
type: string
OutputLocation:
description: 'The location in Amazon S3 where your query results are stored, such
as s3://path/to/query/bucket/. To run the query, you must specify the query
results location using one of the ways: either for individual queries using
either this setting (client-side), or in the workgroup, using WorkGroupConfiguration'
type: string
PublishCloudWatchMetricsEnabled:
description: Indicates that the Amazon CloudWatch metrics are enabled for the
workgroup.
type: boolean
RemoveBytesScannedCutoffPerQuery:
description: Indicates that the data usage control limit per query is removed.
type: boolean
RemoveEncryptionConfiguration:
type: boolean
RemoveOutputLocation:
type: boolean
RequesterPaysEnabled:
description: '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. '
type: boolean
ResultConfiguration:
additionalProperties: false
description: 'The location in Amazon S3 where query results are stored and the
encryption option, if any, used for query results. These are known as "client-side
settings". If workgroup settings override client-side settings, then the query
uses the workgroup settings.
'
properties:
EncryptionConfiguration:
additionalProperties: false
description: If query results are encrypted in Amazon S3, indicates the encryption
option used (for example, SSE-KMS or CSE-KMS) and key information.
properties:
EncryptionOption:
description: Indicates whether Amazon S3 server-side encryption with Amazon
S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys
(SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS)
is used.
enum:
- SSE_S3
- SSE_KMS
- CSE_KMS
type: string
KmsKey:
description: 'For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID. '
type: string
required:
- EncryptionOption
type: object
OutputLocation:
description: 'The location in Amazon S3 where your query results are stored,
such as s3://path/to/query/bucket/. To run the query, you must specify the
query results location using one of the ways: either for individual queries
using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration'
type: string
type: object
ResultConfigurationUpdates:
additionalProperties: false
description: '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. '
properties:
EncryptionConfiguration:
additionalProperties: false
description: If query results are encrypted in Amazon S3, indicates the encryption
option used (for example, SSE-KMS or CSE-KMS) and key information.
properties:
EncryptionOption:
description: Indicates whether Amazon S3 server-side encryption with Amazon
S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys
(SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS)
is used.
enum:
- SSE_S3
- SSE_KMS
- CSE_KMS
type: string
KmsKey:
description: 'For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID. '
type: string
required:
- EncryptionOption
type: object
OutputLocation:
description: 'The location in Amazon S3 where your query results are stored,
such as s3://path/to/query/bucket/. To run the query, you must specify the
query results location using one of the ways: either for individual queries
using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration'
type: string
RemoveEncryptionConfiguration:
type: boolean
RemoveOutputLocation:
type: boolean
type: object
SelectedEngineVersion:
description: The engine version requested by the user. Possible values are determined
by the output of ListEngineVersions, including Auto. The default is Auto.
type: string
Tag:
additionalProperties: false
properties:
Key:
maxLength: 128
minLength: 1
type: string
Value:
maxLength: 256
minLength: 0
type: string
required:
- Key
- Value
type: object
Tags:
insertionOrder: false
items:
additionalProperties: false
properties:
Key:
maxLength: 128
minLength: 1
type: string
Value:
maxLength: 256
minLength: 0
type: string
required:
- Key
- Value
type: object
type: array
WorkGroupConfiguration:
additionalProperties: false
properties:
BytesScannedCutoffPerQuery:
description: The upper data usage limit (cutoff) for the amount of bytes a
single query in a workgroup is allowed to scan.
format: int64
minimum: 10000000
type: integer
EnforceWorkGroupConfiguration:
description: If set to "true", the settings for the workgroup override client-side
settings. If set to "false", client-side settings are used
type: boolean
EngineVersion:
additionalProperties: false
description: The Athena engine version for running queries.
properties:
EffectiveEngineVersion:
description: Read only. The engine version on which the query runs. If
the user requests a valid engine version other than Auto, the effective
engine version is the same as the engine version that the user requested.
If the user requests Auto, the effective engine version is chosen by
Athena. When a request to update the engine version is made by a CreateWorkGroup
or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.
type: string
SelectedEngineVersion:
description: The engine version requested by the user. Possible values
are determined by the output of ListEngineVersions, including Auto.
The default is Auto.
type: string
type: object
PublishCloudWatchMetricsEnabled:
description: Indicates that the Amazon CloudWatch metrics are enabled for
the workgroup.
type: boolean
RequesterPaysEnabled:
description: '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. '
type: boolean
ResultConfiguration:
additionalProperties: false
description: 'The location in Amazon S3 where query results are stored and
the encryption option, if any, used for query results. These are known as
"client-side settings". If workgroup settings override client-side settings,
then the query uses the workgroup settings.
'
properties:
EncryptionConfiguration:
additionalProperties: false
description: If query results are encrypted in Amazon S3, indicates the
encryption option used (for example, SSE-KMS or CSE-KMS) and key information.
properties:
EncryptionOption:
description: Indicates whether Amazon S3 server-side encryption with
Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed
keys (SSE-KMS), or client-side encryption with KMS-managed keys
(CSE-KMS) is used.
enum:
- SSE_S3
- SSE_KMS
- CSE_KMS
type: string
KmsKey:
description: 'For SSE-KMS and CSE-KMS, this is the KMS key ARN or
ID. '
type: string
required:
- EncryptionOption
type: object
OutputLocation:
description: 'The location in Amazon S3 where your query results are stored,
such as s3://path/to/query/bucket/. To run the query, you must specify
the query results location using one of the ways: either for individual
queries using either this setting (client-side), or in the workgroup,
using WorkGroupConfiguration'
type: string
type: object
type: object
WorkGroupConfigurationUpdates:
additionalProperties: false
description: '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. '
properties:
BytesScannedCutoffPerQuery:
description: The upper data usage limit (cutoff) for the amount of bytes a
single query in a workgroup is allowed to scan.
format: int64
minimum: 10000000
type: integer
EnforceWorkGroupConfiguration:
description: If set to "true", the settings for the workgroup override client-side
settings. If set to "false", client-side settings are used
type: boolean
EngineVersion:
additionalProperties: false
description: The Athena engine version for running queries.
properties:
EffectiveEngineVersion:
description: Read only. The engine version on which the query runs. If
the user requests a valid engine version other than Auto, the effective
engine version is the same as the engine version that the user requested.
If the user requests Auto, the effective engine version is chosen by
Athena. When a request to update the engine version is made by a CreateWorkGroup
or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.
type: string
SelectedEngineVersion:
description: The engine version requested by the user. Possible values
are determined by the output of ListEngineVersions, including Auto.
The default is Auto.
type: string
type: object
PublishCloudWatchMetricsEnabled:
description: Indicates that the Amazon CloudWatch metrics are enabled for
the workgroup.
type: boolean
RemoveBytesScannedCutoffPerQuery:
description: Indicates that the data usage control limit per query is removed.
type: boolean
RequesterPaysEnabled:
description: '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. '
type: boolean
ResultConfigurationUpdates:
additionalProperties: false
description: '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. '
properties:
EncryptionConfiguration:
additionalProperties: false
description: If query results are encrypted in Amazon S3, indicates the
encryption option used (for example, SSE-KMS or CSE-KMS) and key information.
properties:
EncryptionOption:
description: Indicates whether Amazon S3 server-side encryption with
Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed
keys (SSE-KMS), or client-side encryption with KMS-managed keys
(CSE-KMS) is used.
enum:
- SSE_S3
- SSE_KMS
- CSE_KMS
type: string
KmsKey:
description: 'For SSE-KMS and CSE-KMS, this is the KMS key ARN or
ID. '
type: string
required:
- EncryptionOption
type: object
OutputLocation:
description: 'The location in Amazon S3 where your query results are stored,
such as s3://path/to/query/bucket/. To run the query, you must specify
the query results location using one of the ways: either for individual
queries using either this setting (client-side), or in the workgroup,
using WorkGroupConfiguration'
type: string
RemoveEncryptionConfiguration:
type: boolean
RemoveOutputLocation:
type: boolean
type: object
type: object
properties:
Description:
description: The workgroup description.
maxLength: 1024
minLength: 0
type: string
RecursiveDeleteOption:
description: The option to delete the workgroup and its contents even if the workgroup
contains any named queries.
type: boolean
State:
description: 'The state of the workgroup: ENABLED or DISABLED.'
enum:
- ENABLED
- DISABLED
type: string
Tags:
insertionOrder: false
items:
additionalProperties: false
properties:
Key:
maxLength: 128
minLength: 1
type: string
Value:
maxLength: 256
minLength: 0
type: string
required:
- Key
- Value
type: object
type: array
WorkGroupConfiguration:
additionalProperties: false
properties:
BytesScannedCutoffPerQuery:
description: The upper data usage limit (cutoff) for the amount of bytes a
single query in a workgroup is allowed to scan.
format: int64
minimum: 10000000
type: integer
EnforceWorkGroupConfiguration:
description: If set to "true", the settings for the workgroup override client-side
settings. If set to "false", client-side settings are used
type: boolean
EngineVersion:
additionalProperties: false
description: The Athena engine version for running queries.
properties:
EffectiveEngineVersion:
description: Read only. The engine version on which the query runs. If
the user requests a valid engine version other than Auto, the effective
engine version is the same as the engine version that the user requested.
If the user requests Auto, the effective engine version is chosen by
Athena. When a request to update the engine version is made by a CreateWorkGroup
or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.
type: string
SelectedEngineVersion:
description: The engine version requested by the user. Possible values
are determined by the output of ListEngineVersions, including Auto.
The default is Auto.
type: string
type: object
PublishCloudWatchMetricsEnabled:
description: Indicates that the Amazon CloudWatch metrics are enabled for
the workgroup.
type: boolean
RequesterPaysEnabled:
description: '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. '
type: boolean
ResultConfiguration:
additionalProperties: false
description: 'The location in Amazon S3 where query results are stored and
the encryption option, if any, used for query results. These are known as
"client-side settings". If workgroup settings override client-side settings,
then the query uses the workgroup settings.
'
properties:
EncryptionConfiguration:
additionalProperties: false
description: If query results are encrypted in Amazon S3, indicates the
encryption option used (for example, SSE-KMS or CSE-KMS) and key information.
properties:
EncryptionOption:
description: Indicates whether Amazon S3 server-side encryption with
Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed
keys (SSE-KMS), or client-side encryption with KMS-managed keys
(CSE-KMS) is used.
enum:
- SSE_S3
- SSE_KMS
- CSE_KMS
type: string
KmsKey:
description: 'For SSE-KMS and CSE-KMS, this is the KMS key ARN or
ID. '
type: string
required:
- EncryptionOption
type: object
OutputLocation:
description: 'The location in Amazon S3 where your query results are stored,
such as s3://path/to/query/bucket/. To run the query, you must specify
the query results location using one of the ways: either for individual
queries using either this setting (client-side), or in the workgroup,
using WorkGroupConfiguration'
type: string
type: object
type: object
WorkGroupConfigurationUpdates:
additionalProperties: false
description: '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. '
properties:
BytesScannedCutoffPerQuery:
description: The upper data usage limit (cutoff) for the amount of bytes a
single query in a workgroup is allowed to scan.
format: int64
minimum: 10000000
type: integer
EnforceWorkGroupConfiguration:
description: If set to "true", the settings for the workgroup override client-side
settings. If set to "false", client-side settings are used
type: boolean
EngineVersion:
additionalProperties: false
description: The Athena engine version for running queries.
properties:
EffectiveEngineVersion:
description: Read only. The engine version on which the query runs. If
the user requests a valid engine version other than Auto, the effective
engine version is the same as the engine version that the user requested.
If the user requests Auto, the effective engine version is chosen by
Athena. When a request to update the engine version is made by a CreateWorkGroup
or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.
type: string
SelectedEngineVersion:
description: The engine version requested by the user. Possible values
are determined by the output of ListEngineVersions, including Auto.
The default is Auto.
type: string
type: object
PublishCloudWatchMetricsEnabled:
description: Indicates that the Amazon CloudWatch metrics are enabled for
the workgroup.
type: boolean
RemoveBytesScannedCutoffPerQuery:
description: Indicates that the data usage control limit per query is removed.
type: boolean
RequesterPaysEnabled:
description: '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. '
type: boolean
ResultConfigurationUpdates:
additionalProperties: false
description: '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. '
properties:
EncryptionConfiguration:
additionalProperties: false
description: If query results are encrypted in Amazon S3, indicates the
encryption option used (for example, SSE-KMS or CSE-KMS) and key information.
properties:
EncryptionOption:
description: Indicates whether Amazon S3 server-side encryption with
Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed
keys (SSE-KMS), or client-side encryption with KMS-managed keys
(CSE-KMS) is used.
enum:
- SSE_S3
- SSE_KMS
- CSE_KMS
type: string
KmsKey:
description: 'For SSE-KMS and CSE-KMS, this is the KMS key ARN or
ID. '
type: string
required:
- EncryptionOption
type: object
OutputLocation:
description: 'The location in Amazon S3 where your query results are stored,
such as s3://path/to/query/bucket/. To run the query, you must specify
the query results location using one of the ways: either for individual
queries using either this setting (client-side), or in the workgroup,
using WorkGroupConfiguration'
type: string
RemoveEncryptionConfiguration:
type: boolean
RemoveOutputLocation:
type: boolean
type: object
type: object
type:
enum:
- update
Permissions - athena:UpdateWorkGroup, athena:TagResource, athena:UntagResource