Module Awso_grafana_lwtSource

include module type of struct include Awso_grafana.Values end
Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

A structure that specifies one user or group in the workspace.

Sourcemodule AuthenticationProviderTypes = Awso_grafana.Values.AuthenticationProviderTypes

A structure that defines which attributes in the IdP assertion are to be used to define information about the users authenticated by the IdP to use the workspace.

A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace. You can specify the metadata either by providing a URL to its location in the url parameter, or by specifying the full metadata in XML format in the xml parameter. Specifying both will cause an error.

This structure defines which groups defined in the SAML assertion attribute are to be mapped to the Grafana Admin and Editor roles in the workspace. SAML authenticated users not part of Admin or Editor role groups have Viewer permission over the workspace.

Sourcemodule AuthenticationProviders = Awso_grafana.Values.AuthenticationProviders
Sourcemodule SamlConfigurationStatus = Awso_grafana.Values.SamlConfigurationStatus
Sourcemodule NotificationDestinationType = Awso_grafana.Values.NotificationDestinationType
Sourcemodule ValidationExceptionField = Awso_grafana.Values.ValidationExceptionField

A structure that contains information about a request parameter that caused an error.

A structure containing information about how this workspace works with SAML.

Sourcemodule UpdateErrorCodeInteger = Awso_grafana.Values.UpdateErrorCodeInteger

Contains the instructions for one Grafana role permission update in a UpdatePermissions operation.

A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication, and whether that authentication is fully configured.

Sourcemodule NotificationDestinationsList = Awso_grafana.Values.NotificationDestinationsList
Sourcemodule ValidationExceptionFieldList = Awso_grafana.Values.ValidationExceptionFieldList
Sourcemodule ValidationExceptionReason = Awso_grafana.Values.ValidationExceptionReason
Sourcemodule NetworkAccessConfiguration = Awso_grafana.Values.NetworkAccessConfiguration

The configuration settings for in-bound 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 are still required. Access is granted to a caller that is in either the IP address list or the VPC endpoint list - they do not need to be in both. If this is not configured, or is removed, then all IP addresses and VPC endpoints are allowed. Standard Grafana authentication and authorization are still required. While both prefixListIds and vpceIds are required, you can pass in an empty array of strings for either parameter if you do not want to allow any of that type. If both are passed as empty arrays, no traffic is allowed to the workspace, because only explicitly allowed connections are accepted.

Sourcemodule OrganizationalUnitList = Awso_grafana.Values.OrganizationalUnitList

The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. Provided securityGroupIds and subnetIds must be part of the same VPC. Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).

A structure containing information about how this workspace works with IAM Identity Center.

A structure containing information about how this workspace works with SAML.

A structure containing information about one error encountered while performing an UpdatePermissions operation.

A structure that contains some information about one workspace in the account.

A structure that contains the information about one service account.

Sourcemodule ServiceAccountTokenSummary = Awso_grafana.Values.ServiceAccountTokenSummary

A structure that contains the information about a service account token.

A structure containing the identity of one user or group and the Admin, Editor, or Viewer role that they have.

Sourcemodule ServiceAccountTokenKey = Awso_grafana.Values.ServiceAccountTokenKey

You do not have sufficient permissions to perform this action.

A resource was in an inconsistent state during an update or a deletion.

Sourcemodule InternalServerException = Awso_grafana.Values.InternalServerException

Unexpected error while processing the request. Retry the request.

Sourcemodule ResourceNotFoundException = Awso_grafana.Values.ResourceNotFoundException

The request references a resource that does not exist.

The request was denied because of request throttling. Retry the request.

The value of a parameter in the request caused an error.

A structure containing information about an Amazon Managed Grafana workspace in your account.

Sourcemodule OverridableConfigurationJson = Awso_grafana.Values.OverridableConfigurationJson
Sourcemodule AuthenticationDescription = Awso_grafana.Values.AuthenticationDescription

A structure containing information about the user authentication methods used by the workspace.

Sourcemodule UpdateInstructionBatch = Awso_grafana.Values.UpdateInstructionBatch
Sourcemodule ListWorkspacesRequestMaxResultsInteger = Awso_grafana.Values.ListWorkspacesRequestMaxResultsInteger
Sourcemodule ListWorkspaceServiceAccountsRequestMaxResultsInteger = Awso_grafana.Values.ListWorkspaceServiceAccountsRequestMaxResultsInteger
Sourcemodule ServiceAccountTokenList = Awso_grafana.Values.ServiceAccountTokenList
Sourcemodule ListWorkspaceServiceAccountTokensRequestMaxResultsInteger = Awso_grafana.Values.ListWorkspaceServiceAccountTokensRequestMaxResultsInteger
Sourcemodule ListVersionsRequestMaxResultsInteger = Awso_grafana.Values.ListVersionsRequestMaxResultsInteger
Sourcemodule ListPermissionsRequestMaxResultsInteger = Awso_grafana.Values.ListPermissionsRequestMaxResultsInteger
Sourcemodule ServiceAccountTokenSummaryWithKey = Awso_grafana.Values.ServiceAccountTokenSummaryWithKey

A structure that contains the information about a service account token. This structure is returned when creating the token. It is important to store the key that is returned, as it is not retrievable at a later time. If you lose the key, you can delete and recreate the token, which will create a new key.

Sourcemodule ServiceQuotaExceededException = Awso_grafana.Values.ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

Sourcemodule CreateWorkspaceServiceAccountTokenRequestSecondsToLiveInteger = Awso_grafana.Values.CreateWorkspaceServiceAccountTokenRequestSecondsToLiveInteger
Sourcemodule ServiceAccountTokenName = Awso_grafana.Values.ServiceAccountTokenName
Sourcemodule CreateWorkspaceApiKeyRequestSecondsToLiveInteger = Awso_grafana.Values.CreateWorkspaceApiKeyRequestSecondsToLiveInteger
Sourcemodule UpdateWorkspaceResponse = Awso_grafana.Values.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. 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.

Sourcemodule UpdateWorkspaceRequest = Awso_grafana.Values.UpdateWorkspaceRequest

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.

Sourcemodule UpdateWorkspaceConfigurationResponse = Awso_grafana.Values.UpdateWorkspaceConfigurationResponse

Updates the configuration string for the given workspace

Sourcemodule UpdateWorkspaceConfigurationRequest = Awso_grafana.Values.UpdateWorkspaceConfigurationRequest

Updates the configuration string for the given workspace

Sourcemodule UpdateWorkspaceAuthenticationResponse = Awso_grafana.Values.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. Changes to the authentication method for a workspace may take a few minutes to take effect.

Sourcemodule UpdateWorkspaceAuthenticationRequest = Awso_grafana.Values.UpdateWorkspaceAuthenticationRequest

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.

Sourcemodule UpdatePermissionsResponse = Awso_grafana.Values.UpdatePermissionsResponse

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

Sourcemodule UpdatePermissionsRequest = Awso_grafana.Values.UpdatePermissionsRequest

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

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

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

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.

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.

Sourcemodule ListWorkspacesResponse = Awso_grafana.Values.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.

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.

Sourcemodule ListWorkspaceServiceAccountsResponse = Awso_grafana.Values.ListWorkspaceServiceAccountsResponse

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.

Sourcemodule ListWorkspaceServiceAccountsRequest = Awso_grafana.Values.ListWorkspaceServiceAccountsRequest

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.

Sourcemodule ListWorkspaceServiceAccountTokensResponse = Awso_grafana.Values.ListWorkspaceServiceAccountTokensResponse

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.

Sourcemodule ListWorkspaceServiceAccountTokensRequest = Awso_grafana.Values.ListWorkspaceServiceAccountTokensRequest

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.

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.

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.

Sourcemodule ListTagsForResourceResponse = Awso_grafana.Values.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.

Sourcemodule ListTagsForResourceRequest = Awso_grafana.Values.ListTagsForResourceRequest

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.

Sourcemodule ListPermissionsResponse = Awso_grafana.Values.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.

Sourcemodule ListPermissionsRequest = Awso_grafana.Values.ListPermissionsRequest

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.

Sourcemodule DisassociateLicenseResponse = Awso_grafana.Values.DisassociateLicenseResponse

Removes the Grafana Enterprise license from a workspace.

Sourcemodule DisassociateLicenseRequest = Awso_grafana.Values.DisassociateLicenseRequest

Removes the Grafana Enterprise license from a workspace.

Sourcemodule DescribeWorkspaceResponse = Awso_grafana.Values.DescribeWorkspaceResponse

Displays information about one Amazon Managed Grafana workspace.

Sourcemodule DescribeWorkspaceRequest = Awso_grafana.Values.DescribeWorkspaceRequest

Displays information about one Amazon Managed Grafana workspace.

Sourcemodule DescribeWorkspaceConfigurationResponse = Awso_grafana.Values.DescribeWorkspaceConfigurationResponse

Gets the current configuration string for the given workspace.

Sourcemodule DescribeWorkspaceConfigurationRequest = Awso_grafana.Values.DescribeWorkspaceConfigurationRequest

Gets the current configuration string for the given workspace.

Sourcemodule DescribeWorkspaceAuthenticationResponse = Awso_grafana.Values.DescribeWorkspaceAuthenticationResponse

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

Sourcemodule DescribeWorkspaceAuthenticationRequest = Awso_grafana.Values.DescribeWorkspaceAuthenticationRequest

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

Sourcemodule DeleteWorkspaceServiceAccountTokenResponse = Awso_grafana.Values.DeleteWorkspaceServiceAccountTokenResponse

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.

Sourcemodule DeleteWorkspaceServiceAccountTokenRequest = Awso_grafana.Values.DeleteWorkspaceServiceAccountTokenRequest

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.

Sourcemodule DeleteWorkspaceServiceAccountResponse = Awso_grafana.Values.DeleteWorkspaceServiceAccountResponse

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.

Sourcemodule DeleteWorkspaceServiceAccountRequest = Awso_grafana.Values.DeleteWorkspaceServiceAccountRequest

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.

Sourcemodule DeleteWorkspaceResponse = Awso_grafana.Values.DeleteWorkspaceResponse

Deletes an Amazon Managed Grafana workspace.

Sourcemodule DeleteWorkspaceRequest = Awso_grafana.Values.DeleteWorkspaceRequest

Deletes an Amazon Managed Grafana workspace.

Sourcemodule DeleteWorkspaceApiKeyResponse = Awso_grafana.Values.DeleteWorkspaceApiKeyResponse

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.

Sourcemodule DeleteWorkspaceApiKeyRequest = Awso_grafana.Values.DeleteWorkspaceApiKeyRequest

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.

Sourcemodule CreateWorkspaceServiceAccountTokenResponse = Awso_grafana.Values.CreateWorkspaceServiceAccountTokenResponse

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.

Sourcemodule CreateWorkspaceServiceAccountTokenRequest = Awso_grafana.Values.CreateWorkspaceServiceAccountTokenRequest

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.

Sourcemodule CreateWorkspaceServiceAccountResponse = Awso_grafana.Values.CreateWorkspaceServiceAccountResponse

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.

Sourcemodule CreateWorkspaceServiceAccountRequest = Awso_grafana.Values.CreateWorkspaceServiceAccountRequest

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.

Sourcemodule CreateWorkspaceResponse = Awso_grafana.Values.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. Don't use CreateWorkspace to modify an existing workspace. Instead, use UpdateWorkspace.

Sourcemodule CreateWorkspaceRequest = Awso_grafana.Values.CreateWorkspaceRequest

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.

Sourcemodule CreateWorkspaceApiKeyResponse = Awso_grafana.Values.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. 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.

Sourcemodule CreateWorkspaceApiKeyRequest = Awso_grafana.Values.CreateWorkspaceApiKeyRequest

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.

Sourcemodule AssociateLicenseResponse = Awso_grafana.Values.AssociateLicenseResponse

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.

Sourcemodule AssociateLicenseRequest = Awso_grafana.Values.AssociateLicenseRequest

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.