Expand description
You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.
The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.
If you’re using the service, you’re probably looking for CloudSearchClient and CloudSearch.
Structs§
- Access
Policies Status The configured access rules for the domain's document and search endpoints, and the current status of those rules.
- Analysis
Options Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.
- Analysis
Scheme Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme:
Synonyms
,Stopwords
,StemmingDictionary
,JapaneseTokenizationDictionary
andAlgorithmicStemming
.- Analysis
Scheme Status The status and configuration of an
AnalysisScheme
.- Availability
Options Status The status and configuration of the domain's availability options.
- Build
Suggesters Request Container for the parameters to the
BuildSuggester
operation. Specifies the name of the domain you want to update.- Build
Suggesters Response The result of a
BuildSuggester
request. Contains a list of the fields used for suggestions.- Cloud
Search Client - A client for the Amazon CloudSearch API.
- Create
Domain Request Container for the parameters to the
CreateDomain
operation. Specifies a name for the new search domain.- Create
Domain Response The result of a
CreateDomainRequest
. Contains the status of a newly created domain.- Date
Array Options Options for a field that contains an array of dates. Present if
IndexFieldType
specifies the field is of typedate-array
. All options are enabled by default.- Date
Options Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if
IndexFieldType
specifies the field is of typedate
. All options are enabled by default.- Define
Analysis Scheme Request Container for the parameters to the
DefineAnalysisScheme
operation. Specifies the name of the domain you want to update and the analysis scheme configuration.- Define
Analysis Scheme Response The result of a
DefineAnalysisScheme
request. Contains the status of the newly-configured analysis scheme.- Define
Expression Request Container for the parameters to the
DefineExpression
operation. Specifies the name of the domain you want to update and the expression you want to configure.- Define
Expression Response The result of a
DefineExpression
request. Contains the status of the newly-configured expression.- Define
Index Field Request Container for the parameters to the
DefineIndexField
operation. Specifies the name of the domain you want to update and the index field configuration.- Define
Index Field Response The result of a
DefineIndexField
request. Contains the status of the newly-configured index field.- Define
Suggester Request Container for the parameters to the
DefineSuggester
operation. Specifies the name of the domain you want to update and the suggester configuration.- Define
Suggester Response The result of a
DefineSuggester
request. Contains the status of the newly-configured suggester.- Delete
Analysis Scheme Request Container for the parameters to the
DeleteAnalysisScheme
operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.- Delete
Analysis Scheme Response The result of a
DeleteAnalysisScheme
request. Contains the status of the deleted analysis scheme.- Delete
Domain Request Container for the parameters to the
DeleteDomain
operation. Specifies the name of the domain you want to delete.- Delete
Domain Response The result of a
DeleteDomain
request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.- Delete
Expression Request Container for the parameters to the
DeleteExpression
operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.- Delete
Expression Response The result of a
DeleteExpression
request. Specifies the expression being deleted.- Delete
Index Field Request Container for the parameters to the
DeleteIndexField
operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.- Delete
Index Field Response The result of a
DeleteIndexField
request.- Delete
Suggester Request Container for the parameters to the
DeleteSuggester
operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.- Delete
Suggester Response The result of a
DeleteSuggester
request. Contains the status of the deleted suggester.- Describe
Analysis Schemes Request Container for the parameters to the
DescribeAnalysisSchemes
operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set theDeployed
option totrue
.- Describe
Analysis Schemes Response The result of a
DescribeAnalysisSchemes
request. Contains the analysis schemes configured for the domain specified in the request.- Describe
Availability Options Request Container for the parameters to the
DescribeAvailabilityOptions
operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option totrue
.- Describe
Availability Options Response The result of a
DescribeAvailabilityOptions
request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.- Describe
Domain Endpoint Options Request Container for the parameters to the
DescribeDomainEndpointOptions
operation. Specify the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option totrue
.- Describe
Domain Endpoint Options Response The result of a
DescribeDomainEndpointOptions
request. Contains the status and configuration of a search domain's endpoint options.- Describe
Domains Request Container for the parameters to the
DescribeDomains
operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.- Describe
Domains Response The result of a
DescribeDomains
request. Contains the status of the domains specified in the request or all domains owned by the account.- Describe
Expressions Request Container for the parameters to the
DescribeDomains
operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set theDeployed
option totrue
.- Describe
Expressions Response The result of a
DescribeExpressions
request. Contains the expressions configured for the domain specified in the request.- Describe
Index Fields Request Container for the parameters to the
DescribeIndexFields
operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set theDeployed
option totrue
.- Describe
Index Fields Response The result of a
DescribeIndexFields
request. Contains the index fields configured for the domain specified in the request.- Describe
Scaling Parameters Request Container for the parameters to the
DescribeScalingParameters
operation. Specifies the name of the domain you want to describe.- Describe
Scaling Parameters Response The result of a
DescribeScalingParameters
request. Contains the scaling parameters configured for the domain specified in the request.- Describe
Service Access Policies Request Container for the parameters to the
DescribeServiceAccessPolicies
operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set theDeployed
option totrue
.- Describe
Service Access Policies Response The result of a
DescribeServiceAccessPolicies
request.- Describe
Suggesters Request Container for the parameters to the
DescribeSuggester
operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set theDeployed
option totrue
.- Describe
Suggesters Response The result of a
DescribeSuggesters
request.- Document
Suggester Options Options for a search suggester.
- Domain
Endpoint Options The domain's endpoint options.
- Domain
Endpoint Options Status The configuration and status of the domain's endpoint options.
- Domain
Status The current status of the search domain.
- Double
Array Options Options for a field that contains an array of double-precision 64-bit floating point values. Present if
IndexFieldType
specifies the field is of typedouble-array
. All options are enabled by default.- Double
Options Options for a double-precision 64-bit floating point field. Present if
IndexFieldType
specifies the field is of typedouble
. All options are enabled by default.- Expression
A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.
- Expression
Status The value of an
Expression
and its current status.- Index
Documents Request Container for the parameters to the
IndexDocuments
operation. Specifies the name of the domain you want to re-index.- Index
Documents Response The result of an
IndexDocuments
request. Contains the status of the indexing operation, including the fields being indexed.- Index
Field Configuration information for a field in the index, including its name, type, and options. The supported options depend on the
IndexFieldType
.- Index
Field Status The value of an
IndexField
and its current status.- IntArray
Options Options for a field that contains an array of 64-bit signed integers. Present if
IndexFieldType
specifies the field is of typeint-array
. All options are enabled by default.- IntOptions
Options for a 64-bit signed integer field. Present if
IndexFieldType
specifies the field is of typeint
. All options are enabled by default.- LatLon
Options Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if
IndexFieldType
specifies the field is of typelatlon
. All options are enabled by default.- Limits
- List
Domain Names Response The result of a
ListDomainNames
request. Contains a list of the domains owned by an account.- Literal
Array Options Options for a field that contains an array of literal strings. Present if
IndexFieldType
specifies the field is of typeliteral-array
. All options are enabled by default.- Literal
Options Options for literal field. Present if
IndexFieldType
specifies the field is of typeliteral
. All options are enabled by default.- Option
Status The status of domain configuration option.
- Scaling
Parameters The desired instance type and desired number of replicas of each index partition.
- Scaling
Parameters Status The status and configuration of a search domain's scaling parameters.
- Service
Endpoint The endpoint to which service requests can be submitted.
- Suggester
Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester:
FuzzyMatching
,SortExpression
.- Suggester
Status The value of a
Suggester
and its current status.- Text
Array Options Options for a field that contains an array of text strings. Present if
IndexFieldType
specifies the field is of typetext-array
. Atext-array
field is always searchable. All options are enabled by default.- Text
Options Options for text field. Present if
IndexFieldType
specifies the field is of typetext
. Atext
field is always searchable. All options are enabled by default.- Update
Availability Options Request Container for the parameters to the
UpdateAvailabilityOptions
operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.- Update
Availability Options Response The result of a
UpdateAvailabilityOptions
request. Contains the status of the domain's availability options.- Update
Domain Endpoint Options Request Container for the parameters to the
UpdateDomainEndpointOptions
operation. Specifies the name of the domain you want to update and the domain endpoint options.- Update
Domain Endpoint Options Response The result of a
UpdateDomainEndpointOptions
request. Contains the configuration and status of the domain's endpoint options.- Update
Scaling Parameters Request Container for the parameters to the
UpdateScalingParameters
operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.- Update
Scaling Parameters Response The result of a
UpdateScalingParameters
request. Contains the status of the newly-configured scaling parameters.- Update
Service Access Policies Request Container for the parameters to the
UpdateServiceAccessPolicies
operation. Specifies the name of the domain you want to update and the access rules you want to configure.- Update
Service Access Policies Response The result of an
UpdateServiceAccessPolicies
request. Contains the new access policies.
Enums§
- Build
Suggesters Error - Errors returned by BuildSuggesters
- Create
Domain Error - Errors returned by CreateDomain
- Define
Analysis Scheme Error - Errors returned by DefineAnalysisScheme
- Define
Expression Error - Errors returned by DefineExpression
- Define
Index Field Error - Errors returned by DefineIndexField
- Define
Suggester Error - Errors returned by DefineSuggester
- Delete
Analysis Scheme Error - Errors returned by DeleteAnalysisScheme
- Delete
Domain Error - Errors returned by DeleteDomain
- Delete
Expression Error - Errors returned by DeleteExpression
- Delete
Index Field Error - Errors returned by DeleteIndexField
- Delete
Suggester Error - Errors returned by DeleteSuggester
- Describe
Analysis Schemes Error - Errors returned by DescribeAnalysisSchemes
- Describe
Availability Options Error - Errors returned by DescribeAvailabilityOptions
- Describe
Domain Endpoint Options Error - Errors returned by DescribeDomainEndpointOptions
- Describe
Domains Error - Errors returned by DescribeDomains
- Describe
Expressions Error - Errors returned by DescribeExpressions
- Describe
Index Fields Error - Errors returned by DescribeIndexFields
- Describe
Scaling Parameters Error - Errors returned by DescribeScalingParameters
- Describe
Service Access Policies Error - Errors returned by DescribeServiceAccessPolicies
- Describe
Suggesters Error - Errors returned by DescribeSuggesters
- Index
Documents Error - Errors returned by IndexDocuments
- List
Domain Names Error - Errors returned by ListDomainNames
- Update
Availability Options Error - Errors returned by UpdateAvailabilityOptions
- Update
Domain Endpoint Options Error - Errors returned by UpdateDomainEndpointOptions
- Update
Scaling Parameters Error - Errors returned by UpdateScalingParameters
- Update
Service Access Policies Error - Errors returned by UpdateServiceAccessPolicies
Traits§
- Cloud
Search - Trait representing the capabilities of the Amazon CloudSearch API. Amazon CloudSearch clients implement this trait.