Deletes a Grafana API key for the workspace.
In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.
Parameters:
-
key_name
(ApiKeyName)
–
The name of the API key to delete.
-
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_api_key(
self,
key_name: "capo_grafana.types.api_key_name.ApiKeyName",
workspace_id: "capo_grafana.types.workspace_id.WorkspaceId",
*,
config_overrides: Optional[AsyncgrafanaClientConfig] = None,
) -> "capo_grafana.types.delete_workspace_api_key_response.DeleteWorkspaceApiKeyResponse":
"""<p>Deletes a Grafana API key for the workspace.</p> <note> <p>In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.</p> </note>
Args:
key_name: <p>The name of the API key to delete.</p>
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_api_key_request.DeleteWorkspaceApiKeyRequest]",
) -> AsyncOperationResponse[
"capo_grafana.types.delete_workspace_api_key_response.DeleteWorkspaceApiKeyResponse"
]:
import capo_grafana._operations.aws_grafana_control_plane.delete_workspace_api_key
(
output,
http_response,
) = await capo_grafana._operations.aws_grafana_control_plane.delete_workspace_api_key.async_delete_workspace_api_key(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteWorkspaceApiKey")
)
input_: capo_grafana.types.delete_workspace_api_key_request.DeleteWorkspaceApiKeyRequest = {
"key_name": key_name,
"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
|