Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.
Request Syntax
GET /workspaces?alias=alias&maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- alias
-
If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.
Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.
Length Constraints: Minimum length of 1. Maximum length of 100.
- maxResults
-
The maximum number of workspaces to return per request. The default is 100.
Valid Range: Minimum value of 1. Maximum value of 1000.
- nextToken
-
The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.
For example, if your initial request has
maxResultsof 10, and there are 12 workspaces to return, then your initial request will return 10 and anextToken. Using the next token in a subsequent call will return the remaining 2 workspaces.Length Constraints: Minimum length of 0. Maximum length of 1000.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"workspaces": [
{
"alias": "string",
"arn": "string",
"createdAt": number,
"kmsKeyArn": "string",
"status": {
"statusCode": "string"
},
"tags": {
"string" : "string"
},
"workspaceId": "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
-
A token indicating that there are more results to retrieve. You can use this token as part of your next
ListWorkspacesrequest to retrieve those results.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
- workspaces
-
An array of
WorkspaceSummarystructures containing information about the workspaces requested.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 access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error occurred during the processing of the request.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
