Grafana

import { Grafana } from "https://aws-api.deno.dev/v0.4/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 deleteWorkspace(params: DeleteWorkspaceRequest, opts?: client.RequestOptions): Promise<DeleteWorkspaceResponse>;

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

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

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

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.

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.

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.

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]