UpdateWorkspaceAlias - Amazon Managed Service for Prometheus

UpdateWorkspaceAlias

Updates the alias of an existing workspace.

Request Syntax

POST /workspaces/workspaceId/alias HTTP/1.1 Content-type: application/json { "alias": "string", "clientToken": "string" }

URI Request Parameters

The request uses the following URI parameters.

workspaceId

The ID of the workspace to update.

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.

alias

The new alias for the workspace. It does not need to be unique.

Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

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

Response Syntax

HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

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

See Also

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