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

UpdateWorkspaceConfiguration

Use this operation to create or update the label sets, label set limits, and retention period of a workspace.

You must specify at least one of limitsPerLabelSet or retentionPeriodInDays for the request to be valid.

Request Syntax


PATCH /workspaces/workspaceId/configuration HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "limitsPerLabelSet": [ 
      { 
         "labelSet": { 
            "string" : "string" 
         },
         "limits": { 
            "maxSeries": number
         }
      }
   ],
   "retentionPeriodInDays": number
}

URI Request Parameters

The request uses the following URI parameters.

workspaceId

The ID of the workspace that you want to update. To find the IDs of your workspaces, use the ListWorkspaces operation.

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

Pattern: .*[0-9A-Za-z][-.0-9A-Z_a-z]*.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

You can include a token in your operation to make it an idempotent opeartion.

Type: String

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

Pattern: [!-~]+

Required: No

limitsPerLabelSet

This is an array of structures, where each structure defines a label set for the workspace, and defines the active time series limit for each of those label sets. Each label name in a label set must be unique.

Type: Array of LimitsPerLabelSet objects

Required: No

retentionPeriodInDays

Specifies how many days that metrics will be retained in the workspace.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "status": { 
      "statusCode": "string",
      "statusReason": "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.

status

The status of the workspace configuration.

Type: WorkspaceConfigurationStatus object

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

ResourceNotFoundException

The request references a resources that doesn't exist.

message: Description of the error.
resourceId: Identifier of the resource affected.
resourceType: Type of the resource affected.

HTTP Status Code: 404

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