DescribeWorkspace - Amazon Managed Grafana


Displays information about one Amazon Managed Grafana workspace.

Request Syntax

GET /workspaces/workspaceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The ID of the workspace to display information about.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 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 200 response.

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


A structure containing information about the workspace.

Type: WorkspaceDescription object


For information about the errors that are common to all actions, see Common Errors.


You do not have sufficient permissions to perform this action.

HTTP Status Code: 403


Unexpected error while processing the request. Retry the request.

HTTP Status Code: 500


The request references a resource that does not exist.

HTTP Status Code: 404


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

HTTP Status Code: 429


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: