AWS.Tools.CloudSearch.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CloudSearch</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSAnalysisSchemeCmdlet"> <summary> Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a <code>text</code> 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 <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSAnalysisSchemeCmdlet.AnalysisSchemeName"> <summary> <para> <para>The analysis schemes you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSAnalysisSchemeCmdlet.Deployed"> <summary> <para> <para>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSAnalysisSchemeCmdlet.DomainName"> <summary> <para> <para>The name of the domain you want to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSAvailabilityOptionCmdlet"> <summary> Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSAvailabilityOptionCmdlet.Deployed"> <summary> <para> <para>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSAvailabilityOptionCmdlet.DomainName"> <summary> <para> <para>The name of the domain you want to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSDomainCmdlet"> <summary> 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 <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&amp;q.parser=structured&amp;size=0</code>. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSDomainCmdlet.DomainName"> <summary> <para> <para>The names of the domains you want to include in the response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSDomainNameListCmdlet"> <summary> Lists all search domains owned by an account. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSExpressionCmdlet"> <summary> 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 <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSExpressionCmdlet.Deployed"> <summary> <para> <para>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSExpressionCmdlet.DomainName"> <summary> <para> <para>The name of the domain you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSExpressionCmdlet.ExpressionName"> <summary> <para> <para>Limits the <code><a>DescribeExpressions</a></code> response to the specified expressions. If not specified, all expressions are shown.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSIndexFieldCmdlet"> <summary> 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 <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSIndexFieldCmdlet.Deployed"> <summary> <para> <para>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSIndexFieldCmdlet.DomainName"> <summary> <para> <para>The name of the domain you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSIndexFieldCmdlet.FieldName"> <summary> <para> <para>A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSScalingParameterCmdlet"> <summary> 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 <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSScalingParameterCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSServiceAccessPolicyCmdlet"> <summary> 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 <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSServiceAccessPolicyCmdlet.Deployed"> <summary> <para> <para>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSServiceAccessPolicyCmdlet.DomainName"> <summary> <para> <para>The name of the domain you want to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.GetCSSuggesterCmdlet"> <summary> 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 <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSSuggesterCmdlet.Deployed"> <summary> <para> <para>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSSuggesterCmdlet.DomainName"> <summary> <para> <para>The name of the domain you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.GetCSSuggesterCmdlet.SuggesterName"> <summary> <para> <para>The suggesters you want to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.NewCSDomainCmdlet"> <summary> Creates a new search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html" target="_blank">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.NewCSDomainCmdlet.DomainName"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.NewCSDomainCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.RemoveCSAnalysisSchemeCmdlet"> <summary> Deletes an analysis scheme. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSAnalysisSchemeCmdlet.AnalysisSchemeName"> <summary> <para> <para>The name of the analysis scheme you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSAnalysisSchemeCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSAnalysisSchemeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.RemoveCSDomainCmdlet"> <summary> Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html" target="_blank">Deleting a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSDomainCmdlet.DomainName"> <summary> <para> <para>The name of the domain you want to permanently delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSDomainCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.RemoveCSExpressionCmdlet"> <summary> Removes an <code><a>Expression</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSExpressionCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSExpressionCmdlet.ExpressionName"> <summary> <para> <para>The name of the <code><a>Expression</a></code> to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSExpressionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.RemoveCSIndexFieldCmdlet"> <summary> Removes an <code><a>IndexField</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSIndexFieldCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSIndexFieldCmdlet.IndexFieldName"> <summary> <para> <para>The name of the index field your want to remove from the domain's indexing options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSIndexFieldCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.RemoveCSSuggesterCmdlet"> <summary> Deletes a suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSSuggesterCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSSuggesterCmdlet.SuggesterName"> <summary> <para> <para>Specifies the name of the suggester you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.RemoveCSSuggesterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet"> <summary> Configures an analysis scheme that can be applied to a <code>text</code> or <code>text-array</code> field to define language-specific text processing options. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.AnalysisOptions_AlgorithmicStemming"> <summary> <para> <para>The level of algorithmic stemming to perform: <code>none</code>, <code>minimal</code>, <code>light</code>, or <code>full</code>. The available levels vary depending on the language. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings" target="_blank">Language Specific Text Processing Settings</a> in the <i>Amazon CloudSearch Developer Guide</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.AnalysisScheme_AnalysisSchemeLanguage"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.AnalysisScheme_AnalysisSchemeName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.AnalysisOptions_JapaneseTokenizationDictionary"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.AnalysisOptions_StemmingDictionary"> <summary> <para> <para>A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, <code>{"term1": "stem1", "term2": "stem2", "term3": "stem3"}</code>. 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.AnalysisOptions_Stopword"> <summary> <para> <para>A JSON array of terms to ignore during indexing and searching. For example, <code>["a", "an", "the", "of"]</code>. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.AnalysisOptions_Synonym"> <summary> <para> <para>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 <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms">Synonyms</a> in the <i>Amazon CloudSearch Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSAnalysisSchemeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.SetCSExpressionCmdlet"> <summary> Configures an <code><a>Expression</a></code> 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 <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSExpressionCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSExpressionCmdlet.Expression_ExpressionName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSExpressionCmdlet.Expression_ExpressionValue"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSExpressionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet"> <summary> Configures an <code><a>IndexField</a></code> 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 <code><a>IndexFieldType</a></code>. If the field exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextArrayOptions_AnalysisScheme"> <summary> <para> <para>The name of an analysis scheme for a <code>text-array</code> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextOptions_AnalysisScheme"> <summary> <para> <para>The name of an analysis scheme for a <code>text</code> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateArrayOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleArrayOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleOptions_DefaultValue"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntArrayOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntOptions_DefaultValue"> <summary> <para> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LatLonOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralArrayOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextArrayOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextOptions_DefaultValue"> <summary> <para> A value to use for the field if the field isn't specified for a document. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateArrayOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleArrayOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntArrayOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LatLonOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralArrayOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralOptions_FacetEnabled"> <summary> <para> <para>Whether facet information can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextArrayOptions_HighlightEnabled"> <summary> <para> <para>Whether highlights can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextOptions_HighlightEnabled"> <summary> <para> <para>Whether highlights can be returned for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IndexField_IndexFieldName"> <summary> <para> <para>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. </para><para>Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported. </para><para>The name <code>score</code> is reserved and cannot be used as a field name. To reference a document's ID, you can use the name <code>_id</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IndexField_IndexFieldType"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateArrayOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleArrayOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntArrayOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LatLonOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralArrayOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextArrayOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextOptions_ReturnEnabled"> <summary> <para> <para>Whether the contents of the field can be returned in the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateArrayOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleArrayOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntArrayOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LatLonOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralArrayOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralOptions_SearchEnabled"> <summary> <para> <para>Whether the contents of the field are searchable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateOptions_SortEnabled"> <summary> <para> <para>Whether the field can be used to sort the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleOptions_SortEnabled"> <summary> <para> <para>Whether the field can be used to sort the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntOptions_SortEnabled"> <summary> <para> <para>Whether the field can be used to sort the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LatLonOptions_SortEnabled"> <summary> <para> <para>Whether the field can be used to sort the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralOptions_SortEnabled"> <summary> <para> <para>Whether the field can be used to sort the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextOptions_SortEnabled"> <summary> <para> <para>Whether the field can be used to sort the search results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateOptions_SourceField"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleOptions_SourceField"> <summary> <para> <para>The name of the source field to map to the field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntOptions_SourceField"> <summary> <para> <para>The name of the source field to map to the field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LatLonOptions_SourceField"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralOptions_SourceField"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextOptions_SourceField"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DateArrayOptions_SourceField"> <summary> <para> <para>A list of source fields to map to the field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.DoubleArrayOptions_SourceField"> <summary> <para> <para>A list of source fields to map to the field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.IntArrayOptions_SourceField"> <summary> <para> <para>A list of source fields to map to the field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.LiteralArrayOptions_SourceField"> <summary> <para> <para>A list of source fields to map to the field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.TextArrayOptions_SourceField"> <summary> <para> <para>A list of source fields to map to the field. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSIndexFieldCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.SetCSSuggesterCmdlet"> <summary> 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 <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSSuggesterCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSSuggesterCmdlet.DocumentSuggesterOptions_FuzzyMatching"> <summary> <para> <para>The level of fuzziness allowed when suggesting matches for a string: <code>none</code>, <code>low</code>, or <code>high</code>. 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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSSuggesterCmdlet.DocumentSuggesterOptions_SortExpression"> <summary> <para> <para>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 <code>_score</code> 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSSuggesterCmdlet.DocumentSuggesterOptions_SourceField"> <summary> <para> <para>The name of the index field you want to use for suggestions. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSSuggesterCmdlet.Suggester_SuggesterName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.SetCSSuggesterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.StartCSIndexCmdlet"> <summary> Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose <a>OptionStatus</a> is <code>RequiresIndexDocuments</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.StartCSIndexCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.StartCSIndexCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.StartCSSuggestersBuildCmdlet"> <summary> Indexes the search suggestions. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters">Configuring Suggesters</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.StartCSSuggestersBuildCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.StartCSSuggestersBuildCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.UpdateCSAvailabilityOptionCmdlet"> <summary> 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 <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSAvailabilityOptionCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSAvailabilityOptionCmdlet.MultiAZ"> <summary> <para> <para>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 <code>false</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSAvailabilityOptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.UpdateCSScalingParameterCmdlet"> <summary> 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 <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSScalingParameterCmdlet.ScalingParameters_DesiredInstanceType"> <summary> <para> <para>The instance type that you want to preconfigure for your domain. For example, <code>search.m1.small</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSScalingParameterCmdlet.ScalingParameters_DesiredPartitionCount"> <summary> <para> <para>The number of partitions you want to preconfigure for your domain. Only valid when you select <code>m2.2xlarge</code> as the desired instance type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSScalingParameterCmdlet.ScalingParameters_DesiredReplicationCount"> <summary> <para> <para>The number of replicas you want to preconfigure for each index partition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSScalingParameterCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSScalingParameterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CS.UpdateCSServiceAccessPolicyCmdlet"> <summary> Configures the access rules that control access to the domain's document and search endpoints. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank"> Configuring Access for an Amazon CloudSearch Domain</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSServiceAccessPolicyCmdlet.AccessPolicy"> <summary> <para> <para>The access rules you want to configure. These rules replace any existing rules. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSServiceAccessPolicyCmdlet.DomainName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CS.UpdateCSServiceAccessPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |