AWS.Tools.Comprehend.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Comprehend</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.COMP.AddCOMPResourceTagCmdlet"> <summary> Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.AddCOMPResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.AddCOMPResourceTagCmdlet.Tag"> <summary> <para> <para>Tags being associated with a specific Amazon Comprehend resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.AddCOMPResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.AddCOMPResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPDominantLanguageCmdlet"> <summary> Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html">Amazon Comprehend Supported Languages</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPDominantLanguageCmdlet.Text"> <summary> <para> <para>A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPDominantLanguageBatchCmdlet"> <summary> Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html">Amazon Comprehend Supported Languages</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPDominantLanguageBatchCmdlet.TextList"> <summary> <para> <para>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPEntityCmdlet"> <summary> Inspects text for named entities, and returns information about them. For more information, about named entities, see <a>how-entities</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPEntityCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPEntityCmdlet.Text"> <summary> <para> <para>A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPEntityBatchCmdlet"> <summary> Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see <a>how-entities</a> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPEntityBatchCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPEntityBatchCmdlet.TextList"> <summary> <para> <para>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPKeyPhraseCmdlet"> <summary> Detects the key noun phrases found in the text. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPKeyPhraseCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPKeyPhraseCmdlet.Text"> <summary> <para> <para>A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPKeyPhrasesBatchCmdlet"> <summary> Detects the key noun phrases found in a batch of documents. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPKeyPhrasesBatchCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPKeyPhrasesBatchCmdlet.TextList"> <summary> <para> <para>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSentimentCmdlet"> <summary> Inspects text and returns an inference of the prevailing sentiment (<code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSentimentCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSentimentCmdlet.Text"> <summary> <para> <para>A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSentimentBatchCmdlet"> <summary> Inspects a batch of documents and returns an inference of the prevailing sentiment, <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>, in each one. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSentimentBatchCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSentimentBatchCmdlet.TextList"> <summary> <para> <para>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSyntaxCmdlet"> <summary> Inspects text for syntax and the part of speech of words in the document. For more information, <a>how-syntax</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSyntaxCmdlet.LanguageCode"> <summary> <para> <para>The language code of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt").</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSyntaxCmdlet.Text"> <summary> <para> <para>A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSyntaxBatchCmdlet"> <summary> Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see <a>how-syntax</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSyntaxBatchCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSyntaxBatchCmdlet.TextList"> <summary> <para> <para>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassificationJobCmdlet"> <summary> Gets the properties associated with a document classification job. Use this operation to get the status of a classification job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassificationJobCmdlet.JobId"> <summary> <para> <para>The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassificationJobListCmdlet"> <summary> Gets a list of the documentation classification jobs that you have submitted.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassificationJobListCmdlet.Filter_JobName"> <summary> <para> <para>Filters on the name of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassificationJobListCmdlet.Filter_JobStatus"> <summary> <para> <para>Filters the list based on job status. Returns only jobs with the specified status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassificationJobListCmdlet.Filter_SubmitTimeAfter"> <summary> <para> <para>Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassificationJobListCmdlet.Filter_SubmitTimeBefore"> <summary> <para> <para>Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassificationJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in each page. The default is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassificationJobListCmdlet.NextToken"> <summary> <para> <para>Identifies the next page of results to return.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierCmdlet"> <summary> Gets the properties associated with a document classifier. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierCmdlet.DocumentClassifierArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierListCmdlet"> <summary> Gets a list of the document classifiers that you have created.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierListCmdlet.Filter_Status"> <summary> <para> <para>Filters the list of classifiers based on status. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierListCmdlet.Filter_SubmitTimeAfter"> <summary> <para> <para>Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierListCmdlet.Filter_SubmitTimeBefore"> <summary> <para> <para>Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted before the specified time. Classifiers are returned in ascending order, oldest to newest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in each page. The default is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierListCmdlet.NextToken"> <summary> <para> <para>Identifies the next page of results to return.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDominantLanguageDetectionJobCmdlet"> <summary> Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDominantLanguageDetectionJobCmdlet.JobId"> <summary> <para> <para>The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDominantLanguageDetectionJobListCmdlet"> <summary> Gets a list of the dominant language detection jobs that you have submitted.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDominantLanguageDetectionJobListCmdlet.Filter"> <summary> <para> <para>Filters that jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDominantLanguageDetectionJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in each page. The default is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDominantLanguageDetectionJobListCmdlet.NextToken"> <summary> <para> <para>Identifies the next page of results to return.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntitiesDetectionJobCmdlet"> <summary> Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntitiesDetectionJobCmdlet.JobId"> <summary> <para> <para>The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntitiesDetectionJobListCmdlet"> <summary> Gets a list of the entity detection jobs that you have submitted.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntitiesDetectionJobListCmdlet.Filter"> <summary> <para> <para>Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntitiesDetectionJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in each page. The default is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntitiesDetectionJobListCmdlet.NextToken"> <summary> <para> <para>Identifies the next page of results to return.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerCmdlet"> <summary> Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerCmdlet.EntityRecognizerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that identifies the entity recognizer.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerListCmdlet"> <summary> Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list. <para> The results of this list are not in any particular order. Please get the list and sort locally if needed. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerListCmdlet.Filter_Status"> <summary> <para> <para>The status of an entity recognizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerListCmdlet.Filter_SubmitTimeAfter"> <summary> <para> <para>Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerListCmdlet.Filter_SubmitTimeBefore"> <summary> <para> <para>Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of results to return on each page. The default is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerListCmdlet.NextToken"> <summary> <para> <para>Identifies the next page of results to return.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPKeyPhrasesDetectionJobCmdlet"> <summary> Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPKeyPhrasesDetectionJobCmdlet.JobId"> <summary> <para> <para>The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPKeyPhrasesDetectionJobListCmdlet"> <summary> Get a list of key phrase detection jobs that you have submitted.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPKeyPhrasesDetectionJobListCmdlet.Filter"> <summary> <para> <para>Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPKeyPhrasesDetectionJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in each page. The default is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPKeyPhrasesDetectionJobListCmdlet.NextToken"> <summary> <para> <para>Identifies the next page of results to return.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPResourceTagCmdlet"> <summary> Lists all tags associated with a given Amazon Comprehend resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPSentimentDetectionJobCmdlet"> <summary> Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPSentimentDetectionJobCmdlet.JobId"> <summary> <para> <para>The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPSentimentDetectionJobListCmdlet"> <summary> Gets a list of sentiment detection jobs that you have submitted.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPSentimentDetectionJobListCmdlet.Filter"> <summary> <para> <para>Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPSentimentDetectionJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in each page. The default is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPSentimentDetectionJobListCmdlet.NextToken"> <summary> <para> <para>Identifies the next page of results to return.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTopicsDetectionJobCmdlet"> <summary> Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTopicsDetectionJobCmdlet.JobId"> <summary> <para> <para>The identifier assigned by the user to the detection job.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTopicsDetectionJobListCmdlet"> <summary> Gets a list of the topic detection jobs that you have submitted.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTopicsDetectionJobListCmdlet.Filter"> <summary> <para> <para>Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTopicsDetectionJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in each page. The default is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTopicsDetectionJobListCmdlet.NextToken"> <summary> <para> <para>Identifies the next page of results to return.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet"> <summary> Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see <a>how-document-classification</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.ClientRequestToken"> <summary> <para> <para>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.DocumentClassifierName"> <summary> <para> <para>The name of the document classifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.OutputDataConfig_KmsKeyId"> <summary> <para> <para>ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:</para><ul><li><para>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li><li><para>KMS Key Alias: <code>"alias/ExampleAlias"</code></para></li><li><para>ARN of a KMS Key Alias: <code>"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.InputDataConfig_S3Uri"> <summary> <para> <para>The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.</para><para>For example, if you use the URI <code>S3://bucketName/prefix</code>, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.OutputDataConfig_S3Uri"> <summary> <para> <para>When you use the <code>OutputDataConfig</code> object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.</para><para>When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The <code>S3Uri</code> field contains the location of the output file, called <code>output.tar.gz</code>. It is a compressed archive that contains the confusion matrix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html">Security Groups for your VPC</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">VPCs and Subnets</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.Tag"> <summary> <para> <para>Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:</para><ul><li><para>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet"> <summary> Creates an entity recognizer using submitted files. After your <code>CreateEntityRecognizer</code> request is submitted, you can check job status using the API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.ClientRequestToken"> <summary> <para> <para> A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.InputDataConfig_EntityType"> <summary> <para> <para>The entity types in the input data for an entity recognizer. A maximum of 12 entity types can be used at one time to train an entity recognizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.LanguageCode"> <summary> <para> <para> The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.RecognizerName"> <summary> <para> <para>The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.Annotations_S3Uri"> <summary> <para> <para> Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.Documents_S3Uri"> <summary> <para> <para> Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.EntityList_S3Uri"> <summary> <para> <para>Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html">Security Groups for your VPC</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">VPCs and Subnets</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.Tag"> <summary> <para> <para>Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:</para><ul><li><para>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPDocumentClassifierCmdlet"> <summary> Deletes a previously created document classifier <para> Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a <code>ResourceInUseException</code> will be returned. </para><para> This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPDocumentClassifierCmdlet.DocumentClassifierArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that identifies the document classifier. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPDocumentClassifierCmdlet.PassThru"> <summary> Returns the value passed to the DocumentClassifierArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPDocumentClassifierCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPEntityRecognizerCmdlet"> <summary> Deletes an entity recognizer. <para> Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a <code>ResourceInUseException</code> will be returned. </para><para> This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPEntityRecognizerCmdlet.EntityRecognizerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that identifies the entity recognizer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPEntityRecognizerCmdlet.PassThru"> <summary> Returns the value passed to the EntityRecognizerArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPEntityRecognizerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPResourceTagCmdlet"> <summary> Removes a specific tag associated with an Amazon Comprehend resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPResourceTagCmdlet.ResourceArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPResourceTagCmdlet.TagKey"> <summary> <para> <para>The initial part of a key-value pair that forms a tag being removed from a given resource. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. Keys must be unique and cannot be duplicated for a particular resource. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDocumentClassificationJobCmdlet"> <summary> Starts an asynchronous document classification job. Use the operation to track the progress of the job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDocumentClassificationJobCmdlet.ClientRequestToken"> <summary> <para> <para>A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDocumentClassificationJobCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDocumentClassificationJobCmdlet.DocumentClassifierArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the document classifier to use to process the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDocumentClassificationJobCmdlet.InputDataConfig"> <summary> <para> <para>Specifies the format and location of the input data for the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDocumentClassificationJobCmdlet.JobName"> <summary> <para> <para>The identifier of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDocumentClassificationJobCmdlet.OutputDataConfig"> <summary> <para> <para>Specifies where to send the output files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDocumentClassificationJobCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html">Security Groups for your VPC</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDocumentClassificationJobCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">VPCs and Subnets</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDocumentClassificationJobCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:</para><ul><li><para>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDocumentClassificationJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDominantLanguageDetectionJobCmdlet"> <summary> Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDominantLanguageDetectionJobCmdlet.ClientRequestToken"> <summary> <para> <para>A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDominantLanguageDetectionJobCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions">https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDominantLanguageDetectionJobCmdlet.InputDataConfig"> <summary> <para> <para>Specifies the format and location of the input data for the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDominantLanguageDetectionJobCmdlet.JobName"> <summary> <para> <para>An identifier for the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDominantLanguageDetectionJobCmdlet.OutputDataConfig"> <summary> <para> <para>Specifies where to send the output files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDominantLanguageDetectionJobCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html">Security Groups for your VPC</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDominantLanguageDetectionJobCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">VPCs and Subnets</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDominantLanguageDetectionJobCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:</para><ul><li><para>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDominantLanguageDetectionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEntitiesDetectionJobCmdlet"> <summary> Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job. <para> This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional <code>EntityRecognizerArn</code> must be used in order to provide access to the recognizer being used to detect the custom entity. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEntitiesDetectionJobCmdlet.ClientRequestToken"> <summary> <para> <para>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEntitiesDetectionJobCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions">https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEntitiesDetectionJobCmdlet.EntityRecognizerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the <code>StartEntitiesDetectionJob</code>. This ARN is optional and is only used for a custom entity recognition job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEntitiesDetectionJobCmdlet.InputDataConfig"> <summary> <para> <para>Specifies the format and location of the input data for the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEntitiesDetectionJobCmdlet.JobName"> <summary> <para> <para>The identifier of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEntitiesDetectionJobCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), German ("de"), Italian ("it"), or Portuguese ("pt"). If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEntitiesDetectionJobCmdlet.OutputDataConfig"> <summary> <para> <para>Specifies where to send the output files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEntitiesDetectionJobCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html">Security Groups for your VPC</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEntitiesDetectionJobCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">VPCs and Subnets</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEntitiesDetectionJobCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:</para><ul><li><para>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEntitiesDetectionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.StartCOMPKeyPhrasesDetectionJobCmdlet"> <summary> Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPKeyPhrasesDetectionJobCmdlet.ClientRequestToken"> <summary> <para> <para>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPKeyPhrasesDetectionJobCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions">https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPKeyPhrasesDetectionJobCmdlet.InputDataConfig"> <summary> <para> <para>Specifies the format and location of the input data for the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPKeyPhrasesDetectionJobCmdlet.JobName"> <summary> <para> <para>The identifier of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPKeyPhrasesDetectionJobCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPKeyPhrasesDetectionJobCmdlet.OutputDataConfig"> <summary> <para> <para>Specifies where to send the output files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPKeyPhrasesDetectionJobCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html">Security Groups for your VPC</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPKeyPhrasesDetectionJobCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">VPCs and Subnets</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPKeyPhrasesDetectionJobCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:</para><ul><li><para>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPKeyPhrasesDetectionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.StartCOMPSentimentDetectionJobCmdlet"> <summary> Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPSentimentDetectionJobCmdlet.ClientRequestToken"> <summary> <para> <para>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPSentimentDetectionJobCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions">https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPSentimentDetectionJobCmdlet.InputDataConfig"> <summary> <para> <para>Specifies the format and location of the input data for the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPSentimentDetectionJobCmdlet.JobName"> <summary> <para> <para>The identifier of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPSentimentDetectionJobCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPSentimentDetectionJobCmdlet.OutputDataConfig"> <summary> <para> <para>Specifies where to send the output files. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPSentimentDetectionJobCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html">Security Groups for your VPC</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPSentimentDetectionJobCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">VPCs and Subnets</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPSentimentDetectionJobCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:</para><ul><li><para>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPSentimentDetectionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTopicsDetectionJobCmdlet"> <summary> Starts an asynchronous topic detection job. Use the <code>DescribeTopicDetectionJob</code> operation to track the status of a job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTopicsDetectionJobCmdlet.ClientRequestToken"> <summary> <para> <para>A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTopicsDetectionJobCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions">https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTopicsDetectionJobCmdlet.InputDataConfig"> <summary> <para> <para>Specifies the format and location of the input data for the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTopicsDetectionJobCmdlet.JobName"> <summary> <para> <para>The identifier of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTopicsDetectionJobCmdlet.NumberOfTopic"> <summary> <para> <para>The number of topics to detect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTopicsDetectionJobCmdlet.OutputDataConfig"> <summary> <para> <para>Specifies where to send the output files. The output is a compressed archive with two files, <code>topic-terms.csv</code> that lists the terms associated with each topic, and <code>doc-topics.csv</code> that lists the documents associated with each topic</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTopicsDetectionJobCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html">Security Groups for your VPC</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTopicsDetectionJobCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">VPCs and Subnets</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTopicsDetectionJobCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:</para><ul><li><para>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTopicsDetectionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.StopCOMPDominantLanguageDetectionJobCmdlet"> <summary> Stops a dominant language detection job in progress. <para> If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the <code>COMPLETED</code> state; otherwise the job is stopped and put into the <code>STOPPED</code> state. </para><para> If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception. </para><para> When a job is stopped, any documents already processed are written to the output location. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPDominantLanguageDetectionJobCmdlet.JobId"> <summary> <para> <para>The identifier of the dominant language detection job to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPDominantLanguageDetectionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.StopCOMPEntitiesDetectionJobCmdlet"> <summary> Stops an entities detection job in progress. <para> If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the <code>COMPLETED</code> state; otherwise the job is stopped and put into the <code>STOPPED</code> state. </para><para> If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception. </para><para> When a job is stopped, any documents already processed are written to the output location. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPEntitiesDetectionJobCmdlet.JobId"> <summary> <para> <para>The identifier of the entities detection job to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPEntitiesDetectionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.StopCOMPKeyPhrasesDetectionJobCmdlet"> <summary> Stops a key phrases detection job in progress. <para> If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the <code>COMPLETED</code> state; otherwise the job is stopped and put into the <code>STOPPED</code> state. </para><para> If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception. </para><para> When a job is stopped, any documents already processed are written to the output location. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPKeyPhrasesDetectionJobCmdlet.JobId"> <summary> <para> <para>The identifier of the key phrases detection job to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPKeyPhrasesDetectionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.StopCOMPSentimentDetectionJobCmdlet"> <summary> Stops a sentiment detection job in progress. <para> If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the <code>COMPLETED</code> state; otherwise the job is be stopped and put into the <code>STOPPED</code> state. </para><para> If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception. </para><para> When a job is stopped, any documents already processed are written to the output location. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPSentimentDetectionJobCmdlet.JobId"> <summary> <para> <para>The identifier of the sentiment detection job to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPSentimentDetectionJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.StopCOMPTrainingDocumentClassifierCmdlet"> <summary> Stops a document classifier training job while in progress. <para> If the training job state is <code>TRAINING</code>, the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the training job completes before it can be stopped, it is put into the <code>TRAINED</code>; otherwise the training job is stopped and put into the <code>STOPPED</code> state and the service sends back an HTTP 200 response with an empty HTTP body. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPTrainingDocumentClassifierCmdlet.DocumentClassifierArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPTrainingDocumentClassifierCmdlet.PassThru"> <summary> Returns the value passed to the DocumentClassifierArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPTrainingDocumentClassifierCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.StopCOMPTrainingEntityRecognizerCmdlet"> <summary> Stops an entity recognizer training job while in progress. <para> If the training job state is <code>TRAINING</code>, the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the training job completes before it can be stopped, it is put into the <code>TRAINED</code>; otherwise the training job is stopped and putted into the <code>STOPPED</code> state and the service sends back an HTTP 200 response with an empty HTTP body. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPTrainingEntityRecognizerCmdlet.EntityRecognizerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPTrainingEntityRecognizerCmdlet.PassThru"> <summary> Returns the value passed to the EntityRecognizerArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPTrainingEntityRecognizerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |