Actions, resources, and condition keys for Amazon CloudSearch
Amazon CloudSearch (service prefix: cloudsearch
) 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.
Topics
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.
The Resource types column indicates whether each action supports resource-level permissions. If
there is no value for this column, you must specify all resources ("*") 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. Required
resources are indicated in the table with an asterisk (*). If you specify a resource-level
permission ARN in a statement using this action, then it must be of this type.
Some actions support multiple resource types. If the resource type is optional (not
indicated as required), then you can choose to use one but not the other.
For details about the columns in the following table, see The actions table.
Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions |
---|---|---|---|---|---|
AddTags | Attaches resource tags to an Amazon CloudSearch domain. | Tagging | |||
BuildSuggesters | Indexes the search suggestions. | Write | |||
CreateDomain | Creates a new search domain. | Write | |||
DefineAnalysisScheme | Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. | Write | |||
DefineExpression | Configures an Expression for the search domain. | Write | |||
DefineIndexField | Configures an IndexField for the search domain. | Write | |||
DefineSuggester | Configures a suggester for a domain. | Write | |||
DeleteAnalysisScheme | Deletes an analysis scheme. | Write | |||
DeleteDomain | Permanently deletes a search domain and all of its data. | Write | |||
DeleteExpression | Removes an Expression from the search domain. | Write | |||
DeleteIndexField | Removes an IndexField from the search domain. | Write | |||
DeleteSuggester | Deletes a suggester. | Write | |||
DescribeAnalysisSchemes | Gets the analysis schemes configured for a domain. | Read | |||
DescribeAvailabilityOptions | Gets the availability options configured for a domain. | Read | |||
DescribeDomainEndpointOptions | Gets the domain endpoint options configured for a domain. | Read | |||
DescribeDomains | Gets information about the search domains owned by this account. | List | |||
DescribeExpressions | Gets the expressions configured for the search domain. | Read | |||
DescribeIndexFields | Gets information about the index fields configured for the search domain. | Read | |||
DescribeScalingParameters | Gets the scaling parameters configured for a domain. | Read | |||
DescribeServiceAccessPolicies | Gets information about the access policies that control access to the domain's document and search endpoints. | Read | |||
DescribeSuggesters | Gets the suggesters configured for a domain. | Read | |||
IndexDocuments | Tells the search domain to start indexing its documents using the latest indexing options. | Write | |||
ListDomainNames | Lists all search domains owned by an account. | List | |||
ListTags | Displays all of the resource tags for an Amazon CloudSearch domain. | Read | |||
RemoveTags | Removes the specified resource tags from an Amazon ES domain. | Tagging | |||
UpdateAvailabilityOptions | Configures the availability options for a domain. | Write | |||
UpdateDomainEndpointOptions | Configures the domain endpoint options for a domain. | Write | |||
UpdateScalingParameters | Configures scaling parameters for a domain. | Write | |||
UpdateServiceAccessPolicies | Configures the access rules that control access to the domain's document and search endpoints. | Permissions management | |||
document [permission only] | Allows access to the document service operations. | Write | |||
search [permission only] | Allows access to the search operations. | Read | |||
suggest [permission only] | Allows access to the suggest operations. | Read |
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. 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 table. For details about the columns
in the following table, see The resource types table.
For information about using Amazon CloudSearch resource ARNs in an IAM policy, see Amazon CloudSearch ARNs in the Amazon CloudSearch Developer Guide.
Resource types | ARN | Condition keys |
---|---|---|
domain |
arn:${Partition}:cloudsearch:${Region}:${Account}:domain/${DomainName}
|
Condition keys for Amazon CloudSearch
CloudSearch has no service-specific context keys that can be used in the Condition
element of policy statements. For the list of the global context keys that are
available to all services, see Available keys for conditions.