View a markdown version of this page

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

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:

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

cloudsearch:BuildSuggesters

Write

CreateDomain

cloudsearch

cloudsearch:CreateDomain

Write

DefineAnalysisScheme

cloudsearch

cloudsearch:DefineAnalysisScheme

Write

DefineExpression

cloudsearch

cloudsearch:DefineExpression

Write

DefineIndexField

cloudsearch

cloudsearch:DefineIndexField

Write

DefineSuggester

cloudsearch

cloudsearch:DefineSuggester

Write

DeleteAnalysisScheme

cloudsearch

cloudsearch:DeleteAnalysisScheme

Write

DeleteDomain

cloudsearch

cloudsearch:DeleteDomain

Write

DeleteExpression

cloudsearch

cloudsearch:DeleteExpression

Write

DeleteIndexField

cloudsearch

cloudsearch:DeleteIndexField

Write

DeleteSuggester

cloudsearch

cloudsearch:DeleteSuggester

Write

DescribeAnalysisSchemes

cloudsearch

cloudsearch:DescribeAnalysisSchemes

Read

DescribeAvailabilityOptions

cloudsearch

cloudsearch:DescribeAvailabilityOptions

Read

DescribeDomainEndpointOptions

cloudsearch

cloudsearch:DescribeDomainEndpointOptions

Read

DescribeDomains

cloudsearch

cloudsearch:DescribeDomains

List

DescribeExpressions

cloudsearch

cloudsearch:DescribeExpressions

Read

DescribeIndexFields

cloudsearch

cloudsearch:DescribeIndexFields

Read

DescribeScalingParameters

cloudsearch

cloudsearch:DescribeScalingParameters

Read

DescribeServiceAccessPolicies

cloudsearch

cloudsearch:DescribeServiceAccessPolicies

Read

DescribeSuggesters

cloudsearch

cloudsearch:DescribeSuggesters

Read

IndexDocuments

cloudsearch

cloudsearch:IndexDocuments

Write

ListDomainNames

cloudsearch

cloudsearch:ListDomainNames

List

UpdateAvailabilityOptions

cloudsearch

cloudsearch:UpdateAvailabilityOptions

Write

UpdateDomainEndpointOptions

cloudsearch

cloudsearch:UpdateDomainEndpointOptions

Write

UpdateScalingParameters

cloudsearch

cloudsearch:UpdateScalingParameters

Write

UpdateServiceAccessPolicies

cloudsearch

cloudsearch:UpdateServiceAccessPolicies

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

AddTags

Attaches resource tags to an Amazon CloudSearch domain

domain*

Tagging, Write

BuildSuggesters

Indexes the search suggestions

domain*

Write

CreateDomain

Creates a new search domain

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

domain*

Write

DefineExpression

Configures an Expression for the search domain

domain*

Write

DefineIndexField

Configures an IndexField for the search domain

domain*

Write

DefineSuggester

Configures a suggester for a domain

domain*

Write

DeleteAnalysisScheme

Deletes an analysis scheme

domain*

Write

DeleteDomain

Permanently deletes a search domain and all of its data

domain*

Write

DeleteExpression

Removes an Expression from the search domain

domain*

Write

DeleteIndexField

Removes an IndexField from the search domain

domain*

Write

DeleteSuggester

Deletes a suggester

domain*

Write

DescribeAnalysisSchemes

Gets the analysis schemes configured for a domain

domain*

Read

DescribeAvailabilityOptions

Gets the availability options configured for a domain

domain*

Read

DescribeDomainEndpointOptions

Gets the domain endpoint options configured for a domain

domain*

Read

DescribeDomains

Gets information about the search domains owned by this account

domain*

List

DescribeExpressions

Gets the expressions configured for the search domain

domain*

Read

DescribeIndexFields

Gets information about the index fields configured for the search domain

domain*

Read

DescribeScalingParameters

Gets the scaling parameters configured for a domain

domain*

Read

DescribeServiceAccessPolicies

Gets information about the access policies that control access to the domain's document and search endpoints

domain*

Read

DescribeSuggesters

Gets the suggesters configured for a domain

domain*

Read

IndexDocuments

Tells the search domain to start indexing its documents using the latest indexing options

domain*

Write

ListDomainNames

Lists all search domains owned by an account

domain*

List

ListTags

Displays all of the resource tags for an Amazon CloudSearch domain

domain*

Read

RemoveTags

Removes the specified resource tags from an Amazon ES domain

domain*

Tagging, Write

UpdateAvailabilityOptions

Configures the availability options for a domain

domain*

Write

UpdateDomainEndpointOptions

Configures the domain endpoint options for a domain

domain*

Write

UpdateScalingParameters

Configures scaling parameters for a domain

domain*

Write

UpdateServiceAccessPolicies

Configures the access rules that control access to the domain's document and search endpoints

domain*

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.

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

document

Allows access to the document service operations

domain

Write

search

Allows access to the search operations

domain

Read

suggest

Allows access to the suggest operations

domain

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.

Resource types ARN Condition keys

domain

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.