Skip to content

WorkGroupSummary

Source code in docs_src/capo_athena/types/work_group_summary.py
class WorkGroupSummary(TypedDict, closed=True):
    name: NotRequired["capo_athena.types.work_group_name.WorkGroupName"]
    """<p>The name of the workgroup.</p>"""
    state: NotRequired["capo_athena.types.work_group_state.WorkGroupState"]
    """<p>The state of the workgroup.</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 workgroup creation date and time.</p>"""
    engine_version: NotRequired["capo_athena.types.engine_version.EngineVersion"]
    """<p>The engine version setting for all queries on the workgroup. Queries on the <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine regardless of this setting.</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>"""

creation_time instance-attribute

creation_time: NotRequired[Date]

The workgroup creation date and time.

description instance-attribute

description: NotRequired[WorkGroupDescriptionString]

The workgroup description.

engine_version instance-attribute

engine_version: NotRequired[EngineVersion]

The engine version setting for all queries on the workgroup. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

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

name: NotRequired[WorkGroupName]

The name of the workgroup.

state instance-attribute

state: NotRequired[WorkGroupState]

The state of the workgroup.