Icon

AWS CloudSearch (version v1.*.*)

build_suggesters

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

Parameters

$body

Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.

Type: object

{
"DomainName" : "Required string"
}

create_domain

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

Parameters

$body

Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.

Type: object

{
"DomainName" : "A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long."
}

define_analysis_scheme

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

Parameters

$body

Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.

Type: object

{
"DomainName" : "Required string",
"AnalysisScheme" : {
"AnalysisOptions" : {
"Synonyms" : "A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.",
"JapaneseTokenizationDictionary" : "A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.",
"AlgorithmicStemming" : "The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide ",
"Stopwords" : "A JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. ",
"StemmingDictionary" : "A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB."
},
"AnalysisSchemeName" : "Required string",
"AnalysisSchemeLanguage" : "Required string. Possible values: ar | bg | ca | cs | da | de | el | en | es | eu | fa | fi | fr | ga | gl | he | hi | hu | hy | id | it | ja | ko | lv | mul | nl | no | pt | ro | ru | sv | th | tr | zh-Hans | zh-Hant"
}
}

define_expression

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

Parameters

$body

Container for the parameters to the DefineExpression operation. Specifies the name of the domain you want to update and the expression you want to configure.

Type: object

{
"DomainName" : "Required string",
"Expression" : {
"ExpressionValue" : "Required string",
"ExpressionName" : "Required string"
}
}

define_index_field

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

Parameters

$body

Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.

Type: object

{
"DomainName" : "Required string",
"IndexField" : {
"LiteralOptions" : {
"DefaultValue" : "A value to use for the field if the field isn't specified for a document.",
"ReturnEnabled" : "Whether the contents of the field can be returned in the search results.",
"SortEnabled" : "Whether the field can be used to sort the search results.",
"SourceField" : "string",
"FacetEnabled" : "Whether facet information can be returned for the field.",
"SearchEnabled" : "Whether the contents of the field are searchable."
},
"DoubleOptions" : {
"DefaultValue" : "A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.",
"ReturnEnabled" : "Whether the contents of the field can be returned in the search results.",
"SortEnabled" : "Whether the field can be used to sort the search results.",
"SourceField" : "The name of the source field to map to the field. ",
"FacetEnabled" : "Whether facet information can be returned for the field.",
"SearchEnabled" : "Whether the contents of the field are searchable."
},
"LatLonOptions" : {
"DefaultValue" : "A value to use for the field if the field isn't specified for a document.",
"ReturnEnabled" : "Whether the contents of the field can be returned in the search results.",
"SortEnabled" : "Whether the field can be used to sort the search results.",
"SourceField" : "string",
"FacetEnabled" : "Whether facet information can be returned for the field.",
"SearchEnabled" : "Whether the contents of the field are searchable."
},
"IndexFieldName" : "A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options. \nRegular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported. \nThe name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id. ",
"DoubleArrayOptions" : {
"DefaultValue" : "A value to use for the field if the field isn't specified for a document.",
"ReturnEnabled" : "Whether the contents of the field can be returned in the search results.",
"SourceFields" : "A list of source fields to map to the field. ",
"FacetEnabled" : "Whether facet information can be returned for the field.",
"SearchEnabled" : "Whether the contents of the field are searchable."
},
"LiteralArrayOptions" : {
"DefaultValue" : "A value to use for the field if the field isn't specified for a document.",
"ReturnEnabled" : "Whether the contents of the field can be returned in the search results.",
"SourceFields" : "A list of source fields to map to the field. ",
"FacetEnabled" : "Whether facet information can be returned for the field.",
"SearchEnabled" : "Whether the contents of the field are searchable."
},
"DateArrayOptions" : {
"DefaultValue" : "A value to use for the field if the field isn't specified for a document.",
"ReturnEnabled" : "Whether the contents of the field can be returned in the search results.",
"SourceFields" : "A list of source fields to map to the field. ",
"FacetEnabled" : "Whether facet information can be returned for the field.",
"SearchEnabled" : "Whether the contents of the field are searchable."
},
"IntArrayOptions" : {
"DefaultValue" : "A value to use for the field if the field isn't specified for a document.",
"ReturnEnabled" : "Whether the contents of the field can be returned in the search results.",
"SourceFields" : "A list of source fields to map to the field. ",
"FacetEnabled" : "Whether facet information can be returned for the field.",
"SearchEnabled" : "Whether the contents of the field are searchable."
},
"TextOptions" : {
"DefaultValue" : "A value to use for the field if the field isn't specified for a document.",
"ReturnEnabled" : "Whether the contents of the field can be returned in the search results.",
"SortEnabled" : "Whether the field can be used to sort the search results.",
"SourceField" : "string",
"HighlightEnabled" : "Whether highlights can be returned for the field.",
"AnalysisScheme" : "The name of an analysis scheme for a text field."
},
"IntOptions" : {
"DefaultValue" : "A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.",
"ReturnEnabled" : "Whether the contents of the field can be returned in the search results.",
"SortEnabled" : "Whether the field can be used to sort the search results.",
"SourceField" : "The name of the source field to map to the field. ",
"FacetEnabled" : "Whether facet information can be returned for the field.",
"SearchEnabled" : "Whether the contents of the field are searchable."
},
"IndexFieldType" : "Required string. Possible values: int | double | literal | text | date | latlon | int-array | double-array | literal-array | text-array | date-array",
"TextArrayOptions" : {
"DefaultValue" : "A value to use for the field if the field isn't specified for a document.",
"ReturnEnabled" : "Whether the contents of the field can be returned in the search results.",
"SourceFields" : "A list of source fields to map to the field. ",
"HighlightEnabled" : "Whether highlights can be returned for the field.",
"AnalysisScheme" : "The name of an analysis scheme for a text-array field."
},
"DateOptions" : {
"DefaultValue" : "A value to use for the field if the field isn't specified for a document.",
"ReturnEnabled" : "Whether the contents of the field can be returned in the search results.",
"SortEnabled" : "Whether the field can be used to sort the search results.",
"SourceField" : "string",
"FacetEnabled" : "Whether facet information can be returned for the field.",
"SearchEnabled" : "Whether the contents of the field are searchable."
}
}
}

define_suggester

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

Parameters

$body

Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.

Type: object

{
"Suggester" : {
"DocumentSuggesterOptions" : {
"FuzzyMatching" : "The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none. ",
"SortExpression" : "An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.",
"SourceField" : "The name of the index field you want to use for suggestions. "
},
"SuggesterName" : "Required string"
},
"DomainName" : "Required string"
}

delete_analysis_scheme

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

Parameters

$body

Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.

Type: object

{
"DomainName" : "Required string",
"AnalysisSchemeName" : "The name of the analysis scheme you want to delete."
}

delete_domain

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

Parameters

$body

Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.

Type: object

{
"DomainName" : "The name of the domain you want to permanently delete."
}

delete_expression

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

Parameters

$body

Container for the parameters to the DeleteExpression operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.

Type: object

{
"DomainName" : "Required string",
"ExpressionName" : "The name of the Expression to delete."
}

delete_index_field

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

Parameters

$body

Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.

Type: object

{
"IndexFieldName" : "The name of the index field your want to remove from the domain's indexing options.",
"DomainName" : "Required string"
}

delete_suggester

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

Parameters

$body

Container for the parameters to the DeleteSuggester operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.

Type: object

{
"DomainName" : "Required string",
"SuggesterName" : "Specifies the name of the suggester you want to delete."
}

describe_analysis_schemes

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

Parameters

$body

Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Type: object

{
"AnalysisSchemeNames" : [ "string" ],
"DomainName" : "The name of the domain you want to describe.",
"Deployed" : "Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false."
}

describe_availability_options

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

Parameters

$body

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Type: object

{
"DomainName" : "The name of the domain you want to describe.",
"Deployed" : "Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false."
}

describe_domains

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

Parameters

$body

Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.

Type: object

{
"DomainNames" : [ "string" ]
}

describe_expressions

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

Parameters

$body

Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Type: object

{
"DomainName" : "The name of the domain you want to describe.",
"ExpressionNames" : [ "string" ],
"Deployed" : "Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false."
}

describe_index_fields

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

Parameters

$body

Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Type: object

{
"DomainName" : "The name of the domain you want to describe.",
"FieldNames" : [ "string" ],
"Deployed" : "Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false."
}

describe_scaling_parameters

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

Parameters

$body

Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.

Type: object

{
"DomainName" : "Required string"
}

describe_service_access_policies

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

Parameters

$body

Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Type: object

{
"DomainName" : "The name of the domain you want to describe.",
"Deployed" : "Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false."
}

describe_suggesters

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

Parameters

$body

Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Type: object

{
"DomainName" : "The name of the domain you want to describe.",
"SuggesterNames" : [ "string" ],
"Deployed" : "Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false."
}

index_documents

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

Parameters

$body

Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.

Type: object

{
"DomainName" : "Required string"
}

list_domain_names

Lists all search domains owned by an account.

This operation has no parameters

update_availability_options

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

Parameters

$body

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

Type: object

{
"DomainName" : "Required string",
"MultiAZ" : "You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false. "
}

update_scaling_parameters

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

Parameters

$body

Container for the parameters to the UpdateScalingParameters operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.

Type: object

{
"ScalingParameters" : {
"DesiredInstanceType" : "The instance type that you want to preconfigure for your domain. For example, search.m1.small.",
"DesiredPartitionCount" : "The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.",
"DesiredReplicationCount" : "The number of replicas you want to preconfigure for each index partition."
},
"DomainName" : "Required string"
}

update_service_access_policies

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

Parameters

$body

Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the domain you want to update and the access rules you want to configure.

Type: object

{
"DomainName" : "Required string",
"AccessPolicies" : "The access rules you want to configure. These rules replace any existing rules. "
}