View a markdown version of this page

Actions, resources, and condition keys for Amazon OpenSearch Memory - Service Authorization Reference

Actions, resources, and condition keys for Amazon OpenSearch Memory

Amazon OpenSearch Memory (service prefix: osm) provides the following service-specific operations, resources, actions, and condition keys for use in IAM permission policies.

References:

Actions defined by Amazon OpenSearch Memory

You can specify the following actions in the Action element of an IAM policy statement. For each action, the table lists the resource types and condition keys supported by that action. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

Actions Description Resource types (*required) Condition keys Access level

BatchGetEvent

Grants permission to retrieve multiple events from a session in an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

osm:actorId

osm:sessionId

Read

CreateEvent

Grants permission to submit an event to a session within an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

osm:actorId

osm:sessionId

Write

CreateMemory

Grants permission to submit a pre-formed memory into an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

osm:actorId

osm:strategyName

Write

CreateSpace

Grants permission to create an OpenSearch Memory space

space*

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

Write

DeleteEvent

Grants permission to delete an event from a session within an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

osm:actorId

osm:sessionId

Write

DeleteMemory

Grants permission to delete a single memory from an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

osm:actorId

osm:strategyName

Write

DeleteSpace

Grants permission to delete an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

Write

GetEvent

Grants permission to retrieve a single event from an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

osm:actorId

osm:sessionId

Read

GetMemory

Grants permission to retrieve a single memory from an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

osm:actorId

osm:strategyName

Read

GetSpace

Grants permission to retrieve metadata about an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

Read

ListEvents

Grants permission to list event metadata for a session within an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

osm:actorId

osm:sessionId

List

ListMemories

Grants permission to enumerate the memories in an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

osm:actorId

osm:strategyName

List

ListSpaces

Grants permission to list the OpenSearch Memory spaces in the account

space*

aws:ResourceTag/${TagKey}

List

ListTagsForResource

Grants permission to list the tags on an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

Read

SearchEvents

Grants permission to run a relevance search over the raw event index of an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

osm:actorId

osm:sessionId

Read

SearchMemories

Grants permission to run a relevance search over the memory indexes of an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

osm:actorId

osm:strategyName

Read

TagResource

Grants permission to add or overwrite tags on an OpenSearch Memory space

space*

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

Tagging, Write

UntagResource

Grants permission to remove tags from an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

aws:TagKeys

Tagging, Write

UpdateMemory

Grants permission to update a single memory in an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

osm:actorId

osm:strategyName

Write

UpdateSpace

Grants permission to update the configuration of an OpenSearch Memory space

space*

aws:ResourceTag/${TagKey}

Write

Resource types defined by Amazon OpenSearch Memory

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements.

Resource types ARN Condition keys

space

arn:${Partition}:osm:${Region}:${Account}:space/${SpaceId}

aws:ResourceTag/${TagKey}

Condition keys for Amazon OpenSearch Memory

Amazon OpenSearch Memory defines the following condition keys that can be used in the Condition element of an IAM policy.

Condition keys Description Type

aws:RequestTag/${TagKey}

Filters access by the tags that are passed in the request

String

aws:ResourceTag/${TagKey}

Filters access by the tags associated with the resource

String

aws:TagKeys

Filters access by the tag keys that are passed in the request

ArrayOfString

osm:actorId

Filters access by the actor IDs specified in the request

ArrayOfString

osm:sessionId

Filters access by the session IDs specified in the request

ArrayOfString

osm:strategyName

Filters access by the memory strategy names specified in the request

ArrayOfString