Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListVersions

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.

Request Syntax


GET /versions?maxResults=maxResults&nextToken=nextToken&workspace-id=workspaceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to include in the response.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The token to use when requesting the next set of results. You receive this token from a previous ListVersions operation.

workspaceId

The ID of the workspace to list the available upgrade versions. If not included, lists all versions of Grafana that are supported for CreateWorkspace.

Pattern: g-[0-9a-f]{10}

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "grafanaVersions": [ "string" ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

grafanaVersions

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.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 255.

nextToken

The token to use in a subsequent ListVersions operation to return the next set of results.

Type: String

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.

message: A description of the error.
retryAfterSeconds: How long to wait before you retry this operation.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

message: The value of a parameter in the request caused an error.
resourceId: The ID of the resource that is associated with the error.
resourceType: The type of the resource that is associated with the error.

HTTP Status Code: 404

ThrottlingException

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

message: A description of the error.
quotaCode: The ID of the service quota that was exceeded.
retryAfterSeconds: The value of a parameter in the request caused an error.
serviceCode: The ID of the service that is associated with the error.

HTTP Status Code: 429

ValidationException

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

fieldList: A list of fields that might be associated with the error.
message: A description of the error.
reason: The reason that the operation failed.

HTTP Status Code: 400