aws-sdk
Version:
AWS SDK for JavaScript
853 lines (852 loc) • 71.1 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Grafana extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Grafana.Types.ClientConfiguration)
config: Config & Grafana.Types.ClientConfiguration;
/**
* 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.
*/
associateLicense(params: Grafana.Types.AssociateLicenseRequest, callback?: (err: AWSError, data: Grafana.Types.AssociateLicenseResponse) => void): Request<Grafana.Types.AssociateLicenseResponse, AWSError>;
/**
* 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.
*/
associateLicense(callback?: (err: AWSError, data: Grafana.Types.AssociateLicenseResponse) => void): Request<Grafana.Types.AssociateLicenseResponse, AWSError>;
/**
* 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.
*/
createWorkspace(params: Grafana.Types.CreateWorkspaceRequest, callback?: (err: AWSError, data: Grafana.Types.CreateWorkspaceResponse) => void): Request<Grafana.Types.CreateWorkspaceResponse, AWSError>;
/**
* 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.
*/
createWorkspace(callback?: (err: AWSError, data: Grafana.Types.CreateWorkspaceResponse) => void): Request<Grafana.Types.CreateWorkspaceResponse, AWSError>;
/**
* 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.
*/
createWorkspaceApiKey(params: Grafana.Types.CreateWorkspaceApiKeyRequest, callback?: (err: AWSError, data: Grafana.Types.CreateWorkspaceApiKeyResponse) => void): Request<Grafana.Types.CreateWorkspaceApiKeyResponse, AWSError>;
/**
* 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.
*/
createWorkspaceApiKey(callback?: (err: AWSError, data: Grafana.Types.CreateWorkspaceApiKeyResponse) => void): Request<Grafana.Types.CreateWorkspaceApiKeyResponse, AWSError>;
/**
* 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.
*/
createWorkspaceServiceAccount(params: Grafana.Types.CreateWorkspaceServiceAccountRequest, callback?: (err: AWSError, data: Grafana.Types.CreateWorkspaceServiceAccountResponse) => void): Request<Grafana.Types.CreateWorkspaceServiceAccountResponse, AWSError>;
/**
* 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.
*/
createWorkspaceServiceAccount(callback?: (err: AWSError, data: Grafana.Types.CreateWorkspaceServiceAccountResponse) => void): Request<Grafana.Types.CreateWorkspaceServiceAccountResponse, AWSError>;
/**
* 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.
*/
createWorkspaceServiceAccountToken(params: Grafana.Types.CreateWorkspaceServiceAccountTokenRequest, callback?: (err: AWSError, data: Grafana.Types.CreateWorkspaceServiceAccountTokenResponse) => void): Request<Grafana.Types.CreateWorkspaceServiceAccountTokenResponse, AWSError>;
/**
* 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.
*/
createWorkspaceServiceAccountToken(callback?: (err: AWSError, data: Grafana.Types.CreateWorkspaceServiceAccountTokenResponse) => void): Request<Grafana.Types.CreateWorkspaceServiceAccountTokenResponse, AWSError>;
/**
* Deletes an Amazon Managed Grafana workspace.
*/
deleteWorkspace(params: Grafana.Types.DeleteWorkspaceRequest, callback?: (err: AWSError, data: Grafana.Types.DeleteWorkspaceResponse) => void): Request<Grafana.Types.DeleteWorkspaceResponse, AWSError>;
/**
* Deletes an Amazon Managed Grafana workspace.
*/
deleteWorkspace(callback?: (err: AWSError, data: Grafana.Types.DeleteWorkspaceResponse) => void): Request<Grafana.Types.DeleteWorkspaceResponse, AWSError>;
/**
* 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.
*/
deleteWorkspaceApiKey(params: Grafana.Types.DeleteWorkspaceApiKeyRequest, callback?: (err: AWSError, data: Grafana.Types.DeleteWorkspaceApiKeyResponse) => void): Request<Grafana.Types.DeleteWorkspaceApiKeyResponse, AWSError>;
/**
* 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.
*/
deleteWorkspaceApiKey(callback?: (err: AWSError, data: Grafana.Types.DeleteWorkspaceApiKeyResponse) => void): Request<Grafana.Types.DeleteWorkspaceApiKeyResponse, AWSError>;
/**
* 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.
*/
deleteWorkspaceServiceAccount(params: Grafana.Types.DeleteWorkspaceServiceAccountRequest, callback?: (err: AWSError, data: Grafana.Types.DeleteWorkspaceServiceAccountResponse) => void): Request<Grafana.Types.DeleteWorkspaceServiceAccountResponse, AWSError>;
/**
* 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.
*/
deleteWorkspaceServiceAccount(callback?: (err: AWSError, data: Grafana.Types.DeleteWorkspaceServiceAccountResponse) => void): Request<Grafana.Types.DeleteWorkspaceServiceAccountResponse, AWSError>;
/**
* 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.
*/
deleteWorkspaceServiceAccountToken(params: Grafana.Types.DeleteWorkspaceServiceAccountTokenRequest, callback?: (err: AWSError, data: Grafana.Types.DeleteWorkspaceServiceAccountTokenResponse) => void): Request<Grafana.Types.DeleteWorkspaceServiceAccountTokenResponse, AWSError>;
/**
* 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.
*/
deleteWorkspaceServiceAccountToken(callback?: (err: AWSError, data: Grafana.Types.DeleteWorkspaceServiceAccountTokenResponse) => void): Request<Grafana.Types.DeleteWorkspaceServiceAccountTokenResponse, AWSError>;
/**
* Displays information about one Amazon Managed Grafana workspace.
*/
describeWorkspace(params: Grafana.Types.DescribeWorkspaceRequest, callback?: (err: AWSError, data: Grafana.Types.DescribeWorkspaceResponse) => void): Request<Grafana.Types.DescribeWorkspaceResponse, AWSError>;
/**
* Displays information about one Amazon Managed Grafana workspace.
*/
describeWorkspace(callback?: (err: AWSError, data: Grafana.Types.DescribeWorkspaceResponse) => void): Request<Grafana.Types.DescribeWorkspaceResponse, AWSError>;
/**
* Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
*/
describeWorkspaceAuthentication(params: Grafana.Types.DescribeWorkspaceAuthenticationRequest, callback?: (err: AWSError, data: Grafana.Types.DescribeWorkspaceAuthenticationResponse) => void): Request<Grafana.Types.DescribeWorkspaceAuthenticationResponse, AWSError>;
/**
* Displays information about the authentication methods used in one Amazon Managed Grafana workspace.
*/
describeWorkspaceAuthentication(callback?: (err: AWSError, data: Grafana.Types.DescribeWorkspaceAuthenticationResponse) => void): Request<Grafana.Types.DescribeWorkspaceAuthenticationResponse, AWSError>;
/**
* Gets the current configuration string for the given workspace.
*/
describeWorkspaceConfiguration(params: Grafana.Types.DescribeWorkspaceConfigurationRequest, callback?: (err: AWSError, data: Grafana.Types.DescribeWorkspaceConfigurationResponse) => void): Request<Grafana.Types.DescribeWorkspaceConfigurationResponse, AWSError>;
/**
* Gets the current configuration string for the given workspace.
*/
describeWorkspaceConfiguration(callback?: (err: AWSError, data: Grafana.Types.DescribeWorkspaceConfigurationResponse) => void): Request<Grafana.Types.DescribeWorkspaceConfigurationResponse, AWSError>;
/**
* Removes the Grafana Enterprise license from a workspace.
*/
disassociateLicense(params: Grafana.Types.DisassociateLicenseRequest, callback?: (err: AWSError, data: Grafana.Types.DisassociateLicenseResponse) => void): Request<Grafana.Types.DisassociateLicenseResponse, AWSError>;
/**
* Removes the Grafana Enterprise license from a workspace.
*/
disassociateLicense(callback?: (err: AWSError, data: Grafana.Types.DisassociateLicenseResponse) => void): Request<Grafana.Types.DisassociateLicenseResponse, AWSError>;
/**
* 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.
*/
listPermissions(params: Grafana.Types.ListPermissionsRequest, callback?: (err: AWSError, data: Grafana.Types.ListPermissionsResponse) => void): Request<Grafana.Types.ListPermissionsResponse, AWSError>;
/**
* 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.
*/
listPermissions(callback?: (err: AWSError, data: Grafana.Types.ListPermissionsResponse) => void): Request<Grafana.Types.ListPermissionsResponse, AWSError>;
/**
* 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.
*/
listTagsForResource(params: Grafana.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Grafana.Types.ListTagsForResourceResponse) => void): Request<Grafana.Types.ListTagsForResourceResponse, AWSError>;
/**
* 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.
*/
listTagsForResource(callback?: (err: AWSError, data: Grafana.Types.ListTagsForResourceResponse) => void): Request<Grafana.Types.ListTagsForResourceResponse, AWSError>;
/**
* 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.
*/
listVersions(params: Grafana.Types.ListVersionsRequest, callback?: (err: AWSError, data: Grafana.Types.ListVersionsResponse) => void): Request<Grafana.Types.ListVersionsResponse, AWSError>;
/**
* 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.
*/
listVersions(callback?: (err: AWSError, data: Grafana.Types.ListVersionsResponse) => void): Request<Grafana.Types.ListVersionsResponse, AWSError>;
/**
* 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.
*/
listWorkspaceServiceAccountTokens(params: Grafana.Types.ListWorkspaceServiceAccountTokensRequest, callback?: (err: AWSError, data: Grafana.Types.ListWorkspaceServiceAccountTokensResponse) => void): Request<Grafana.Types.ListWorkspaceServiceAccountTokensResponse, AWSError>;
/**
* 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.
*/
listWorkspaceServiceAccountTokens(callback?: (err: AWSError, data: Grafana.Types.ListWorkspaceServiceAccountTokensResponse) => void): Request<Grafana.Types.ListWorkspaceServiceAccountTokensResponse, AWSError>;
/**
* 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.
*/
listWorkspaceServiceAccounts(params: Grafana.Types.ListWorkspaceServiceAccountsRequest, callback?: (err: AWSError, data: Grafana.Types.ListWorkspaceServiceAccountsResponse) => void): Request<Grafana.Types.ListWorkspaceServiceAccountsResponse, AWSError>;
/**
* 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.
*/
listWorkspaceServiceAccounts(callback?: (err: AWSError, data: Grafana.Types.ListWorkspaceServiceAccountsResponse) => void): Request<Grafana.Types.ListWorkspaceServiceAccountsResponse, AWSError>;
/**
* 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.
*/
listWorkspaces(params: Grafana.Types.ListWorkspacesRequest, callback?: (err: AWSError, data: Grafana.Types.ListWorkspacesResponse) => void): Request<Grafana.Types.ListWorkspacesResponse, AWSError>;
/**
* 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.
*/
listWorkspaces(callback?: (err: AWSError, data: Grafana.Types.ListWorkspacesResponse) => void): Request<Grafana.Types.ListWorkspacesResponse, AWSError>;
/**
* 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.
*/
tagResource(params: Grafana.Types.TagResourceRequest, callback?: (err: AWSError, data: Grafana.Types.TagResourceResponse) => void): Request<Grafana.Types.TagResourceResponse, AWSError>;
/**
* 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.
*/
tagResource(callback?: (err: AWSError, data: Grafana.Types.TagResourceResponse) => void): Request<Grafana.Types.TagResourceResponse, AWSError>;
/**
* The UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource.
*/
untagResource(params: Grafana.Types.UntagResourceRequest, callback?: (err: AWSError, data: Grafana.Types.UntagResourceResponse) => void): Request<Grafana.Types.UntagResourceResponse, AWSError>;
/**
* The UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource.
*/
untagResource(callback?: (err: AWSError, data: Grafana.Types.UntagResourceResponse) => void): Request<Grafana.Types.UntagResourceResponse, AWSError>;
/**
* Updates which users in a workspace have the Grafana Admin or Editor roles.
*/
updatePermissions(params: Grafana.Types.UpdatePermissionsRequest, callback?: (err: AWSError, data: Grafana.Types.UpdatePermissionsResponse) => void): Request<Grafana.Types.UpdatePermissionsResponse, AWSError>;
/**
* Updates which users in a workspace have the Grafana Admin or Editor roles.
*/
updatePermissions(callback?: (err: AWSError, data: Grafana.Types.UpdatePermissionsResponse) => void): Request<Grafana.Types.UpdatePermissionsResponse, AWSError>;
/**
* 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.
*/
updateWorkspace(params: Grafana.Types.UpdateWorkspaceRequest, callback?: (err: AWSError, data: Grafana.Types.UpdateWorkspaceResponse) => void): Request<Grafana.Types.UpdateWorkspaceResponse, AWSError>;
/**
* 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.
*/
updateWorkspace(callback?: (err: AWSError, data: Grafana.Types.UpdateWorkspaceResponse) => void): Request<Grafana.Types.UpdateWorkspaceResponse, AWSError>;
/**
* 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.
*/
updateWorkspaceAuthentication(params: Grafana.Types.UpdateWorkspaceAuthenticationRequest, callback?: (err: AWSError, data: Grafana.Types.UpdateWorkspaceAuthenticationResponse) => void): Request<Grafana.Types.UpdateWorkspaceAuthenticationResponse, AWSError>;
/**
* 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.
*/
updateWorkspaceAuthentication(callback?: (err: AWSError, data: Grafana.Types.UpdateWorkspaceAuthenticationResponse) => void): Request<Grafana.Types.UpdateWorkspaceAuthenticationResponse, AWSError>;
/**
* Updates the configuration string for the given workspace
*/
updateWorkspaceConfiguration(params: Grafana.Types.UpdateWorkspaceConfigurationRequest, callback?: (err: AWSError, data: Grafana.Types.UpdateWorkspaceConfigurationResponse) => void): Request<Grafana.Types.UpdateWorkspaceConfigurationResponse, AWSError>;
/**
* Updates the configuration string for the given workspace
*/
updateWorkspaceConfiguration(callback?: (err: AWSError, data: Grafana.Types.UpdateWorkspaceConfigurationResponse) => void): Request<Grafana.Types.UpdateWorkspaceConfigurationResponse, AWSError>;
}
declare namespace Grafana {
export type AccountAccessType = "CURRENT_ACCOUNT"|"ORGANIZATION"|string;
export type AllowedOrganization = string;
export type AllowedOrganizations = AllowedOrganization[];
export type ApiKeyName = string;
export type ApiKeyToken = string;
export type AssertionAttribute = string;
export interface AssertionAttributes {
/**
* The name of the attribute within the SAML assertion to use as the email names for SAML users.
*/
email?: AssertionAttribute;
/**
* The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.
*/
groups?: AssertionAttribute;
/**
* The name of the attribute within the SAML assertion to use as the login names for SAML users.
*/
login?: AssertionAttribute;
/**
* The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.
*/
name?: AssertionAttribute;
/**
* The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.
*/
org?: AssertionAttribute;
/**
* The name of the attribute within the SAML assertion to use as the user roles.
*/
role?: AssertionAttribute;
}
export interface AssociateLicenseRequest {
/**
* A token from Grafana Labs that ties your Amazon Web Services account with a Grafana Labs account. For more information, see Link your account with Grafana Labs.
*/
grafanaToken?: GrafanaToken;
/**
* The type of license to associate with the workspace. Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
*/
licenseType: LicenseType;
/**
* The ID of the workspace to associate the license with.
*/
workspaceId: WorkspaceId;
}
export interface AssociateLicenseResponse {
/**
* A structure containing data about the workspace.
*/
workspace: WorkspaceDescription;
}
export interface AuthenticationDescription {
/**
* A structure containing information about how this workspace works with IAM Identity Center.
*/
awsSso?: AwsSsoAuthentication;
/**
* Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.
*/
providers: AuthenticationProviders;
/**
* A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace.
*/
saml?: SamlAuthentication;
}
export type AuthenticationProviderTypes = "AWS_SSO"|"SAML"|string;
export type AuthenticationProviders = AuthenticationProviderTypes[];
export interface AuthenticationSummary {
/**
* Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.
*/
providers: AuthenticationProviders;
/**
* Specifies whether the workplace's user authentication method is fully configured.
*/
samlConfigurationStatus?: SamlConfigurationStatus;
}
export interface AwsSsoAuthentication {
/**
* The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.
*/
ssoClientId?: SSOClientId;
}
export type Boolean = boolean;
export type ClientToken = string;
export interface CreateWorkspaceApiKeyRequest {
/**
* Specifies the name of the key. Keynames must be unique to the workspace.
*/
keyName: ApiKeyName;
/**
* Specifies the permission level of the key. Valid values: ADMIN|EDITOR|VIEWER
*/
keyRole: String;
/**
* Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.
*/
secondsToLive: CreateWorkspaceApiKeyRequestSecondsToLiveInteger;
/**
* The ID of the workspace to create an API key.
*/
workspaceId: WorkspaceId;
}
export type CreateWorkspaceApiKeyRequestSecondsToLiveInteger = number;
export interface CreateWorkspaceApiKeyResponse {
/**
* The key token. Use this value as a bearer token to authenticate HTTP requests to the workspace.
*/
key: ApiKeyToken;
/**
* The name of the key that was created.
*/
keyName: ApiKeyName;
/**
* The ID of the workspace that the key is valid for.
*/
workspaceId: WorkspaceId;
}
export interface CreateWorkspaceRequest {
/**
* Specifies whether the workspace can access Amazon Web Services resources in this Amazon Web Services account only, or whether it can also access Amazon Web Services resources in other accounts in the same organization. If you specify ORGANIZATION, you must specify which organizational units the workspace can access in the workspaceOrganizationalUnits parameter.
*/
accountAccessType: AccountAccessType;
/**
* Specifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
*/
authenticationProviders: AuthenticationProviders;
/**
* A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
*/
clientToken?: ClientToken;
/**
* The configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
*/
configuration?: OverridableConfigurationJson;
/**
* Specifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 10.4). To get a list of supported versions, use the ListVersions operation.
*/
grafanaVersion?: GrafanaVersion;
/**
* Configuration for network access to your workspace. When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required. If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.
*/
networkAccessControl?: NetworkAccessConfiguration;
/**
* The name of an IAM role that already exists to use with Organizations to access Amazon Web Services data sources and notification channels in other accounts in an organization.
*/
organizationRoleName?: OrganizationRoleName;
/**
* When creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels. You must also specify a workspaceRoleArn for a role that you will manage for the workspace to use when accessing those datasources and notification channels. The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to SERVICE_MANAGED. Use only the CUSTOMER_MANAGED permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation. For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels.
*/
permissionType: PermissionType;
/**
* The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
*/
stackSetName?: StackSetName;
/**
* The list of tags associated with the workspace.
*/
tags?: TagMap;
/**
* The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).
*/
vpcConfiguration?: VpcConfiguration;
/**
* This parameter is for internal use only, and should not be used.
*/
workspaceDataSources?: DataSourceTypesList;
/**
* A description for the workspace. This is used only to help you identify this workspace. Pattern: ^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$
*/
workspaceDescription?: Description;
/**
* The name for the workspace. It does not have to be unique.
*/
workspaceName?: WorkspaceName;
/**
* Specify the Amazon Web Services notification channels that you plan to use in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to use these channels.
*/
workspaceNotificationDestinations?: NotificationDestinationsList;
/**
* Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.
*/
workspaceOrganizationalUnits?: OrganizationalUnitList;
/**
* Specified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added.
*/
workspaceRoleArn?: IamRoleArn;
}
export interface CreateWorkspaceResponse {
/**
* A structure containing data about the workspace that was created.
*/
workspace: WorkspaceDescription;
}
export interface CreateWorkspaceServiceAccountRequest {
/**
* The permission level to use for this service account. For more information about the roles and the permissions each has, see User roles in the Amazon Managed Grafana User Guide.
*/
grafanaRole: Role;
/**
* A name for the service account. The name must be unique within the workspace, as it determines the ID associated with the service account.
*/
name: ServiceAccountName;
/**
* The ID of the workspace within which to create the service account.
*/
workspaceId: WorkspaceId;
}
export interface CreateWorkspaceServiceAccountResponse {
/**
* The permission level given to the service account.
*/
grafanaRole: Role;
/**
* The ID of the service account.
*/
id: String;
/**
* The name of the service account.
*/
name: String;
/**
* The workspace with which the service account is associated.
*/
workspaceId: WorkspaceId;
}
export interface CreateWorkspaceServiceAccountTokenRequest {
/**
* A name for the token to create.
*/
name: ServiceAccountTokenName;
/**
* Sets how long the token will be valid, in seconds. You can set the time up to 30 days in the future.
*/
secondsToLive: CreateWorkspaceServiceAccountTokenRequestSecondsToLiveInteger;
/**
* The ID of the service account for which to create a token.
*/
serviceAccountId: String;
/**
* The ID of the workspace the service account resides within.
*/
workspaceId: WorkspaceId;
}
export type CreateWorkspaceServiceAccountTokenRequestSecondsToLiveInteger = number;
export interface CreateWorkspaceServiceAccountTokenResponse {
/**
* The ID of the service account where the token was created.
*/
serviceAccountId: String;
/**
* Information about the created token, including the key. Be sure to store the key securely.
*/
serviceAccountToken: ServiceAccountTokenSummaryWithKey;
/**
* The ID of the workspace where the token was created.
*/
workspaceId: WorkspaceId;
}
export type DataSourceType = "AMAZON_OPENSEARCH_SERVICE"|"CLOUDWATCH"|"PROMETHEUS"|"XRAY"|"TIMESTREAM"|"SITEWISE"|"ATHENA"|"REDSHIFT"|"TWINMAKER"|string;
export type DataSourceTypesList = DataSourceType[];
export interface DeleteWorkspaceApiKeyRequest {
/**
* The name of the API key to delete.
*/
keyName: ApiKeyName;
/**
* The ID of the workspace to delete.
*/
workspaceId: WorkspaceId;
}
export interface DeleteWorkspaceApiKeyResponse {
/**
* The name of the key that was deleted.
*/
keyName: ApiKeyName;
/**
* The ID of the workspace where the key was deleted.
*/
workspaceId: WorkspaceId;
}
export interface DeleteWorkspaceRequest {
/**
* The ID of the workspace to delete.
*/
workspaceId: WorkspaceId;
}
export interface DeleteWorkspaceResponse {
/**
* A structure containing information about the workspace that was deleted.
*/
workspace: WorkspaceDescription;
}
export interface DeleteWorkspaceServiceAccountRequest {
/**
* The ID of the service account to delete.
*/
serviceAccountId: String;
/**
* The ID of the workspace where the service account resides.
*/
workspaceId: WorkspaceId;
}
export interface DeleteWorkspaceServiceAccountResponse {
/**
* The ID of the service account deleted.
*/
serviceAccountId: String;
/**
* The ID of the workspace where the service account was deleted.
*/
workspaceId: WorkspaceId;
}
export interface DeleteWorkspaceServiceAccountTokenRequest {
/**
* The ID of the service account from which to delete the token.
*/
serviceAccountId: String;
/**
* The ID of the token to delete.
*/
tokenId: String;
/**
* The ID of the workspace from which to delete the token.
*/
workspaceId: WorkspaceId;
}
export interface DeleteWorkspaceServiceAccountTokenResponse {
/**
* The ID of the service account where the token was deleted.
*/
serviceAccountId: String;
/**
* The ID of the token that was deleted.
*/
tokenId: String;
/**
* The ID of the workspace where the token was deleted.
*/
workspaceId: WorkspaceId;
}
export interface DescribeWorkspaceAuthenticationRequest {
/**
* The ID of the workspace to return authentication information about.
*/
workspaceId: WorkspaceId;
}
export interface DescribeWorkspaceAuthenticationResponse {
/**
* A structure containing information about the authentication methods used in the workspace.
*/
authentication: AuthenticationDescription;
}
export interface DescribeWorkspaceConfigurationRequest {
/**
* The ID of the workspace to get configuration information for.
*/
workspaceId: WorkspaceId;
}
export interface DescribeWorkspaceConfigurationResponse {
/**
* The configuration string for the workspace that you requested. For more information about the format and configuration options available, see Working in your Grafana workspace.
*/
configuration: OverridableConfigurationJson;
/**
* The supported Grafana version for the workspace.
*/
grafanaVersion?: GrafanaVersion;
}
export interface DescribeWorkspaceRequest {
/**
* The ID of the workspace to display information about.
*/
workspaceId: WorkspaceId;
}
export interface DescribeWorkspaceResponse {
/**
* A structure containing information about the workspace.
*/
workspace: WorkspaceDescription;
}
export type Description = string;
export interface DisassociateLicenseRequest {
/**
* The type of license to remove from the workspace.
*/
licenseType: LicenseType;
/**
* The ID of the workspace to remove the Grafana Enterprise license from.
*/
workspaceId: WorkspaceId;
}
export interface DisassociateLicenseResponse {
/**
* A structure containing information about the workspace.
*/
workspace: WorkspaceDescription;
}
export type Endpoint = string;
export type GrafanaToken = string;
export type GrafanaVersion = string;
export type GrafanaVersionList = GrafanaVersion[];
export type IamRoleArn = string;
export interface IdpMetadata {
/**
* The URL of the location containing the IdP metadata.
*/
url?: IdpMetadataUrl;
/**
* The full IdP metadata, in XML format.
*/
xml?: String;
}
export type IdpMetadataUrl = string;
export type LicenseType = "ENTERPRISE"|"ENTERPRISE_FREE_TRIAL"|string;
export interface ListPermissionsRequest {
/**
* (Optional) Limits the results to only the group that matches this ID.
*/
groupId?: SsoId;
/**
* The maximum number of results to include in the response.
*/
maxResults?: ListPermissionsRequestMaxResultsInteger;
/**
* The token to use when requesting the next set of results. You received this token from a previous ListPermissions operation.
*/
nextToken?: PaginationToken;
/**
* (Optional) Limits the results to only the user that matches this ID.
*/
userId?: SsoId;
/**
* (Optional) If you specify SSO_USER, then only the permissions of IAM Identity Center users are returned. If you specify SSO_GROUP, only the permissions of IAM Identity Center groups are returned.
*/
userType?: UserType;
/**
* The ID of the workspace to list permissions for. This parameter is required.
*/
workspaceId: WorkspaceId;
}
export type ListPermissionsRequestMaxResultsInteger = number;
export interface ListPermissionsResponse {
/**
* The token to use in a subsequent ListPermissions operation to return the next set of results.
*/
nextToken?: PaginationToken;
/**
* The permissions returned by the operation.
*/
permissions: PermissionEntryList;
}
export interface ListTagsForResourceRequest {
/**
* The ARN of the resource the list of tags are associated with.
*/
resourceArn: String;
}
export interface ListTagsForResourceResponse {
/**
* The list of tags that are associated with the resource.
*/
tags?: TagMap;
}
export interface ListVersionsRequest {
/**
* The maximum number of results to include in the response.
*/
maxResults?: ListVersionsRequestMaxResultsInteger;
/**
* The token to use when requesting the next set of results. You receive this token from a previous ListVersions operation.
*/
nextToken?: PaginationToken;
/**
* The ID of the workspace to list the available upgrade versions. If not included, lists all versions of Grafana that are supported for CreateWorkspace.
*/
workspaceId?: WorkspaceId;
}
export type ListVersionsRequestMaxResultsInteger = number;
export interface ListVersionsResponse {
/**
* The Grafana versions available to create. If a workspace ID is included in the request, the Grafana versions to which this workspace can be upgraded.
*/
grafanaVersions?: GrafanaVersionList;
/**
* The token to use in a subsequent ListVersions operation to return the next set of results.
*/
nextToken?: PaginationToken;
}
export interface ListWorkspaceServiceAccountTokensRequest {
/**
* The maximum number of tokens to include in the results.
*/
maxResults?: ListWorkspaceServiceAccountTokensRequestMaxResultsInteger;
/**
* The token for the next set of service accounts to return. (You receive this token from a previous ListWorkspaceServiceAccountTokens operation.)
*/
nextToken?: PaginationToken;
/**
* The ID of the service account for which to return tokens.
*/
serviceAccountId: String;
/**
* The ID of the workspace for which to return tokens.
*/
workspaceId: WorkspaceId;
}
export type ListWorkspaceServiceAccountTokensRequestMaxResultsInteger = number;
export interface ListWorkspaceServiceAccountTokensResponse {
/**
* The token to use when requesting the next set of service accounts.
*/
nextToken?: PaginationToken;
/**
* The ID of the service account where the tokens reside.
*/
serviceAccountId: String;
/**
* An array of structures containing information about the tokens.
*/
serviceAccountTokens: ServiceAccountTokenList;
/**
* The ID of the workspace where the tokens reside.
*/
workspaceId: WorkspaceId;
}
export interface ListWorkspaceServiceAccountsRequest {
/**
* The maximum number of service accounts to include in the results.
*/
maxResults?: ListWorkspaceServiceAccountsRequestMaxResultsInteger;
/**
* The token for the next set of service accounts to return. (You receive this token from a previous ListWorkspaceServiceAccounts operation.)
*/
nextToken?: PaginationToken;
/**
* The workspace for which to list service accounts.
*/
workspaceId: WorkspaceId;
}
export type ListWorkspaceServiceAccountsRequestMaxResultsInteger = number;
export interface ListWorkspaceServiceAccountsResponse {
/**
* The token to use when requesting the next set of service accounts.
*/
nextToken?: PaginationToken;
/**
* An array of structures containing information about the service accounts.
*/
serviceAccounts: ServiceAccountList;
/**
* The workspace to which the service accounts are associated.
*/
workspaceId: WorkspaceId;
}
export interface ListWorkspacesRequest {
/**
* The maximum number of workspaces to include in the results.
*/
maxResults?: ListWorkspacesRequestMaxResultsInteger;
/**
* The token for the next set of workspaces to return. (You receive this token from a previous ListWorkspaces operation.)
*/
nextToken?: PaginationToken;
}
export type ListWorkspacesRequestMaxResultsInteger = number;
export interface ListWorkspacesResponse {
/**
* The token to use when requesting the next set of workspaces.
*/
nextToken?: PaginationToken;
/**
* An array of structures that contain some information about the workspaces in the account.
*/
workspaces: WorkspaceList;
}
export type LoginValidityDuration = number;
export interface NetworkAccessConfiguration {
/**
* An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration (passed an empty array) then no IP addresses are allowed to access the workspace. You create a prefix list using the Amazon VPC console. Prefix list IDs have the format pl-1a2b3c4d . For more information about prefix lists, see Group CIDR blocks using managed prefix listsin the Amazon Virtual Private Cloud User Guide.
*/
prefixListIds: PrefixListIds;
/**
* An array of Amazon VPC endpoint IDs for the workspace. You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a NetworkAccessConfiguration is specified then only VPC endpoints specified here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace. VPC endpoint IDs have the format vpce-1a2b3c4d . For more information about creating an interface VPC endpoint, see Interface VPC endpoints in the Amazon Managed Grafana User Guide. The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints are ignored.
*/
vpceIds: VpceIds;
}
export type NotificationDestinationType = "SNS"|string;
export type NotificationDestinationsList = NotificationDestinationType[];
export type OrganizationRoleName = string;
export type OrganizationalUnit = string;
export type OrganizationalUnitList = OrganizationalUnit[];
export type OverridableConfigurationJson = string;
export type PaginationToken = string;
export interface PermissionEntry {
/**
* Specifies whether the user or group has the Admin, Editor, or Viewer role.
*/
role: Role;
/**
* A structure with the ID of the user or group with this role.
*/
user: User;
}
export type PermissionEntryList = PermissionEntry[];
export type PermissionType = "CUSTOMER_MANAGED"|"SERVICE_MANAGED"|string;
export type PrefixListId = string;
export type PrefixListIds = PrefixListId[];
export type Role = "ADMIN"|"EDITOR"|"VIEWER"|string;
export type RoleValue = string;
export type RoleValueList = RoleValue[];
export interface RoleValues {
/**
* A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.
*/
admin?: RoleValueList;
/**
* A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.
*/
editor?: RoleValueList;
}
export type SSOClientId = string;
export interface SamlAuthentication {
/**
* A structure containing details about how this workspace works with SAML.
*/
configuration?: SamlConfiguration;
/**
* Specifies whether the workspace's SAML configuration is complete.
*/
status: SamlConfigurationStatus;
}
export interface SamlConfiguration {
/**
* Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.
*/