AssociateLicense
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.
Request Syntax
POST /workspaces/workspaceId/licenses/licenseType HTTP/1.1
Grafana-Token: grafanaToken
URI Request Parameters
The request uses the following URI parameters.
- grafanaToken
-
A token from Grafana Labs that ties your AWS account with a Grafana Labs account. For more information, see Link your account with Grafana Labs.
Length Constraints: Minimum length of 1. Maximum length of 36.
- licenseType
-
The type of license to associate with the workspace.
Note
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
Valid Values:
ENTERPRISE | ENTERPRISE_FREE_TRIALRequired: Yes
- workspaceId
-
The ID of the workspace to associate the license with.
Pattern:
^g-[0-9a-f]{10}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"workspace": {
"accountAccessType": "string",
"authentication": {
"providers": [ "string" ],
"samlConfigurationStatus": "string"
},
"created": number,
"dataSources": [ "string" ],
"description": "string",
"endpoint": "string",
"freeTrialConsumed": boolean,
"freeTrialExpiration": number,
"grafanaToken": "string",
"grafanaVersion": "string",
"id": "string",
"licenseExpiration": number,
"licenseType": "string",
"modified": number,
"name": "string",
"networkAccessControl": {
"prefixListIds": [ "string" ],
"vpceIds": [ "string" ]
},
"notificationDestinations": [ "string" ],
"organizationalUnits": [ "string" ],
"organizationRoleName": "string",
"permissionType": "string",
"stackSetName": "string",
"status": "string",
"tags": {
"string" : "string"
},
"vpcConfiguration": {
"securityGroupIds": [ "string" ],
"subnetIds": [ "string" ]
},
"workspaceRoleArn": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
- workspace
-
A structure containing data about the workspace.
Type: WorkspaceDescription object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
- InternalServerException
-
Unexpected error while processing the request. Retry the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request references a resource that does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied because of request throttling. Retry the request.
HTTP Status Code: 429
- ValidationException
-
The value of a parameter in the request caused an error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
