grafana/aws.sdk.kotlin.services.grafana/GrafanaClient

GrafanaClient

interface GrafanaClient : SdkClient

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.

With Amazon Managed Grafana, you create logically isolated Grafana servers called workspaces. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to build, package, or deploy any hardware to run Grafana servers.

Properties

Link copied to clipboard
abstract override val config: GrafanaClient.Config

GrafanaClient's configuration

Functions

Link copied to clipboard
abstract suspend fun associateLicense(input: AssociateLicenseRequest): AssociateLicenseResponse

Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise.

Link copied to clipboard
abstract suspend fun createWorkspace(input: CreateWorkspaceRequest): 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.

Link copied to clipboard
abstract suspend fun createWorkspaceApiKey(input: CreateWorkspaceApiKeyRequest): 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.

Link copied to clipboard
abstract suspend fun deleteWorkspace(input: DeleteWorkspaceRequest): DeleteWorkspaceResponse

Deletes an Amazon Managed Grafana workspace.

Link copied to clipboard
abstract suspend fun deleteWorkspaceApiKey(input: DeleteWorkspaceApiKeyRequest): DeleteWorkspaceApiKeyResponse

Deletes a Grafana API key for the workspace.

Link copied to clipboard
abstract suspend fun describeWorkspace(input: DescribeWorkspaceRequest): DescribeWorkspaceResponse

Displays information about one Amazon Managed Grafana workspace.

Link copied to clipboard
abstract suspend fun describeWorkspaceAuthentication(input: DescribeWorkspaceAuthenticationRequest): DescribeWorkspaceAuthenticationResponse

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

Link copied to clipboard
abstract suspend fun describeWorkspaceConfiguration(input: DescribeWorkspaceConfigurationRequest): DescribeWorkspaceConfigurationResponse

Gets the current configuration string for the given workspace.

Link copied to clipboard
abstract suspend fun disassociateLicense(input: DisassociateLicenseRequest): DisassociateLicenseResponse

Removes the Grafana Enterprise license from a workspace.

Link copied to clipboard
abstract suspend fun listPermissions(input: ListPermissionsRequest): 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.

Link copied to clipboard
abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): 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.

Link copied to clipboard
abstract suspend fun listVersions(input: ListVersionsRequest = ListVersionsRequest { }): 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.

Link copied to clipboard
abstract suspend fun listWorkspaces(input: ListWorkspacesRequest = ListWorkspacesRequest { }): 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.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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

Link copied to clipboard
abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

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

Link copied to clipboard
abstract suspend fun updatePermissions(input: UpdatePermissionsRequest): UpdatePermissionsResponse

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

Link copied to clipboard
abstract suspend fun updateWorkspace(input: UpdateWorkspaceRequest): 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.

Link copied to clipboard
abstract suspend fun updateWorkspaceAuthentication(input: UpdateWorkspaceAuthenticationRequest): 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.

Link copied to clipboard
abstract suspend fun updateWorkspaceConfiguration(input: UpdateWorkspaceConfigurationRequest): UpdateWorkspaceConfigurationResponse

Updates the configuration string for the given workspace

Inherited functions

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

Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
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.

Link copied to clipboard
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.

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

Deletes an Amazon Managed Grafana workspace.

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

Deletes a Grafana API key for the workspace.

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

Displays information about one Amazon Managed Grafana workspace.

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

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

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

Gets the current configuration string for the given workspace.

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

Removes the Grafana Enterprise license from a workspace.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

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

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

Link copied to clipboard
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.

Link copied to clipboard
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.

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

Updates the configuration string for the given workspace

Link copied to clipboard
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.