WorkspaceSummary
A structure that contains some information about one workspace in the account.
Contents
- authentication
-
A structure containing information about the authentication methods used in the workspace.
Type: AuthenticationSummary object
Required: Yes
- created
-
The date that the workspace was created.
Type: Timestamp
Required: Yes
- endpoint
-
The URL endpoint to use to access the Grafana console in the workspace.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
- grafanaVersion
-
The Grafana version that the workspace is running.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- id
-
The unique ID of the workspace.
Type: String
Pattern:
^g-[0-9a-f]{10}$Required: Yes
- modified
-
The most recent date that the workspace was modified.
Type: Timestamp
Required: Yes
- status
-
The current status of the workspace.
Type: String
Valid Values:
ACTIVE | CREATING | DELETING | FAILED | UPDATING | UPGRADING | DELETION_FAILED | CREATION_FAILED | UPDATE_FAILED | UPGRADE_FAILED | LICENSE_REMOVAL_FAILED | VERSION_UPDATING | VERSION_UPDATE_FAILEDRequired: Yes
- description
-
The customer-entered description of the workspace.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
- grafanaToken
-
The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Required: No
- licenseType
-
Specifies whether this workspace has a full Grafana Enterprise license.
Note
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
Type: String
Valid Values:
ENTERPRISE | ENTERPRISE_FREE_TRIALRequired: No
- name
-
The name of the workspace.
Type: String
Pattern:
^[a-zA-Z0-9-._~]{1,255}$Required: No
- notificationDestinations
-
The AWS notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.
Type: Array of strings
Valid Values:
SNSRequired: No
-
The list of tags associated with the workspace.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
