ListWorkspaces - AWS Managed Grafana

ListWorkspaces

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.

Request Syntax

GET /workspaces?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of workspaces to include in the results.

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

nextToken

The token for the next set of workspaces to return. (You receive this token from a previous ListWorkspaces operation.)

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "workspaces": [ { "authentication": { "providers": [ "string" ], "samlConfigurationStatus": "string" }, "created": number, "description": "string", "endpoint": "string", "grafanaVersion": "string", "id": "string", "modified": number, "name": "string", "notificationDestinations": [ "string" ], "status": "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.

nextToken

The token to use when requesting the next set of workspaces.

Type: String

workspaces

An array of structures that contain some information about the workspaces in the account.

Type: Array of WorkspaceSummary objects

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

ThrottlingException

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

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: