update_work_group ¶

def update_work_group(
    self,
    work_group: "capo_athena.types.work_group_name.WorkGroupName",
    *,
    config_overrides: Optional[AthenaClientConfig] = None,
    description: Optional[
        "capo_athena.types.work_group_description_string.WorkGroupDescriptionString"
    ] = None,
    configuration_updates: Optional[
        "capo_athena.types.work_group_configuration_updates.WorkGroupConfigurationUpdates"
    ] = None,
    state: Optional["capo_athena.types.work_group_state.WorkGroupState"] = None,
) -> "capo_athena.types.update_work_group_output.UpdateWorkGroupOutput":
    """<p>Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only <code>ConfigurationUpdates</code> can be specified.</p>

    Args:
        work_group: <p>The specified workgroup that will be updated.</p>
        description: <p>The workgroup description.</p>
        configuration_updates: <p>Contains configuration updates for an Athena SQL workgroup.</p>
        state: <p>The workgroup state that will be updated for the given workgroup.</p>

    Raises:
        capo_athena.errors.internal_server_exception.InternalServerException: <p>Indicates a platform issue, which may be due to a transient condition or outage.</p>
        capo_athena.errors.invalid_request_exception.InvalidRequestException: <p>Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.</p>
        capo_athena.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_athena.types.update_work_group_input.UpdateWorkGroupInput]",
    ) -> OperationResponse[
        "capo_athena.types.update_work_group_output.UpdateWorkGroupOutput"
    ]:
        import capo_athena._operations.amazon_athena.update_work_group

        output, http_response = (
            capo_athena._operations.amazon_athena.update_work_group.update_work_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateWorkGroup")
    )
    input_: capo_athena.types.update_work_group_input.UpdateWorkGroupInput = {
        "work_group": work_group
    }
    if description is not None:
        input_["description"] = description
    if configuration_updates is not None:
        input_["configuration_updates"] = configuration_updates
    if state is not None:
        input_["state"] = state

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output