AWS.Tools.CloudSearchDomain.dll-Help.xml
|
<helpItems schema="maml"><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Get-CSDSuggestion</name><description><para>Calls the Amazon CloudSearchDomain Suggest API operation.</para></description><verb>Get</verb><noun>CSDSuggestion</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.
For more information about configuring suggesters and retrieving suggestions, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html">Getting Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. The endpoint for submitting <code>Suggest</code> requests is domain-specific. You submit suggest requests to a domain&#39;s search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain&#39;s endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias <i>Get-CSDSuggestions</i>. </para></description><syntax><syntaxItem><name>Get-CSDSuggestion</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ServiceUrl</name><description><para>Specifies the Search or Document service endpoint. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"><name>Query</name><description><para>Specifies the string for which you want to get suggestions. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"><name>Suggester</name><description><para>Specifies the name of the suggester to use to find suggested matches. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Size</name><description><para>Specifies the maximum number of suggestions to return. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>UseAnonymousCredentials</name><description><para>If set, the cmdlet calls the service operation using anonymous credentials. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudSearchDomain.Model.SuggestResponse). Specifying the name of a property of type Amazon.CloudSearchDomain.Model.SuggestResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"><name>Query</name><description><para>Specifies the string for which you want to get suggestions. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudSearchDomain.Model.SuggestResponse). Specifying the name of a property of type Amazon.CloudSearchDomain.Model.SuggestResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ServiceUrl</name><description><para>Specifies the Search or Document service endpoint. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Size</name><description><para>Specifies the maximum number of suggestions to return. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue><type><name>System.Int64</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"><name>Suggester</name><description><para>Specifies the name of the suggester to use to find suggested matches. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>UseAnonymousCredentials</name><description><para>If set, the cmdlet calls the service operation using anonymous credentials. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.CloudSearchDomain.Model.SuggestResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.CloudSearchDomain.Model.SuggestResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-CSDSuggestion.html&tocid=Get-CSDSuggestion</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Developer Guide:</linkText><uri>https://docs.aws.amazon.com/cloudsearch/latest/developerguide/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Search-CSDDocument</name><description><para>Calls the Amazon CloudSearchDomain Search API operation.</para></description><verb>Search</verb><noun>CSDDocument</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers: -<code>simple</code>: search all <code>text</code> and <code>text-array</code> fields for the specified string. Search for phrases, individual terms, and prefixes. -<code>structured</code>: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching. -<code>lucene</code>: specify search criteria using the Apache Lucene query parser syntax. -<code>dismax</code>: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html">Searching Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. The endpoint for submitting <code>Search</code> requests is domain-specific. You submit search requests to a domain&#39;s search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain&#39;s endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias <i>Search-CSDDocuments</i>. </para></description><syntax><syntaxItem><name>Search-CSDDocument</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ServiceUrl</name><description><para>Specifies the Search or Document service endpoint. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"><name>Query</name><description><para>Specifies the search criteria for the request. How you specify the search criteria depends on the query parser used for the request and the parser options specified in the <code>queryOptions</code> parameter. By default, the <code>simple</code> query parser is used to process requests. To use the <code>structured</code>, <code>lucene</code>, or <code>dismax</code> query parser, you must also specify the <code>queryParser</code> parameter. For more information about specifying search criteria, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html">Searching Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Cursor</name><description><para>Retrieves a cursor value you can use to page through large result sets. Use the <code>size</code> parameter to control the number of hits to include in each response. You can specify either the <code>cursor</code> or <code>start</code> parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor value to <code>initial</code>. In subsequent requests, specify the cursor value returned in the hits section of the response. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html">Paginating Results</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Expr</name><description><para>Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify expressions as return fields. You specify the expressions in JSON using the form <code>{"EXPRESSIONNAME":"EXPRESSION"}</code>. You can define and use multiple expressions in a search request. For example: <code> {"expression1":"_score*rating", "expression2":"(1/rank)*year"} </code> For information about the variables, operators, and functions you can use in expressions, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html#writing-expressions">Writing Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Facet</name><description><para>Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each specified field must be facet-enabled in the domain configuration. The fields and options are specified in JSON using the form <code>{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}</code>. You can specify the following faceting options: - <code>buckets</code> specifies an array of the facet values or ranges to count. Ranges are specified using the same syntax that you use to search for a range of values. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-ranges.html"> Searching for a Range of Values</a> in the <i>Amazon CloudSearch Developer Guide</i>. Buckets are returned in the order they are specified in the request. The <code>sort</code> and <code>size</code> options are not valid if you specify <code>buckets</code>. - <code>size</code> specifies the maximum number of facets to include in the results. By default, Amazon CloudSearch returns counts for the top 10. The <code>size</code> parameter is only valid when you specify the <code>sort</code> option; it cannot be used in conjunction with <code>buckets</code>. - <code>sort</code> specifies how you want to sort the facets in the results: <code>bucket</code> or <code>count</code>. Specify <code>bucket</code> to sort alphabetically or numerically by facet value (in ascending order). Specify <code>count</code> to sort by the facet counts computed for each facet value (in descending order). To retrieve facet counts for particular values or ranges of values, use the <code>buckets</code> option instead of <code>sort</code>. If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results. To count particular buckets of values, use the <code>buckets</code> option. For example, the following request uses the <code>buckets</code> option to calculate and return facet counts by decade. <code> {"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}} </code> To sort facets by facet count, use the <code>count</code> option. For example, the following request sets the <code>sort</code> option to <code>count</code> to sort the facet values by facet count, with the facet values that have the most matching documents listed first. Setting the <code>size</code> option to 3 returns only the top three facet values. <code> {"year":{"sort":"count","size":3}} </code> To sort the facets by value, use the <code>bucket</code> option. For example, the following request sets the <code>sort</code> option to <code>bucket</code> to sort the facet values numerically by year, with earliest year listed first. <code> {"year":{"sort":"bucket"}} </code> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/faceting.html">Getting and Using Facet Information</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FilterQuery</name><description><para>Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use <code>filterQuery</code> in conjunction with the <code>query</code> parameter to filter the documents that match the constraints specified in the <code>query</code> parameter. Specifying a filter controls only which matching documents are included in the results, it has no effect on how they are scored and sorted. The <code>filterQuery</code> parameter supports the full structured query syntax. For more information about using filters, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/filtering-results.html">Filtering Matching Documents</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Highlight</name><description><para>Retrieves highlights for matches in the specified <code>text</code> or <code>text-array</code> fields. Each specified field must be highlight enabled in the domain configuration. The fields and options are specified in JSON using the form <code>{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}</code>. You can specify the following highlight options: -<code>format</code>: specifies the format of the data in the text field: <code>text</code> or <code>html</code>. When data is returned as HTML, all non-alphanumeric characters are encoded. The default is <code>html</code>. -<code>max_phrases</code>: specifies the maximum number of occurrences of the search term(s) you want to highlight. By default, the first occurrence is highlighted. -<code>pre_tag</code>: specifies the string to prepend to an occurrence of a search term. The default for HTML highlights is <code>&lt;em&gt;</code>. The default for text highlights is <code>*</code>. -<code>post_tag</code>: specifies the string to append to an occurrence of a search term. The default for HTML highlights is <code>&lt;/em&gt;</code>. The default for text highlights is <code>*</code>. If no highlight options are specified for a field, the returned field text is treated as HTML and the first match is highlighted with emphasis tags: <code>&lt;em>search-term&lt;/em&gt;</code>. For example, the following request retrieves highlights for the <code>actors</code> and <code>title</code> fields. <code>{ "actors": {}, "title": {"format": "text","max_phrases": 2,"pre_tag": "<b>","post_tag": "</b>"} }</code> </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Partial</name><description><para>Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>QueryOption</name><description><para>Configures options for the query parser specified in the <code>queryParser</code> parameter. You specify the options in JSON using the following form <code>{"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"}.</code> The options you can configure vary according to which parser you use: -<code>defaultOperator</code>: The default operator used to combine individual terms in the search string. For example: <code>defaultOperator: 'or'</code>. For the <code>dismax</code> parser, you specify a percentage that represents the percentage of terms in the search string (rounded down) that must match, rather than a default operator. A value of <code>0%</code> is the equivalent to OR, and a value of <code>100%</code> is equivalent to AND. The percentage must be specified as a value in the range 0-100 followed by the percent (%) symbol. For example, <code>defaultOperator: 50%</code>. Valid values: <code>and</code>, <code>or</code>, a percentage in the range 0%-100% (<code>dismax</code>). Default: <code>and</code> (<code>simple</code>, <code>structured</code>, <code>lucene</code>) or <code>100</code> (<code>dismax</code>). Valid for: <code>simple</code>, <code>structured</code>, <code>lucene</code>, and <code>dismax</code>. -<code>fields</code>: An array of the fields to search when no fields are specified in a search. If no fields are specified in a search and this option is not specified, all text and text-array fields are searched. You can specify a weight for each field to control the relative importance of each field when Amazon CloudSearch calculates relevance scores. To specify a field weight, append a caret (<code>^</code>) symbol and the weight to the field name. For example, to boost the importance of the <code>title</code> field over the <code>description</code> field you could specify: <code>"fields":["title^5","description"]</code>. Valid values: The name of any configured field and an optional numeric value greater than zero. Default: All <code>text</code> and <code>text-array</code> fields. Valid for: <code>simple</code>, <code>structured</code>, <code>lucene</code>, and <code>dismax</code>. -<code>operators</code>: An array of the operators or special characters you want to disable for the simple query parser. If you disable the <code>and</code>, <code>or</code>, or <code>not</code> operators, the corresponding operators (<code>+</code>, <code>|</code>, <code>-</code>) have no special meaning and are dropped from the search string. Similarly, disabling <code>prefix</code> disables the wildcard operator (<code>*</code>) and disabling <code>phrase</code> disables the ability to search for phrases by enclosing phrases in double quotes. Disabling precedence disables the ability to control order of precedence using parentheses. Disabling <code>near</code> disables the ability to use the ~ operator to perform a sloppy phrase search. Disabling the <code>fuzzy</code> operator disables the ability to use the ~ operator to perform a fuzzy search. <code>escape</code> disables the ability to use a backslash (<code>\</code>) to escape special characters within the search string. Disabling whitespace is an advanced option that prevents the parser from tokenizing on whitespace, which can be useful for Vietnamese. (It prevents Vietnamese words from being split incorrectly.) For example, you could disable all operators other than the phrase operator to support just simple term and phrase queries: <code>"operators":["and","not","or", "prefix"]</code>. Valid values: <code>and</code>, <code>escape</code>, <code>fuzzy</code>, <code>near</code>, <code>not</code>, <code>or</code>, <code>phrase</code>, <code>precedence</code>, <code>prefix</code>, <code>whitespace</code>. Default: All operators and special characters are enabled. Valid for: <code>simple</code>. -<code>phraseFields</code>: An array of the <code>text</code> or <code>text-array</code> fields you want to use for phrase searches. When the terms in the search string appear in close proximity within a field, the field scores higher. You can specify a weight for each field to boost that score. The <code>phraseSlop</code> option controls how much the matches can deviate from the search string and still be boosted. To specify a field weight, append a caret (<code>^</code>) symbol and the weight to the field name. For example, to boost phrase matches in the <code>title</code> field over the <code>abstract</code> field, you could specify: <code>"phraseFields":["title^3", "plot"]</code> Valid values: The name of any <code>text</code> or <code>text-array</code> field and an optional numeric value greater than zero. Default: No fields. If you don't specify any fields with <code>phraseFields</code>, proximity scoring is disabled even if <code>phraseSlop</code> is specified. Valid for: <code>dismax</code>. -<code>phraseSlop</code>: An integer value that specifies how much matches can deviate from the search phrase and still be boosted according to the weights specified in the <code>phraseFields</code> option; for example, <code>phraseSlop: 2</code>. You must also specify <code>phraseFields</code> to enable proximity scoring. Valid values: positive integers. Default: 0. Valid for: <code>dismax</code>. -<code>explicitPhraseSlop</code>: An integer value that specifies how much a match can deviate from the search phrase when the phrase is enclosed in double quotes in the search string. (Phrases that exceed this proximity distance are not considered a match.) For example, to specify a slop of three for dismax phrase queries, you would specify <code>"explicitPhraseSlop":3</code>. Valid values: positive integers. Default: 0. Valid for: <code>dismax</code>. -<code>tieBreaker</code>: When a term in the search string is found in a document's field, a score is calculated for that field based on how common the word is in that field compared to other documents. If the term occurs in multiple fields within a document, by default only the highest scoring field contributes to the document's overall score. You can specify a <code>tieBreaker</code> value to enable the matches in lower-scoring fields to contribute to the document's score. That way, if two documents have the same max field score for a particular term, the score for the document that has matches in more fields will be higher. The formula for calculating the score with a tieBreaker is <code>(max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields)</code>. Set <code>tieBreaker</code> to 0 to disregard all but the highest scoring field (pure max): <code>"tieBreaker":0</code>. Set to 1 to sum the scores from all fields (pure sum): <code>"tieBreaker":1</code>. Valid values: 0.0 to 1.0. Default: 0.0. Valid for: <code>dismax</code>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>QueryParser</name><description><para>Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentCmdlet.QueryParser </para></description><parameterValue required="true" variableLength="false">Amazon.CloudSearchDomain.QueryParser</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Return</name><description><para>Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentCmdlet.Return </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Size</name><description><para>Specifies the maximum number of search hits to include in the response. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Sort</name><description><para>Specifies the fields or custom expressions to use to sort the search results. Multiple fields or expressions are specified as a comma-separated list. You must specify the sort direction (<code>asc</code> or <code>desc</code>) for each field; for example, <code>year desc,title asc</code>. To use a field to sort results, the field must be sort-enabled in the domain configuration. Array type fields cannot be used for sorting. If no <code>sort</code> parameter is specified, results are sorted by their default relevance scores in descending order: <code>_score desc</code>. You can also sort by document ID (<code>_id asc</code>) and version (<code>_version desc</code>). For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/sorting-results.html">Sorting Results</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Start</name><description><para>Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0. You can specify either the <code>start</code> or <code>cursor</code> parameter in a request, they are mutually exclusive. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html">Paginating Results</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>UseAnonymousCredentials</name><description><para>If set, the cmdlet calls the service operation using anonymous credentials. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudSearchDomain.Model.SearchResponse). Specifying the name of a property of type Amazon.CloudSearchDomain.Model.SearchResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Cursor</name><description><para>Retrieves a cursor value you can use to page through large result sets. Use the <code>size</code> parameter to control the number of hits to include in each response. You can specify either the <code>cursor</code> or <code>start</code> parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor value to <code>initial</code>. In subsequent requests, specify the cursor value returned in the hits section of the response. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html">Paginating Results</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Expr</name><description><para>Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify expressions as return fields. You specify the expressions in JSON using the form <code>{"EXPRESSIONNAME":"EXPRESSION"}</code>. You can define and use multiple expressions in a search request. For example: <code> {"expression1":"_score*rating", "expression2":"(1/rank)*year"} </code> For information about the variables, operators, and functions you can use in expressions, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html#writing-expressions">Writing Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Facet</name><description><para>Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each specified field must be facet-enabled in the domain configuration. The fields and options are specified in JSON using the form <code>{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}</code>. You can specify the following faceting options: - <code>buckets</code> specifies an array of the facet values or ranges to count. Ranges are specified using the same syntax that you use to search for a range of values. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-ranges.html"> Searching for a Range of Values</a> in the <i>Amazon CloudSearch Developer Guide</i>. Buckets are returned in the order they are specified in the request. The <code>sort</code> and <code>size</code> options are not valid if you specify <code>buckets</code>. - <code>size</code> specifies the maximum number of facets to include in the results. By default, Amazon CloudSearch returns counts for the top 10. The <code>size</code> parameter is only valid when you specify the <code>sort</code> option; it cannot be used in conjunction with <code>buckets</code>. - <code>sort</code> specifies how you want to sort the facets in the results: <code>bucket</code> or <code>count</code>. Specify <code>bucket</code> to sort alphabetically or numerically by facet value (in ascending order). Specify <code>count</code> to sort by the facet counts computed for each facet value (in descending order). To retrieve facet counts for particular values or ranges of values, use the <code>buckets</code> option instead of <code>sort</code>. If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results. To count particular buckets of values, use the <code>buckets</code> option. For example, the following request uses the <code>buckets</code> option to calculate and return facet counts by decade. <code> {"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}} </code> To sort facets by facet count, use the <code>count</code> option. For example, the following request sets the <code>sort</code> option to <code>count</code> to sort the facet values by facet count, with the facet values that have the most matching documents listed first. Setting the <code>size</code> option to 3 returns only the top three facet values. <code> {"year":{"sort":"count","size":3}} </code> To sort the facets by value, use the <code>bucket</code> option. For example, the following request sets the <code>sort</code> option to <code>bucket</code> to sort the facet values numerically by year, with earliest year listed first. <code> {"year":{"sort":"bucket"}} </code> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/faceting.html">Getting and Using Facet Information</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FilterQuery</name><description><para>Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use <code>filterQuery</code> in conjunction with the <code>query</code> parameter to filter the documents that match the constraints specified in the <code>query</code> parameter. Specifying a filter controls only which matching documents are included in the results, it has no effect on how they are scored and sorted. The <code>filterQuery</code> parameter supports the full structured query syntax. For more information about using filters, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/filtering-results.html">Filtering Matching Documents</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Highlight</name><description><para>Retrieves highlights for matches in the specified <code>text</code> or <code>text-array</code> fields. Each specified field must be highlight enabled in the domain configuration. The fields and options are specified in JSON using the form <code>{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}</code>. You can specify the following highlight options: -<code>format</code>: specifies the format of the data in the text field: <code>text</code> or <code>html</code>. When data is returned as HTML, all non-alphanumeric characters are encoded. The default is <code>html</code>. -<code>max_phrases</code>: specifies the maximum number of occurrences of the search term(s) you want to highlight. By default, the first occurrence is highlighted. -<code>pre_tag</code>: specifies the string to prepend to an occurrence of a search term. The default for HTML highlights is <code>&lt;em&gt;</code>. The default for text highlights is <code>*</code>. -<code>post_tag</code>: specifies the string to append to an occurrence of a search term. The default for HTML highlights is <code>&lt;/em&gt;</code>. The default for text highlights is <code>*</code>. If no highlight options are specified for a field, the returned field text is treated as HTML and the first match is highlighted with emphasis tags: <code>&lt;em>search-term&lt;/em&gt;</code>. For example, the following request retrieves highlights for the <code>actors</code> and <code>title</code> fields. <code>{ "actors": {}, "title": {"format": "text","max_phrases": 2,"pre_tag": "<b>","post_tag": "</b>"} }</code> </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Partial</name><description><para>Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage. </para></description><parameterValue required="true" variableLength="false">System.Boolean</parameterValue><type><name>System.Boolean</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"><name>Query</name><description><para>Specifies the search criteria for the request. How you specify the search criteria depends on the query parser used for the request and the parser options specified in the <code>queryOptions</code> parameter. By default, the <code>simple</code> query parser is used to process requests. To use the <code>structured</code>, <code>lucene</code>, or <code>dismax</code> query parser, you must also specify the <code>queryParser</code> parameter. For more information about specifying search criteria, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html">Searching Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>QueryOption</name><description><para>Configures options for the query parser specified in the <code>queryParser</code> parameter. You specify the options in JSON using the following form <code>{"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"}.</code> The options you can configure vary according to which parser you use: -<code>defaultOperator</code>: The default operator used to combine individual terms in the search string. For example: <code>defaultOperator: 'or'</code>. For the <code>dismax</code> parser, you specify a percentage that represents the percentage of terms in the search string (rounded down) that must match, rather than a default operator. A value of <code>0%</code> is the equivalent to OR, and a value of <code>100%</code> is equivalent to AND. The percentage must be specified as a value in the range 0-100 followed by the percent (%) symbol. For example, <code>defaultOperator: 50%</code>. Valid values: <code>and</code>, <code>or</code>, a percentage in the range 0%-100% (<code>dismax</code>). Default: <code>and</code> (<code>simple</code>, <code>structured</code>, <code>lucene</code>) or <code>100</code> (<code>dismax</code>). Valid for: <code>simple</code>, <code>structured</code>, <code>lucene</code>, and <code>dismax</code>. -<code>fields</code>: An array of the fields to search when no fields are specified in a search. If no fields are specified in a search and this option is not specified, all text and text-array fields are searched. You can specify a weight for each field to control the relative importance of each field when Amazon CloudSearch calculates relevance scores. To specify a field weight, append a caret (<code>^</code>) symbol and the weight to the field name. For example, to boost the importance of the <code>title</code> field over the <code>description</code> field you could specify: <code>"fields":["title^5","description"]</code>. Valid values: The name of any configured field and an optional numeric value greater than zero. Default: All <code>text</code> and <code>text-array</code> fields. Valid for: <code>simple</code>, <code>structured</code>, <code>lucene</code>, and <code>dismax</code>. -<code>operators</code>: An array of the operators or special characters you want to disable for the simple query parser. If you disable the <code>and</code>, <code>or</code>, or <code>not</code> operators, the corresponding operators (<code>+</code>, <code>|</code>, <code>-</code>) have no special meaning and are dropped from the search string. Similarly, disabling <code>prefix</code> disables the wildcard operator (<code>*</code>) and disabling <code>phrase</code> disables the ability to search for phrases by enclosing phrases in double quotes. Disabling precedence disables the ability to control order of precedence using parentheses. Disabling <code>near</code> disables the ability to use the ~ operator to perform a sloppy phrase search. Disabling the <code>fuzzy</code> operator disables the ability to use the ~ operator to perform a fuzzy search. <code>escape</code> disables the ability to use a backslash (<code>\</code>) to escape special characters within the search string. Disabling whitespace is an advanced option that prevents the parser from tokenizing on whitespace, which can be useful for Vietnamese. (It prevents Vietnamese words from being split incorrectly.) For example, you could disable all operators other than the phrase operator to support just simple term and phrase queries: <code>"operators":["and","not","or", "prefix"]</code>. Valid values: <code>and</code>, <code>escape</code>, <code>fuzzy</code>, <code>near</code>, <code>not</code>, <code>or</code>, <code>phrase</code>, <code>precedence</code>, <code>prefix</code>, <code>whitespace</code>. Default: All operators and special characters are enabled. Valid for: <code>simple</code>. -<code>phraseFields</code>: An array of the <code>text</code> or <code>text-array</code> fields you want to use for phrase searches. When the terms in the search string appear in close proximity within a field, the field scores higher. You can specify a weight for each field to boost that score. The <code>phraseSlop</code> option controls how much the matches can deviate from the search string and still be boosted. To specify a field weight, append a caret (<code>^</code>) symbol and the weight to the field name. For example, to boost phrase matches in the <code>title</code> field over the <code>abstract</code> field, you could specify: <code>"phraseFields":["title^3", "plot"]</code> Valid values: The name of any <code>text</code> or <code>text-array</code> field and an optional numeric value greater than zero. Default: No fields. If you don't specify any fields with <code>phraseFields</code>, proximity scoring is disabled even if <code>phraseSlop</code> is specified. Valid for: <code>dismax</code>. -<code>phraseSlop</code>: An integer value that specifies how much matches can deviate from the search phrase and still be boosted according to the weights specified in the <code>phraseFields</code> option; for example, <code>phraseSlop: 2</code>. You must also specify <code>phraseFields</code> to enable proximity scoring. Valid values: positive integers. Default: 0. Valid for: <code>dismax</code>. -<code>explicitPhraseSlop</code>: An integer value that specifies how much a match can deviate from the search phrase when the phrase is enclosed in double quotes in the search string. (Phrases that exceed this proximity distance are not considered a match.) For example, to specify a slop of three for dismax phrase queries, you would specify <code>"explicitPhraseSlop":3</code>. Valid values: positive integers. Default: 0. Valid for: <code>dismax</code>. -<code>tieBreaker</code>: When a term in the search string is found in a document's field, a score is calculated for that field based on how common the word is in that field compared to other documents. If the term occurs in multiple fields within a document, by default only the highest scoring field contributes to the document's overall score. You can specify a <code>tieBreaker</code> value to enable the matches in lower-scoring fields to contribute to the document's score. That way, if two documents have the same max field score for a particular term, the score for the document that has matches in more fields will be higher. The formula for calculating the score with a tieBreaker is <code>(max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields)</code>. Set <code>tieBreaker</code> to 0 to disregard all but the highest scoring field (pure max): <code>"tieBreaker":0</code>. Set to 1 to sum the scores from all fields (pure sum): <code>"tieBreaker":1</code>. Valid values: 0.0 to 1.0. Default: 0.0. Valid for: <code>dismax</code>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>QueryParser</name><description><para>Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentCmdlet.QueryParser </para></description><parameterValue required="true" variableLength="false">Amazon.CloudSearchDomain.QueryParser</parameterValue><type><name>Amazon.CloudSearchDomain.QueryParser</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Return</name><description><para>Amazon.PowerShell.Cmdlets.CSD.SearchCSDDocumentCmdlet.Return </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudSearchDomain.Model.SearchResponse). Specifying the name of a property of type Amazon.CloudSearchDomain.Model.SearchResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ServiceUrl</name><description><para>Specifies the Search or Document service endpoint. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Size</name><description><para>Specifies the maximum number of search hits to include in the response. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue><type><name>System.Int64</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Sort</name><description><para>Specifies the fields or custom expressions to use to sort the search results. Multiple fields or expressions are specified as a comma-separated list. You must specify the sort direction (<code>asc</code> or <code>desc</code>) for each field; for example, <code>year desc,title asc</code>. To use a field to sort results, the field must be sort-enabled in the domain configuration. Array type fields cannot be used for sorting. If no <code>sort</code> parameter is specified, results are sorted by their default relevance scores in descending order: <code>_score desc</code>. You can also sort by document ID (<code>_id asc</code>) and version (<code>_version desc</code>). For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/sorting-results.html">Sorting Results</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Start</name><description><para>Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0. You can specify either the <code>start</code> or <code>cursor</code> parameter in a request, they are mutually exclusive. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html">Paginating Results</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para></description><parameterValue required="true" variableLength="false">System.Int64</parameterValue><type><name>System.Int64</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>UseAnonymousCredentials</name><description><para>If set, the cmdlet calls the service operation using anonymous credentials. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.CloudSearchDomain.Model.SearchResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.CloudSearchDomain.Model.SearchResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Search-CSDDocument.html&tocid=Search-CSDDocument</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Developer Guide:</linkText><uri>https://docs.aws.amazon.com/cloudsearch/latest/developerguide/</uri></navigationLink></relatedLinks></command><command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><details><name>Write-CSDDocument</name><description><para>Calls the Amazon CloudSearchDomain UploadDocuments API operation.</para></description><verb>Write</verb><noun>CSDDocument</noun><copyright><para>&copy; Copyright 2012 - 2024 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para></copyright></details><description><para>Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain&#39;s document service. The endpoint for submitting <code>UploadDocuments</code> requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain&#39;s endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. For more information about formatting your data for Amazon CloudSearch, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html">Preparing Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. For more information about uploading data for indexing, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html">Uploading Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias <i>Write-CSDDocuments</i>. </para></description><syntax><syntaxItem><name>Write-CSDDocument</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ServiceUrl</name><description><para>Specifies the Search or Document service endpoint. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ContentType</name><description><para>The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats: -application/json -application/xml </para></description><parameterValue required="true" variableLength="false">Amazon.CloudSearchDomain.ContentType</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FilePath</name><description><para>The full path and name to a file that contains a batch of documents to be uploaded. The batch of documents should be formatted in JSON or HTML. If this property is set, the UploadDocumentsRequest.Documents property is ignored. For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>UseAnonymousCredentials</name><description><para>If set, the cmdlet calls the service operation using anonymous credentials. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudSearchDomain.Model.UploadDocumentsResponse). Specifying the name of a property of type Amazon.CloudSearchDomain.Model.UploadDocumentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem><syntaxItem><name>Write-CSDDocument</name><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ServiceUrl</name><description><para>Specifies the Search or Document service endpoint. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ContentType</name><description><para>The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats: -application/json -application/xml </para></description><parameterValue required="true" variableLength="false">Amazon.CloudSearchDomain.ContentType</parameterValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Document</name><description><para>A batch of documents formatted in JSON or HTML. </para></description><parameterValue required="true" variableLength="false">System.IO.Stream</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>UseAnonymousCredentials</name><description><para>If set, the cmdlet calls the service operation using anonymous credentials. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudSearchDomain.Model.UploadDocumentsResponse). Specifying the name of a property of type Amazon.CloudSearchDomain.Model.UploadDocumentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue></parameter></syntaxItem></syntax><parameters><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>AccessKey</name><description><para>The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ContentType</name><description><para>The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats: -application/json -application/xml </para></description><parameterValue required="true" variableLength="false">Amazon.CloudSearchDomain.ContentType</parameterValue><type><name>Amazon.CloudSearchDomain.ContentType</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>Credential</name><description><para>An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials. </para></description><parameterValue required="true" variableLength="false">Amazon.Runtime.AWSCredentials</parameterValue><type><name>Amazon.Runtime.AWSCredentials</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Document</name><description><para>A batch of documents formatted in JSON or HTML. </para></description><parameterValue required="true" variableLength="false">System.IO.Stream</parameterValue><type><name>System.IO.Stream</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>EndpointUrl</name><description><para>The endpoint to make the call against. <b>Note:</b> This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>FilePath</name><description><para>The full path and name to a file that contains a batch of documents to be uploaded. The batch of documents should be formatted in JSON or HTML. If this property is set, the UploadDocumentsRequest.Documents property is ignored. For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Force</name><description><para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="Named"><name>NetworkCredential</name><description><para>Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.PSCredential</parameterValue><type><name>System.Management.Automation.PSCredential</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileLocation</name><description><para>Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs) If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given. As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>ProfileName</name><description><para>The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>Region</name><description><para>The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific. </para></description><parameterValue required="true" variableLength="false">System.Object</parameterValue><type><name>System.Object</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SecretKey</name><description><para>The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"><name>Select</name><description><para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudSearchDomain.Model.UploadDocumentsResponse). Specifying the name of a property of type Amazon.CloudSearchDomain.Model.UploadDocumentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"><name>ServiceUrl</name><description><para>Specifies the Search or Document service endpoint. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>SessionToken</name><description><para>The session token if the access and secret keys are temporary session-based credentials. </para></description><parameterValue required="true" variableLength="false">System.String</parameterValue><type><name>System.String</name><uri /></type><defaultValue>None</defaultValue></parameter><parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"><name>UseAnonymousCredentials</name><description><para>If set, the cmdlet calls the service operation using anonymous credentials. </para></description><parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue><type><name>System.Management.Automation.SwitchParameter</name><uri /></type><defaultValue>None</defaultValue></parameter></parameters><returnValues><returnValue><type><name>Amazon.CloudSearchDomain.Model.UploadDocumentsResponse</name><uri /><description /></type><description><para>This cmdlet returns an Amazon.CloudSearchDomain.Model.UploadDocumentsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para></description></returnValue></returnValues><relatedLinks><navigationLink><linkText>Online version:</linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Write-CSDDocument.html&tocid=Write-CSDDocument</uri></navigationLink><navigationLink><linkText>Common credential and region parameters: </linkText><uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri></navigationLink><navigationLink><linkText>Developer Guide:</linkText><uri>https://docs.aws.amazon.com/cloudsearch/latest/developerguide/</uri></navigationLink></relatedLinks></command></helpItems> |