View a markdown version of this page

UpdateSpace - Amazon CloudWatch Omni

UpdateSpace

Updates a space.

Only the provided fields are changed; omitted fields are left unchanged.

Request Parameters

encryptionConfiguration

How to encrypt the space's data at rest. Omit to leave encryption unchanged. Pass encryptionStrategy AWS_OWNED to stop using a customer managed key and revert to service owned encryption.

Type: EncryptionConfiguration object

Required: No

name

A new name for the space. Omit to leave unchanged. Must be 3-64 characters: lowercase letters, numbers, and hyphens. It must begin and end with a letter or number and cannot contain consecutive hyphens.

Type: String

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

Pattern: [a-z0-9]+(-[a-z0-9]+)*

Required: No

spaceId

The unique ID of the space to update.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Response Elements

The following element is returned by the service.

space

The updated details of the space.

Type: Space object

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The caller is not authorized to perform this action.

HTTP Status Code: 403

ConflictException

The operation could not be completed because of a conflict with the current state of the resource.

conflictType

The type of conflict that caused the request to fail. Not always present.

errorCode

The error code associated with the conflict. Not always present.

message

A human-readable description of the conflict.

resourceId

The identifier of the resource that is in conflict. Not always present.

resourceType

The type of the resource that is in conflict. Not always present.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

errorCode

The error code associated with the internal error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

errorCode

The error code associated with the failure.

resourceId

The identifier of the resource that could not be found. Not always present.

resourceType

The type of the resource that could not be found. Not always present.

HTTP Status Code: 404

ServiceQuotaExceededException

A service quota was exceeded.

HTTP Status Code: 402

ThrottlingException

The request was throttled due to exceeding the allowed request rate.

retryAfterSeconds

The number of seconds to wait before retrying the request. Not always present.

HTTP Status Code: 429

ValidationException

A parameter is specified incorrectly.

errorCode

The error code associated with the validation failure.

HTTP Status Code: 400

Examples

Rename a space

The following example updates only the name of a space; omitted fields are left unchanged. The response returns the full space with a later updatedAt timestamp. Payloads are shown as JSON; on the wire they are CBOR-encoded.

Sample Request

{ "name": "prod-observability-team", "spaceId": "a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d" }

Sample Response

{ "space": { "agentCoreEvaluationRoleArn": "arn:aws:iam::123456789012:role/CloudWatchAgentCoreEvaluationRole", "createdAt": "2026-09-16T14:22:31Z", "dataAccessRoleArn": "arn:aws:iam::123456789012:role/CloudWatchSpaceDataAccessRole", "domainArn": "arn:aws:cloudwatch:us-east-1:123456789012:domain/d-1a2b3c4d5e", "encryptionConfiguration": { "encryptionStrategy": "CUSTOMER_MANAGED", "kmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/1a2b3c4d-5e6f-4a3b-8c9d-0e1f2a3b4c5d" }, "name": "prod-observability-team", "ownerAccountId": "123456789012", "region": "us-east-1", "spaceArn": "arn:aws:cloudwatch:us-east-1:123456789012:space/a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d", "spaceId": "a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d", "status": "ACTIVE", "updatedAt": "2026-09-17T09:11:52Z" } }

See Also

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