Grafana

import { Grafana } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/grafana.ts?docs=full";

class Grafana {

constructor(apiFactory: client.ApiFactory);

async associateLicense(params: AssociateLicenseRequest, opts?: client.RequestOptions): Promise<AssociateLicenseResponse>;

async createWorkspace(params: CreateWorkspaceRequest, opts?: client.RequestOptions): Promise<CreateWorkspaceResponse>;

async createWorkspaceApiKey(params: CreateWorkspaceApiKeyRequest, opts?: client.RequestOptions): Promise<CreateWorkspaceApiKeyResponse>;

async createWorkspaceServiceAccount(params: CreateWorkspaceServiceAccountRequest, opts?: client.RequestOptions): Promise<CreateWorkspaceServiceAccountResponse>;

async createWorkspaceServiceAccountToken(params: CreateWorkspaceServiceAccountTokenRequest, opts?: client.RequestOptions): Promise<CreateWorkspaceServiceAccountTokenResponse>;

async deleteWorkspace(params: DeleteWorkspaceRequest, opts?: client.RequestOptions): Promise<DeleteWorkspaceResponse>;

async deleteWorkspaceApiKey(params: DeleteWorkspaceApiKeyRequest, opts?: client.RequestOptions): Promise<DeleteWorkspaceApiKeyResponse>;

async deleteWorkspaceServiceAccount(params: DeleteWorkspaceServiceAccountRequest, opts?: client.RequestOptions): Promise<DeleteWorkspaceServiceAccountResponse>;

async deleteWorkspaceServiceAccountToken(params: DeleteWorkspaceServiceAccountTokenRequest, opts?: client.RequestOptions): Promise<DeleteWorkspaceServiceAccountTokenResponse>;

async describeWorkspace(params: DescribeWorkspaceRequest, opts?: client.RequestOptions): Promise<DescribeWorkspaceResponse>;

async describeWorkspaceAuthentication(params: DescribeWorkspaceAuthenticationRequest, opts?: client.RequestOptions): Promise<DescribeWorkspaceAuthenticationResponse>;

async describeWorkspaceConfiguration(params: DescribeWorkspaceConfigurationRequest, opts?: client.RequestOptions): Promise<DescribeWorkspaceConfigurationResponse>;

async disassociateLicense(params: DisassociateLicenseRequest, opts?: client.RequestOptions): Promise<DisassociateLicenseResponse>;

async listPermissions(params: ListPermissionsRequest, opts?: client.RequestOptions): Promise<ListPermissionsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listVersions(params?: ListVersionsRequest, opts?: client.RequestOptions): Promise<ListVersionsResponse>;

async listWorkspaces(params?: ListWorkspacesRequest, opts?: client.RequestOptions): Promise<ListWorkspacesResponse>;

async listWorkspaceServiceAccounts(params: ListWorkspaceServiceAccountsRequest, opts?: client.RequestOptions): Promise<ListWorkspaceServiceAccountsResponse>;

async listWorkspaceServiceAccountTokens(params: ListWorkspaceServiceAccountTokensRequest, opts?: client.RequestOptions): Promise<ListWorkspaceServiceAccountTokensResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updatePermissions(params: UpdatePermissionsRequest, opts?: client.RequestOptions): Promise<UpdatePermissionsResponse>;

async updateWorkspace(params: UpdateWorkspaceRequest, opts?: client.RequestOptions): Promise<UpdateWorkspaceResponse>;

async updateWorkspaceAuthentication(params: UpdateWorkspaceAuthenticationRequest, opts?: client.RequestOptions): Promise<UpdateWorkspaceAuthenticationResponse>;

async updateWorkspaceConfiguration(params: UpdateWorkspaceConfigurationRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Grafana(apiFactory: client.ApiFactory)

[src]

§Methods

associateLicense(params: AssociateLicenseRequest, opts?: client.RequestOptions): Promise<AssociateLicenseResponse>

[src]

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(params: CreateWorkspaceRequest, opts?: client.RequestOptions): Promise<CreateWorkspaceResponse>

[src]

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.

Don't use CreateWorkspace to modify an existing workspace. Instead, use UpdateWorkspace.

createWorkspaceApiKey(params: CreateWorkspaceApiKeyRequest, opts?: client.RequestOptions): Promise<CreateWorkspaceApiKeyResponse>

[src]

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.

Note: 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.

createWorkspaceServiceAccount(params: CreateWorkspaceServiceAccountRequest, opts?: client.RequestOptions): Promise<CreateWorkspaceServiceAccountResponse>

[src]

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.

You can only create service accounts for workspaces that are compatible with Grafana version 9 and above.

Note: For more information about service accounts, see Service accounts in the Amazon Managed Grafana User Guide. For more information about the Grafana HTTP APIs, see Using Grafana HTTP APIs in the Amazon Managed Grafana User Guide.

createWorkspaceServiceAccountToken(params: CreateWorkspaceServiceAccountTokenRequest, opts?: client.RequestOptions): Promise<CreateWorkspaceServiceAccountTokenResponse>

[src]

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.

! IMPORTANT: ! When you create the service account token, you will receive a key that is used when calling Grafana APIs. ! Do not lose this key, as it will not be retrievable again. ! If you do lose the key, you can delete the token and recreate it to receive a new key. ! This will disable the initial key.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

deleteWorkspace(params: DeleteWorkspaceRequest, opts?: client.RequestOptions): Promise<DeleteWorkspaceResponse>

[src]

Deletes an Amazon Managed Grafana workspace.

deleteWorkspaceApiKey(params: DeleteWorkspaceApiKeyRequest, opts?: client.RequestOptions): Promise<DeleteWorkspaceApiKeyResponse>

[src]

Deletes a Grafana API key for the workspace.

Note: 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.

deleteWorkspaceServiceAccount(params: DeleteWorkspaceServiceAccountRequest, opts?: client.RequestOptions): Promise<DeleteWorkspaceServiceAccountResponse>

[src]

Deletes a workspace service account from the workspace.

This will delete any tokens created for the service account, as well. If the tokens are currently in use, the will fail to authenticate / authorize after they are deleted.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

deleteWorkspaceServiceAccountToken(params: DeleteWorkspaceServiceAccountTokenRequest, opts?: client.RequestOptions): Promise<DeleteWorkspaceServiceAccountTokenResponse>

[src]

Deletes a token for the workspace service account.

This will disable the key associated with the token. If any automation is currently using the key, it will no longer be authenticated or authorized to perform actions with the Grafana HTTP APIs.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

describeWorkspace(params: DescribeWorkspaceRequest, opts?: client.RequestOptions): Promise<DescribeWorkspaceResponse>

[src]

Displays information about one Amazon Managed Grafana workspace.

describeWorkspaceAuthentication(params: DescribeWorkspaceAuthenticationRequest, opts?: client.RequestOptions): Promise<DescribeWorkspaceAuthenticationResponse>

[src]

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

describeWorkspaceConfiguration(params: DescribeWorkspaceConfigurationRequest, opts?: client.RequestOptions): Promise<DescribeWorkspaceConfigurationResponse>

[src]

Gets the current configuration string for the given workspace.

disassociateLicense(params: DisassociateLicenseRequest, opts?: client.RequestOptions): Promise<DisassociateLicenseResponse>

[src]

Removes the Grafana Enterprise license from a workspace.

listPermissions(params: ListPermissionsRequest, opts?: client.RequestOptions): Promise<ListPermissionsResponse>

[src]

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(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

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(params?: ListVersionsRequest, opts?: client.RequestOptions): Promise<ListVersionsResponse>

[src]

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(params?: ListWorkspacesRequest, opts?: client.RequestOptions): Promise<ListWorkspacesResponse>

[src]

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(params: ListWorkspaceServiceAccountsRequest, opts?: client.RequestOptions): Promise<ListWorkspaceServiceAccountsResponse>

[src]

Returns a list of service accounts for a workspace.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

listWorkspaceServiceAccountTokens(params: ListWorkspaceServiceAccountTokensRequest, opts?: client.RequestOptions): Promise<ListWorkspaceServiceAccountTokensResponse>

[src]

Returns a list of tokens for a workspace service account.

Note: This does not return the key for each token. You cannot access keys after they are created. To create a new key, delete the token and recreate it.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

updatePermissions(params: UpdatePermissionsRequest, opts?: client.RequestOptions): Promise<UpdatePermissionsResponse>

[src]

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

updateWorkspace(params: UpdateWorkspaceRequest, opts?: client.RequestOptions): Promise<UpdateWorkspaceResponse>

[src]

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.

To modify the user authentication methods that the workspace uses, such as SAML or IAM Identity Center, use UpdateWorkspaceAuthentication.

To modify which users in the workspace have the Admin and Editor Grafana roles, use UpdatePermissions.

updateWorkspaceAuthentication(params: UpdateWorkspaceAuthenticationRequest, opts?: client.RequestOptions): Promise<UpdateWorkspaceAuthenticationResponse>

[src]

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.

Note: Changes to the authentication method for a workspace may take a few minutes to take effect.

updateWorkspaceConfiguration(params: UpdateWorkspaceConfigurationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Updates the configuration string for the given workspace

§Static Properties

ApiMetadata: client.ApiMetadata

[src]