CedarTagValue - Amazon Verified Permissions

CedarTagValue

The value of an entity's Cedar tag.

This data type is used as a member of the EntityItem structure that forms the body of the Entities request parameter for the IsAuthorized, BatchIsAuthorized, IsAuthorizedWithToken, and BatchIsAuthorizedWithToken operations.

Contents

Note

In the following list, the required parameters are described first.

Important

This data type is a UNION, so only one of the following members can be specified when used or returned.

boolean

A Cedar tag value of Boolean type.

Example: {"boolean": false}

Type: Boolean

Required: No

datetime

A Cedar tag value of datetime type.

Example: {"datetime": "2025-11-04T11:35:00.000+0100"}

Type: String

Length Constraints: Minimum length of 10. Maximum length of 28.

Pattern: \d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d{3})?(Z|[+-]\d{4}))?

Required: No

decimal

A Cedar tag value of decimal type.

Example: {"decimal": "-2.0"}

Type: String

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

Pattern: -?\d{1,15}\.\d{1,4}

Required: No

duration

A Cedar tag value of duration type.

Example: {"duration": "-1d12h"}

Type: String

Length Constraints: Minimum length of 2. Maximum length of 100.

Pattern: -?(\d+d)?(\d+h)?(\d+m)?(\d+s)?(\d+ms)?

Required: No

entityIdentifier

A Cedar tag value of type EntityIdentifier.

Example: {"entityIdentifier": { "entityId": "alice", "entityType": "User"} }

Type: EntityIdentifier object

Required: No

ipaddr

A Cedar tag value of ipaddr type.

Example: {"ip": "10.50.0.0/24"}

Type: String

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

Pattern: [0-9a-fA-F\.:\/]*

Required: No

long

A Cedar tag value of Long type.

Example: {"long": 0}

Type: Long

Required: No

record

A Cedar tag value of Record type.

Example: {"record": { "keyName": {} } }

Type: String to CedarTagValue object map

Required: No

set

A Cedar tag value of Set type.

Example: {"set": [ { "string": "abc" } ] }

Type: Array of CedarTagValue objects

Required: No

string

A Cedar tag value of String type.

Example: {"string": "abc"}

Type: String

Required: No

See Also

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