View a markdown version of this page

CreateAccessProfile - Amazon CloudWatch Omni

CreateAccessProfile

Creates an access profile in a space.

Use GetAccessProfile and ListAccessProfiles to retrieve profiles, and UpdateAccessProfile to modify one.

Request Parameters

clientToken

Idempotency token for safe retries. Repeated requests with the same token return the original result instead of creating a duplicate.

Type: String

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

Pattern: [!-~]+

Required: No

description

An optional description of the access profile.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

name

A name that identifies the access profile.

Type: String

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

Pattern: [a-zA-Z0-9 _.:/=+@-]+

Required: Yes

spaceId

The unique ID of the space to create the profile in.

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

tags

The tags to associate with the access profile.

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.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Elements

The following element is returned by the service.

accessProfile

The access profile.

Type: AccessProfile 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

Create an access profile

The following example creates a customer-managed access profile in a space. Payloads are shown as JSON; on the wire they are CBOR-encoded.

Sample Request

{ "clientToken": "3f2a9c1e-7b04-4d8a-9e15-6c2b8d0f4a73", "description": "Read-only access for analysts.", "name": "Analyst read-only profile", "spaceId": "a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d", "tags": { "Team": "observability" } }

Sample Response

{ "accessProfile": { "arn": "arn:aws:cloudwatch:us-east-1:123456789012:access-profile/analyst-readonly", "assumeStatus": "ALLOWED", "createdAt": "2026-09-16T14:22:31Z", "description": "Read-only access for analysts.", "name": "Analyst read-only profile", "profileId": "analyst-readonly", "profileType": "CUSTOMER_MANAGED", "spaceId": "a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d", "updatedAt": "2026-09-16T14:22:31Z" } }

See Also

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