Skip to content

CreateWorkGroupInput

Source code in docs_src/capo_athena/types/create_work_group_input.py
class CreateWorkGroupInput(TypedDict, closed=True):
    name: "capo_athena.types.work_group_name.WorkGroupName"
    """<p>The workgroup name.</p>"""
    configuration: NotRequired[
        "capo_athena.types.work_group_configuration.WorkGroupConfiguration"
    ]
    """<p>Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with <code>EnforceWorkGroupConfiguration</code>) in the <code>WorkGroupConfiguration</code> override client-side settings. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"""
    description: NotRequired[
        "capo_athena.types.work_group_description_string.WorkGroupDescriptionString"
    ]
    """<p>The workgroup description.</p>"""
    tags: NotRequired["capo_athena.types.tag_list.TagList"]
    """<p>A list of comma separated tags to add to the workgroup that is created.</p>"""

configuration instance-attribute

configuration: NotRequired[WorkGroupConfiguration]

Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

description instance-attribute

description: NotRequired[WorkGroupDescriptionString]

The workgroup description.

name instance-attribute

The workgroup name.

tags instance-attribute

tags: NotRequired[TagList]

A list of comma separated tags to add to the workgroup that is created.