/ 
Amazon-API-1.3.1
River stage one • 1 direct dependent • 1 total dependent
/ Amazon::API::CloudSearch

NAME

CloudSearch

DESCRIPTION

Amazon CloudSearch

VERSION

Version 1.2.7

METHODS

BuildSuggesters

Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.

Input

BuildSuggestersRequest

Output

BuildSuggestersResponse

Errors
BaseException
InternalException
ResourceNotFoundException
ValidationException
Method

POST

Request URI

/

CreateDomain

Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.

Input

CreateDomainRequest

Output

CreateDomainResponse

Errors
BaseException
InternalException
LimitExceededException
ResourceAlreadyExistsException
ValidationException
Method

POST

Request URI

/

DefineAnalysisScheme

Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Input

DefineAnalysisSchemeRequest

Output

DefineAnalysisSchemeResponse

Errors
BaseException
InternalException
LimitExceededException
InvalidTypeException
ResourceNotFoundException
ValidationException
Method

POST

Request URI

/

DefineExpression

Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Input

DefineExpressionRequest

Output

DefineExpressionResponse

Errors
BaseException
InternalException
LimitExceededException
InvalidTypeException
ResourceNotFoundException
ValidationException
Method

POST

Request URI

/

DefineIndexField

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Input

DefineIndexFieldRequest

Output

DefineIndexFieldResponse

Errors
BaseException
InternalException
LimitExceededException
InvalidTypeException
ResourceNotFoundException
ValidationException
Method

POST

Request URI

/

DefineSuggester

Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Input

DefineSuggesterRequest

Output

DefineSuggesterResponse

Errors
BaseException
InternalException
LimitExceededException
InvalidTypeException
ResourceNotFoundException
ValidationException
Method

POST

Request URI

/

DeleteAnalysisScheme

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Input

DeleteAnalysisSchemeRequest

Output

DeleteAnalysisSchemeResponse

Errors
BaseException
InternalException
InvalidTypeException
ResourceNotFoundException
ValidationException
Method

POST

Request URI

/

DeleteDomain

Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.

Input

DeleteDomainRequest

Output

DeleteDomainResponse

Errors
BaseException
InternalException
Method

POST

Request URI

/

DeleteExpression

Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Input

DeleteExpressionRequest

Output

DeleteExpressionResponse

Errors
BaseException
InternalException
InvalidTypeException
ResourceNotFoundException
ValidationException
Method

POST

Request URI

/

DeleteIndexField

Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Input

DeleteIndexFieldRequest

Output

DeleteIndexFieldResponse

Errors
BaseException
InternalException
InvalidTypeException
ResourceNotFoundException
ValidationException
Method

POST

Request URI

/

DeleteSuggester

Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Input

DeleteSuggesterRequest

Output

DeleteSuggesterResponse

Errors
BaseException
InternalException
InvalidTypeException
ResourceNotFoundException
ValidationException
Method

POST

Request URI

/

DescribeAnalysisSchemes

Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Input

DescribeAnalysisSchemesRequest

Output

DescribeAnalysisSchemesResponse

Errors
BaseException
InternalException
ResourceNotFoundException
Method

POST

Request URI

/

DescribeAvailabilityOptions

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

Input

DescribeAvailabilityOptionsRequest

Output

DescribeAvailabilityOptionsResponse

Errors
BaseException
InternalException
InvalidTypeException
LimitExceededException
ResourceNotFoundException
DisabledOperationException
Method

POST

Request URI

/

DescribeDomainEndpointOptions

Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

Input

DescribeDomainEndpointOptionsRequest

Output

DescribeDomainEndpointOptionsResponse

Errors
BaseException
InternalException
LimitExceededException
ResourceNotFoundException
DisabledOperationException
Method

POST

Request URI

/

DescribeDomains

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&q.parser=structured&size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.

Input

DescribeDomainsRequest

Output

DescribeDomainsResponse

Errors
BaseException
InternalException
Method

POST

Request URI

/

DescribeExpressions

Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Input

DescribeExpressionsRequest

Output

DescribeExpressionsResponse

Errors
BaseException
InternalException
ResourceNotFoundException
Method

POST

Request URI

/

DescribeIndexFields

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.

Input

DescribeIndexFieldsRequest

Output

DescribeIndexFieldsResponse

Errors
BaseException
InternalException
ResourceNotFoundException
Method

POST

Request URI

/

DescribeScalingParameters

Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

Input

DescribeScalingParametersRequest

Output

DescribeScalingParametersResponse

Errors
BaseException
InternalException
ResourceNotFoundException
Method

POST

Request URI

/

DescribeServiceAccessPolicies

Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.

Input

DescribeServiceAccessPoliciesRequest

Output

DescribeServiceAccessPoliciesResponse

Errors
BaseException
InternalException
ResourceNotFoundException
Method

POST

Request URI

/

DescribeSuggesters

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Input

DescribeSuggestersRequest

Output

DescribeSuggestersResponse

Errors
BaseException
InternalException
ResourceNotFoundException
Method

POST

Request URI

/

IndexDocuments

Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.

Input

IndexDocumentsRequest

Output

IndexDocumentsResponse

Errors
BaseException
InternalException
ResourceNotFoundException
ValidationException
Method

POST

Request URI

/

ListDomainNames

Lists all search domains owned by an account.

Input

None

Output

ListDomainNamesResponse

Errors
BaseException
Method

POST

Request URI

/

UpdateAvailabilityOptions

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

Input

UpdateAvailabilityOptionsRequest

Output

UpdateAvailabilityOptionsResponse

Errors
BaseException
InternalException
InvalidTypeException
LimitExceededException
ResourceNotFoundException
DisabledOperationException
ValidationException
Method

POST

Request URI

/

UpdateDomainEndpointOptions

Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

Input

UpdateDomainEndpointOptionsRequest

Output

UpdateDomainEndpointOptionsResponse

Errors
BaseException
InternalException
InvalidTypeException
LimitExceededException
ResourceNotFoundException
DisabledOperationException
ValidationException
Method

POST

Request URI

/

UpdateScalingParameters

Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

Input

UpdateScalingParametersRequest

Output

UpdateScalingParametersResponse

Errors
BaseException
InternalException
LimitExceededException
ResourceNotFoundException
InvalidTypeException
ValidationException
Method

POST

Request URI

/

UpdateServiceAccessPolicies

Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.

Input

UpdateServiceAccessPoliciesRequest

Output

UpdateServiceAccessPoliciesResponse

Errors
BaseException
InternalException
LimitExceededException
ResourceNotFoundException
InvalidTypeException
ValidationException
Method

POST

Request URI

/

NOTE

Autogenerated by lib/Amazon/API/Botocore.pm at Tue Apr 12 13:47:39 2022

LICENSE AND COPYRIGHT

This module is free software it may be used, redistributed and/or modified under the same terms as Perl itself.