Amazon CloudSearch 2013-01-01
- Client: Aws\CloudSearch\CloudSearchClient
- Service ID: cloudsearch
- Version: 2013-01-01
This page describes the parameters and results for the operations of the Amazon CloudSearch (2013-01-01), and shows how to use the Aws\CloudSearch\CloudSearchClient object to call the described operations. This documentation is specific to the 2013-01-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- BuildSuggesters ( array $params = [] )
- Indexes the search suggestions.
- CreateDomain ( array $params = [] )
- Creates a new search domain.
- DefineAnalysisScheme ( array $params = [] )
- Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options.
- DefineExpression ( array $params = [] )
- Configures an Expression for the search domain.
- DefineIndexField ( array $params = [] )
- Configures an IndexField for the search domain.
- DefineSuggester ( array $params = [] )
- Configures a suggester for a domain.
- DeleteAnalysisScheme ( array $params = [] )
- Deletes an analysis scheme.
- DeleteDomain ( array $params = [] )
- Permanently deletes a search domain and all of its data.
- DeleteExpression ( array $params = [] )
- Removes an Expression from the search domain.
- DeleteIndexField ( array $params = [] )
- Removes an IndexField from the search domain.
- DeleteSuggester ( array $params = [] )
- Deletes a suggester.
- DescribeAnalysisSchemes ( array $params = [] )
- Gets the analysis schemes configured for a domain.
- DescribeAvailabilityOptions ( array $params = [] )
- Gets the availability options configured for a domain.
- DescribeDomainEndpointOptions ( array $params = [] )
- Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.
- DescribeDomains ( array $params = [] )
- Gets information about the search domains owned by this account.
- DescribeExpressions ( array $params = [] )
- Gets the expressions configured for the search domain.
- DescribeIndexFields ( array $params = [] )
- Gets information about the index fields configured for the search domain.
- DescribeScalingParameters ( array $params = [] )
- Gets the scaling parameters configured for a domain.
- DescribeServiceAccessPolicies ( array $params = [] )
- Gets information about the access policies that control access to the domain's document and search endpoints.
- DescribeSuggesters ( array $params = [] )
- Gets the suggesters configured for a domain.
- IndexDocuments ( array $params = [] )
- Tells the search domain to start indexing its documents using the latest indexing options.
- ListDomainNames ( array $params = [] )
- Lists all search domains owned by an account.
- UpdateAvailabilityOptions ( array $params = [] )
- Configures the availability options for a domain.
- UpdateDomainEndpointOptions ( array $params = [] )
- Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.
- UpdateScalingParameters ( array $params = [] )
- Configures scaling parameters for a domain.
- UpdateServiceAccessPolicies ( array $params = [] )
- Configures the access rules that control access to the domain's document and search endpoints.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
BuildSuggesters
$result = $client->buildSuggesters
([/* ... */]); $promise = $client->buildSuggestersAsync
([/* ... */]);
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.
Parameter Syntax
$result = $client->buildSuggesters([ 'DomainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
Result Syntax
[ 'FieldNames' => ['<string>', ...], ]
Result Details
Members
- FieldNames
-
- Type: Array of strings
A list of field names.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- ValidationException:
The request was rejected because it has invalid parameters.
CreateDomain
$result = $client->createDomain
([/* ... */]); $promise = $client->createDomainAsync
([/* ... */]);
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
Parameter Syntax
$result = $client->createDomain([ 'DomainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.
Result Syntax
[ 'DomainStatus' => [ 'ARN' => '<string>', 'Created' => true || false, 'Deleted' => true || false, 'DocService' => [ 'Endpoint' => '<string>', ], 'DomainId' => '<string>', 'DomainName' => '<string>', 'Limits' => [ 'MaximumPartitionCount' => <integer>, 'MaximumReplicationCount' => <integer>, ], 'Processing' => true || false, 'RequiresIndexDocuments' => true || false, 'SearchInstanceCount' => <integer>, 'SearchInstanceType' => '<string>', 'SearchPartitionCount' => <integer>, 'SearchService' => [ 'Endpoint' => '<string>', ], ], ]
Result Details
Members
- DomainStatus
-
- Type: DomainStatus structure
The current status of the search domain.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- LimitExceededException:
The request was rejected because a resource limit has already been met.
- ResourceAlreadyExistsException:
The request was rejected because it attempted to create a resource that already exists.
- ValidationException:
The request was rejected because it has invalid parameters.
DefineAnalysisScheme
$result = $client->defineAnalysisScheme
([/* ... */]); $promise = $client->defineAnalysisSchemeAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->defineAnalysisScheme([ 'AnalysisScheme' => [ // REQUIRED 'AnalysisOptions' => [ 'AlgorithmicStemming' => 'none|minimal|light|full', 'JapaneseTokenizationDictionary' => '<string>', 'StemmingDictionary' => '<string>', 'Stopwords' => '<string>', 'Synonyms' => '<string>', ], 'AnalysisSchemeLanguage' => 'ar|bg|ca|cs|da|de|el|en|es|eu|fa|fi|fr|ga|gl|he|hi|hu|hy|id|it|ja|ko|lv|mul|nl|no|pt|ro|ru|sv|th|tr|zh-Hans|zh-Hant', // REQUIRED 'AnalysisSchemeName' => '<string>', // REQUIRED ], 'DomainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AnalysisScheme
-
- Required: Yes
- Type: AnalysisScheme structure
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
. - DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
Result Syntax
[ 'AnalysisScheme' => [ 'Options' => [ 'AnalysisOptions' => [ 'AlgorithmicStemming' => 'none|minimal|light|full', 'JapaneseTokenizationDictionary' => '<string>', 'StemmingDictionary' => '<string>', 'Stopwords' => '<string>', 'Synonyms' => '<string>', ], 'AnalysisSchemeLanguage' => 'ar|bg|ca|cs|da|de|el|en|es|eu|fa|fi|fr|ga|gl|he|hi|hu|hy|id|it|ja|ko|lv|mul|nl|no|pt|ro|ru|sv|th|tr|zh-Hans|zh-Hant', 'AnalysisSchemeName' => '<string>', ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- AnalysisScheme
-
- Required: Yes
- Type: AnalysisSchemeStatus structure
The status and configuration of an
AnalysisScheme
.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- LimitExceededException:
The request was rejected because a resource limit has already been met.
- InvalidTypeException:
The request was rejected because it specified an invalid type definition.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- ValidationException:
The request was rejected because it has invalid parameters.
DefineExpression
$result = $client->defineExpression
([/* ... */]); $promise = $client->defineExpressionAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->defineExpression([ 'DomainName' => '<string>', // REQUIRED 'Expression' => [ // REQUIRED 'ExpressionName' => '<string>', // REQUIRED 'ExpressionValue' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
- Expression
-
- Required: Yes
- Type: Expression structure
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.
Result Syntax
[ 'Expression' => [ 'Options' => [ 'ExpressionName' => '<string>', 'ExpressionValue' => '<string>', ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- Expression
-
- Required: Yes
- Type: ExpressionStatus structure
The value of an
Expression
and its current status.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- LimitExceededException:
The request was rejected because a resource limit has already been met.
- InvalidTypeException:
The request was rejected because it specified an invalid type definition.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- ValidationException:
The request was rejected because it has invalid parameters.
DefineIndexField
$result = $client->defineIndexField
([/* ... */]); $promise = $client->defineIndexFieldAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->defineIndexField([ 'DomainName' => '<string>', // REQUIRED 'IndexField' => [ // REQUIRED 'DateArrayOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'DateOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'DoubleArrayOptions' => [ 'DefaultValue' => <float>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'DoubleOptions' => [ 'DefaultValue' => <float>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'IndexFieldName' => '<string>', // REQUIRED 'IndexFieldType' => 'int|double|literal|text|date|latlon|int-array|double-array|literal-array|text-array|date-array', // REQUIRED 'IntArrayOptions' => [ 'DefaultValue' => <integer>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'IntOptions' => [ 'DefaultValue' => <integer>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'LatLonOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'LiteralArrayOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'LiteralOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'TextArrayOptions' => [ 'AnalysisScheme' => '<string>', 'DefaultValue' => '<string>', 'HighlightEnabled' => true || false, 'ReturnEnabled' => true || false, 'SourceFields' => '<string>', ], 'TextOptions' => [ 'AnalysisScheme' => '<string>', 'DefaultValue' => '<string>', 'HighlightEnabled' => true || false, 'ReturnEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], ], ]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
- IndexField
-
- Required: Yes
- Type: IndexField structure
The index field and field options you want to configure.
Result Syntax
[ 'IndexField' => [ 'Options' => [ 'DateArrayOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'DateOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'DoubleArrayOptions' => [ 'DefaultValue' => <float>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'DoubleOptions' => [ 'DefaultValue' => <float>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'IndexFieldName' => '<string>', 'IndexFieldType' => 'int|double|literal|text|date|latlon|int-array|double-array|literal-array|text-array|date-array', 'IntArrayOptions' => [ 'DefaultValue' => <integer>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'IntOptions' => [ 'DefaultValue' => <integer>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'LatLonOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'LiteralArrayOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'LiteralOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'TextArrayOptions' => [ 'AnalysisScheme' => '<string>', 'DefaultValue' => '<string>', 'HighlightEnabled' => true || false, 'ReturnEnabled' => true || false, 'SourceFields' => '<string>', ], 'TextOptions' => [ 'AnalysisScheme' => '<string>', 'DefaultValue' => '<string>', 'HighlightEnabled' => true || false, 'ReturnEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- IndexField
-
- Required: Yes
- Type: IndexFieldStatus structure
The value of an
IndexField
and its current status.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- LimitExceededException:
The request was rejected because a resource limit has already been met.
- InvalidTypeException:
The request was rejected because it specified an invalid type definition.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- ValidationException:
The request was rejected because it has invalid parameters.
DefineSuggester
$result = $client->defineSuggester
([/* ... */]); $promise = $client->defineSuggesterAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->defineSuggester([ 'DomainName' => '<string>', // REQUIRED 'Suggester' => [ // REQUIRED 'DocumentSuggesterOptions' => [ // REQUIRED 'FuzzyMatching' => 'none|low|high', 'SortExpression' => '<string>', 'SourceField' => '<string>', // REQUIRED ], 'SuggesterName' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
- Suggester
-
- Required: Yes
- Type: Suggester structure
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
.
Result Syntax
[ 'Suggester' => [ 'Options' => [ 'DocumentSuggesterOptions' => [ 'FuzzyMatching' => 'none|low|high', 'SortExpression' => '<string>', 'SourceField' => '<string>', ], 'SuggesterName' => '<string>', ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- Suggester
-
- Required: Yes
- Type: SuggesterStatus structure
The value of a
Suggester
and its current status.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- LimitExceededException:
The request was rejected because a resource limit has already been met.
- InvalidTypeException:
The request was rejected because it specified an invalid type definition.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- ValidationException:
The request was rejected because it has invalid parameters.
DeleteAnalysisScheme
$result = $client->deleteAnalysisScheme
([/* ... */]); $promise = $client->deleteAnalysisSchemeAsync
([/* ... */]);
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
Parameter Syntax
$result = $client->deleteAnalysisScheme([ 'AnalysisSchemeName' => '<string>', // REQUIRED 'DomainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AnalysisSchemeName
-
- Required: Yes
- Type: string
The name of the analysis scheme you want to delete.
- DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
Result Syntax
[ 'AnalysisScheme' => [ 'Options' => [ 'AnalysisOptions' => [ 'AlgorithmicStemming' => 'none|minimal|light|full', 'JapaneseTokenizationDictionary' => '<string>', 'StemmingDictionary' => '<string>', 'Stopwords' => '<string>', 'Synonyms' => '<string>', ], 'AnalysisSchemeLanguage' => 'ar|bg|ca|cs|da|de|el|en|es|eu|fa|fi|fr|ga|gl|he|hi|hu|hy|id|it|ja|ko|lv|mul|nl|no|pt|ro|ru|sv|th|tr|zh-Hans|zh-Hant', 'AnalysisSchemeName' => '<string>', ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- AnalysisScheme
-
- Required: Yes
- Type: AnalysisSchemeStatus structure
The status of the analysis scheme being deleted.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- InvalidTypeException:
The request was rejected because it specified an invalid type definition.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- ValidationException:
The request was rejected because it has invalid parameters.
DeleteDomain
$result = $client->deleteDomain
([/* ... */]); $promise = $client->deleteDomainAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteDomain([ 'DomainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
The name of the domain you want to permanently delete.
Result Syntax
[ 'DomainStatus' => [ 'ARN' => '<string>', 'Created' => true || false, 'Deleted' => true || false, 'DocService' => [ 'Endpoint' => '<string>', ], 'DomainId' => '<string>', 'DomainName' => '<string>', 'Limits' => [ 'MaximumPartitionCount' => <integer>, 'MaximumReplicationCount' => <integer>, ], 'Processing' => true || false, 'RequiresIndexDocuments' => true || false, 'SearchInstanceCount' => <integer>, 'SearchInstanceType' => '<string>', 'SearchPartitionCount' => <integer>, 'SearchService' => [ 'Endpoint' => '<string>', ], ], ]
Result Details
Members
- DomainStatus
-
- Type: DomainStatus structure
The current status of the search domain.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
DeleteExpression
$result = $client->deleteExpression
([/* ... */]); $promise = $client->deleteExpressionAsync
([/* ... */]);
Removes an Expression
from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
Parameter Syntax
$result = $client->deleteExpression([ 'DomainName' => '<string>', // REQUIRED 'ExpressionName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
- ExpressionName
-
- Required: Yes
- Type: string
The name of the
Expression
to delete.
Result Syntax
[ 'Expression' => [ 'Options' => [ 'ExpressionName' => '<string>', 'ExpressionValue' => '<string>', ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- Expression
-
- Required: Yes
- Type: ExpressionStatus structure
The status of the expression being deleted.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- InvalidTypeException:
The request was rejected because it specified an invalid type definition.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- ValidationException:
The request was rejected because it has invalid parameters.
DeleteIndexField
$result = $client->deleteIndexField
([/* ... */]); $promise = $client->deleteIndexFieldAsync
([/* ... */]);
Removes an IndexField
from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
Parameter Syntax
$result = $client->deleteIndexField([ 'DomainName' => '<string>', // REQUIRED 'IndexFieldName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
- IndexFieldName
-
- Required: Yes
- Type: string
The name of the index field your want to remove from the domain's indexing options.
Result Syntax
[ 'IndexField' => [ 'Options' => [ 'DateArrayOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'DateOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'DoubleArrayOptions' => [ 'DefaultValue' => <float>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'DoubleOptions' => [ 'DefaultValue' => <float>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'IndexFieldName' => '<string>', 'IndexFieldType' => 'int|double|literal|text|date|latlon|int-array|double-array|literal-array|text-array|date-array', 'IntArrayOptions' => [ 'DefaultValue' => <integer>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'IntOptions' => [ 'DefaultValue' => <integer>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'LatLonOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'LiteralArrayOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'LiteralOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'TextArrayOptions' => [ 'AnalysisScheme' => '<string>', 'DefaultValue' => '<string>', 'HighlightEnabled' => true || false, 'ReturnEnabled' => true || false, 'SourceFields' => '<string>', ], 'TextOptions' => [ 'AnalysisScheme' => '<string>', 'DefaultValue' => '<string>', 'HighlightEnabled' => true || false, 'ReturnEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- IndexField
-
- Required: Yes
- Type: IndexFieldStatus structure
The status of the index field being deleted.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- InvalidTypeException:
The request was rejected because it specified an invalid type definition.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- ValidationException:
The request was rejected because it has invalid parameters.
DeleteSuggester
$result = $client->deleteSuggester
([/* ... */]); $promise = $client->deleteSuggesterAsync
([/* ... */]);
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
Parameter Syntax
$result = $client->deleteSuggester([ 'DomainName' => '<string>', // REQUIRED 'SuggesterName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
- SuggesterName
-
- Required: Yes
- Type: string
Specifies the name of the suggester you want to delete.
Result Syntax
[ 'Suggester' => [ 'Options' => [ 'DocumentSuggesterOptions' => [ 'FuzzyMatching' => 'none|low|high', 'SortExpression' => '<string>', 'SourceField' => '<string>', ], 'SuggesterName' => '<string>', ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- Suggester
-
- Required: Yes
- Type: SuggesterStatus structure
The status of the suggester being deleted.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- InvalidTypeException:
The request was rejected because it specified an invalid type definition.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- ValidationException:
The request was rejected because it has invalid parameters.
DescribeAnalysisSchemes
$result = $client->describeAnalysisSchemes
([/* ... */]); $promise = $client->describeAnalysisSchemesAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeAnalysisSchemes([ 'AnalysisSchemeNames' => ['<string>', ...], 'Deployed' => true || false, 'DomainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AnalysisSchemeNames
-
- Type: Array of strings
The analysis schemes you want to describe.
- Deployed
-
- Type: boolean
Whether to display the deployed configuration (
true
) or include any pending changes (false
). Defaults tofalse
. - DomainName
-
- Required: Yes
- Type: string
The name of the domain you want to describe.
Result Syntax
[ 'AnalysisSchemes' => [ [ 'Options' => [ 'AnalysisOptions' => [ 'AlgorithmicStemming' => 'none|minimal|light|full', 'JapaneseTokenizationDictionary' => '<string>', 'StemmingDictionary' => '<string>', 'Stopwords' => '<string>', 'Synonyms' => '<string>', ], 'AnalysisSchemeLanguage' => 'ar|bg|ca|cs|da|de|el|en|es|eu|fa|fi|fr|ga|gl|he|hi|hu|hy|id|it|ja|ko|lv|mul|nl|no|pt|ro|ru|sv|th|tr|zh-Hans|zh-Hant', 'AnalysisSchemeName' => '<string>', ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], // ... ], ]
Result Details
Members
- AnalysisSchemes
-
- Required: Yes
- Type: Array of AnalysisSchemeStatus structures
The analysis scheme descriptions.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
DescribeAvailabilityOptions
$result = $client->describeAvailabilityOptions
([/* ... */]); $promise = $client->describeAvailabilityOptionsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeAvailabilityOptions([ 'Deployed' => true || false, 'DomainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Deployed
-
- Type: boolean
Whether to display the deployed configuration (
true
) or include any pending changes (false
). Defaults tofalse
. - DomainName
-
- Required: Yes
- Type: string
The name of the domain you want to describe.
Result Syntax
[ 'AvailabilityOptions' => [ 'Options' => true || false, 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- AvailabilityOptions
-
- Type: AvailabilityOptionsStatus structure
The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- InvalidTypeException:
The request was rejected because it specified an invalid type definition.
- LimitExceededException:
The request was rejected because a resource limit has already been met.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- DisabledOperationException:
The request was rejected because it attempted an operation which is not enabled.
DescribeDomainEndpointOptions
$result = $client->describeDomainEndpointOptions
([/* ... */]); $promise = $client->describeDomainEndpointOptionsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeDomainEndpointOptions([ 'Deployed' => true || false, 'DomainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Deployed
-
- Type: boolean
Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to
false
. - DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain.
Result Syntax
[ 'DomainEndpointOptions' => [ 'Options' => [ 'EnforceHTTPS' => true || false, 'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07', ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- DomainEndpointOptions
-
- Type: DomainEndpointOptionsStatus structure
The status and configuration of a search domain's endpoint options.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- LimitExceededException:
The request was rejected because a resource limit has already been met.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- DisabledOperationException:
The request was rejected because it attempted an operation which is not enabled.
DescribeDomains
$result = $client->describeDomains
([/* ... */]); $promise = $client->describeDomainsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeDomains([ 'DomainNames' => ['<string>', ...], ]);
Parameter Details
Members
- DomainNames
-
- Type: Array of strings
The names of the domains you want to include in the response.
Result Syntax
[ 'DomainStatusList' => [ [ 'ARN' => '<string>', 'Created' => true || false, 'Deleted' => true || false, 'DocService' => [ 'Endpoint' => '<string>', ], 'DomainId' => '<string>', 'DomainName' => '<string>', 'Limits' => [ 'MaximumPartitionCount' => <integer>, 'MaximumReplicationCount' => <integer>, ], 'Processing' => true || false, 'RequiresIndexDocuments' => true || false, 'SearchInstanceCount' => <integer>, 'SearchInstanceType' => '<string>', 'SearchPartitionCount' => <integer>, 'SearchService' => [ 'Endpoint' => '<string>', ], ], // ... ], ]
Result Details
Members
- DomainStatusList
-
- Required: Yes
- Type: Array of DomainStatus structures
A list that contains the status of each requested domain.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
DescribeExpressions
$result = $client->describeExpressions
([/* ... */]); $promise = $client->describeExpressionsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeExpressions([ 'Deployed' => true || false, 'DomainName' => '<string>', // REQUIRED 'ExpressionNames' => ['<string>', ...], ]);
Parameter Details
Members
- Deployed
-
- Type: boolean
Whether to display the deployed configuration (
true
) or include any pending changes (false
). Defaults tofalse
. - DomainName
-
- Required: Yes
- Type: string
The name of the domain you want to describe.
- ExpressionNames
-
- Type: Array of strings
Limits the
DescribeExpressions
response to the specified expressions. If not specified, all expressions are shown.
Result Syntax
[ 'Expressions' => [ [ 'Options' => [ 'ExpressionName' => '<string>', 'ExpressionValue' => '<string>', ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], // ... ], ]
Result Details
Members
- Expressions
-
- Required: Yes
- Type: Array of ExpressionStatus structures
The expressions configured for the domain.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
DescribeIndexFields
$result = $client->describeIndexFields
([/* ... */]); $promise = $client->describeIndexFieldsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeIndexFields([ 'Deployed' => true || false, 'DomainName' => '<string>', // REQUIRED 'FieldNames' => ['<string>', ...], ]);
Parameter Details
Members
- Deployed
-
- Type: boolean
Whether to display the deployed configuration (
true
) or include any pending changes (false
). Defaults tofalse
. - DomainName
-
- Required: Yes
- Type: string
The name of the domain you want to describe.
- FieldNames
-
- Type: Array of strings
A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.
Result Syntax
[ 'IndexFields' => [ [ 'Options' => [ 'DateArrayOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'DateOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'DoubleArrayOptions' => [ 'DefaultValue' => <float>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'DoubleOptions' => [ 'DefaultValue' => <float>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'IndexFieldName' => '<string>', 'IndexFieldType' => 'int|double|literal|text|date|latlon|int-array|double-array|literal-array|text-array|date-array', 'IntArrayOptions' => [ 'DefaultValue' => <integer>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'IntOptions' => [ 'DefaultValue' => <integer>, 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'LatLonOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'LiteralArrayOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SourceFields' => '<string>', ], 'LiteralOptions' => [ 'DefaultValue' => '<string>', 'FacetEnabled' => true || false, 'ReturnEnabled' => true || false, 'SearchEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], 'TextArrayOptions' => [ 'AnalysisScheme' => '<string>', 'DefaultValue' => '<string>', 'HighlightEnabled' => true || false, 'ReturnEnabled' => true || false, 'SourceFields' => '<string>', ], 'TextOptions' => [ 'AnalysisScheme' => '<string>', 'DefaultValue' => '<string>', 'HighlightEnabled' => true || false, 'ReturnEnabled' => true || false, 'SortEnabled' => true || false, 'SourceField' => '<string>', ], ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], // ... ], ]
Result Details
Members
- IndexFields
-
- Required: Yes
- Type: Array of IndexFieldStatus structures
The index fields configured for the domain.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
DescribeScalingParameters
$result = $client->describeScalingParameters
([/* ... */]); $promise = $client->describeScalingParametersAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeScalingParameters([ 'DomainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
Result Syntax
[ 'ScalingParameters' => [ 'Options' => [ 'DesiredInstanceType' => 'search.m1.small|search.m1.large|search.m2.xlarge|search.m2.2xlarge|search.m3.medium|search.m3.large|search.m3.xlarge|search.m3.2xlarge|search.small|search.medium|search.large|search.xlarge|search.2xlarge|search.previousgeneration.small|search.previousgeneration.large|search.previousgeneration.xlarge|search.previousgeneration.2xlarge', 'DesiredPartitionCount' => <integer>, 'DesiredReplicationCount' => <integer>, ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- ScalingParameters
-
- Required: Yes
- Type: ScalingParametersStatus structure
The status and configuration of a search domain's scaling parameters.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
DescribeServiceAccessPolicies
$result = $client->describeServiceAccessPolicies
([/* ... */]); $promise = $client->describeServiceAccessPoliciesAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeServiceAccessPolicies([ 'Deployed' => true || false, 'DomainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Deployed
-
- Type: boolean
Whether to display the deployed configuration (
true
) or include any pending changes (false
). Defaults tofalse
. - DomainName
-
- Required: Yes
- Type: string
The name of the domain you want to describe.
Result Syntax
[ 'AccessPolicies' => [ 'Options' => '<string>', 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- AccessPolicies
-
- Required: Yes
- Type: AccessPoliciesStatus structure
The access rules configured for the domain specified in the request.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
DescribeSuggesters
$result = $client->describeSuggesters
([/* ... */]); $promise = $client->describeSuggestersAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeSuggesters([ 'Deployed' => true || false, 'DomainName' => '<string>', // REQUIRED 'SuggesterNames' => ['<string>', ...], ]);
Parameter Details
Members
- Deployed
-
- Type: boolean
Whether to display the deployed configuration (
true
) or include any pending changes (false
). Defaults tofalse
. - DomainName
-
- Required: Yes
- Type: string
The name of the domain you want to describe.
- SuggesterNames
-
- Type: Array of strings
The suggesters you want to describe.
Result Syntax
[ 'Suggesters' => [ [ 'Options' => [ 'DocumentSuggesterOptions' => [ 'FuzzyMatching' => 'none|low|high', 'SortExpression' => '<string>', 'SourceField' => '<string>', ], 'SuggesterName' => '<string>', ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], // ... ], ]
Result Details
Members
- Suggesters
-
- Required: Yes
- Type: Array of SuggesterStatus structures
The suggesters configured for the domain specified in the request.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
IndexDocuments
$result = $client->indexDocuments
([/* ... */]); $promise = $client->indexDocumentsAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->indexDocuments([ 'DomainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
Result Syntax
[ 'FieldNames' => ['<string>', ...], ]
Result Details
Members
- FieldNames
-
- Type: Array of strings
The names of the fields that are currently being indexed.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- ValidationException:
The request was rejected because it has invalid parameters.
ListDomainNames
$result = $client->listDomainNames
([/* ... */]); $promise = $client->listDomainNamesAsync
([/* ... */]);
Lists all search domains owned by an account.
Parameter Syntax
$result = $client->listDomainNames([ ]);
Parameter Details
Members
Result Syntax
[ 'DomainNames' => ['<string>', ...], ]
Result Details
Members
- DomainNames
-
- Type: Associative array of custom strings keys (DomainName) to strings
The names of the search domains owned by an account.
Errors
- BaseException:
An error occurred while processing the request.
UpdateAvailabilityOptions
$result = $client->updateAvailabilityOptions
([/* ... */]); $promise = $client->updateAvailabilityOptionsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateAvailabilityOptions([ 'DomainName' => '<string>', // REQUIRED 'MultiAZ' => true || false, // REQUIRED ]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
- MultiAZ
-
- Required: Yes
- Type: boolean
You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to
false
.
Result Syntax
[ 'AvailabilityOptions' => [ 'Options' => true || false, 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- AvailabilityOptions
-
- Type: AvailabilityOptionsStatus structure
The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- InvalidTypeException:
The request was rejected because it specified an invalid type definition.
- LimitExceededException:
The request was rejected because a resource limit has already been met.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- DisabledOperationException:
The request was rejected because it attempted an operation which is not enabled.
- ValidationException:
The request was rejected because it has invalid parameters.
UpdateDomainEndpointOptions
$result = $client->updateDomainEndpointOptions
([/* ... */]); $promise = $client->updateDomainEndpointOptionsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateDomainEndpointOptions([ 'DomainEndpointOptions' => [ // REQUIRED 'EnforceHTTPS' => true || false, 'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07', ], 'DomainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DomainEndpointOptions
-
- Required: Yes
- Type: DomainEndpointOptions structure
Whether to require that all requests to the domain arrive over HTTPS. We recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility with older clients, the default is Policy-Min-TLS-1-0-2019-07.
- DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain.
Result Syntax
[ 'DomainEndpointOptions' => [ 'Options' => [ 'EnforceHTTPS' => true || false, 'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07', ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- DomainEndpointOptions
-
- Type: DomainEndpointOptionsStatus structure
The newly-configured domain endpoint options.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- InvalidTypeException:
The request was rejected because it specified an invalid type definition.
- LimitExceededException:
The request was rejected because a resource limit has already been met.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- DisabledOperationException:
The request was rejected because it attempted an operation which is not enabled.
- ValidationException:
The request was rejected because it has invalid parameters.
UpdateScalingParameters
$result = $client->updateScalingParameters
([/* ... */]); $promise = $client->updateScalingParametersAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateScalingParameters([ 'DomainName' => '<string>', // REQUIRED 'ScalingParameters' => [ // REQUIRED 'DesiredInstanceType' => 'search.m1.small|search.m1.large|search.m2.xlarge|search.m2.2xlarge|search.m3.medium|search.m3.large|search.m3.xlarge|search.m3.2xlarge|search.small|search.medium|search.large|search.xlarge|search.2xlarge|search.previousgeneration.small|search.previousgeneration.large|search.previousgeneration.xlarge|search.previousgeneration.2xlarge', 'DesiredPartitionCount' => <integer>, 'DesiredReplicationCount' => <integer>, ], ]);
Parameter Details
Members
- DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
- ScalingParameters
-
- Required: Yes
- Type: ScalingParameters structure
The desired instance type and desired number of replicas of each index partition.
Result Syntax
[ 'ScalingParameters' => [ 'Options' => [ 'DesiredInstanceType' => 'search.m1.small|search.m1.large|search.m2.xlarge|search.m2.2xlarge|search.m3.medium|search.m3.large|search.m3.xlarge|search.m3.2xlarge|search.small|search.medium|search.large|search.xlarge|search.2xlarge|search.previousgeneration.small|search.previousgeneration.large|search.previousgeneration.xlarge|search.previousgeneration.2xlarge', 'DesiredPartitionCount' => <integer>, 'DesiredReplicationCount' => <integer>, ], 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- ScalingParameters
-
- Required: Yes
- Type: ScalingParametersStatus structure
The status and configuration of a search domain's scaling parameters.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- LimitExceededException:
The request was rejected because a resource limit has already been met.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- InvalidTypeException:
The request was rejected because it specified an invalid type definition.
- ValidationException:
The request was rejected because it has invalid parameters.
UpdateServiceAccessPolicies
$result = $client->updateServiceAccessPolicies
([/* ... */]); $promise = $client->updateServiceAccessPoliciesAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateServiceAccessPolicies([ 'AccessPolicies' => '<string>', // REQUIRED 'DomainName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AccessPolicies
-
- Required: Yes
- Type: string
The access rules you want to configure. These rules replace any existing rules.
- DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
Result Syntax
[ 'AccessPolicies' => [ 'Options' => '<string>', 'Status' => [ 'CreationDate' => <DateTime>, 'PendingDeletion' => true || false, 'State' => 'RequiresIndexDocuments|Processing|Active|FailedToValidate', 'UpdateDate' => <DateTime>, 'UpdateVersion' => <integer>, ], ], ]
Result Details
Members
- AccessPolicies
-
- Required: Yes
- Type: AccessPoliciesStatus structure
The access rules configured for the domain.
Errors
- BaseException:
An error occurred while processing the request.
- InternalException:
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
- LimitExceededException:
The request was rejected because a resource limit has already been met.
- ResourceNotFoundException:
The request was rejected because it attempted to reference a resource that does not exist.
- InvalidTypeException:
The request was rejected because it specified an invalid type definition.
- ValidationException:
The request was rejected because it has invalid parameters.
Shapes
AccessPoliciesStatus
Description
The configured access rules for the domain's document and search endpoints, and the current status of those rules.
Members
- Options
-
- Required: Yes
- Type: string
Access rules for a domain's document or search service endpoints. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. The maximum size of a policy document is 100 KB.
- Status
-
- Required: Yes
- Type: OptionStatus structure
The status of domain configuration option.
AnalysisOptions
Description
Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.
Members
- AlgorithmicStemming
-
- Type: string
The level of algorithmic stemming to perform:
none
,minimal
,light
, orfull
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide - JapaneseTokenizationDictionary
-
- Type: string
A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
- StemmingDictionary
-
- Type: string
A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example,
{"term1": "stem1", "term2": "stem2", "term3": "stem3"}
. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB. - Stopwords
-
- Type: string
A JSON array of terms to ignore during indexing and searching. For example,
["a", "an", "the", "of"]
. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. - Synonyms
-
- Type: string
A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
AnalysisScheme
Description
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
and AlgorithmicStemming
.
Members
- AnalysisOptions
-
- Type: AnalysisOptions structure
Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.
- AnalysisSchemeLanguage
-
- Required: Yes
- Type: string
An IETF RFC 4646 language code or
mul
for multiple languages. - AnalysisSchemeName
-
- Required: Yes
- Type: string
Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
AnalysisSchemeStatus
Description
The status and configuration of an AnalysisScheme
.
Members
- Options
-
- Required: Yes
- Type: AnalysisScheme structure
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
. - Status
-
- Required: Yes
- Type: OptionStatus structure
The status of domain configuration option.
AvailabilityOptionsStatus
Description
The status and configuration of the domain's availability options.
Members
- Options
-
- Required: Yes
- Type: boolean
The availability options configured for the domain.
- Status
-
- Required: Yes
- Type: OptionStatus structure
The status of domain configuration option.
BaseException
Description
An error occurred while processing the request.
Members
- Code
-
- Type: string
A machine-parsable string error or warning code.
- Message
-
- Type: string
A human-readable string error or warning message.
BuildSuggestersResponse
Description
The result of a BuildSuggester
request. Contains a list of the fields used for suggestions.
Members
- FieldNames
-
- Type: Array of strings
A list of field names.
CreateDomainResponse
Description
The result of a CreateDomainRequest
. Contains the status of a newly created domain.
Members
- DomainStatus
-
- Type: DomainStatus structure
The current status of the search domain.
DateArrayOptions
Description
Options for a field that contains an array of dates. Present if IndexFieldType
specifies the field is of type date-array
. All options are enabled by default.
Members
- DefaultValue
-
- Type: string
A value to use for the field if the field isn't specified for a document. - FacetEnabled
-
- Type: boolean
Whether facet information can be returned for the field.
- ReturnEnabled
-
- Type: boolean
Whether the contents of the field can be returned in the search results.
- SearchEnabled
-
- Type: boolean
Whether the contents of the field are searchable.
- SourceFields
-
- Type: string
A list of source fields to map to the field.
DateOptions
Description
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 type date
. All options are enabled by default.
Members
- DefaultValue
-
- Type: string
A value to use for the field if the field isn't specified for a document. - FacetEnabled
-
- Type: boolean
Whether facet information can be returned for the field.
- ReturnEnabled
-
- Type: boolean
Whether the contents of the field can be returned in the search results.
- SearchEnabled
-
- Type: boolean
Whether the contents of the field are searchable.
- SortEnabled
-
- Type: boolean
Whether the field can be used to sort the search results.
- SourceField
-
- Type: string
A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name
score
is reserved and cannot be used as a field name. To reference a document's ID, you can use the name_id
.
DefineAnalysisSchemeResponse
Description
The result of a DefineAnalysisScheme
request. Contains the status of the newly-configured analysis scheme.
Members
- AnalysisScheme
-
- Required: Yes
- Type: AnalysisSchemeStatus structure
The status and configuration of an
AnalysisScheme
.
DefineExpressionResponse
Description
The result of a DefineExpression
request. Contains the status of the newly-configured expression.
Members
- Expression
-
- Required: Yes
- Type: ExpressionStatus structure
The value of an
Expression
and its current status.
DefineIndexFieldResponse
Description
The result of a DefineIndexField
request. Contains the status of the newly-configured index field.
Members
- IndexField
-
- Required: Yes
- Type: IndexFieldStatus structure
The value of an
IndexField
and its current status.
DefineSuggesterResponse
Description
The result of a DefineSuggester
request. Contains the status of the newly-configured suggester.
Members
- Suggester
-
- Required: Yes
- Type: SuggesterStatus structure
The value of a
Suggester
and its current status.
DeleteAnalysisSchemeResponse
Description
The result of a DeleteAnalysisScheme
request. Contains the status of the deleted analysis scheme.
Members
- AnalysisScheme
-
- Required: Yes
- Type: AnalysisSchemeStatus structure
The status of the analysis scheme being deleted.
DeleteDomainResponse
Description
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.
Members
- DomainStatus
-
- Type: DomainStatus structure
The current status of the search domain.
DeleteExpressionResponse
Description
The result of a DeleteExpression
request. Specifies the expression being deleted.
Members
- Expression
-
- Required: Yes
- Type: ExpressionStatus structure
The status of the expression being deleted.
DeleteIndexFieldResponse
Description
The result of a DeleteIndexField
request.
Members
- IndexField
-
- Required: Yes
- Type: IndexFieldStatus structure
The status of the index field being deleted.
DeleteSuggesterResponse
Description
The result of a DeleteSuggester
request. Contains the status of the deleted suggester.
Members
- Suggester
-
- Required: Yes
- Type: SuggesterStatus structure
The status of the suggester being deleted.
DescribeAnalysisSchemesResponse
Description
The result of a DescribeAnalysisSchemes
request. Contains the analysis schemes configured for the domain specified in the request.
Members
- AnalysisSchemes
-
- Required: Yes
- Type: Array of AnalysisSchemeStatus structures
The analysis scheme descriptions.
DescribeAvailabilityOptionsResponse
Description
The result of a DescribeAvailabilityOptions
request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.
Members
- AvailabilityOptions
-
- Type: AvailabilityOptionsStatus structure
The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.
DescribeDomainEndpointOptionsResponse
Description
The result of a DescribeDomainEndpointOptions
request. Contains the status and configuration of a search domain's endpoint options.
Members
- DomainEndpointOptions
-
- Type: DomainEndpointOptionsStatus structure
The status and configuration of a search domain's endpoint options.
DescribeDomainsResponse
Description
The result of a DescribeDomains
request. Contains the status of the domains specified in the request or all domains owned by the account.
Members
- DomainStatusList
-
- Required: Yes
- Type: Array of DomainStatus structures
A list that contains the status of each requested domain.
DescribeExpressionsResponse
Description
The result of a DescribeExpressions
request. Contains the expressions configured for the domain specified in the request.
Members
- Expressions
-
- Required: Yes
- Type: Array of ExpressionStatus structures
The expressions configured for the domain.
DescribeIndexFieldsResponse
Description
The result of a DescribeIndexFields
request. Contains the index fields configured for the domain specified in the request.
Members
- IndexFields
-
- Required: Yes
- Type: Array of IndexFieldStatus structures
The index fields configured for the domain.
DescribeScalingParametersResponse
Description
The result of a DescribeScalingParameters
request. Contains the scaling parameters configured for the domain specified in the request.
Members
- ScalingParameters
-
- Required: Yes
- Type: ScalingParametersStatus structure
The status and configuration of a search domain's scaling parameters.
DescribeServiceAccessPoliciesResponse
Description
The result of a DescribeServiceAccessPolicies
request.
Members
- AccessPolicies
-
- Required: Yes
- Type: AccessPoliciesStatus structure
The access rules configured for the domain specified in the request.
DescribeSuggestersResponse
Description
The result of a DescribeSuggesters
request.
Members
- Suggesters
-
- Required: Yes
- Type: Array of SuggesterStatus structures
The suggesters configured for the domain specified in the request.
DisabledOperationException
Description
The request was rejected because it attempted an operation which is not enabled.
Members
DocumentSuggesterOptions
Description
Options for a search suggester.
Members
- FuzzyMatching
-
- Type: string
The level of fuzziness allowed when suggesting matches for a string:
none
,low
, orhigh
. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none. - SortExpression
-
- Type: string
An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the
_score
value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first. - SourceField
-
- Required: Yes
- Type: string
The name of the index field you want to use for suggestions.
DomainEndpointOptions
Description
The domain's endpoint options.
Members
- EnforceHTTPS
-
- Type: boolean
Whether the domain is HTTPS only enabled.
- TLSSecurityPolicy
-
- Type: string
The minimum required TLS version
DomainEndpointOptionsStatus
Description
The configuration and status of the domain's endpoint options.
Members
- Options
-
- Required: Yes
- Type: DomainEndpointOptions structure
The domain endpoint options configured for the domain.
- Status
-
- Required: Yes
- Type: OptionStatus structure
The status of the configured domain endpoint options.
DomainStatus
Description
The current status of the search domain.
Members
- ARN
-
- Type: string
The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
- Created
-
- Type: boolean
True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
- Deleted
-
- Type: boolean
True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
- DocService
-
- Type: ServiceEndpoint structure
The service endpoint for updating documents in a search domain.
- DomainId
-
- Required: Yes
- Type: string
An internally generated unique identifier for a domain.
- DomainName
-
- Required: Yes
- Type: string
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
- Limits
-
- Type: Limits structure
- Processing
-
- Type: boolean
True if processing is being done to activate the current domain configuration.
- RequiresIndexDocuments
-
- Required: Yes
- Type: boolean
True if IndexDocuments needs to be called to activate the current domain configuration.
- SearchInstanceCount
-
- Type: int
The number of search instances that are available to process search requests.
- SearchInstanceType
-
- Type: string
The instance type that is being used to process search requests.
- SearchPartitionCount
-
- Type: int
The number of partitions across which the search index is spread.
- SearchService
-
- Type: ServiceEndpoint structure
The service endpoint for requesting search results from a search domain.
DoubleArrayOptions
Description
Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType
specifies the field is of type double-array
. All options are enabled by default.
Members
- DefaultValue
-
- Type: double
A value to use for the field if the field isn't specified for a document. - FacetEnabled
-
- Type: boolean
Whether facet information can be returned for the field.
- ReturnEnabled
-
- Type: boolean
Whether the contents of the field can be returned in the search results.
- SearchEnabled
-
- Type: boolean
Whether the contents of the field are searchable.
- SourceFields
-
- Type: string
A list of source fields to map to the field.
DoubleOptions
Description
Options for a double-precision 64-bit floating point field. Present if IndexFieldType
specifies the field is of type double
. All options are enabled by default.
Members
- DefaultValue
-
- Type: double
A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
- FacetEnabled
-
- Type: boolean
Whether facet information can be returned for the field.
- ReturnEnabled
-
- Type: boolean
Whether the contents of the field can be returned in the search results.
- SearchEnabled
-
- Type: boolean
Whether the contents of the field are searchable.
- SortEnabled
-
- Type: boolean
Whether the field can be used to sort the search results.
- SourceField
-
- Type: string
The name of the source field to map to the field.
Expression
Description
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.
Members
- ExpressionName
-
- Required: Yes
- Type: string
Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
- ExpressionValue
-
- Required: Yes
- Type: string
The expression to evaluate for sorting while processing a search request. The
Expression
syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
ExpressionStatus
Description
The value of an Expression
and its current status.
Members
- Options
-
- Required: Yes
- Type: Expression structure
The expression that is evaluated for sorting while processing a search request.
- Status
-
- Required: Yes
- Type: OptionStatus structure
The status of domain configuration option.
IndexDocumentsResponse
Description
The result of an IndexDocuments
request. Contains the status of the indexing operation, including the fields being indexed.
Members
- FieldNames
-
- Type: Array of strings
The names of the fields that are currently being indexed.
IndexField
Description
Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType
.
Members
- DateArrayOptions
-
- Type: DateArrayOptions structure
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. - DateOptions
-
- Type: DateOptions structure
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. - DoubleArrayOptions
-
- Type: DoubleArrayOptions structure
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. - DoubleOptions
-
- Type: DoubleOptions structure
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. - IndexFieldName
-
- Required: Yes
- Type: string
A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name
score
is reserved and cannot be used as a field name. To reference a document's ID, you can use the name_id
. - IndexFieldType
-
- Required: Yes
- Type: string
The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
- IntArrayOptions
-
- Type: IntArrayOptions structure
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
-
- Type: IntOptions structure
Options for a 64-bit signed integer field. Present if
IndexFieldType
specifies the field is of typeint
. All options are enabled by default. - LatLonOptions
-
- Type: LatLonOptions structure
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. - LiteralArrayOptions
-
- Type: LiteralArrayOptions structure
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. - LiteralOptions
-
- Type: LiteralOptions structure
Options for literal field. Present if
IndexFieldType
specifies the field is of typeliteral
. All options are enabled by default. - TextArrayOptions
-
- Type: TextArrayOptions structure
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. - TextOptions
-
- Type: TextOptions structure
Options for text field. Present if
IndexFieldType
specifies the field is of typetext
. Atext
field is always searchable. All options are enabled by default.
IndexFieldStatus
Description
The value of an IndexField
and its current status.
Members
- Options
-
- Required: Yes
- Type: IndexField structure
Configuration information for a field in the index, including its name, type, and options. The supported options depend on the
IndexFieldType
. - Status
-
- Required: Yes
- Type: OptionStatus structure
The status of domain configuration option.
IntArrayOptions
Description
Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType
specifies the field is of type int-array
. All options are enabled by default.
Members
- DefaultValue
-
- Type: long (int|float)
A value to use for the field if the field isn't specified for a document. - FacetEnabled
-
- Type: boolean
Whether facet information can be returned for the field.
- ReturnEnabled
-
- Type: boolean
Whether the contents of the field can be returned in the search results.
- SearchEnabled
-
- Type: boolean
Whether the contents of the field are searchable.
- SourceFields
-
- Type: string
A list of source fields to map to the field.
IntOptions
Description
Options for a 64-bit signed integer field. Present if IndexFieldType
specifies the field is of type int
. All options are enabled by default.
Members
- DefaultValue
-
- Type: long (int|float)
A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document. - FacetEnabled
-
- Type: boolean
Whether facet information can be returned for the field.
- ReturnEnabled
-
- Type: boolean
Whether the contents of the field can be returned in the search results.
- SearchEnabled
-
- Type: boolean
Whether the contents of the field are searchable.
- SortEnabled
-
- Type: boolean
Whether the field can be used to sort the search results.
- SourceField
-
- Type: string
The name of the source field to map to the field.
InternalException
Description
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
Members
InvalidTypeException
Description
The request was rejected because it specified an invalid type definition.
Members
LatLonOptions
Description
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 type latlon
. All options are enabled by default.
Members
- DefaultValue
-
- Type: string
A value to use for the field if the field isn't specified for a document. - FacetEnabled
-
- Type: boolean
Whether facet information can be returned for the field.
- ReturnEnabled
-
- Type: boolean
Whether the contents of the field can be returned in the search results.
- SearchEnabled
-
- Type: boolean
Whether the contents of the field are searchable.
- SortEnabled
-
- Type: boolean
Whether the field can be used to sort the search results.
- SourceField
-
- Type: string
A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name
score
is reserved and cannot be used as a field name. To reference a document's ID, you can use the name_id
.
LimitExceededException
Description
The request was rejected because a resource limit has already been met.
Members
Limits
Members
- MaximumPartitionCount
-
- Required: Yes
- Type: int
- MaximumReplicationCount
-
- Required: Yes
- Type: int
ListDomainNamesResponse
Description
The result of a ListDomainNames
request. Contains a list of the domains owned by an account.
Members
- DomainNames
-
- Type: Associative array of custom strings keys (DomainName) to strings
The names of the search domains owned by an account.
LiteralArrayOptions
Description
Options for a field that contains an array of literal strings. Present if IndexFieldType
specifies the field is of type literal-array
. All options are enabled by default.
Members
- DefaultValue
-
- Type: string
A value to use for the field if the field isn't specified for a document. - FacetEnabled
-
- Type: boolean
Whether facet information can be returned for the field.
- ReturnEnabled
-
- Type: boolean
Whether the contents of the field can be returned in the search results.
- SearchEnabled
-
- Type: boolean
Whether the contents of the field are searchable.
- SourceFields
-
- Type: string
A list of source fields to map to the field.
LiteralOptions
Description
Options for literal field. Present if IndexFieldType
specifies the field is of type literal
. All options are enabled by default.
Members
- DefaultValue
-
- Type: string
A value to use for the field if the field isn't specified for a document. - FacetEnabled
-
- Type: boolean
Whether facet information can be returned for the field.
- ReturnEnabled
-
- Type: boolean
Whether the contents of the field can be returned in the search results.
- SearchEnabled
-
- Type: boolean
Whether the contents of the field are searchable.
- SortEnabled
-
- Type: boolean
Whether the field can be used to sort the search results.
- SourceField
-
- Type: string
A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name
score
is reserved and cannot be used as a field name. To reference a document's ID, you can use the name_id
.
OptionStatus
Description
The status of domain configuration option.
Members
- CreationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp for when this option was created.
- PendingDeletion
-
- Type: boolean
Indicates that the option will be deleted once processing is complete.
- State
-
- Required: Yes
- Type: string
The state of processing a change to an option. Possible values:
RequiresIndexDocuments
: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.Processing
: the option's latest value is in the process of being activated.Active
: the option's latest value is completely deployed.FailedToValidate
: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
- UpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp for when this option was last updated.
- UpdateVersion
-
- Type: int
A unique integer that indicates when this option was last updated.
ResourceAlreadyExistsException
Description
The request was rejected because it attempted to create a resource that already exists.
Members
ResourceNotFoundException
Description
The request was rejected because it attempted to reference a resource that does not exist.
Members
ScalingParameters
Description
The desired instance type and desired number of replicas of each index partition.
Members
- DesiredInstanceType
-
- Type: string
The instance type that you want to preconfigure for your domain. For example,
search.m1.small
. - DesiredPartitionCount
-
- Type: int
The number of partitions you want to preconfigure for your domain. Only valid when you select
m2.2xlarge
as the desired instance type. - DesiredReplicationCount
-
- Type: int
The number of replicas you want to preconfigure for each index partition.
ScalingParametersStatus
Description
The status and configuration of a search domain's scaling parameters.
Members
- Options
-
- Required: Yes
- Type: ScalingParameters structure
The desired instance type and desired number of replicas of each index partition.
- Status
-
- Required: Yes
- Type: OptionStatus structure
The status of domain configuration option.
ServiceEndpoint
Description
The endpoint to which service requests can be submitted.
Members
- Endpoint
-
- Type: string
The endpoint to which service requests can be submitted. For example,
search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
ordoc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
.
Suggester
Description
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
.
Members
- DocumentSuggesterOptions
-
- Required: Yes
- Type: DocumentSuggesterOptions structure
Options for a search suggester.
- SuggesterName
-
- Required: Yes
- Type: string
Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
SuggesterStatus
Description
The value of a Suggester
and its current status.
Members
- Options
-
- Required: Yes
- Type: Suggester structure
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
. - Status
-
- Required: Yes
- Type: OptionStatus structure
The status of domain configuration option.
TextArrayOptions
Description
Options for a field that contains an array of text strings. Present if IndexFieldType
specifies the field is of type text-array
. A text-array
field is always searchable. All options are enabled by default.
Members
- AnalysisScheme
-
- Type: string
The name of an analysis scheme for a
text-array
field. - DefaultValue
-
- Type: string
A value to use for the field if the field isn't specified for a document. - HighlightEnabled
-
- Type: boolean
Whether highlights can be returned for the field.
- ReturnEnabled
-
- Type: boolean
Whether the contents of the field can be returned in the search results.
- SourceFields
-
- Type: string
A list of source fields to map to the field.
TextOptions
Description
Options for text field. Present if IndexFieldType
specifies the field is of type text
. A text
field is always searchable. All options are enabled by default.
Members
- AnalysisScheme
-
- Type: string
The name of an analysis scheme for a
text
field. - DefaultValue
-
- Type: string
A value to use for the field if the field isn't specified for a document. - HighlightEnabled
-
- Type: boolean
Whether highlights can be returned for the field.
- ReturnEnabled
-
- Type: boolean
Whether the contents of the field can be returned in the search results.
- SortEnabled
-
- Type: boolean
Whether the field can be used to sort the search results.
- SourceField
-
- Type: string
A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name
score
is reserved and cannot be used as a field name. To reference a document's ID, you can use the name_id
.
UpdateAvailabilityOptionsResponse
Description
The result of a UpdateAvailabilityOptions
request. Contains the status of the domain's availability options.
Members
- AvailabilityOptions
-
- Type: AvailabilityOptionsStatus structure
The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.
UpdateDomainEndpointOptionsResponse
Description
The result of a UpdateDomainEndpointOptions
request. Contains the configuration and status of the domain's endpoint options.
Members
- DomainEndpointOptions
-
- Type: DomainEndpointOptionsStatus structure
The newly-configured domain endpoint options.
UpdateScalingParametersResponse
Description
The result of a UpdateScalingParameters
request. Contains the status of the newly-configured scaling parameters.
Members
- ScalingParameters
-
- Required: Yes
- Type: ScalingParametersStatus structure
The status and configuration of a search domain's scaling parameters.
UpdateServiceAccessPoliciesResponse
Description
The result of an UpdateServiceAccessPolicies
request. Contains the new access policies.
Members
- AccessPolicies
-
- Required: Yes
- Type: AccessPoliciesStatus structure
The access rules configured for the domain.
ValidationException
Description
The request was rejected because it has invalid parameters.