Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
Parameters:
-
work_group
(WorkGroupName)
–
The unique name of the workgroup to delete.
-
recursive_delete_option
(Optional[BoxedBoolean], default:
None
)
–
The option to delete the workgroup and its contents even if the workgroup contains any named queries, query executions, or notebooks.
Raises:
-
InternalServerException
–
Indicates a platform issue, which may be due to a transient condition or outage.
-
InvalidRequestException
–
Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_athena/_services/athena.py
| def delete_work_group(
self,
work_group: "capo_athena.types.work_group_name.WorkGroupName",
*,
config_overrides: Optional[AthenaClientConfig] = None,
recursive_delete_option: Optional[
"capo_athena.types.boxed_boolean.BoxedBoolean"
] = None,
) -> "capo_athena.types.delete_work_group_output.DeleteWorkGroupOutput":
"""<p>Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.</p>
Args:
work_group: <p>The unique name of the workgroup to delete.</p>
recursive_delete_option: <p>The option to delete the workgroup and its contents even if the workgroup contains any named queries, query executions, or notebooks.</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.delete_work_group_input.DeleteWorkGroupInput]",
) -> OperationResponse[
"capo_athena.types.delete_work_group_output.DeleteWorkGroupOutput"
]:
import capo_athena._operations.amazon_athena.delete_work_group
output, http_response = (
capo_athena._operations.amazon_athena.delete_work_group.delete_work_group(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteWorkGroup")
)
input_: capo_athena.types.delete_work_group_input.DeleteWorkGroupInput = {
"work_group": work_group
}
if recursive_delete_option is not None:
input_["recursive_delete_option"] = recursive_delete_option
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|