grafana/aws.sdk.kotlin.services.grafana

Package-level declarations

Types

Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool that is popular for its extensible data support.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

associateLicense

inline suspend fun GrafanaClient.associateLicense(crossinline block: AssociateLicenseRequest.Builder.() -> Unit): AssociateLicenseResponse

Assigns a Grafana Enterprise license to a workspace. To upgrade, you must use ENTERPRISE for the licenseType, and pass in a valid Grafana Labs token for the grafanaToken. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise.

createWorkspace

inline suspend fun GrafanaClient.createWorkspace(crossinline block: CreateWorkspaceRequest.Builder.() -> Unit): CreateWorkspaceResponse

Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.

createWorkspaceApiKey

inline suspend fun GrafanaClient.createWorkspaceApiKey(crossinline block: CreateWorkspaceApiKeyRequest.Builder.() -> Unit): CreateWorkspaceApiKeyResponse

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.

createWorkspaceServiceAccount

inline suspend fun GrafanaClient.createWorkspaceServiceAccount(crossinline block: CreateWorkspaceServiceAccountRequest.Builder.() -> Unit): CreateWorkspaceServiceAccountResponse

Creates a service account for the workspace. A service account can be used to call Grafana HTTP APIs, and run automated workloads. After creating the service account with the correct GrafanaRole for your use case, use CreateWorkspaceServiceAccountToken to create a token that can be used to authenticate and authorize Grafana HTTP API calls.

createWorkspaceServiceAccountToken

inline suspend fun GrafanaClient.createWorkspaceServiceAccountToken(crossinline block: CreateWorkspaceServiceAccountTokenRequest.Builder.() -> Unit): CreateWorkspaceServiceAccountTokenResponse

Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account. The service account acts as a user for the API operations, and defines the permissions that are used by the API.

deleteWorkspace

inline suspend fun GrafanaClient.deleteWorkspace(crossinline block: DeleteWorkspaceRequest.Builder.() -> Unit): DeleteWorkspaceResponse

Deletes an Amazon Managed Grafana workspace.

deleteWorkspaceApiKey

inline suspend fun GrafanaClient.deleteWorkspaceApiKey(crossinline block: DeleteWorkspaceApiKeyRequest.Builder.() -> Unit): DeleteWorkspaceApiKeyResponse

Deletes a Grafana API key for the workspace.

deleteWorkspaceServiceAccount

inline suspend fun GrafanaClient.deleteWorkspaceServiceAccount(crossinline block: DeleteWorkspaceServiceAccountRequest.Builder.() -> Unit): DeleteWorkspaceServiceAccountResponse

Deletes a workspace service account from the workspace.

deleteWorkspaceServiceAccountToken

inline suspend fun GrafanaClient.deleteWorkspaceServiceAccountToken(crossinline block: DeleteWorkspaceServiceAccountTokenRequest.Builder.() -> Unit): DeleteWorkspaceServiceAccountTokenResponse

Deletes a token for the workspace service account.

describeWorkspace

inline suspend fun GrafanaClient.describeWorkspace(crossinline block: DescribeWorkspaceRequest.Builder.() -> Unit): DescribeWorkspaceResponse

Displays information about one Amazon Managed Grafana workspace.

describeWorkspaceAuthentication

inline suspend fun GrafanaClient.describeWorkspaceAuthentication(crossinline block: DescribeWorkspaceAuthenticationRequest.Builder.() -> Unit): DescribeWorkspaceAuthenticationResponse

Displays information about the authentication methods used in one Amazon Managed Grafana workspace.

describeWorkspaceConfiguration

inline suspend fun GrafanaClient.describeWorkspaceConfiguration(crossinline block: DescribeWorkspaceConfigurationRequest.Builder.() -> Unit): DescribeWorkspaceConfigurationResponse

Gets the current configuration string for the given workspace.

disassociateLicense

inline suspend fun GrafanaClient.disassociateLicense(crossinline block: DisassociateLicenseRequest.Builder.() -> Unit): DisassociateLicenseResponse

Removes the Grafana Enterprise license from a workspace.

listPermissions

inline suspend fun GrafanaClient.listPermissions(crossinline block: ListPermissionsRequest.Builder.() -> Unit): ListPermissionsResponse

Lists the users and groups who have the Grafana Admin and Editor roles in this workspace. If you use this operation without specifying userId or groupId, the operation returns the roles of all users and groups. If you specify a userId or a groupId, only the roles for that user or group are returned. If you do this, you can specify only one userId or one groupId.

listTagsForResource

inline suspend fun GrafanaClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

The ListTagsForResource operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the resourceArn. Currently, the only resource that can be tagged is a workspace.

listVersions

inline suspend fun GrafanaClient.listVersions(crossinline block: ListVersionsRequest.Builder.() -> Unit): ListVersionsResponse

Lists available versions of Grafana. These are available when calling CreateWorkspace. Optionally, include a workspace to list the versions to which it can be upgraded.

listWorkspaces

inline suspend fun GrafanaClient.listWorkspaces(crossinline block: ListWorkspacesRequest.Builder.() -> Unit): ListWorkspacesResponse

Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use DescribeWorkspace.

listWorkspaceServiceAccounts

inline suspend fun GrafanaClient.listWorkspaceServiceAccounts(crossinline block: ListWorkspaceServiceAccountsRequest.Builder.() -> Unit): ListWorkspaceServiceAccountsResponse

Returns a list of service accounts for a workspace.

listWorkspaceServiceAccountTokens

inline suspend fun GrafanaClient.listWorkspaceServiceAccountTokens(crossinline block: ListWorkspaceServiceAccountTokensRequest.Builder.() -> Unit): ListWorkspaceServiceAccountTokensResponse

Returns a list of tokens for a workspace service account.

tagResource

inline suspend fun GrafanaClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

The TagResource operation associates tags with an Amazon Managed Grafana resource. Currently, the only resource that can be tagged is workspaces.

untagResource

inline suspend fun GrafanaClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

The UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource.

updatePermissions

inline suspend fun GrafanaClient.updatePermissions(crossinline block: UpdatePermissionsRequest.Builder.() -> Unit): UpdatePermissionsResponse

Updates which users in a workspace have the Grafana Admin or Editor roles.

updateWorkspace

inline suspend fun GrafanaClient.updateWorkspace(crossinline block: UpdateWorkspaceRequest.Builder.() -> Unit): UpdateWorkspaceResponse

Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed.

updateWorkspaceAuthentication

inline suspend fun GrafanaClient.updateWorkspaceAuthentication(crossinline block: UpdateWorkspaceAuthenticationRequest.Builder.() -> Unit): UpdateWorkspaceAuthenticationResponse

Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace.

updateWorkspaceConfiguration

inline suspend fun GrafanaClient.updateWorkspaceConfiguration(crossinline block: UpdateWorkspaceConfigurationRequest.Builder.() -> Unit): UpdateWorkspaceConfigurationResponse

Updates the configuration string for the given workspace

withConfig

fun GrafanaClient.withConfig(block: GrafanaClient.Config.Builder.() -> Unit): GrafanaClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.