Skip to content

delete_workspace async

delete_workspace(
    workspace_id: WorkspaceId,
    *,
    config_overrides: Optional[AsyncgrafanaClientConfig] = None,
) -> DeleteWorkspaceResponse

Deletes an Amazon Managed Grafana workspace.

Parameters:

  • workspace_id (WorkspaceId) –

    The ID of the workspace to delete.

Raises:

Source code in docs_src/capo_grafana/_services/async_grafana.py
async def delete_workspace(
    self,
    workspace_id: "capo_grafana.types.workspace_id.WorkspaceId",
    *,
    config_overrides: Optional[AsyncgrafanaClientConfig] = None,
) -> "capo_grafana.types.delete_workspace_response.DeleteWorkspaceResponse":
    """<p>Deletes an Amazon Managed Grafana workspace.</p>

    Args:
        workspace_id: <p>The ID of the workspace to delete.</p>

    Raises:
        capo_grafana.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action. </p>
        capo_grafana.errors.conflict_exception.ConflictException: <p>A resource was in an inconsistent state during an update or a deletion.</p>
        capo_grafana.errors.internal_server_exception.InternalServerException: <p>Unexpected error while processing the request. Retry the request.</p>
        capo_grafana.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that does not exist.</p>
        capo_grafana.errors.throttling_exception.ThrottlingException: <p>The request was denied because of request throttling. Retry the request.</p>
        capo_grafana.errors.validation_exception.ValidationException: <p>The value of a parameter in the request caused an error.</p>
        capo_grafana.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_grafana.types.delete_workspace_request.DeleteWorkspaceRequest]",
    ) -> AsyncOperationResponse[
        "capo_grafana.types.delete_workspace_response.DeleteWorkspaceResponse"
    ]:
        import capo_grafana._operations.aws_grafana_control_plane.delete_workspace

        (
            output,
            http_response,
        ) = await capo_grafana._operations.aws_grafana_control_plane.delete_workspace.async_delete_workspace(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_grafana.types.delete_workspace_response.DeleteWorkspaceResponse",
    ) -> dict[str, Any]:
        import capo_grafana.types.delete_workspace_response

        return capo_grafana.types.delete_workspace_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DeleteWorkspace", redact_output=_redact_output),
    )
    input_: capo_grafana.types.delete_workspace_request.DeleteWorkspaceRequest = {
        "workspace_id": workspace_id
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output