CreateWorkspace
Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.
Request Syntax
POST /workspaces HTTP/1.1
Content-type: application/json
{
"alias": "string",
"clientToken": "string",
"kmsKeyArn": "string",
"tags": {
"string" : "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- alias
-
An alias that you assign to this workspace to help you identify it. It does not need to be unique.
Blank spaces at the beginning or end of the alias that you specify will be trimmed from the value used.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- clientToken
-
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[!-~]+Required: No
- kmsKeyArn
-
(optional) The ARN for a customer managed AWS KMS key to use for encrypting data within your workspace. For more information about using your own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus User Guide.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/[-a-f0-9]+Required: No
-
The list of tag keys and values to associate with the workspace.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)Required: No
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"arn": "string",
"kmsKeyArn": "string",
"status": {
"statusCode": "string"
},
"tags": {
"string" : "string"
},
"workspaceId": "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.
- arn
-
The ARN for the new workspace.
Type: String
Pattern:
arn:aws[-a-z]*:aps:[-a-z0-9]+:[0-9]{12}:workspace/.+ - kmsKeyArn
-
(optional) If the workspace was created with a customer managed AWS KMS key, the ARN for the key used.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/[-a-f0-9]+ - status
-
The current status of the new workspace. Immediately after you create the workspace, the status is usually
CREATING.Type: WorkspaceStatus object
-
The list of tag keys and values that are associated with the workspace.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*) - workspaceId
-
The unique ID for the new workspace.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
.*[0-9A-Za-z][-.0-9A-Z_a-z]*.*
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.
- message
-
Description of the error.
HTTP Status Code: 403
- ConflictException
-
The request would cause an inconsistent state.
- message
-
Description of the error.
- resourceId
-
Identifier of the resource affected.
- resourceType
-
Type of the resource affected.
HTTP Status Code: 409
- InternalServerException
-
An unexpected error occurred during the processing of the request.
- message
-
Description of the error.
- retryAfterSeconds
-
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500
- ServiceQuotaExceededException
-
Completing the request would cause a service quota to be exceeded.
- message
-
Description of the error.
- quotaCode
-
Service quotas code of the originating quota.
- resourceId
-
Identifier of the resource affected.
- resourceType
-
Type of the resource affected.
- serviceCode
-
Service quotas code for the originating service.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to request throttling.
- message
-
Description of the error.
- quotaCode
-
Service quotas code for the originating quota.
- retryAfterSeconds
-
Advice to clients on when the call can be safely retried.
- serviceCode
-
Service quotas code for the originating service.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
- fieldList
-
The field that caused the error, if applicable.
- message
-
Description of the error.
- reason
-
Reason the request failed validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
