You use the Configuration Service to create, configure, and manage search domains. \n Amazon CloudSearch configuration requests are submitted to cloudsearch.us-east-1.amazonaws.com\n using the AWS Query protocol.
A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "CreateDomainResponse", "type": "structure", "members": { "DomainStatus": { "shape_name": "DomainStatus", "type": "structure", "members": { "DomainId": { "shape_name": "DomainId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\nAn 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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true }, "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 " }, "NumSearchableDocs": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nThe number of documents that have been submitted to the domain and indexed.
\n " }, "DocService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Arn": { "shape_name": "Arn", "type": "string", "documentation": "\nAn Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
\n " }, "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\nThe URL (including /version/pathPrefix) to which service requests can be submitted.
\n " } }, "documentation": "\nThe service endpoint for updating documents in a search domain.
\n " }, "SearchService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Arn": { "shape_name": "Arn", "type": "string", "documentation": "\nAn Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
\n " }, "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\nThe URL (including /version/pathPrefix) to which service requests can be submitted.
\n " } }, "documentation": "\nThe 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 (such as search.m1.small) 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 response message that contains the status of a newly created domain.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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": "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.
\n " }, "DefineIndexField": { "name": "DefineIndexField", "input": { "shape_name": "DefineIndexFieldRequest", "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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\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 names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.
\n ", "required": true }, "IndexFieldType": { "shape_name": "IndexFieldType", "type": "string", "enum": [ "uint", "literal", "text" ], "documentation": "\nThe type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.
\n ", "required": true }, "UIntOptions": { "shape_name": "UIntOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nThe default value for an unsigned integer field. Optional.
\n " } }, "documentation": "\nOptions for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.
The default value for a literal field. Optional.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether search is enabled for this field. Default: False.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether facets are enabled for this field. Default: False.
\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether values of this field can be returned in search results and used for ranking. Default: False.
\n " } }, "documentation": "\nOptions for literal field. Present if IndexFieldType specifies the field is of type literal.
The default value for a text field. Optional.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether facets are enabled for this field. Default: False.
\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether values of this field can be returned in search results and used for ranking. Default: False.
\n " }, "TextProcessor": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe text processor to apply to this field. Optional. Possible values:
\ncs_text_no_stemming: turns off stemming for the field.Default: none
\n " } }, "documentation": "\nOptions for text field. Present if IndexFieldType specifies the field is of type text.
Identifies the transformation to apply when copying data from a source attribute.
\n ", "required": true }, "SourceDataCopy": { "shape_name": "SourceData", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the document source field to add to this IndexField.
The default value to use if the source attribute is not specified in a document. Optional.
\n " } }, "documentation": "\nCopies data from a source document attribute to an IndexField.
The name of the document source field to add to this IndexField.
The default value to use if the source attribute is not specified in a document. Optional.
\n " }, "Separator": { "shape_name": "String", "type": "string", "documentation": "\nThe separator that follows the text to trim.
\n " }, "Language": { "shape_name": "Language", "type": "string", "pattern": "[a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*", "documentation": "\nAn IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.
\n " } }, "documentation": "\nTrims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.
The name of the document source field to add to this IndexField.
The default value to use if the source attribute is not specified in a document. Optional.
\n " }, "Cases": { "shape_name": "StringCaseMap", "type": "map", "keys": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\nThe value of a field or source document attribute.
\n " }, "members": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\nThe value of a field or source document attribute.
\n " }, "documentation": "\nA map that translates source field values to custom values.
\n " } }, "documentation": "\nMaps source document attribute values to new values when populating the IndexField.
Identifies the source data for an index field. An optional data transformation can be applied to the source data when populating the index field. By default, the value of the source attribute is copied to the index field.
\n " }, "documentation": "\nAn optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.
Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.
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 names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.
\n ", "required": true }, "IndexFieldType": { "shape_name": "IndexFieldType", "type": "string", "enum": [ "uint", "literal", "text" ], "documentation": "\nThe type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.
\n ", "required": true }, "UIntOptions": { "shape_name": "UIntOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nThe default value for an unsigned integer field. Optional.
\n " } }, "documentation": "\nOptions for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.
The default value for a literal field. Optional.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether search is enabled for this field. Default: False.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether facets are enabled for this field. Default: False.
\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether values of this field can be returned in search results and used for ranking. Default: False.
\n " } }, "documentation": "\nOptions for literal field. Present if IndexFieldType specifies the field is of type literal.
The default value for a text field. Optional.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether facets are enabled for this field. Default: False.
\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether values of this field can be returned in search results and used for ranking. Default: False.
\n " }, "TextProcessor": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe text processor to apply to this field. Optional. Possible values:
\ncs_text_no_stemming: turns off stemming for the field.Default: none
\n " } }, "documentation": "\nOptions for text field. Present if IndexFieldType specifies the field is of type text.
Identifies the transformation to apply when copying data from a source attribute.
\n ", "required": true }, "SourceDataCopy": { "shape_name": "SourceData", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the document source field to add to this IndexField.
The default value to use if the source attribute is not specified in a document. Optional.
\n " } }, "documentation": "\nCopies data from a source document attribute to an IndexField.
The name of the document source field to add to this IndexField.
The default value to use if the source attribute is not specified in a document. Optional.
\n " }, "Separator": { "shape_name": "String", "type": "string", "documentation": "\nThe separator that follows the text to trim.
\n " }, "Language": { "shape_name": "Language", "type": "string", "pattern": "[a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*", "documentation": "\nAn IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.
\n " } }, "documentation": "\nTrims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.
The name of the document source field to add to this IndexField.
The default value to use if the source attribute is not specified in a document. Optional.
\n " }, "Cases": { "shape_name": "StringCaseMap", "type": "map", "keys": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\nThe value of a field or source document attribute.
\n " }, "members": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\nThe value of a field or source document attribute.
\n " }, "documentation": "\nA map that translates source field values to custom values.
\n " } }, "documentation": "\nMaps source document attribute values to new values when populating the IndexField.
Identifies the source data for an index field. An optional data transformation can be applied to the source data when populating the index field. By default, the value of the source attribute is copied to the index field.
\n " }, "documentation": "\nAn optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.
Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than 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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nThe value of an IndexField and its current status.
A response message that contains the status of an updated index field.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields.
A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true }, "RankExpression": { "shape_name": "NamedRankExpression", "type": "structure", "members": { "RankName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.
\n ", "required": true }, "RankExpression": { "shape_name": "RankExpression", "type": "string", "min_length": 1, "max_length": 10240, "documentation": "\nThe expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:
a || b evaluates to the value a if a is true without evaluting b at all+ - * / %\nabs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow\nacosh acos asinh asin atanh atan cosh cos sinh sin tanh tan\nrand\ntime\nmin max functions that operate on a variable argument listIntermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.
The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.
For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.
\n ", "required": true } }, "documentation": "\nA named expression that can be evaluated at search time and used for ranking or thresholding\n in a search query.
\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DefineRankExpressionResponse", "type": "structure", "members": { "RankExpression": { "shape_name": "RankExpressionStatus", "type": "structure", "members": { "Options": { "shape_name": "NamedRankExpression", "type": "structure", "members": { "RankName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.
\n ", "required": true }, "RankExpression": { "shape_name": "RankExpression", "type": "string", "min_length": 1, "max_length": 10240, "documentation": "\nThe expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:
a || b evaluates to the value a if a is true without evaluting b at all+ - * / %\nabs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow\nacosh acos asinh asin atanh atan cosh cos sinh sin tanh tan\nrand\ntime\nmin max functions that operate on a variable argument listIntermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.
The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.
For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.
\n ", "required": true } }, "documentation": "\nThe expression that is evaluated for ranking or thresholding 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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nThe value of a RankExpression and its current status.
A response message that contains the status of an updated RankExpression.
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 RankExpression for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions.
A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DeleteDomainResponse", "type": "structure", "members": { "DomainStatus": { "shape_name": "DomainStatus", "type": "structure", "members": { "DomainId": { "shape_name": "DomainId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\nAn 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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true }, "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 " }, "NumSearchableDocs": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nThe number of documents that have been submitted to the domain and indexed.
\n " }, "DocService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Arn": { "shape_name": "Arn", "type": "string", "documentation": "\nAn Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
\n " }, "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\nThe URL (including /version/pathPrefix) to which service requests can be submitted.
\n " } }, "documentation": "\nThe service endpoint for updating documents in a search domain.
\n " }, "SearchService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Arn": { "shape_name": "Arn", "type": "string", "documentation": "\nAn Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
\n " }, "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\nThe URL (including /version/pathPrefix) to which service requests can be submitted.
\n " } }, "documentation": "\nThe 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 (such as search.m1.small) 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 response message that contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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.
\n " }, "DeleteIndexField": { "name": "DeleteIndexField", "input": { "shape_name": "DeleteIndexFieldRequest", "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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true }, "IndexFieldName": { "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 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 names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.
\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DeleteIndexFieldResponse", "type": "structure", "members": { "IndexField": { "shape_name": "IndexFieldStatus", "type": "structure", "members": { "Options": { "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 names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.
\n ", "required": true }, "IndexFieldType": { "shape_name": "IndexFieldType", "type": "string", "enum": [ "uint", "literal", "text" ], "documentation": "\nThe type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.
\n ", "required": true }, "UIntOptions": { "shape_name": "UIntOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nThe default value for an unsigned integer field. Optional.
\n " } }, "documentation": "\nOptions for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.
The default value for a literal field. Optional.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether search is enabled for this field. Default: False.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether facets are enabled for this field. Default: False.
\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether values of this field can be returned in search results and used for ranking. Default: False.
\n " } }, "documentation": "\nOptions for literal field. Present if IndexFieldType specifies the field is of type literal.
The default value for a text field. Optional.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether facets are enabled for this field. Default: False.
\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether values of this field can be returned in search results and used for ranking. Default: False.
\n " }, "TextProcessor": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe text processor to apply to this field. Optional. Possible values:
\ncs_text_no_stemming: turns off stemming for the field.Default: none
\n " } }, "documentation": "\nOptions for text field. Present if IndexFieldType specifies the field is of type text.
Identifies the transformation to apply when copying data from a source attribute.
\n ", "required": true }, "SourceDataCopy": { "shape_name": "SourceData", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the document source field to add to this IndexField.
The default value to use if the source attribute is not specified in a document. Optional.
\n " } }, "documentation": "\nCopies data from a source document attribute to an IndexField.
The name of the document source field to add to this IndexField.
The default value to use if the source attribute is not specified in a document. Optional.
\n " }, "Separator": { "shape_name": "String", "type": "string", "documentation": "\nThe separator that follows the text to trim.
\n " }, "Language": { "shape_name": "Language", "type": "string", "pattern": "[a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*", "documentation": "\nAn IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.
\n " } }, "documentation": "\nTrims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.
The name of the document source field to add to this IndexField.
The default value to use if the source attribute is not specified in a document. Optional.
\n " }, "Cases": { "shape_name": "StringCaseMap", "type": "map", "keys": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\nThe value of a field or source document attribute.
\n " }, "members": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\nThe value of a field or source document attribute.
\n " }, "documentation": "\nA map that translates source field values to custom values.
\n " } }, "documentation": "\nMaps source document attribute values to new values when populating the IndexField.
Identifies the source data for an index field. An optional data transformation can be applied to the source data when populating the index field. By default, the value of the source attribute is copied to the index field.
\n " }, "documentation": "\nAn optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.
Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than 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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nThe value of an IndexField and its current status.
A response message that contains the status of a deleted index field.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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.
A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true }, "RankName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the RankExpression to delete.
The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.
\n ", "required": true }, "RankExpression": { "shape_name": "RankExpression", "type": "string", "min_length": 1, "max_length": 10240, "documentation": "\nThe expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:
a || b evaluates to the value a if a is true without evaluting b at all+ - * / %\nabs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow\nacosh acos asinh asin atanh atan cosh cos sinh sin tanh tan\nrand\ntime\nmin max functions that operate on a variable argument listIntermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.
The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.
For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.
\n ", "required": true } }, "documentation": "\nThe expression that is evaluated for ranking or thresholding 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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nThe value of a RankExpression and its current status.
A response message that contains the status of a deleted RankExpression.
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 a RankExpression from the search domain.
A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeDefaultSearchFieldResponse", "type": "structure", "members": { "DefaultSearchField": { "shape_name": "DefaultSearchFieldStatus", "type": "structure", "members": { "Options": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the IndexField to use as the default search field. The default is an empty string, which automatically searches all text fields.
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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nThe name of the IndexField to use for search requests issued with the q parameter. The default is the empty string, which automatically searches all text fields.
A response message that contains the default search field for a search domain.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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 default search field configured for the search domain.
\n " }, "DescribeDomains": { "name": "DescribeDomains", "input": { "shape_name": "DescribeDomainsRequest", "type": "structure", "members": { "DomainNames": { "shape_name": "DomainNameList", "type": "list", "members": { "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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n " }, "documentation": "\nLimits the DescribeDomains response to the specified search domains.
\n " } }, "documentation": null }, "output": { "shape_name": "DescribeDomainsResponse", "type": "structure", "members": { "DomainStatusList": { "shape_name": "DomainStatusList", "type": "list", "members": { "shape_name": "DomainStatus", "type": "structure", "members": { "DomainId": { "shape_name": "DomainId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\nAn 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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true }, "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 " }, "NumSearchableDocs": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nThe number of documents that have been submitted to the domain and indexed.
\n " }, "DocService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Arn": { "shape_name": "Arn", "type": "string", "documentation": "\nAn Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
\n " }, "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\nThe URL (including /version/pathPrefix) to which service requests can be submitted.
\n " } }, "documentation": "\nThe service endpoint for updating documents in a search domain.
\n " }, "SearchService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Arn": { "shape_name": "Arn", "type": "string", "documentation": "\nAn Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
\n " }, "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\nThe URL (including /version/pathPrefix) to which service requests can be submitted.
\n " } }, "documentation": "\nThe 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 (such as search.m1.small) 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 current status of all of your search domains.
\n ", "required": true } }, "documentation": "\nA response message that contains the status of one or more domains.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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.
\n " }, "DescribeIndexFields": { "name": "DescribeIndexFields", "input": { "shape_name": "DescribeIndexFieldsRequest", "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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\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 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 names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.
\n\n " }, "documentation": "\nLimits the DescribeIndexFields response to the specified fields.
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 names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.
\n ", "required": true }, "IndexFieldType": { "shape_name": "IndexFieldType", "type": "string", "enum": [ "uint", "literal", "text" ], "documentation": "\nThe type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.
\n ", "required": true }, "UIntOptions": { "shape_name": "UIntOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\nThe default value for an unsigned integer field. Optional.
\n " } }, "documentation": "\nOptions for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.
The default value for a literal field. Optional.
\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether search is enabled for this field. Default: False.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether facets are enabled for this field. Default: False.
\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether values of this field can be returned in search results and used for ranking. Default: False.
\n " } }, "documentation": "\nOptions for literal field. Present if IndexFieldType specifies the field is of type literal.
The default value for a text field. Optional.
\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether facets are enabled for this field. Default: False.
\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether values of this field can be returned in search results and used for ranking. Default: False.
\n " }, "TextProcessor": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe text processor to apply to this field. Optional. Possible values:
\ncs_text_no_stemming: turns off stemming for the field.Default: none
\n " } }, "documentation": "\nOptions for text field. Present if IndexFieldType specifies the field is of type text.
Identifies the transformation to apply when copying data from a source attribute.
\n ", "required": true }, "SourceDataCopy": { "shape_name": "SourceData", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\nThe name of the document source field to add to this IndexField.
The default value to use if the source attribute is not specified in a document. Optional.
\n " } }, "documentation": "\nCopies data from a source document attribute to an IndexField.
The name of the document source field to add to this IndexField.
The default value to use if the source attribute is not specified in a document. Optional.
\n " }, "Separator": { "shape_name": "String", "type": "string", "documentation": "\nThe separator that follows the text to trim.
\n " }, "Language": { "shape_name": "Language", "type": "string", "pattern": "[a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*", "documentation": "\nAn IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.
\n " } }, "documentation": "\nTrims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.
The name of the document source field to add to this IndexField.
The default value to use if the source attribute is not specified in a document. Optional.
\n " }, "Cases": { "shape_name": "StringCaseMap", "type": "map", "keys": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\nThe value of a field or source document attribute.
\n " }, "members": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\nThe value of a field or source document attribute.
\n " }, "documentation": "\nA map that translates source field values to custom values.
\n " } }, "documentation": "\nMaps source document attribute values to new values when populating the IndexField.
Identifies the source data for an index field. An optional data transformation can be applied to the source data when populating the index field. By default, the value of the source attribute is copied to the index field.
\n " }, "documentation": "\nAn optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.
Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than 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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nThe value of an IndexField and its current status.
The index fields configured for the domain.
\n ", "required": true } }, "documentation": "\nA response message that contains the index fields for a search domain.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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. Can be limited to specific fields by name. Shows all fields by default.
\n " }, "DescribeRankExpressions": { "name": "DescribeRankExpressions", "input": { "shape_name": "DescribeRankExpressionsRequest", "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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true }, "RankNames": { "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 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 names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.
\n\n " }, "documentation": "\nLimits the DescribeRankExpressions response to the specified fields.
The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.
\n ", "required": true }, "RankExpression": { "shape_name": "RankExpression", "type": "string", "min_length": 1, "max_length": 10240, "documentation": "\nThe expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:
a || b evaluates to the value a if a is true without evaluting b at all+ - * / %\nabs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow\nacosh acos asinh asin atanh atan cosh cos sinh sin tanh tan\nrand\ntime\nmin max functions that operate on a variable argument listIntermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.
The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.
For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.
\n ", "required": true } }, "documentation": "\nThe expression that is evaluated for ranking or thresholding 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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nThe value of a RankExpression and its current status.
The rank expressions configured for the domain.
\n ", "required": true } }, "documentation": "\nA response message that contains the rank expressions for a search domain.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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 rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default.
\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": "\nA string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeServiceAccessPoliciesResponse", "type": "structure", "members": { "AccessPolicies": { "shape_name": "AccessPoliciesStatus", "type": "structure", "members": { "Options": { "shape_name": "PolicyDocument", "type": "string", "documentation": "\nAn IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100 KB.
\nExample: {\"Statement\": [{\"Effect\":\"Allow\",\n \"Action\": \"*\",\n \"Resource\":\n \"arn:aws:cs:us-east-1:1234567890:search/movies\",\n \"Condition\": \n { \"IpAddress\": { aws:SourceIp\": [\"203.0.113.1/32\"] }\n }},\n {\"Effect\":\"Allow\",\n \"Action\": \"*\",\n \"Resource\":\n \"arn:aws:cs:us-east-1:1234567890:documents/movies\",\n \"Condition\": \n { \"IpAddress\": { aws:SourceIp\": [\"203.0.113.1/32\"] }\n }}\n ]\n}
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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nA PolicyDocument that specifies access policies for the search domain's services, and the current status of those policies.
A response message that contains the access policies for a domain.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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 resource-based policies that control access to the domain's document and search services.
\n " }, "DescribeStemmingOptions": { "name": "DescribeStemmingOptions", "input": { "shape_name": "DescribeStemmingOptionsRequest", "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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeStemmingOptionsResponse", "type": "structure", "members": { "Stems": { "shape_name": "StemmingOptionsStatus", "type": "structure", "members": { "Options": { "shape_name": "StemsDocument", "type": "string", "documentation": "\nMaps terms to their stems, serialized as a JSON document. The document has a single object with one property \"stems\" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: { \"stems\": {\"people\": \"person\", \"walking\": \"walk\"} }
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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nThe stemming options configured for this search domain and the current status of those options.
\n ", "required": true } }, "documentation": "\nA response message that contains the stemming options for a search domain.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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 stemming dictionary configured for the search domain.
\n " }, "DescribeStopwordOptions": { "name": "DescribeStopwordOptions", "input": { "shape_name": "DescribeStopwordOptionsRequest", "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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeStopwordOptionsResponse", "type": "structure", "members": { "Stopwords": { "shape_name": "StopwordOptionsStatus", "type": "structure", "members": { "Options": { "shape_name": "StopwordsDocument", "type": "string", "documentation": "\nLists stopwords serialized as a JSON document. The document has a single object with one property \"stopwords\" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: { \"stopwords\": [\"a\", \"an\", \"the\", \"of\"] }
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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nThe stopword options configured for this search domain and the current status of those options.
\n ", "required": true } }, "documentation": "\nA response message that contains the stopword options for a search domain.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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 stopwords configured for the search domain.
\n " }, "DescribeSynonymOptions": { "name": "DescribeSynonymOptions", "input": { "shape_name": "DescribeSynonymOptionsRequest", "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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeSynonymOptionsResponse", "type": "structure", "members": { "Synonyms": { "shape_name": "SynonymOptionsStatus", "type": "structure", "members": { "Options": { "shape_name": "SynonymsDocument", "type": "string", "documentation": "\nMaps terms to their synonyms, serialized as a JSON document. The document has a single object with one property \"synonyms\" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { \"synonyms\": {\"cat\": [\"feline\", \"kitten\"], \"puppy\": \"dog\"} }
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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nThe synonym options configured for this search domain and the current status of those options.
\n ", "required": true } }, "documentation": "\nA response message that contains the synonym options for a search domain.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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 synonym dictionary configured for the search domain.
\n " }, "IndexDocuments": { "name": "IndexDocuments", "input": { "shape_name": "IndexDocumentsRequest", "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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "IndexDocumentsResponse", "type": "structure", "members": { "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 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 names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.
\n\n " }, "documentation": "\nThe names of the fields that are currently being processed due to an IndexDocuments action.
The result of an IndexDocuments action.
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 text processing options and IndexFields. This operation must be invoked to make options whose OptionStatus has OptionState of RequiresIndexDocuments visible in search results.
A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true }, "DefaultSearchField": { "shape_name": "String", "type": "string", "documentation": "\nThe IndexField to use for search requests issued with the q parameter. The default is an empty string, which automatically searches all text fields.
The name of the IndexField to use as the default search field. The default is an empty string, which automatically searches all text fields.
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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nThe value of the DefaultSearchField configured for this search domain and its current status.
A response message that contains the status of an updated default search field.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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": "\nConfigures the default search field for the search domain. The default search field is used when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields.
\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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true }, "AccessPolicies": { "shape_name": "PolicyDocument", "type": "string", "documentation": "\nAn IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100 KB.
\nExample: {\"Statement\": [{\"Effect\":\"Allow\",\n \"Action\": \"*\",\n \"Resource\":\n \"arn:aws:cs:us-east-1:1234567890:search/movies\",\n \"Condition\": \n { \"IpAddress\": { aws:SourceIp\": [\"203.0.113.1/32\"] }\n }},\n {\"Effect\":\"Allow\",\n \"Action\": \"*\",\n \"Resource\":\n \"arn:aws:cs:us-east-1:1234567890:documents/movies\",\n \"Condition\": \n { \"IpAddress\": { aws:SourceIp\": [\"203.0.113.1/32\"] }\n }}\n ]\n}
An IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100 KB.
\nExample: {\"Statement\": [{\"Effect\":\"Allow\",\n \"Action\": \"*\",\n \"Resource\":\n \"arn:aws:cs:us-east-1:1234567890:search/movies\",\n \"Condition\": \n { \"IpAddress\": { aws:SourceIp\": [\"203.0.113.1/32\"] }\n }},\n {\"Effect\":\"Allow\",\n \"Action\": \"*\",\n \"Resource\":\n \"arn:aws:cs:us-east-1:1234567890:documents/movies\",\n \"Condition\": \n { \"IpAddress\": { aws:SourceIp\": [\"203.0.113.1/32\"] }\n }}\n ]\n}
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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nA PolicyDocument that specifies access policies for the search domain's services, and the current status of those policies.
A response message that contains the status of updated access policies.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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 policies that control access to the domain's document and search services. The maximum size of an access policy document is 100 KB.
\n " }, "UpdateStemmingOptions": { "name": "UpdateStemmingOptions", "input": { "shape_name": "UpdateStemmingOptionsRequest", "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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true }, "Stems": { "shape_name": "StemsDocument", "type": "string", "documentation": "\nMaps terms to their stems, serialized as a JSON document. The document has a single object with one property \"stems\" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: { \"stems\": {\"people\": \"person\", \"walking\": \"walk\"} }
Maps terms to their stems, serialized as a JSON document. The document has a single object with one property \"stems\" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: { \"stems\": {\"people\": \"person\", \"walking\": \"walk\"} }
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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nThe stemming options configured for this search domain and the current status of those options.
\n ", "required": true } }, "documentation": "\nA response message that contains the status of updated stemming options.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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 " } ], "documentation": "\nConfigures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500 KB.
\n " }, "UpdateStopwordOptions": { "name": "UpdateStopwordOptions", "input": { "shape_name": "UpdateStopwordOptionsRequest", "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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true }, "Stopwords": { "shape_name": "StopwordsDocument", "type": "string", "documentation": "\nLists stopwords serialized as a JSON document. The document has a single object with one property \"stopwords\" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: { \"stopwords\": [\"a\", \"an\", \"the\", \"of\"] }
Lists stopwords serialized as a JSON document. The document has a single object with one property \"stopwords\" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: { \"stopwords\": [\"a\", \"an\", \"the\", \"of\"] }
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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nThe stopword options configured for this search domain and the current status of those options.
\n ", "required": true } }, "documentation": "\nA response message that contains the status of updated stopword options.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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 " } ], "documentation": "\nConfigures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10 KB.
\n \n " }, "UpdateSynonymOptions": { "name": "UpdateSynonymOptions", "input": { "shape_name": "UpdateSynonymOptionsRequest", "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 must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.
\n\n ", "required": true }, "Synonyms": { "shape_name": "SynonymsDocument", "type": "string", "documentation": "\nMaps terms to their synonyms, serialized as a JSON document. The document has a single object with one property \"synonyms\" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { \"synonyms\": {\"cat\": [\"feline\", \"kitten\"], \"puppy\": \"dog\"} }
Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property \"synonyms\" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { \"synonyms\": {\"cat\": [\"feline\", \"kitten\"], \"puppy\": \"dog\"} }
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" ], "documentation": "\nThe state of processing a change to an option. Possible values:
\nRequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.Processing: the option's latest value is not yet visible in all searches but is in the process of being activated. Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.Indicates that the option will be deleted once processing is complete.
\n " } }, "documentation": "\nThe status of an option, including when it was last updated and whether it is actively in use for searches.
\n ", "required": true } }, "documentation": "\nThe synonym options configured for this search domain and the current status of those options.
\n ", "required": true } }, "documentation": "\nA response message that contains the status of updated synonym options.
\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\nA 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 " } ], "documentation": "\nConfigures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB.
\n " } }, "metadata": { "regions": { "us-east-1": null, "us-west-1": null, "us-west-2": null, "eu-west-1": null, "ap-southeast-1": null }, "protocols": [ "https" ] }, "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 } } } } } } }