Skip to content

WorkGroup

Source code in docs_src/capo_athena/types/work_group.py
class WorkGroup(TypedDict, closed=True):
    name: "capo_athena.types.work_group_name.WorkGroupName"
    """<p>The workgroup name.</p>"""
    state: NotRequired["capo_athena.types.work_group_state.WorkGroupState"]
    """<p>The state of the workgroup: ENABLED or DISABLED.</p>"""
    configuration: NotRequired[
        "capo_athena.types.work_group_configuration.WorkGroupConfiguration"
    ]
    """<p>The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for query and calculation 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 <code>EnforceWorkGroupConfiguration</code> (true/false) in the <code>WorkGroupConfiguration</code>. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"""
    description: NotRequired[
        "capo_athena.types.work_group_description_string.WorkGroupDescriptionString"
    ]
    """<p>The workgroup description.</p>"""
    creation_time: NotRequired["capo_athena.types.date.Date"]
    """<p>The date and time the workgroup was created.</p>"""
    identity_center_application_arn: NotRequired[
        "capo_athena.types.identity_center_application_arn.IdentityCenterApplicationArn"
    ]
    """<p>The ARN of the IAM Identity Center enabled application associated with the workgroup.</p>"""

configuration instance-attribute

configuration: NotRequired[WorkGroupConfiguration]

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

creation_time instance-attribute

creation_time: NotRequired[Date]

The date and time the workgroup was created.

description instance-attribute

description: NotRequired[WorkGroupDescriptionString]

The workgroup description.

identity_center_application_arn instance-attribute

identity_center_application_arn: NotRequired[IdentityCenterApplicationArn]

The ARN of the IAM Identity Center enabled application associated with the workgroup.

name instance-attribute

The workgroup name.

state instance-attribute

state: NotRequired[WorkGroupState]

The state of the workgroup: ENABLED or DISABLED.