WorkGroupConfigurationUpdates ¶

class WorkGroupConfigurationUpdates(TypedDict, closed=True):
    enforce_work_group_configuration: NotRequired[
        "capo_athena.types.boxed_boolean.BoxedBoolean"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html">Workgroup Settings Override Client-Side Settings</a>.</p>"""
    result_configuration_updates: NotRequired[
        "capo_athena.types.result_configuration_updates.ResultConfigurationUpdates"
    ]
    """<p>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.</p>"""
    managed_query_results_configuration_updates: NotRequired[
        "capo_athena.types.managed_query_results_configuration_updates.ManagedQueryResultsConfigurationUpdates"
    ]
    """<p>Updates configuration information for managed query results in the workgroup.</p>"""
    publish_cloud_watch_metrics_enabled: NotRequired[
        "capo_athena.types.boxed_boolean.BoxedBoolean"
    ]
    """<p>Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.</p>"""
    bytes_scanned_cutoff_per_query: NotRequired[
        "capo_athena.types.bytes_scanned_cutoff_value.BytesScannedCutoffValue"
    ]
    """<p>The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.</p>"""
    remove_bytes_scanned_cutoff_per_query: NotRequired[
        "capo_athena.types.boxed_boolean.BoxedBoolean"
    ]
    """<p>Indicates that the data usage control limit per query is removed. <a>WorkGroupConfiguration$BytesScannedCutoffPerQuery</a> </p>"""
    requester_pays_enabled: NotRequired["capo_athena.types.boxed_boolean.BoxedBoolean"]
    """<p>If set to <code>true</code>, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to <code>false</code>, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is <code>false</code>. For more information about Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays Buckets</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"""
    engine_version: NotRequired["capo_athena.types.engine_version.EngineVersion"]
    """<p>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 <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine regardless of this setting.</p>"""
    remove_customer_content_encryption_configuration: NotRequired[
        "capo_athena.types.boxed_boolean.BoxedBoolean"
    ]
    """<p>Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.</p>"""
    additional_configuration: NotRequired["capo_athena.types.name_string.NameString"]
    """<p>Contains a user defined string in JSON format for a Spark-enabled workgroup.</p>"""
    execution_role: NotRequired["capo_athena.types.role_arn.RoleArn"]
    """<p>The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.</p>"""
    customer_content_encryption_configuration: NotRequired[
        "capo_athena.types.customer_content_encryption_configuration.CustomerContentEncryptionConfiguration"
    ]
    enable_minimum_encryption_configuration: NotRequired[
        "capo_athena.types.boxed_boolean.BoxedBoolean"
    ]
    """<p>Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries. This setting does not apply to Spark-enabled workgroups.</p> <p>The <code>EnforceWorkGroupConfiguration</code> setting takes precedence over the <code>EnableMinimumEncryptionConfiguration</code> flag. This means that if <code>EnforceWorkGroupConfiguration</code> is true, the <code>EnableMinimumEncryptionConfiguration</code> flag is ignored, and the workgroup configuration for encryption is used.</p>"""
    query_results_s3_access_grants_configuration: NotRequired[
        "capo_athena.types.query_results_s3_access_grants_configuration.QueryResultsS3AccessGrantsConfiguration"
    ]
    """<p>Specifies whether Amazon S3 access grants are enabled for query results.</p>"""
    monitoring_configuration: NotRequired[
        "capo_athena.types.monitoring_configuration.MonitoringConfiguration"
    ]
    """<p>Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.</p>"""
    engine_configuration: NotRequired[
        "capo_athena.types.engine_configuration.EngineConfiguration"
    ]