aws-elixir

View Source AWS.Grafana (aws-elixir v1.0.4)

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.

Link to this section Summary

Functions

associate_license(client, license_type, workspace_id, input, options \\ [])

Assigns a Grafana Enterprise license to a workspace.

create_workspace(client, input, options \\ [])

Creates a workspace.

create_workspace_api_key(client, workspace_id, input, options \\ [])

Creates a Grafana API key for the workspace.

create_workspace_service_account(client, workspace_id, input, options \\ [])

Creates a service account for the workspace.

create_workspace_service_account_token(client, service_account_id, workspace_id, input, options \\ [])

Creates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account.

delete_workspace(client, workspace_id, input, options \\ [])

Deletes an Amazon Managed Grafana workspace.

delete_workspace_api_key(client, key_name, workspace_id, input, options \\ [])

Deletes a Grafana API key for the workspace.

delete_workspace_service_account(client, service_account_id, workspace_id, input, options \\ [])

Deletes a workspace service account from the workspace.

delete_workspace_service_account_token(client, service_account_id, token_id, workspace_id, input, options \\ [])

Deletes a token for the workspace service account.

describe_workspace(client, workspace_id, options \\ [])

Displays information about one Amazon Managed Grafana workspace.

describe_workspace_authentication(client, workspace_id, options \\ [])

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

describe_workspace_configuration(client, workspace_id, options \\ [])

Gets the current configuration string for the given workspace.

disassociate_license(client, license_type, workspace_id, input, options \\ [])

Removes the Grafana Enterprise license from a workspace.

list_permissions(client, workspace_id, group_id \\ nil, max_results \\ nil, next_token \\ nil, user_id \\ nil, user_type \\ nil, options \\ [])

Lists the users and groups who have the Grafana Admin and Editor roles in this workspace.

list_tags_for_resource(client, resource_arn, options \\ [])

The ListTagsForResource operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the resourceArn.

list_versions(client, max_results \\ nil, next_token \\ nil, workspace_id \\ nil, options \\ [])

Lists available versions of Grafana.

list_workspace_service_account_tokens(client, service_account_id, workspace_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of tokens for a workspace service account.

list_workspace_service_accounts(client, workspace_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of service accounts for a workspace.

list_workspaces(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace.

metadata()
tag_resource(client, resource_arn, input, options \\ [])

The TagResource operation associates tags with an Amazon Managed Grafana resource.

untag_resource(client, resource_arn, input, options \\ [])

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

update_permissions(client, workspace_id, input, options \\ [])

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

update_workspace(client, workspace_id, input, options \\ [])

Modifies an existing Amazon Managed Grafana workspace.

update_workspace_authentication(client, workspace_id, input, options \\ [])

Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML.

update_workspace_configuration(client, workspace_id, input, options \\ [])

Updates the configuration string for the given workspace

Link to this section Functions

Link to this function

associate_license(client, license_type, workspace_id, input, options \\ [])

View Source

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.

Link to this function

create_workspace(client, input, options \\ [])

View Source

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.

Link to this function

create_workspace_api_key(client, workspace_id, input, options \\ [])

View Source

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.

Link to this function

create_workspace_service_account(client, workspace_id, input, options \\ [])

View Source

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.

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.

Link to this function

create_workspace_service_account_token(client, service_account_id, workspace_id, input, options \\ [])

View Source

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.

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.

Link to this function

delete_workspace(client, workspace_id, input, options \\ [])

View Source

Deletes an Amazon Managed Grafana workspace.

Link to this function

delete_workspace_api_key(client, key_name, workspace_id, input, options \\ [])

View Source

Deletes a Grafana API key for the workspace.

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.

Link to this function

delete_workspace_service_account(client, service_account_id, workspace_id, input, options \\ [])

View Source

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.

Link to this function

delete_workspace_service_account_token(client, service_account_id, token_id, workspace_id, input, options \\ [])

View Source

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.

Link to this function

describe_workspace(client, workspace_id, options \\ [])

View Source

Displays information about one Amazon Managed Grafana workspace.

Link to this function

describe_workspace_authentication(client, workspace_id, options \\ [])

View Source

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

Link to this function

describe_workspace_configuration(client, workspace_id, options \\ [])

View Source

Gets the current configuration string for the given workspace.

Link to this function

disassociate_license(client, license_type, workspace_id, input, options \\ [])

View Source

Removes the Grafana Enterprise license from a workspace.

Link to this function

list_permissions(client, workspace_id, group_id \\ nil, max_results \\ nil, next_token \\ nil, user_id \\ nil, user_type \\ nil, options \\ [])

View Source

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 to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

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 to this function

list_versions(client, max_results \\ nil, next_token \\ nil, workspace_id \\ nil, options \\ [])

View Source

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 to this function

list_workspace_service_account_tokens(client, service_account_id, workspace_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of tokens for a workspace service account.

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.

Link to this function

list_workspace_service_accounts(client, workspace_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

list_workspaces(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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 to this function

metadata()

View Source
Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

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

Link to this function

update_permissions(client, workspace_id, input, options \\ [])

View Source

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

Link to this function

update_workspace(client, workspace_id, input, options \\ [])

View Source

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.

Link to this function

update_workspace_authentication(client, workspace_id, input, options \\ [])

View Source

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.

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

Link to this function

update_workspace_configuration(client, workspace_id, input, options \\ [])

View Source

Updates the configuration string for the given workspace