Actions, resources, and condition keys for Amazon OpenSearch
Amazon OpenSearch (service prefix: opensearch) provides the following
service-specific operations, resources, actions, and condition 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.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by Amazon OpenSearch
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|
|
AcceptInboundConnection |
Write |
|||
Write |
||||
|
AddDataSource |
Write |
|||
iam:PassedToService |
directquery.opensearchservice.amazonaws.com |
Write |
||
|
AddDirectQueryDataSource |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
directquery.opensearchservice.amazonaws.com |
Write |
||
|
AddTags |
Tagging, Write |
|||
|
AssociatePackage |
Write |
|||
|
AssociatePackages |
Write |
|||
|
AttachDataSource |
Write |
|||
|
AuthorizeVpcEndpointAccess |
Write |
|||
|
CancelDomainConfigChange |
Write |
|||
|
CancelServiceSoftwareUpdate |
Write |
|||
Write |
||||
|
CreateApplication |
Tagging, Write |
|||
Write |
||||
Write |
||||
|
CreateDomain |
Tagging, Write |
|||
Write |
||||
Write |
||||
iam:PassedToService |
es.amazonaws.com |
Write |
||
|
CreateIndex |
Write |
|||
|
CreateOutboundConnection |
Write |
|||
Write |
||||
|
CreatePackage |
Write |
|||
|
CreateVpcEndpoint |
Write |
|||
|
DeleteApplication |
Write |
|||
|
DeleteDataSource |
Write |
|||
|
DeleteDirectQueryDataSource |
Write |
|||
|
DeleteDomain |
Write |
|||
Write |
||||
|
DeleteInboundConnection |
Write |
|||
|
DeleteIndex |
Write |
|||
|
DeleteOutboundConnection |
Write |
|||
Write |
||||
|
DeletePackage |
Write |
|||
|
DeleteVpcEndpoint |
Write |
|||
|
DeregisterCapability |
Write |
|||
|
DescribeDataSourceAttachment |
Read |
|||
|
DescribeDomain |
Read |
|||
Read |
||||
|
DescribeDomainAutoTunes |
Read |
|||
|
DescribeDomainChangeProgress |
Read |
|||
|
DescribeDomainConfig |
Read |
|||
Read |
||||
|
DescribeDomainHealth |
Read |
|||
|
DescribeDomainNodes |
Read |
|||
|
DescribeDomains |
List |
|||
List |
||||
|
DescribeDryRunProgress |
Read |
|||
|
DescribeInboundConnections |
List |
|||
List |
||||
|
DescribeInsightDetails |
Read |
|||
|
DescribeInstanceTypeLimits |
List |
|||
List |
||||
|
DescribeOutboundConnections |
List |
|||
List |
||||
|
DescribePackages |
Read |
|||
|
DescribeReservedInstanceOfferings |
List |
|||
List |
||||
|
DescribeReservedInstances |
List |
|||
List |
||||
|
DescribeVpcEndpoints |
List |
|||
|
DetachDataSource |
Write |
|||
|
DissociatePackage |
Write |
|||
|
DissociatePackages |
Write |
|||
|
GetApplication |
Read |
|||
|
GetCapability |
Read |
|||
|
GetCompatibleVersions |
List |
|||
List |
||||
|
GetDataSource |
Read |
|||
|
GetDefaultApplicationSetting |
Read |
|||
|
GetDirectQueryDataSource |
Read |
|||
|
GetDomainMaintenanceStatus |
Read |
|||
|
GetIndex |
Read |
|||
|
GetPackageVersionHistory |
Read |
|||
|
GetUpgradeHistory |
Read |
|||
|
GetUpgradeStatus |
Read |
|||
|
InsightFeedback |
Write |
|||
|
ListApplications |
List |
|||
|
ListDataSourceAttachments |
List |
|||
|
ListDataSources |
List |
|||
|
ListDirectQueryDataSources |
List |
|||
|
ListDomainMaintenances |
List |
|||
|
ListDomainNames |
List |
|||
|
ListDomainsForPackage |
List |
|||
|
ListInsights |
List |
|||
|
ListInstanceTypeDetails |
List |
|||
List |
||||
|
ListPackagesForDomain |
List |
|||
|
ListScheduledActions |
List |
|||
|
ListTags |
Read |
|||
|
ListVersions |
List |
|||
List |
||||
|
ListVpcEndpointAccess |
List |
|||
|
ListVpcEndpoints |
List |
|||
|
ListVpcEndpointsForDomain |
List |
|||
|
PurchaseReservedInstanceOffering |
Write |
|||
Write |
||||
|
PutDefaultApplicationSetting |
Write |
|||
|
RegisterCapability |
Write |
|||
|
RejectInboundConnection |
Write |
|||
Write |
||||
|
RemoveTags |
Tagging, Write |
|||
|
RevokeVpcEndpointAccess |
Write |
|||
|
RollbackServiceSoftwareUpdate |
Write |
|||
Write |
||||
|
StartDomainMaintenance |
Write |
|||
|
StartServiceSoftwareUpdate |
Write |
|||
Write |
||||
|
UpdateApplication |
Write |
|||
|
UpdateDataSource |
Write |
|||
iam:PassedToService |
directquery.opensearchservice.amazonaws.com |
Write |
||
|
UpdateDirectQueryDataSource |
Write |
|||
iam:PassedToService |
directquery.opensearchservice.amazonaws.com |
Write |
||
|
UpdateDomainConfig |
Write |
|||
Write |
||||
iam:PassedToService |
es.amazonaws.com |
Write |
||
|
UpdateIndex |
Write |
|||
|
UpdatePackage |
Write |
|||
|
UpdatePackageScope |
Write |
|||
|
UpdateScheduledAction |
Write |
|||
|
UpdateVpcEndpoint |
Write |
|||
|
UpgradeDomain |
Write |
|||
Write |
Actions defined by Amazon OpenSearch
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.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to cancel submitted Auto Optimize Job |
Write |
|||
Grants permission to cancel the query that is submitted on the OpenSearch DataSource resource |
Write |
|||
Grants permission to delete Auto Optimize Job |
Write |
|||
Grants permission to get the Auto Optimize Job details |
Read |
|||
Grants permission to get the query status that are performed on the OpenSearch DataSource resource |
Read |
|||
Grants permission to get the results of a query that is performed on the OpenSearch DataSource resource |
Read |
|||
Grants permission to retrieve a list of Auto Optimize Jobs |
List |
|||
Grants permission to start a direct query on the provided OpenSearch DataSource arns |
Write |
|||
Grants permission to create new Auto Optimize Job |
Write |
Permission-only actions for Amazon OpenSearch
The following actions are defined by Amazon OpenSearch but are not directly invocable through any API operation. They can only be used in IAM policy statements to grant or deny permissions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to access OpenSearch Application |
Permissions management, Write |
|||
Grants permission to view the login page of an OpenSearch Application |
Permissions management, Write |
Resource types defined by Amazon OpenSearch
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 |
|---|---|---|
arn:${Partition}:opensearch:${Region}:${Account}:application/${AppId} |
||
arn:${Partition}:opensearch:${Region}:${Account}:datasource/${DataSourceName} |
Condition keys for Amazon OpenSearch
Amazon OpenSearch has no service-specific condition keys that can be used in the
Condition element of policy statements.
