Actions, resources, and condition keys for Amazon OpenSearch Serverless

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

References:

• Learn how to configure this service.

• View a list of the API operations available for this service.

• Learn how to secure this service and its resources by using IAM permission policies.

Actions defined by Amazon OpenSearch Serverless

You can specify the following actions in the Action element of an IAM policy statement. 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.

The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.

The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.

Note

Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.

For details about the columns in the following table, see Actions table.

Actions	Description	Access level	Resource types (*required)	Condition keys	Dependent actions
APIAccessAll	Grant permission to all the supported Opensearch APIs	Write	Collection*
BatchGetCollection	Grants permission to get attributes for one or more collections	Read
BatchGetEffectiveLifecyclePolicy	Grants permission to get the information about a lifecycle policy applied to one or more AOSS resources	Read
BatchGetLifecyclePolicy	Grants permission to get information about one or more lifecycle policies	Read
BatchGetVpcEndpoint	Grants permission to get attributes for one or more VPC endpoints	Read
CreateAccessPolicy	Grants permission to create a data access policy	Write		aoss:collection aoss:index
CreateCollection	Grants permission to create a serverless collection	Write		aws:RequestTag/${TagKey} aws:TagKeys
CreateLifecyclePolicy	Grants permission to create a lifecycle policy	Write		aoss:collection aoss:index
CreateSecurityConfig	Grants permission to create a serverless security configuration	Write
CreateSecurityPolicy	Grants permission to create a network or encryption policy	Write		aoss:collection
CreateVpcEndpoint	Grants permission to create an OpenSearch-Serverless-managed interface VPC endpoint	Write
DashboardsAccessAll	Grants permission to Opensearch Serverless Dashboards	Write	Dashboards*
DeleteAccessPolicy	Grants permission to delete a data access policy	Write		aoss:collection aoss:index
DeleteCollection	Grants permission to delete a serverless collection	Write	Collection*
DeleteLifecyclePolicy	Grants permission to delete a lifecycle policy	Write		aoss:collection aoss:index
DeleteSecurityConfig	Grants permission to delete a security configuration	Write
DeleteSecurityPolicy	Grants permission to delete a security policy	Write		aoss:collection
DeleteVpcEndpoint	Grants permission to delete an OpenSearch Serverless-managed interface VPC endpoint	Write
GetAccessPolicy	Grants permission to get information about a data access policy	Read		aoss:collection aoss:index
GetAccountSettings	Grants permission to get account settings, including capacity settings	Read
GetPoliciesStats	Grants permission to get statistis about the security policies in your account	Read
GetSecurityConfig	Grants permission to get information about a serverless security configuration	Read
GetSecurityPolicy	Grants permission to get information about a security policy	Read		aoss:collection
ListAccessPolicies	Grants permission to list data access policies	List
ListCollections	Grants permission to list collections	List
ListLifecyclePolicies	Grants permission to list lifecycle policies	List
ListSecurityConfigs	Grants permission to list security configurations	List
ListSecurityPolicies	Grants permission to list security policies	List
ListTagsForResource	Grants permission to list tags for a collection	List
ListVpcEndpoints	Grants permission to list OpenSearch Serverless-managed VPC endpoints	List
TagResource	Grants permission to tag a serverless collection	Write		aws:RequestTag/${TagKey} aws:TagKeys
UntagResource	Grants permission to remove tags from a collection	Write		aws:TagKeys
UpdateAccessPolicy	Grants permission to update a data access policy	Write		aoss:collection aoss:index
UpdateAccountSettings	Grants permission to update account settings, including capacity settings	Write
UpdateCollection	Grants permission to update a collection	Write	Collection*
UpdateLifecyclePolicy	Grants permission to update a lifecycle policy	Write		aoss:collection aoss:index
UpdateSecurityConfig	Grants permission to update a security configuration	Write
UpdateSecurityPolicy	Grants permission to update a security policy	Write		aoss:collection
UpdateVpcEndpoint	Grants permission to update an OpenSearch Serverless-managed VPC endpoint	Write

Resource types defined by Amazon OpenSearch Serverless

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.

Resource types	ARN	Condition keys
Collection	arn:${Partition}:aoss:${Region}:${Account}:collection/${CollectionId}	aws:ResourceTag/${TagKey}
Dashboards	arn:${Partition}:aoss:${Region}:${Account}:dashboards/default

Condition keys for Amazon OpenSearch Serverless

Amazon OpenSearch Serverless defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.

To view the global condition keys that are available to all services, see Available global condition keys.

Condition keys	Description	Type
aoss:CollectionId	Filters access by the identifier of the collection	String
aoss:collection	Filters access by the collection name	String
aoss:index	Filters access by the index	String
aws:RequestTag/${TagKey}	Filters access based on the tags that are passed in the request	String
aws:ResourceTag/${TagKey}	Filters access based on the tags associated with the resource	String
aws:TagKeys	Filters access based on the tag keys that are passed in the request	ArrayOfString