{
"api_version": "2013-01-01",
"type": "query",
"result_wrapped": true,
"signature_version": "v4",
"service_full_name": "Amazon CloudSearch",
"endpoint_prefix": "cloudsearch",
"xmlnamespace": "http://cloudsearch.amazonaws.com/doc/2013-01-01/",
"documentation": "\n
You use the Amazon CloudSearch configuration service to create, configure, and manage search domains.\n Configuration service requests are submitted using the AWS Query protocol. AWS Query requests\n are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.
\nThe endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com.\n For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints,\n see Regions and Endpoints.
\n ", "operations": { "BuildSuggesters": { "name": "BuildSuggesters", "input": { "shape_name": "BuildSuggestersRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\nA 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).
\n ", "required": true } }, "documentation": "\nContainer for the parameters to the BuildSuggester
operation. Specifies the name of the domain you want to update.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
A list of field names.
\n " } }, "documentation": "\nThe result of a BuildSuggester
request. Contains a list of the fields used for suggestions.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nIndexes the search suggestions.
\n " }, "CreateDomain": { "name": "CreateDomain", "input": { "shape_name": "CreateDomainRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\nA 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.
\n ", "required": true } }, "documentation": "\nContainer for the parameters to the CreateDomain
operation. Specifies a name for the new search domain.
An internally generated unique identifier for a domain.
\n ", "required": true }, "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\nA 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).
\n ", "required": true }, "ARN": { "shape_name": "ARN", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
\n " }, "Created": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nTrue 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.
\n " }, "Deleted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nTrue 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.
\n " }, "DocService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\nThe endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
.
The service endpoint for updating documents in a search domain.
\n " }, "SearchService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\nThe endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
.
The service endpoint for requesting search results from a search domain.
\n " }, "RequiresIndexDocuments": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nTrue if IndexDocuments needs to be called to activate the current domain configuration.
\n ", "required": true }, "Processing": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nTrue if processing is being done to activate the current domain configuration.
\n " }, "SearchInstanceType": { "shape_name": "SearchInstanceType", "type": "string", "documentation": "\nThe instance type that is being used to process search requests.
\n " }, "SearchPartitionCount": { "shape_name": "PartitionCount", "type": "integer", "min_length": 1, "documentation": "\nThe number of partitions across which the search index is spread.
\n " }, "SearchInstanceCount": { "shape_name": "InstanceCount", "type": "integer", "min_length": 1, "documentation": "\nThe number of search instances that are available to process search requests.
\n " } }, "documentation": "\nThe current status of the search domain.
\n " } }, "documentation": "\nThe result of a CreateDomainRequest
. Contains the status of a newly created domain.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because a resource limit has already been met.
\n " } ], "documentation": "\nCreates a new search domain. For more information,\n see Creating a Search Domain in the Amazon CloudSearch Developer Guide.
\n " }, "DefineAnalysisScheme": { "name": "DefineAnalysisScheme", "input": { "shape_name": "DefineAnalysisSchemeRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\nA 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).
\n ", "required": true }, "AnalysisScheme": { "shape_name": "AnalysisScheme", "type": "structure", "members": { "AnalysisSchemeName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nA string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
An IETF RFC 4646 language code or mul
for multiple languages.
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.
\n " }, "Stopwords": { "shape_name": "String", "type": "string", "documentation": "\nA 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.
\n " }, "StemmingDictionary": { "shape_name": "String", "type": "string", "documentation": "\nA 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.
\n " }, "AlgorithmicStemming": { "shape_name": "AlgorithmicStemming", "type": "string", "enum": [ "none", "minimal", "light", "full" ], "documentation": "\nThe level of algorithmic stemming to perform: none
, minimal
, light
, or full
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide
Synonyms, stopwords, and stemming options for an analysis scheme.
\n " } }, "documentation": "\nConfiguration 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
, and AlgorithmicStemming
.
Container for the parameters to the DefineAnalysisScheme
operation. Specifies the name of the domain you want to update and the analysis scheme configuration.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
An IETF RFC 4646 language code or mul
for multiple languages.
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.
\n " }, "Stopwords": { "shape_name": "String", "type": "string", "documentation": "\nA 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.
\n " }, "StemmingDictionary": { "shape_name": "String", "type": "string", "documentation": "\nA 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.
\n " }, "AlgorithmicStemming": { "shape_name": "AlgorithmicStemming", "type": "string", "enum": [ "none", "minimal", "light", "full" ], "documentation": "\nThe level of algorithmic stemming to perform: none
, minimal
, light
, or full
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide
Synonyms, stopwords, and stemming options for an analysis scheme.
\n " } }, "documentation": "\nConfiguration 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
, and AlgorithmicStemming
.
A timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe status and configuration of an AnalysisScheme
.
The result of a DefineAnalysisScheme
request. Contains the status of the newly-configured analysis scheme.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because a resource limit has already been met.
\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it specified an invalid type definition.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nConfigures an analysis scheme for a domain. An analysis scheme defines language-specific text processing options for a text
field. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
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).
\n ", "required": true }, "Expression": { "shape_name": "Expression", "type": "structure", "members": { "ExpressionName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nA string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
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.
A named expression that can be evaluated at search time. Can be used for sorting and filtering search results and constructing other expressions.
\n ", "required": true } }, "documentation": "\nContainer for the parameters to the DefineExpression
operation. Specifies the name of the domain you want to update and the expression you want to configure.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
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.
The expression that is evaluated for sorting or filtering while processing a search request.
\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe value of an Expression
and its current status.
The result of a DefineExpression
request. Contains the status of the newly-configured expression.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because a resource limit has already been met.
\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it specified an invalid type definition.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nConfigures 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.
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).
\n ", "required": true }, "IndexField": { "shape_name": "IndexField", "type": "structure", "members": { "IndexFieldName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of a field in the search index. Field names must begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The name \"score\" is reserved and cannot be specified as field or expression name.
\n ", "required": true }, "IndexFieldType": { "shape_name": "IndexFieldType", "type": "string", "enum": [ "int", "double", "literal", "text", "date", "latlon", "int-array", "double-array", "literal-array", "text-array", "date-array" ], "documentation": "\nThe 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.
\n ", "required": true }, "IntOptions": { "shape_name": "IntOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "Long", "type": "long", "documentation": "\n 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.\n " }, "SourceField": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the source field to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions for a 64-bit signed integer field. Present if IndexFieldType
specifies the field is of type int
. All options are enabled by default.
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.
\n " }, "SourceField": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the source field to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions 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.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions for literal field. Present if IndexFieldType
specifies the field is of type literal
. All options are enabled by default.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " }, "HighlightEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether highlights can be returned for the field.
\n " }, "AnalysisScheme": { "shape_name": "Word", "type": "string", "pattern": "[\\S]+", "documentation": "\nThe name of an analysis scheme for a text
field.
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.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions 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.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "HighlightEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether highlights can be returned for the field.
\n " }, "AnalysisScheme": { "shape_name": "Word", "type": "string", "pattern": "[\\S]+", "documentation": "\nThe name of an analysis scheme for a text-array
field.
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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
The index field and field options you want to configure.
\n ", "required": true } }, "documentation": "\nContainer for the parameters to the DefineIndexField
operation. Specifies the name of the domain you want to update and the index field configuration.
The name of a field in the search index. Field names must begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The name \"score\" is reserved and cannot be specified as field or expression name.
\n ", "required": true }, "IndexFieldType": { "shape_name": "IndexFieldType", "type": "string", "enum": [ "int", "double", "literal", "text", "date", "latlon", "int-array", "double-array", "literal-array", "text-array", "date-array" ], "documentation": "\nThe 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.
\n ", "required": true }, "IntOptions": { "shape_name": "IntOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "Long", "type": "long", "documentation": "\n 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.\n " }, "SourceField": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the source field to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions for a 64-bit signed integer field. Present if IndexFieldType
specifies the field is of type int
. All options are enabled by default.
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.
\n " }, "SourceField": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the source field to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions 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.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions for literal field. Present if IndexFieldType
specifies the field is of type literal
. All options are enabled by default.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " }, "HighlightEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether highlights can be returned for the field.
\n " }, "AnalysisScheme": { "shape_name": "Word", "type": "string", "pattern": "[\\S]+", "documentation": "\nThe name of an analysis scheme for a text
field.
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.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions 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.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "HighlightEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether highlights can be returned for the field.
\n " }, "AnalysisScheme": { "shape_name": "Word", "type": "string", "pattern": "[\\S]+", "documentation": "\nThe name of an analysis scheme for a text-array
field.
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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType
.
A timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe value of an IndexField
and its current status.
The result of a DefineIndexField
request. Contains the status of the newly-configured index field.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because a resource limit has already been met.
\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it specified an invalid type definition.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nConfigures 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.
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).
\n ", "required": true }, "Suggester": { "shape_name": "Suggester", "type": "structure", "members": { "SuggesterName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nA string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
The name of the index field you want to use for suggestions.\n
\n ", "required": true }, "FuzzyMatching": { "shape_name": "SuggesterFuzzyMatching", "type": "string", "enum": [ "none", "low", "high" ], "documentation": "\nThe level of fuzziness allowed when suggesting matches for a string: none
, low
, or high
. 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.
An expression that computes a score for each suggestion to control how they are sorted.
\n " } }, "documentation": "\nOptions for a search suggester.
\n ", "required": true } }, "documentation": "\nConfiguration 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
.
Container for the parameters to the DefineSuggester
operation. Specifies the name of the domain you want to update and the suggester configuration.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
The name of the index field you want to use for suggestions.\n
\n ", "required": true }, "FuzzyMatching": { "shape_name": "SuggesterFuzzyMatching", "type": "string", "enum": [ "none", "low", "high" ], "documentation": "\nThe level of fuzziness allowed when suggesting matches for a string: none
, low
, or high
. 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.
An expression that computes a score for each suggestion to control how they are sorted.
\n " } }, "documentation": "\nOptions for a search suggester.
\n ", "required": true } }, "documentation": "\nConfiguration 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
.
A timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe value of a Suggester
and its current status.
The result of a DefineSuggester
request. Contains the status of the newly-configured suggester.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because a resource limit has already been met.
\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it specified an invalid type definition.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nConfigures 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.
\n " }, "DeleteAnalysisScheme": { "name": "DeleteAnalysisScheme", "input": { "shape_name": "DeleteAnalysisSchemeRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\nA 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).
\n ", "required": true }, "AnalysisSchemeName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the analysis scheme you want to delete.
\n ", "required": true } }, "documentation": "\nContainer for the parameters to the DeleteAnalysisScheme
operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
An IETF RFC 4646 language code or mul
for multiple languages.
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.
\n " }, "Stopwords": { "shape_name": "String", "type": "string", "documentation": "\nA 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.
\n " }, "StemmingDictionary": { "shape_name": "String", "type": "string", "documentation": "\nA 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.
\n " }, "AlgorithmicStemming": { "shape_name": "AlgorithmicStemming", "type": "string", "enum": [ "none", "minimal", "light", "full" ], "documentation": "\nThe level of algorithmic stemming to perform: none
, minimal
, light
, or full
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide
Synonyms, stopwords, and stemming options for an analysis scheme.
\n " } }, "documentation": "\nConfiguration 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
, and AlgorithmicStemming
.
A timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe status of the analysis scheme being deleted.
\n ", "required": true } }, "documentation": "\nThe result of a DeleteAnalysisScheme
request. Contains the status of the deleted analysis scheme.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it specified an invalid type definition.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nDeletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
\n " }, "DeleteDomain": { "name": "DeleteDomain", "input": { "shape_name": "DeleteDomainRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\nThe name of the domain you want to permanently delete.
\n ", "required": true } }, "documentation": "\nContainer for the parameters to the DeleteDomain
operation. Specifies the name of the domain you want to delete.
An internally generated unique identifier for a domain.
\n ", "required": true }, "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\nA 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).
\n ", "required": true }, "ARN": { "shape_name": "ARN", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
\n " }, "Created": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nTrue 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.
\n " }, "Deleted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nTrue 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.
\n " }, "DocService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\nThe endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
.
The service endpoint for updating documents in a search domain.
\n " }, "SearchService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\nThe endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
.
The service endpoint for requesting search results from a search domain.
\n " }, "RequiresIndexDocuments": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nTrue if IndexDocuments needs to be called to activate the current domain configuration.
\n ", "required": true }, "Processing": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nTrue if processing is being done to activate the current domain configuration.
\n " }, "SearchInstanceType": { "shape_name": "SearchInstanceType", "type": "string", "documentation": "\nThe instance type that is being used to process search requests.
\n " }, "SearchPartitionCount": { "shape_name": "PartitionCount", "type": "integer", "min_length": 1, "documentation": "\nThe number of partitions across which the search index is spread.
\n " }, "SearchInstanceCount": { "shape_name": "InstanceCount", "type": "integer", "min_length": 1, "documentation": "\nThe number of search instances that are available to process search requests.
\n " } }, "documentation": "\nThe current status of the search domain.
\n " } }, "documentation": "\nThe result of a DeleteDomain
request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " } ], "documentation": "\nPermanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information,\n see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.
\n " }, "DeleteExpression": { "name": "DeleteExpression", "input": { "shape_name": "DeleteExpressionRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\nA 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).
\n ", "required": true }, "ExpressionName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the Expression
to delete.
Container for the parameters to the DeleteExpression
operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
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.
The expression that is evaluated for sorting or filtering while processing a search request.
\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe status of the expression being deleted.
\n ", "required": true } }, "documentation": "\nThe result of a DeleteExpression
request. Specifies the expression being deleted.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it specified an invalid type definition.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nRemoves an Expression
from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
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).
\n ", "required": true }, "IndexFieldName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the index field your want to remove from the domain's indexing options.
\n ", "required": true } }, "documentation": "\nContainer for the parameters to the DeleteIndexField
operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.
The name of a field in the search index. Field names must begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The name \"score\" is reserved and cannot be specified as field or expression name.
\n ", "required": true }, "IndexFieldType": { "shape_name": "IndexFieldType", "type": "string", "enum": [ "int", "double", "literal", "text", "date", "latlon", "int-array", "double-array", "literal-array", "text-array", "date-array" ], "documentation": "\nThe 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.
\n ", "required": true }, "IntOptions": { "shape_name": "IntOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "Long", "type": "long", "documentation": "\n 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.\n " }, "SourceField": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the source field to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions for a 64-bit signed integer field. Present if IndexFieldType
specifies the field is of type int
. All options are enabled by default.
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.
\n " }, "SourceField": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the source field to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions 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.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions for literal field. Present if IndexFieldType
specifies the field is of type literal
. All options are enabled by default.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " }, "HighlightEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether highlights can be returned for the field.
\n " }, "AnalysisScheme": { "shape_name": "Word", "type": "string", "pattern": "[\\S]+", "documentation": "\nThe name of an analysis scheme for a text
field.
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.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions 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.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "HighlightEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether highlights can be returned for the field.
\n " }, "AnalysisScheme": { "shape_name": "Word", "type": "string", "pattern": "[\\S]+", "documentation": "\nThe name of an analysis scheme for a text-array
field.
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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType
.
A timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe status of the index field being deleted.
\n ", "required": true } }, "documentation": "\nThe result of a DeleteIndexField
request.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it specified an invalid type definition.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nRemoves an IndexField
from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
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).
\n ", "required": true }, "SuggesterName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nSpecifies the name of the suggester you want to delete.
\n ", "required": true } }, "documentation": "\nContainer for the parameters to the DeleteSuggester
operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
The name of the index field you want to use for suggestions.\n
\n ", "required": true }, "FuzzyMatching": { "shape_name": "SuggesterFuzzyMatching", "type": "string", "enum": [ "none", "low", "high" ], "documentation": "\nThe level of fuzziness allowed when suggesting matches for a string: none
, low
, or high
. 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.
An expression that computes a score for each suggestion to control how they are sorted.
\n " } }, "documentation": "\nOptions for a search suggester.
\n ", "required": true } }, "documentation": "\nConfiguration 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
.
A timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe status of the suggester being deleted.
\n ", "required": true } }, "documentation": "\nThe result of a DeleteSuggester
request. Contains the status of the deleted suggester.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it specified an invalid type definition.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nDeletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
\n " }, "DescribeAnalysisSchemes": { "name": "DescribeAnalysisSchemes", "input": { "shape_name": "DescribeAnalysisSchemesRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\nThe name of the domain you want to describe.
\n ", "required": true }, "AnalysisSchemeNames": { "shape_name": "FieldNameList", "type": "list", "members": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nA string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
The analysis schemes you want to describe.
\n " }, "Deployed": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether to display the deployed configuration (true
) or include any pending changes (false
). Defaults to false
.
Container for the parameters to the DescribeAnalysisSchemes
operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed
option to true
.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
An IETF RFC 4646 language code or mul
for multiple languages.
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.
\n " }, "Stopwords": { "shape_name": "String", "type": "string", "documentation": "\nA 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.
\n " }, "StemmingDictionary": { "shape_name": "String", "type": "string", "documentation": "\nA 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.
\n " }, "AlgorithmicStemming": { "shape_name": "AlgorithmicStemming", "type": "string", "enum": [ "none", "minimal", "light", "full" ], "documentation": "\nThe level of algorithmic stemming to perform: none
, minimal
, light
, or full
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide
Synonyms, stopwords, and stemming options for an analysis scheme.
\n " } }, "documentation": "\nConfiguration 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
, and AlgorithmicStemming
.
A timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe status and configuration of an AnalysisScheme
.
The analysis scheme descriptions.
\n ", "required": true } }, "documentation": "\nThe result of a DescribeAnalysisSchemes
request. Contains the analysis schemes configured for the domain specified in the request.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nGets 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.
The name of the domain you want to describe.
\n ", "required": true }, "Deployed": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether to display the deployed configuration (true
) or include any pending changes (false
). Defaults to false
.
Container for the parameters to the DescribeAvailabilityOptions
operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true
.
The availability options configured for the domain.
\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.
\n " } }, "documentation": "\nThe result of a DescribeAvailabilityOptions
request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it specified an invalid type definition.
\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because a resource limit has already been met.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " }, { "shape_name": "DisabledOperationException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted an operation which is not enabled.
\n " } ], "documentation": "\nGets 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.
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).
\n " }, "documentation": "\nThe names of the domains you want to include in the response.
\n " } }, "documentation": "\nContainer for the parameters to the DescribeDomains
operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.
An internally generated unique identifier for a domain.
\n ", "required": true }, "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\nA 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).
\n ", "required": true }, "ARN": { "shape_name": "ARN", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
\n " }, "Created": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nTrue 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.
\n " }, "Deleted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nTrue 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.
\n " }, "DocService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\nThe endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
.
The service endpoint for updating documents in a search domain.
\n " }, "SearchService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\nThe endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com
.
The service endpoint for requesting search results from a search domain.
\n " }, "RequiresIndexDocuments": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nTrue if IndexDocuments needs to be called to activate the current domain configuration.
\n ", "required": true }, "Processing": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nTrue if processing is being done to activate the current domain configuration.
\n " }, "SearchInstanceType": { "shape_name": "SearchInstanceType", "type": "string", "documentation": "\nThe instance type that is being used to process search requests.
\n " }, "SearchPartitionCount": { "shape_name": "PartitionCount", "type": "integer", "min_length": 1, "documentation": "\nThe number of partitions across which the search index is spread.
\n " }, "SearchInstanceCount": { "shape_name": "InstanceCount", "type": "integer", "min_length": 1, "documentation": "\nThe number of search instances that are available to process search requests.
\n " } }, "documentation": "\nThe current status of the search domain.
\n " }, "documentation": "\nA list that contains the status of each requested domain.
\n ", "required": true } }, "documentation": "\nThe result of a DescribeDomains
request. Contains the status of the domains specified in the request or all domains owned by the account.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " } ], "documentation": "\nGets information about the search domains owned by this account. Can be limited to specific domains. Shows\n 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,\n see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.
The name of the domain you want to describe.
\n ", "required": true }, "ExpressionNames": { "shape_name": "FieldNameList", "type": "list", "members": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nA string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Limits the DescribeExpressions
response to the specified expressions. If not specified, all expressions are shown.
Whether to display the deployed configuration (true
) or include any pending changes (false
). Defaults to false
.
Container for the parameters to the DescribeDomains
operation.\n Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed
option to true
.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
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.
The expression that is evaluated for sorting or filtering while processing a search request.
\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe value of an Expression
and its current status.
The expressions configured for the domain.
\n ", "required": true } }, "documentation": "\nThe result of a DescribeExpressions
request. Contains the expressions configured for the domain specified in the request.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nGets 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.
The name of the domain you want to describe.
\n ", "required": true }, "FieldNames": { "shape_name": "FieldNameList", "type": "list", "members": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nA string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.
\n " }, "Deployed": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether to display the deployed configuration (true
) or include any pending changes (false
). Defaults to false
.
Container for the parameters to the DescribeIndexFields
operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed
option to true
.
The name of a field in the search index. Field names must begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The name \"score\" is reserved and cannot be specified as field or expression name.
\n ", "required": true }, "IndexFieldType": { "shape_name": "IndexFieldType", "type": "string", "enum": [ "int", "double", "literal", "text", "date", "latlon", "int-array", "double-array", "literal-array", "text-array", "date-array" ], "documentation": "\nThe 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.
\n ", "required": true }, "IntOptions": { "shape_name": "IntOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "Long", "type": "long", "documentation": "\n 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.\n " }, "SourceField": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the source field to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions for a 64-bit signed integer field. Present if IndexFieldType
specifies the field is of type int
. All options are enabled by default.
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.
\n " }, "SourceField": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the source field to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions 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.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions for literal field. Present if IndexFieldType
specifies the field is of type literal
. All options are enabled by default.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " }, "HighlightEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether highlights can be returned for the field.
\n " }, "AnalysisScheme": { "shape_name": "Word", "type": "string", "pattern": "[\\S]+", "documentation": "\nThe name of an analysis scheme for a text
field.
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.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions 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.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
Whether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "SortEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the field can be used to sort the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
A list of source fields to map to the field.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " }, "HighlightEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether highlights can be returned for the field.
\n " }, "AnalysisScheme": { "shape_name": "Word", "type": "string", "pattern": "[\\S]+", "documentation": "\nThe name of an analysis scheme for a text-array
field.
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.
A list of source fields to map to the field.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether facet information can be returned for the field.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field are searchable.
\n " }, "ReturnEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether the contents of the field can be returned in the search results.
\n " } }, "documentation": "\nOptions 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.
Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType
.
A timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe value of an IndexField
and its current status.
The index fields configured for the domain.
\n ", "required": true } }, "documentation": "\nThe result of a DescribeIndexFields
request. Contains the index fields configured for the domain specified in the request.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nGets information about the index fields configured for the search domain.\n 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,\n see Getting Domain Information in the Amazon CloudSearch Developer Guide.
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).
\n ", "required": true } }, "documentation": "\nContainer for the parameters to the DescribeScalingParameters
operation. Specifies the name of the domain you want to describe.
The instance type that you want to preconfigure for your domain. For example, search.m1.small
.
The number of replicas you want to preconfigure for each index partition.
\n " }, "DesiredPartitionCount": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nThe number of partitions you want to preconfigure for your domain. Only valid when\n you select m2.2xlarge
as the desired instance type.
The desired instance type and desired number of replicas of each index partition.
\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe status and configuration of a search domain's scaling parameters.
\n ", "required": true } }, "documentation": "\nThe result of a DescribeScalingParameters
request. Contains the scaling parameters configured for the domain specified in the request.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nGets 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.
\n " }, "DescribeServiceAccessPolicies": { "name": "DescribeServiceAccessPolicies", "input": { "shape_name": "DescribeServiceAccessPoliciesRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\nThe name of the domain you want to describe.
\n ", "required": true }, "Deployed": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether to display the deployed configuration (true
) or include any pending changes (false
). Defaults to false
.
Container for the parameters to the DescribeServiceAccessPolicies
operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed
option to true
.
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.
\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe access rules configured for the domain specified in the request.
\n ", "required": true } }, "documentation": "\nThe result of a DescribeServiceAccessPolicies
request.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nGets 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,\n see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.
The name of the domain you want to describe.
\n ", "required": true }, "SuggesterNames": { "shape_name": "FieldNameList", "type": "list", "members": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nA string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
The suggesters you want to describe.
\n " }, "Deployed": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhether to display the deployed configuration (true
) or include any pending changes (false
). Defaults to false
.
Container for the parameters to the DescribeSuggester
operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed
option to true
.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
The name of the index field you want to use for suggestions.\n
\n ", "required": true }, "FuzzyMatching": { "shape_name": "SuggesterFuzzyMatching", "type": "string", "enum": [ "none", "low", "high" ], "documentation": "\nThe level of fuzziness allowed when suggesting matches for a string: none
, low
, or high
. 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.
An expression that computes a score for each suggestion to control how they are sorted.
\n " } }, "documentation": "\nOptions for a search suggester.
\n ", "required": true } }, "documentation": "\nConfiguration 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
.
A timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe value of a Suggester
and its current status.
The suggesters configured for the domain specified in the request.
\n ", "required": true } }, "documentation": "\nThe result of a DescribeSuggesters
request.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nGets 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.
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).
\n ", "required": true } }, "documentation": "\nContainer for the parameters to the IndexDocuments
operation. Specifies the name of the domain you want to re-index.
A string that represents the name of an index field. Field names begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). 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
.
The names of the fields that are currently being indexed.
\n " } }, "documentation": "\nThe result of an IndexDocuments
request. Contains the status of the indexing operation, including the fields being indexed.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " } ], "documentation": "\nTells 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
.
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).
\n " }, "members": { "shape_name": "APIVersion", "type": "string", "documentation": "\nThe Amazon CloudSearch API version for a domain: 2011-02-01 or 2013-01-01.
\n " }, "documentation": "\nThe names of the search domains owned by an account.
\n " } }, "documentation": "\nThe result of a ListDomainNames
request. Contains a list of the domains owned by an account.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " } ], "documentation": "\nLists all search domains owned by an account.
\n " }, "UpdateAvailabilityOptions": { "name": "UpdateAvailabilityOptions", "input": { "shape_name": "UpdateAvailabilityOptionsRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\nA 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).
\n ", "required": true }, "MultiAZ": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nYou 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
.
Container for the parameters to the UpdateAvailabilityOptions
operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.
The availability options configured for the domain.
\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.
\n " } }, "documentation": "\nThe result of a UpdateAvailabilityOptions
request. Contains the status of the domain's availability options.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it specified an invalid type definition.
\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because a resource limit has already been met.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " }, { "shape_name": "DisabledOperationException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted an operation which is not enabled.
\n " } ], "documentation": "\nConfigures 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.
\n " }, "UpdateScalingParameters": { "name": "UpdateScalingParameters", "input": { "shape_name": "UpdateScalingParametersRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\nA 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).
\n ", "required": true }, "ScalingParameters": { "shape_name": "ScalingParameters", "type": "structure", "members": { "DesiredInstanceType": { "shape_name": "PartitionInstanceType", "type": "string", "enum": [ "search.m1.small", "search.m1.large", "search.m2.xlarge", "search.m2.2xlarge" ], "documentation": "\nThe instance type that you want to preconfigure for your domain. For example, search.m1.small
.
The number of replicas you want to preconfigure for each index partition.
\n " }, "DesiredPartitionCount": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nThe number of partitions you want to preconfigure for your domain. Only valid when\n you select m2.2xlarge
as the desired instance type.
The desired instance type and desired number of replicas of each index partition.
\n ", "required": true } }, "documentation": "\nContainer for the parameters to the UpdateScalingParameters
operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.
The instance type that you want to preconfigure for your domain. For example, search.m1.small
.
The number of replicas you want to preconfigure for each index partition.
\n " }, "DesiredPartitionCount": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nThe number of partitions you want to preconfigure for your domain. Only valid when\n you select m2.2xlarge
as the desired instance type.
The desired instance type and desired number of replicas of each index partition.
\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe status and configuration of a search domain's scaling parameters.
\n ", "required": true } }, "documentation": "\nThe result of a UpdateScalingParameters
request. Contains the status of the newly-configured scaling parameters.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because a resource limit has already been met.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it specified an invalid type definition.
\n " } ], "documentation": "\nConfigures 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.
\n " }, "UpdateServiceAccessPolicies": { "name": "UpdateServiceAccessPolicies", "input": { "shape_name": "UpdateServiceAccessPoliciesRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\nA 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).
\n ", "required": true }, "AccessPolicies": { "shape_name": "PolicyDocument", "type": "string", "documentation": "\nThe access rules you want to configure. These rules replace any existing rules.
\n ", "required": true } }, "documentation": "\nContainer for the parameters to the UpdateServiceAccessPolicies
operation. Specifies the name of the domain you want to update and the access rules you want to configure.
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.
\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was created.
\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\nA timestamp for when this option was last updated.
\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nA unique integer that indicates when this option was last updated.
\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments
: 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.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of domain configuration option.
\n ", "required": true } }, "documentation": "\nThe access rules configured for the domain.
\n ", "required": true } }, "documentation": "\nThe result of an UpdateServiceAccessPolicies
request. Contains the new access policies.
A machine-parsable string error or warning code.
\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\nA human-readable string error or warning message.
\n " } }, "documentation": "\nAn error occurred while processing the request.
\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\nAn internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.
\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because a resource limit has already been met.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it attempted to reference a resource that does not exist.
\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\nThe request was rejected because it specified an invalid type definition.
\n " } ], "documentation": "\nConfigures the access rules that control access to the domain's document and search endpoints.\n For more information, see \n Configuring Access for an Amazon CloudSearch Domain.
\n " } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "request_limit_exceeded": { "applies_when": { "response": { "service_error_code": "BandwidthLimitExceeded", "http_status_code": 509 } } } } } } }