Actions, resources, and condition keys for Amazon CloudSearch
Amazon CloudSearch (service prefix: cloudsearch) 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 CloudSearch
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 | SDK client | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|---|
|
BuildSuggesters |
cloudsearch |
Write |
|||
|
CreateDomain |
cloudsearch |
Write |
|||
|
DefineAnalysisScheme |
cloudsearch |
Write |
|||
|
DefineExpression |
cloudsearch |
Write |
|||
|
DefineIndexField |
cloudsearch |
Write |
|||
|
DefineSuggester |
cloudsearch |
Write |
|||
|
DeleteAnalysisScheme |
cloudsearch |
Write |
|||
|
DeleteDomain |
cloudsearch |
Write |
|||
|
DeleteExpression |
cloudsearch |
Write |
|||
|
DeleteIndexField |
cloudsearch |
Write |
|||
|
DeleteSuggester |
cloudsearch |
Write |
|||
|
DescribeAnalysisSchemes |
cloudsearch |
Read |
|||
|
DescribeAvailabilityOptions |
cloudsearch |
Read |
|||
|
DescribeDomainEndpointOptions |
cloudsearch |
Read |
|||
|
DescribeDomains |
cloudsearch |
List |
|||
|
DescribeExpressions |
cloudsearch |
Read |
|||
|
DescribeIndexFields |
cloudsearch |
Read |
|||
|
DescribeScalingParameters |
cloudsearch |
Read |
|||
|
DescribeServiceAccessPolicies |
cloudsearch |
Read |
|||
|
DescribeSuggesters |
cloudsearch |
Read |
|||
|
IndexDocuments |
cloudsearch |
Write |
|||
|
ListDomainNames |
cloudsearch |
List |
|||
|
UpdateAvailabilityOptions |
cloudsearch |
Write |
|||
|
UpdateDomainEndpointOptions |
cloudsearch |
Write |
|||
|
UpdateScalingParameters |
cloudsearch |
Write |
|||
|
UpdateServiceAccessPolicies |
cloudsearch |
Permissions management, Write |
Actions defined by Amazon CloudSearch
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 |
|---|---|---|---|---|
Attaches resource tags to an Amazon CloudSearch domain |
Tagging, Write |
|||
Indexes the search suggestions |
Write |
|||
Creates a new search domain |
Write |
|||
Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options |
Write |
|||
Configures an Expression for the search domain |
Write |
|||
Configures an IndexField for the search domain |
Write |
|||
Configures a suggester for a domain |
Write |
|||
Deletes an analysis scheme |
Write |
|||
Permanently deletes a search domain and all of its data |
Write |
|||
Removes an Expression from the search domain |
Write |
|||
Removes an IndexField from the search domain |
Write |
|||
Deletes a suggester |
Write |
|||
Gets the analysis schemes configured for a domain |
Read |
|||
Gets the availability options configured for a domain |
Read |
|||
Gets the domain endpoint options configured for a domain |
Read |
|||
Gets information about the search domains owned by this account |
List |
|||
Gets the expressions configured for the search domain |
Read |
|||
Gets information about the index fields configured for the search domain |
Read |
|||
Gets the scaling parameters configured for a domain |
Read |
|||
Gets information about the access policies that control access to the domain's document and search endpoints |
Read |
|||
Gets the suggesters configured for a domain |
Read |
|||
Tells the search domain to start indexing its documents using the latest indexing options |
Write |
|||
Lists all search domains owned by an account |
List |
|||
Displays all of the resource tags for an Amazon CloudSearch domain |
Read |
|||
Removes the specified resource tags from an Amazon ES domain |
Tagging, Write |
|||
Configures the availability options for a domain |
Write |
|||
Configures the domain endpoint options for a domain |
Write |
|||
Configures scaling parameters for a domain |
Write |
|||
Configures the access rules that control access to the domain's document and search endpoints |
Permissions management, Write |
Permission-only actions for Amazon CloudSearch
The following actions are defined by Amazon CloudSearch but are not directly invocable through any API operation. They can only be used in IAM policy statements to grant or deny permissions.
Resource types defined by Amazon CloudSearch
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}:cloudsearch:${Region}:${Account}:domain/${DomainName} |
Condition keys for Amazon CloudSearch
Amazon CloudSearch has no service-specific condition keys that can be used in the
Condition element of policy statements.