AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Creates a Grafana API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html for available APIs and example requests.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateWorkspaceApiKey and EndCreateWorkspaceApiKey.

Namespace: Amazon.ManagedGrafana
Assembly: AWSSDK.ManagedGrafana.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<CreateWorkspaceApiKeyResponse> CreateWorkspaceApiKeyAsync(
         CreateWorkspaceApiKeyRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ManagedGrafana.Model.CreateWorkspaceApiKeyRequest

Container for the necessary parameters to execute the CreateWorkspaceApiKey service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CreateWorkspaceApiKey service method, as returned by ManagedGrafana.

Exceptions

ExceptionCondition
AccessDeniedException You do not have sufficient permissions to perform this action.
ConflictException A resource was in an inconsistent state during an update or a deletion.
InternalServerException Unexpected error while processing the request. Retry the request.
ResourceNotFoundException The request references a resource that does not exist.
ServiceQuotaExceededException The request would cause a service quota to be exceeded.
ThrottlingException The request was denied because of request throttling. Retry the request.
ValidationException The value of a parameter in the request caused an error.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also