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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.AddCOMPResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </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. The string must contain at least 20 characters. The maximum string size is 100 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPDominantLanguageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Languages'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DetectDominantLanguageResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DetectDominantLanguageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPDominantLanguageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Text parameter. The -PassThru parameter is deprecated, use -Select '^Text' instead. This parameter will be removed in a future version. </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 UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters. The maximum size of each document is 5 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPDominantLanguageBatchCmdlet.Select"> <summary> 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.Comprehend.Model.BatchDetectDominantLanguageResponse). Specifying the name of a property of type Amazon.Comprehend.Model.BatchDetectDominantLanguageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPEntityCmdlet"> <summary> Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model. <para> When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html">Entities</a> in the Comprehend Developer Guide. </para><para> When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image). </para><para> If the system detects errors while processing a page in the input document, the API response includes an entry in <c>Errors</c> for each error. </para><para> If the system detects a document-level error in your input document, the API returns an <c>InvalidRequestException</c> error response. For details about this exception, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html"> Errors in semi-structured documents</a> in the Comprehend Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPEntityCmdlet.Byte"> <summary> <para> <para>This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For other cases, enter your text input in the <c>Text</c> field.</para><para> Use the <c>Bytes</c> parameter to input a text, PDF, Word or image file. Using a plain-text file in the <c>Bytes</c> parameter is equivelent to using the <c>Text</c> parameter (the <c>Entities</c> field in the response is identical).</para><para>You can also use the <c>Bytes</c> parameter to input an Amazon Textract <c>DetectDocumentText</c> or <c>AnalyzeDocument</c> output file.</para><para>Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode the document file bytes for you. </para><para>The maximum length of this field depends on the input document type. For details, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html"> Inputs for real-time custom analysis</a> in the Comprehend Developer Guide. </para><para>If you use the <c>Bytes</c> parameter, do not use the <c>Text</c> parameter.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPEntityCmdlet.DocumentReaderConfig_DocumentReadAction"> <summary> <para> <para>This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:</para><ul><li><para><c>TEXTRACT_DETECT_DOCUMENT_TEXT</c> - The Amazon Comprehend service uses the <c>DetectDocumentText</c> API operation. </para></li><li><para><c>TEXTRACT_ANALYZE_DOCUMENT</c> - The Amazon Comprehend service uses the <c>AnalyzeDocument</c> API operation. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPEntityCmdlet.DocumentReaderConfig_DocumentReadMode"> <summary> <para> <para>Determines the text extraction actions for PDF files. Enter one of the following values:</para><ul><li><para><c>SERVICE_DEFAULT</c> - use the Amazon Comprehend service defaults for PDF files.</para></li><li><para><c>FORCE_DOCUMENT_READ_ACTION</c> - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPEntityCmdlet.EndpointArn"> <summary> <para> <para>The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.</para><para>If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.</para><para>For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPEntityCmdlet.DocumentReaderConfig_FeatureType"> <summary> <para> <para>Specifies the type of Amazon Textract features to apply. If you chose <c>TEXTRACT_ANALYZE_DOCUMENT</c> as the read action, you must specify one or both of the following values:</para><ul><li><para><c>TABLES</c> - Returns additional information about any tables that are detected in the input document. </para></li><li><para><c>FORMS</c> - Returns additional information about any forms that are detected in the input document. </para></li></ul> </para> </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. If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.</para><para>All input 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. The maximum string size is 100 KB. If you enter text using this parameter, do not use the <c>Bytes</c> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPEntityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Entities'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DetectEntitiesResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DetectEntitiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPEntityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Text parameter. The -PassThru parameter is deprecated, use -Select '^Text' instead. This parameter will be removed in a future version. </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 href="https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html">Entities</a> in the Comprehend Developer Guide. </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. 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 UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPEntityBatchCmdlet.Select"> <summary> 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.Comprehend.Model.BatchDetectEntitiesResponse). Specifying the name of a property of type Amazon.Comprehend.Model.BatchDetectEntitiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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. 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. The string must contain less than 100 KB of UTF-8 encoded characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPKeyPhraseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KeyPhrases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DetectKeyPhrasesResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DetectKeyPhrasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPKeyPhraseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Text parameter. The -PassThru parameter is deprecated, use -Select '^Text' instead. This parameter will be removed in a future version. </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. 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 UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPKeyPhrasesBatchCmdlet.Select"> <summary> 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.Comprehend.Model.BatchDetectKeyPhrasesResponse). Specifying the name of a property of type Amazon.Comprehend.Model.BatchDetectKeyPhrasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPPiiEntityCmdlet"> <summary> Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPPiiEntityCmdlet.LanguageCode"> <summary> <para> <para>The language of the input text. Enter the language code for English (en) or Spanish (es).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPPiiEntityCmdlet.Text"> <summary> <para> <para>A UTF-8 text string. The maximum string size is 100 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPPiiEntityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Entities'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DetectPiiEntitiesResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DetectPiiEntitiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPPiiEntityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Text parameter. The -PassThru parameter is deprecated, use -Select '^Text' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPPiiEntityTypeCmdlet"> <summary> Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPPiiEntityTypeCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPPiiEntityTypeCmdlet.Text"> <summary> <para> <para>A UTF-8 text string. The maximum string size is 100 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPPiiEntityTypeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Labels'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ContainsPiiEntitiesResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ContainsPiiEntitiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPPiiEntityTypeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Text parameter. The -PassThru parameter is deprecated, use -Select '^Text' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSentimentCmdlet"> <summary> Inspects text and returns an inference of the prevailing sentiment (<c>POSITIVE</c>, <c>NEUTRAL</c>, <c>MIXED</c>, or <c>NEGATIVE</c>). </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. 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. The maximum string size is 5 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSentimentCmdlet.Select"> <summary> 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.Comprehend.Model.DetectSentimentResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DetectSentimentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSentimentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Text parameter. The -PassThru parameter is deprecated, use -Select '^Text' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSentimentBatchCmdlet"> <summary> Inspects a batch of documents and returns an inference of the prevailing sentiment, <c>POSITIVE</c>, <c>NEUTRAL</c>, <c>MIXED</c>, or <c>NEGATIVE</c>, 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. 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 UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSentimentBatchCmdlet.Select"> <summary> 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.Comprehend.Model.BatchDetectSentimentResponse). Specifying the name of a property of type Amazon.Comprehend.Model.BatchDetectSentimentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html">Syntax</a> in the Comprehend Developer Guide. </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 following 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. The maximum string size is 5 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSyntaxCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SyntaxTokens'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DetectSyntaxResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DetectSyntaxResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSyntaxCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Text parameter. The -PassThru parameter is deprecated, use -Select '^Text' instead. This parameter will be removed in a future version. </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 href="https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html">Syntax</a> in the Comprehend Developer Guide. </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 following 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 UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size for each document is 5 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPSyntaxBatchCmdlet.Select"> <summary> 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.Comprehend.Model.BatchDetectSyntaxResponse). Specifying the name of a property of type Amazon.Comprehend.Model.BatchDetectSyntaxResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPTargetedSentimentCmdlet"> <summary> Inspects the input text and returns a sentiment analysis for each entity identified in the text. <para> For more information about targeted sentiment, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html">Targeted sentiment</a> in the <i>Amazon Comprehend Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPTargetedSentimentCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents. Currently, English is the only supported language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPTargetedSentimentCmdlet.Text"> <summary> <para> <para>A UTF-8 text string. The maximum string length is 5 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPTargetedSentimentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Entities'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DetectTargetedSentimentResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DetectTargetedSentimentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPTargetedSentimentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Text parameter. The -PassThru parameter is deprecated, use -Select '^Text' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPTargetedSentimentBatchCmdlet"> <summary> Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents. <para> For more information about targeted sentiment, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html">Targeted sentiment</a> in the <i>Amazon Comprehend Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPTargetedSentimentBatchCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents. Currently, English is the only supported language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPTargetedSentimentBatchCmdlet.TextList"> <summary> <para> <para>A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPTargetedSentimentBatchCmdlet.Select"> <summary> 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.Comprehend.Model.BatchDetectTargetedSentimentResponse). Specifying the name of a property of type Amazon.Comprehend.Model.BatchDetectTargetedSentimentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.FindCOMPToxicContentCmdlet"> <summary> Performs toxicity analysis on the list of text strings that you provide as input. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html">Toxicity detection</a> in the <i>Amazon Comprehend Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPToxicContentCmdlet.LanguageCode"> <summary> <para> <para>The language of the input text. Currently, English is the only supported language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPToxicContentCmdlet.TextSegment"> <summary> <para> <para>A list of up to 10 text strings. Each string has a maximum size of 1 KB, and the maximum size of the list is 10 KB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPToxicContentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResultList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DetectToxicContentResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DetectToxicContentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.FindCOMPToxicContentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LanguageCode parameter. The -PassThru parameter is deprecated, use -Select '^LanguageCode' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDatasetCmdlet"> <summary> Returns information about the dataset that you specify. For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html"> Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDatasetCmdlet.DatasetArn"> <summary> <para> <para>The ARN of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DescribeDatasetResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribeDatasetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDatasetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatasetArn parameter. The -PassThru parameter is deprecated, use -Select '^DatasetArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDatasetListCmdlet"> <summary> List the datasets that you have configured in this Region. For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html"> Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDatasetListCmdlet.Filter_CreationTimeAfter"> <summary> <para> <para>Filter the datasets to include datasets created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDatasetListCmdlet.Filter_CreationTimeBefore"> <summary> <para> <para>Filter the datasets to include datasets created before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDatasetListCmdlet.Filter_DatasetType"> <summary> <para> <para>Filter the datasets based on the dataset type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDatasetListCmdlet.FlywheelArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the flywheel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDatasetListCmdlet.Filter_Status"> <summary> <para> <para>Filter the datasets based on the dataset status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDatasetListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return in a response. The default is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDatasetListCmdlet.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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDatasetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetPropertiesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListDatasetsResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListDatasetsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDatasetListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlywheelArn parameter. The -PassThru parameter is deprecated, use -Select '^FlywheelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDatasetListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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 <c>StartDocumentClassificationJob</c> operation returns this identifier in its response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassificationJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentClassificationJobProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DescribeDocumentClassificationJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribeDocumentClassificationJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassificationJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </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 cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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 after 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 before 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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>500</b>'.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassificationJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentClassificationJobPropertiesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListDocumentClassificationJobsResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListDocumentClassificationJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassificationJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Filter_JobName parameter. The -PassThru parameter is deprecated, use -Select '^Filter_JobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassificationJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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 <c>CreateDocumentClassifier</c> operation returns this identifier in its response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentClassifierProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DescribeDocumentClassifierResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribeDocumentClassifierResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DocumentClassifierArn parameter. The -PassThru parameter is deprecated, use -Select '^DocumentClassifierArn' instead. This parameter will be removed in a future version. </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 cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierListCmdlet.Filter_DocumentClassifierName"> <summary> <para> <para>The name that you assigned to the document classifier</para> </para> </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>500</b>'.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentClassifierPropertiesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListDocumentClassifiersResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListDocumentClassifiersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierSummaryListCmdlet"> <summary> Gets a list of summaries of the document classifiers that you have created<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierSummaryListCmdlet.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.GetCOMPDocumentClassifierSummaryListCmdlet.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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierSummaryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentClassifierSummariesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListDocumentClassifierSummariesResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListDocumentClassifierSummariesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDocumentClassifierSummaryListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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 <c>StartDominantLanguageDetectionJob</c> operation returns this identifier in its response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDominantLanguageDetectionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DominantLanguageDetectionJobProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DescribeDominantLanguageDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribeDominantLanguageDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDominantLanguageDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </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 cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>500</b>'.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDominantLanguageDetectionJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DominantLanguageDetectionJobPropertiesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListDominantLanguageDetectionJobsResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListDominantLanguageDetectionJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDominantLanguageDetectionJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Filter parameter. The -PassThru parameter is deprecated, use -Select '^Filter' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPDominantLanguageDetectionJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEndpointCmdlet"> <summary> Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEndpointCmdlet.EndpointArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the endpoint being described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DescribeEndpointResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribeEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointArn parameter. The -PassThru parameter is deprecated, use -Select '^EndpointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEndpointListCmdlet"> <summary> Gets a list of all existing endpoints that you've created. For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEndpointListCmdlet.Filter_CreationTimeAfter"> <summary> <para> <para>Specifies a date after which the returned endpoint or endpoints were created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEndpointListCmdlet.Filter_CreationTimeBefore"> <summary> <para> <para>Specifies a date before which the returned endpoint or endpoints were created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEndpointListCmdlet.Filter_ModelArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the model to which the endpoint is attached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEndpointListCmdlet.Filter_Status"> <summary> <para> <para>Specifies the status of the endpoint being returned. Possible values are: Creating, Ready, Updating, Deleting, Failed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEndpointListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in each page. The default is 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>500</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEndpointListCmdlet.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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEndpointListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointPropertiesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListEndpointsResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListEndpointsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEndpointListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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 <c>StartEntitiesDetectionJob</c> operation returns this identifier in its response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntitiesDetectionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EntitiesDetectionJobProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DescribeEntitiesDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribeEntitiesDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntitiesDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </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 cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>500</b>'.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntitiesDetectionJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EntitiesDetectionJobPropertiesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListEntitiesDetectionJobsResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListEntitiesDetectionJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntitiesDetectionJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Filter parameter. The -PassThru parameter is deprecated, use -Select '^Filter' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntitiesDetectionJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EntityRecognizerProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DescribeEntityRecognizerResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribeEntityRecognizerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EntityRecognizerArn parameter. The -PassThru parameter is deprecated, use -Select '^EntityRecognizerArn' instead. This parameter will be removed in a future version. </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 cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerListCmdlet.Filter_RecognizerName"> <summary> <para> <para>The name that you assigned the entity recognizer.</para> </para> </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>500</b>'.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EntityRecognizerPropertiesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListEntityRecognizersResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListEntityRecognizersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Filter_Status parameter. The -PassThru parameter is deprecated, use -Select '^Filter_Status' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerSummaryListCmdlet"> <summary> Gets a list of summaries for the entity recognizers that you have created.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerSummaryListCmdlet.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.GetCOMPEntityRecognizerSummaryListCmdlet.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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerSummaryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EntityRecognizerSummariesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListEntityRecognizerSummariesResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListEntityRecognizerSummariesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEntityRecognizerSummaryListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEventsDetectionJobCmdlet"> <summary> Gets the status and details of an events detection job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEventsDetectionJobCmdlet.JobId"> <summary> <para> <para>The identifier of the events detection job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEventsDetectionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventsDetectionJobProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DescribeEventsDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribeEventsDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEventsDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEventsDetectionJobListCmdlet"> <summary> Gets a list of the events detection jobs that you have submitted.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEventsDetectionJobListCmdlet.Filter_JobName"> <summary> <para> <para>Filters on the name of the events detection job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEventsDetectionJobListCmdlet.Filter_JobStatus"> <summary> <para> <para>Filters the list of jobs based on job status. Returns only jobs with the specified status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEventsDetectionJobListCmdlet.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 after the specified time. Jobs are returned in descending order, newest to oldest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEventsDetectionJobListCmdlet.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 before the specified time. Jobs are returned in ascending order, oldest to newest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEventsDetectionJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in each page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEventsDetectionJobListCmdlet.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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEventsDetectionJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventsDetectionJobPropertiesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListEventsDetectionJobsResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListEventsDetectionJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPEventsDetectionJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelCmdlet"> <summary> Provides configuration information about the flywheel. For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html"> Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelCmdlet.FlywheelArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the flywheel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FlywheelProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DescribeFlywheelResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribeFlywheelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlywheelArn parameter. The -PassThru parameter is deprecated, use -Select '^FlywheelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelIterationCmdlet"> <summary> Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html"> Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelIterationCmdlet.FlywheelArn"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelIterationCmdlet.FlywheelIterationId"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelIterationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FlywheelIterationProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DescribeFlywheelIterationResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribeFlywheelIterationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelIterationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlywheelArn parameter. The -PassThru parameter is deprecated, use -Select '^FlywheelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelIterationHistoryListCmdlet"> <summary> Information about the history of a flywheel iteration. For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html"> Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelIterationHistoryListCmdlet.Filter_CreationTimeAfter"> <summary> <para> <para>Filter the flywheel iterations to include iterations created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelIterationHistoryListCmdlet.Filter_CreationTimeBefore"> <summary> <para> <para>Filter the flywheel iterations to include iterations created before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelIterationHistoryListCmdlet.FlywheelArn"> <summary> <para> <para>The ARN of the flywheel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelIterationHistoryListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of iteration history results to return</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelIterationHistoryListCmdlet.NextToken"> <summary> <para> <para>Next token</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelIterationHistoryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FlywheelIterationPropertiesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListFlywheelIterationHistoryResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListFlywheelIterationHistoryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelIterationHistoryListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlywheelArn parameter. The -PassThru parameter is deprecated, use -Select '^FlywheelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelIterationHistoryListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelListCmdlet"> <summary> Gets a list of the flywheels that you have created.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelListCmdlet.Filter_CreationTimeAfter"> <summary> <para> <para>Filter the flywheels to include flywheels created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelListCmdlet.Filter_CreationTimeBefore"> <summary> <para> <para>Filter the flywheels to include flywheels created before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelListCmdlet.Filter_Status"> <summary> <para> <para>Filter the flywheels based on the flywheel status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return in a response. The default is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelListCmdlet.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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FlywheelSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListFlywheelsResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListFlywheelsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPFlywheelListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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 <c>StartKeyPhrasesDetectionJob</c> operation returns this identifier in its response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPKeyPhrasesDetectionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KeyPhrasesDetectionJobProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DescribeKeyPhrasesDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribeKeyPhrasesDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPKeyPhrasesDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </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 cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>500</b>'.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPKeyPhrasesDetectionJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KeyPhrasesDetectionJobPropertiesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListKeyPhrasesDetectionJobsResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListKeyPhrasesDetectionJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPKeyPhrasesDetectionJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Filter parameter. The -PassThru parameter is deprecated, use -Select '^Filter' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPKeyPhrasesDetectionJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPPiiEntitiesDetectionJobCmdlet"> <summary> Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPPiiEntitiesDetectionJobCmdlet.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="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPPiiEntitiesDetectionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PiiEntitiesDetectionJobProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DescribePiiEntitiesDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribePiiEntitiesDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPPiiEntitiesDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPPiiEntitiesDetectionJobListCmdlet"> <summary> Gets a list of the PII entity detection jobs that you have submitted.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPPiiEntitiesDetectionJobListCmdlet.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.GetCOMPPiiEntitiesDetectionJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in each page.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>500</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPPiiEntitiesDetectionJobListCmdlet.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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPPiiEntitiesDetectionJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PiiEntitiesDetectionJobPropertiesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListPiiEntitiesDetectionJobsResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListPiiEntitiesDetectionJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPPiiEntitiesDetectionJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Filter parameter. The -PassThru parameter is deprecated, use -Select '^Filter' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPPiiEntitiesDetectionJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPResourcePolicyCmdlet"> <summary> Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the custom model version that has the resource policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPResourcePolicyCmdlet.Select"> <summary> 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.Comprehend.Model.DescribeResourcePolicyResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribeResourcePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </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="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </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="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPSentimentDetectionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SentimentDetectionJobProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DescribeSentimentDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribeSentimentDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPSentimentDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </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 cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>500</b>'.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPSentimentDetectionJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SentimentDetectionJobPropertiesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListSentimentDetectionJobsResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListSentimentDetectionJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPSentimentDetectionJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Filter parameter. The -PassThru parameter is deprecated, use -Select '^Filter' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPSentimentDetectionJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTargetedSentimentDetectionJobCmdlet"> <summary> Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTargetedSentimentDetectionJobCmdlet.JobId"> <summary> <para> <para>The identifier that Amazon Comprehend generated for the job. The <c>StartTargetedSentimentDetectionJob</c> operation returns this identifier in its response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTargetedSentimentDetectionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TargetedSentimentDetectionJobProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DescribeTargetedSentimentDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribeTargetedSentimentDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTargetedSentimentDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTargetedSentimentDetectionJobListCmdlet"> <summary> Gets a list of targeted sentiment detection jobs that you have submitted.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTargetedSentimentDetectionJobListCmdlet.Filter_JobName"> <summary> <para> <para>Filters on the name of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTargetedSentimentDetectionJobListCmdlet.Filter_JobStatus"> <summary> <para> <para>Filters the list of jobs based on job status. Returns only jobs with the specified status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTargetedSentimentDetectionJobListCmdlet.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 after the specified time. Jobs are returned in descending order, newest to oldest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTargetedSentimentDetectionJobListCmdlet.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 before the specified time. Jobs are returned in ascending order, oldest to newest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTargetedSentimentDetectionJobListCmdlet.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.GetCOMPTargetedSentimentDetectionJobListCmdlet.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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTargetedSentimentDetectionJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TargetedSentimentDetectionJobPropertiesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListTargetedSentimentDetectionJobsResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListTargetedSentimentDetectionJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTargetedSentimentDetectionJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Filter_JobName parameter. The -PassThru parameter is deprecated, use -Select '^Filter_JobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTargetedSentimentDetectionJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </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="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTopicsDetectionJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TopicsDetectionJobProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DescribeTopicsDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.DescribeTopicsDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTopicsDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </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 cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>500</b>'.</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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTopicsDetectionJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TopicsDetectionJobPropertiesList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ListTopicsDetectionJobsResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ListTopicsDetectionJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTopicsDetectionJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Filter parameter. The -PassThru parameter is deprecated, use -Select '^Filter' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.GetCOMPTopicsDetectionJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COMP.ImportCOMPModelCmdlet"> <summary> Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one. <para> If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it. </para><para> The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.ImportCOMPModelCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.ImportCOMPModelCmdlet.ModelKmsKeyId"> <summary> <para> <para>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:</para><ul><li><para>KMS Key ID: <c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.ImportCOMPModelCmdlet.ModelName"> <summary> <para> <para>The name to assign to the custom model that is created in Amazon Comprehend by this import.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.ImportCOMPModelCmdlet.SourceModelArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the custom model to import.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.ImportCOMPModelCmdlet.Tag"> <summary> <para> <para>Tags to associate with the custom model that is created by this import. 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.ImportCOMPModelCmdlet.VersionName"> <summary> <para> <para>The version name given to the custom model that is created by this import. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.ImportCOMPModelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ImportModelResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ImportModelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.ImportCOMPModelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SourceModelArn parameter. The -PassThru parameter is deprecated, use -Select '^SourceModelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.ImportCOMPModelCmdlet.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.InvokeCOMPDocumentClassificationCmdlet"> <summary> Creates a classification request to analyze a single document in real-time. <c>ClassifyDocument</c> supports the following model types: <ul><li><para> Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Amazon Textract API output. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html">Custom classification</a> in the <i>Amazon Comprehend Developer Guide</i>. </para></li><li><para> Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying input prompts for generative AI applications. For input, you provide English plain text input. For prompt safety classification, the response includes only the <c>Classes</c> field. For more information about prompt safety classifiers, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification">Prompt safety classification</a> in the <i>Amazon Comprehend Developer Guide</i>. </para></li></ul><para> If the system detects errors while processing a page in the input document, the API response includes an <c>Errors</c> field that describes the errors. </para><para> If the system detects a document-level error in your input document, the API returns an <c>InvalidRequestException</c> error response. For details about this exception, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html"> Errors in semi-structured documents</a> in the Comprehend Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.InvokeCOMPDocumentClassificationCmdlet.Byte"> <summary> <para> <para>Use the <c>Bytes</c> parameter to input a text, PDF, Word or image file.</para><para>When you classify a document using a custom model, you can also use the <c>Bytes</c> parameter to input an Amazon Textract <c>DetectDocumentText</c> or <c>AnalyzeDocument</c> output file.</para><para>To classify a document using the prompt safety classifier, use the <c>Text</c> parameter for input.</para><para>Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode the document file bytes for you. </para><para>The maximum length of this field depends on the input document type. For details, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html"> Inputs for real-time custom analysis</a> in the Comprehend Developer Guide. </para><para>If you use the <c>Bytes</c> parameter, do not use the <c>Text</c> parameter.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.InvokeCOMPDocumentClassificationCmdlet.DocumentReaderConfig_DocumentReadAction"> <summary> <para> <para>This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:</para><ul><li><para><c>TEXTRACT_DETECT_DOCUMENT_TEXT</c> - The Amazon Comprehend service uses the <c>DetectDocumentText</c> API operation. </para></li><li><para><c>TEXTRACT_ANALYZE_DOCUMENT</c> - The Amazon Comprehend service uses the <c>AnalyzeDocument</c> API operation. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.InvokeCOMPDocumentClassificationCmdlet.DocumentReaderConfig_DocumentReadMode"> <summary> <para> <para>Determines the text extraction actions for PDF files. Enter one of the following values:</para><ul><li><para><c>SERVICE_DEFAULT</c> - use the Amazon Comprehend service defaults for PDF files.</para></li><li><para><c>FORCE_DOCUMENT_READ_ACTION</c> - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.InvokeCOMPDocumentClassificationCmdlet.EndpointArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the endpoint. </para><para>For prompt safety classification, Amazon Comprehend provides the endpoint ARN. For more information about prompt safety classifiers, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification">Prompt safety classification</a> in the <i>Amazon Comprehend Developer Guide</i></para><para>For custom classification, you create an endpoint for your custom model. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/using-endpoints.html">Using Amazon Comprehend endpoints</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.InvokeCOMPDocumentClassificationCmdlet.DocumentReaderConfig_FeatureType"> <summary> <para> <para>Specifies the type of Amazon Textract features to apply. If you chose <c>TEXTRACT_ANALYZE_DOCUMENT</c> as the read action, you must specify one or both of the following values:</para><ul><li><para><c>TABLES</c> - Returns additional information about any tables that are detected in the input document. </para></li><li><para><c>FORMS</c> - Returns additional information about any forms that are detected in the input document. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.InvokeCOMPDocumentClassificationCmdlet.Text"> <summary> <para> <para>The document text to be analyzed. If you enter text using this parameter, do not use the <c>Bytes</c> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.InvokeCOMPDocumentClassificationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Classes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.ClassifyDocumentResponse). Specifying the name of a property of type Amazon.Comprehend.Model.ClassifyDocumentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.InvokeCOMPDocumentClassificationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Text parameter. The -PassThru parameter is deprecated, use -Select '^Text' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.InvokeCOMPDocumentClassificationCmdlet.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.NewCOMPDatasetCmdlet"> <summary> Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html"> Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDatasetCmdlet.InputDataConfig_AugmentedManifest"> <summary> <para> <para>A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDatasetCmdlet.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.NewCOMPDatasetCmdlet.InputDataConfig_DataFormat"> <summary> <para> <para><c>COMPREHEND_CSV</c>: The data format is a two-column CSV file, where the first column contains labels and the second column contains documents.</para><para><c>AUGMENTED_MANIFEST</c>: The data format </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDatasetCmdlet.DatasetName"> <summary> <para> <para>Name of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDatasetCmdlet.DatasetType"> <summary> <para> <para>The dataset type. You can specify that the data in a dataset is for training the model or for testing the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDatasetCmdlet.Description"> <summary> <para> <para>Description of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDatasetCmdlet.FlywheelArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive the data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDatasetCmdlet.Documents_InputFormat"> <summary> <para> <para> Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDatasetCmdlet.DocumentClassifierInputDataConfig_LabelDelimiter"> <summary> <para> <para>Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDatasetCmdlet.DocumentClassifierInputDataConfig_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 <c>S3://bucketName/prefix</c>, 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>This parameter is required if you set <c>DataFormat</c> to <c>COMPREHEND_CSV</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDatasetCmdlet.Annotations_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.NewCOMPDatasetCmdlet.Documents_S3Uri"> <summary> <para> <para> Specifies the Amazon S3 location where the documents for the dataset are located. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDatasetCmdlet.EntityList_S3Uri"> <summary> <para> <para>Specifies the Amazon S3 location where the entity list is located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDatasetCmdlet.Tag"> <summary> <para> <para>Tags for the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.CreateDatasetResponse). Specifying the name of a property of type Amazon.Comprehend.Model.CreateDatasetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDatasetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlywheelArn parameter. The -PassThru parameter is deprecated, use -Select '^FlywheelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDatasetCmdlet.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.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 are labeled with the categories that you want to use. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/training-classifier-model.html">Training classifier models</a> in the Comprehend Developer Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.InputDataConfig_AugmentedManifest"> <summary> <para> <para>A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.</para><para>This parameter is required if you set <c>DataFormat</c> to <c>AUGMENTED_MANIFEST</c>.</para> </para> </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 IAM role that grants Amazon Comprehend read access to your input data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.InputDataConfig_DataFormat"> <summary> <para> <para>The format of your training data:</para><ul><li><para><c>COMPREHEND_CSV</c>: A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the <c>S3Uri</c> parameter in your request.</para></li><li><para><c>AUGMENTED_MANIFEST</c>: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels. </para><para>If you use this value, you must provide the <c>AugmentedManifests</c> parameter in your request.</para></li></ul><para>If you don't specify a value, Amazon Comprehend uses <c>COMPREHEND_CSV</c> as the default.</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.DocumentReaderConfig_DocumentReadAction"> <summary> <para> <para>This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:</para><ul><li><para><c>TEXTRACT_DETECT_DOCUMENT_TEXT</c> - The Amazon Comprehend service uses the <c>DetectDocumentText</c> API operation. </para></li><li><para><c>TEXTRACT_ANALYZE_DOCUMENT</c> - The Amazon Comprehend service uses the <c>AnalyzeDocument</c> API operation. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.DocumentReaderConfig_DocumentReadMode"> <summary> <para> <para>Determines the text extraction actions for PDF files. Enter one of the following values:</para><ul><li><para><c>SERVICE_DEFAULT</c> - use the Amazon Comprehend service defaults for PDF files.</para></li><li><para><c>FORCE_DOCUMENT_READ_ACTION</c> - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.InputDataConfig_DocumentType"> <summary> <para> <para>The type of input documents for training the model. Provide plain-text documents to create a plain-text model, and provide semi-structured documents to create a native document model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.DocumentReaderConfig_FeatureType"> <summary> <para> <para>Specifies the type of Amazon Textract features to apply. If you chose <c>TEXTRACT_ANALYZE_DOCUMENT</c> as the read action, you must specify one or both of the following values:</para><ul><li><para><c>TABLES</c> - Returns additional information about any tables that are detected in the input document. </para></li><li><para><c>FORMS</c> - Returns additional information about any forms that are detected in the input document. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.OutputDataConfig_FlywheelStatsS3Prefix"> <summary> <para> <para>The Amazon S3 prefix for the data lake location of the flywheel statistics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.OutputDataConfig_KmsKeyId"> <summary> <para> <para>ID for the Amazon Web Services 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: <c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>KMS Key Alias: <c>"alias/ExampleAlias"</c></para></li><li><para>ARN of a KMS Key Alias: <c>"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.InputDataConfig_LabelDelimiter"> <summary> <para> <para>Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.</para> </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 languages supported by Amazon Comprehend. All documents must be in the same language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.Mode"> <summary> <para> <para>Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode identifies a single class label for each document and multi-label mode identifies one or more class labels for each document. Multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.ModelKmsKeyId"> <summary> <para> <para>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:</para><ul><li><para>KMS Key ID: <c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.ModelPolicy"> <summary> <para> <para>The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another Amazon Web Services account to import your custom model.</para><para>Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:</para><para><c>"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"</c></para><para>To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:</para><para><c>'{"attribute": "value", "attribute": ["value"]}'</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.Documents_S3Uri"> <summary> <para> <para>The S3 URI location of the training documents specified in the S3Uri CSV file.</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 <c>S3://bucketName/prefix</c>, 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>This parameter is required if you set <c>DataFormat</c> to <c>COMPREHEND_CSV</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.OutputDataConfig_S3Uri"> <summary> <para> <para>When you use the <c>OutputDataConfig</c> object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files. 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 <c>S3Uri</c> field contains the location of the output file, called <c>output.tar.gz</c>. 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 associate with the document classifier. 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.Documents_TestS3Uri"> <summary> <para> <para>The S3 URI location of the test documents included in the TestS3Uri CSV file. This field is not required if you do not specify a test CSV file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.InputDataConfig_TestS3Uri"> <summary> <para> <para>This specifies the Amazon S3 location that contains the test annotations for the document classifier. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.VersionName"> <summary> <para> <para>The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the Amazon Web Services account/Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the Amazon Web Services 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: <c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentClassifierArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.CreateDocumentClassifierResponse). Specifying the name of a property of type Amazon.Comprehend.Model.CreateDocumentClassifierResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPDocumentClassifierCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DocumentClassifierName parameter. The -PassThru parameter is deprecated, use -Select '^DocumentClassifierName' instead. This parameter will be removed in a future version. </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.NewCOMPEndpointCmdlet"> <summary> Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEndpointCmdlet.ClientRequestToken"> <summary> <para> <para>An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a <c>ResourceInUseException</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEndpointCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEndpointCmdlet.DesiredInferenceUnit"> <summary> <para> <para> The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEndpointCmdlet.EndpointName"> <summary> <para> <para>This is the descriptive suffix that becomes part of the <c>EndpointArn</c> used for all subsequent requests to this resource. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEndpointCmdlet.FlywheelArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEndpointCmdlet.ModelArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEndpointCmdlet.Tag"> <summary> <para> <para>Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.CreateEndpointResponse). Specifying the name of a property of type Amazon.Comprehend.Model.CreateEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointName parameter. The -PassThru parameter is deprecated, use -Select '^EndpointName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEndpointCmdlet.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 <c>CreateEntityRecognizer</c> request is submitted, you can check job status using the <c>DescribeEntityRecognizer</c> API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.InputDataConfig_AugmentedManifest"> <summary> <para> <para>A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.</para><para>This parameter is required if you set <c>DataFormat</c> to <c>AUGMENTED_MANIFEST</c>.</para> </para> </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 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_DataFormat"> <summary> <para> <para>The format of your training data:</para><ul><li><para><c>COMPREHEND_CSV</c>: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list.</para><para>If you use this value, you must provide your CSV file by using either the <c>Annotations</c> or <c>EntityList</c> parameters. You must provide your training documents by using the <c>Documents</c> parameter.</para></li><li><para><c>AUGMENTED_MANIFEST</c>: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document. </para><para>If you use this value, you must provide the <c>AugmentedManifests</c> parameter in your request.</para></li></ul><para>If you don't specify a value, Amazon Comprehend uses <c>COMPREHEND_CSV</c> as the default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.InputDataConfig_EntityType"> <summary> <para> <para>The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don't specify are ignored.</para><para>A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break), \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and , (comma). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.Documents_InputFormat"> <summary> <para> <para> Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.LanguageCode"> <summary> <para> <para> You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.ModelKmsKeyId"> <summary> <para> <para>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:</para><ul><li><para>KMS Key ID: <c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.ModelPolicy"> <summary> <para> <para>The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another Amazon Web Services account to import your custom model.</para><para>Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:</para><para><c>"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"</c></para><para>To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:</para><para><c>'{"attribute": "value", "attribute": ["value"]}'</c></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 associate with the entity recognizer. 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.Annotations_TestS3Uri"> <summary> <para> <para> Specifies the Amazon S3 location where the test 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_TestS3Uri"> <summary> <para> <para> Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.VersionName"> <summary> <para> <para>The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the Amazon Web Services 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: <c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EntityRecognizerArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.CreateEntityRecognizerResponse). Specifying the name of a property of type Amazon.Comprehend.Model.CreateEntityRecognizerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPEntityRecognizerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RecognizerName parameter. The -PassThru parameter is deprecated, use -Select '^RecognizerName' instead. This parameter will be removed in a future version. </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.NewCOMPFlywheelCmdlet"> <summary> A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model. <para> When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model. </para><para> To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake. </para><para> To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel. </para><para> For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html"> Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPFlywheelCmdlet.ActiveModelArn"> <summary> <para> <para>To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version. Do not set <c>TaskConfig</c> or <c>ModelType</c> if you specify an <c>ActiveModelArn</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPFlywheelCmdlet.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.NewCOMPFlywheelCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPFlywheelCmdlet.DataSecurityConfig_DataLakeKmsKeyId"> <summary> <para> <para>ID for the KMS key that Amazon Comprehend uses to encrypt the data in the data lake.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPFlywheelCmdlet.DataLakeS3Uri"> <summary> <para> <para>Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPFlywheelCmdlet.EntityRecognitionConfig_EntityType"> <summary> <para> <para>Up to 25 entity types that the model is trained to recognize.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPFlywheelCmdlet.FlywheelName"> <summary> <para> <para>Name for the flywheel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPFlywheelCmdlet.DocumentClassificationConfig_Label"> <summary> <para> <para>One or more labels to associate with the custom classifier.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPFlywheelCmdlet.TaskConfig_LanguageCode"> <summary> <para> <para>Language code for the language that the model supports.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPFlywheelCmdlet.DocumentClassificationConfig_Mode"> <summary> <para> <para>Classification mode indicates whether the documents are <c>MULTI_CLASS</c> or <c>MULTI_LABEL</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPFlywheelCmdlet.DataSecurityConfig_ModelKmsKeyId"> <summary> <para> <para>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:</para><ul><li><para>KMS Key ID: <c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPFlywheelCmdlet.ModelType"> <summary> <para> <para>The model type. You need to set <c>ModelType</c> if you are creating a flywheel for a new model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPFlywheelCmdlet.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.NewCOMPFlywheelCmdlet.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.NewCOMPFlywheelCmdlet.Tag"> <summary> <para> <para>The tags to associate with this flywheel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPFlywheelCmdlet.DataSecurityConfig_VolumeKmsKeyId"> <summary> <para> <para>ID for the KMS key that Amazon Comprehend uses to encrypt the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPFlywheelCmdlet.Select"> <summary> 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.Comprehend.Model.CreateFlywheelResponse). Specifying the name of a property of type Amazon.Comprehend.Model.CreateFlywheelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.NewCOMPFlywheelCmdlet.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 <c>ResourceInUseException</c> 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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DeleteDocumentClassifierResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPDocumentClassifierCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DocumentClassifierArn parameter. The -PassThru parameter is deprecated, use -Select '^DocumentClassifierArn' instead. This parameter will be removed in a future version. </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.RemoveCOMPEndpointCmdlet"> <summary> Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPEndpointCmdlet.EndpointArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the endpoint being deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DeleteEndpointResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointArn parameter. The -PassThru parameter is deprecated, use -Select '^EndpointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPEndpointCmdlet.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 <c>ResourceInUseException</c> 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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DeleteEntityRecognizerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPEntityRecognizerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EntityRecognizerArn parameter. The -PassThru parameter is deprecated, use -Select '^EntityRecognizerArn' instead. This parameter will be removed in a future version. </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.RemoveCOMPFlywheelCmdlet"> <summary> Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel. <para> For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html"> Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPFlywheelCmdlet.FlywheelArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the flywheel to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPFlywheelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DeleteFlywheelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPFlywheelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlywheelArn parameter. The -PassThru parameter is deprecated, use -Select '^FlywheelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPFlywheelCmdlet.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.RemoveCOMPResourcePolicyCmdlet"> <summary> Deletes a resource-based policy that is attached to a custom model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPResourcePolicyCmdlet.PolicyRevisionId"> <summary> <para> <para>The revision ID of the policy to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.DeleteResourcePolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPResourcePolicyCmdlet.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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.RemoveCOMPResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </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 using a custom classification model. Use the <c>DescribeDocumentClassificationJob</c> 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 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.FlywheelArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the flywheel associated with the model to use.</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.Tag"> <summary> <para> <para>Tags to associate with the document classification job. A tag is a key-value pair that adds 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.StartCOMPDocumentClassificationJobCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the Amazon Web Services 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: <c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDocumentClassificationJobCmdlet.Select"> <summary> 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.Comprehend.Model.StartDocumentClassificationJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StartDocumentClassificationJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDocumentClassificationJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DocumentClassifierArn parameter. The -PassThru parameter is deprecated, use -Select '^DocumentClassifierArn' instead. This parameter will be removed in a future version. </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 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/security_iam_id-based-policy-examples.html#auth-role-permissions">Role-based 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.Tag"> <summary> <para> <para>Tags to associate with the dominant language detection job. A tag is a key-value pair that adds 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.StartCOMPDominantLanguageDetectionJobCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the Amazon Web Services 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: <c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDominantLanguageDetectionJobCmdlet.Select"> <summary> 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.Comprehend.Model.StartDominantLanguageDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StartDominantLanguageDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPDominantLanguageDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InputDataConfig parameter. The -PassThru parameter is deprecated, use -Select '^InputDataConfig' instead. This parameter will be removed in a future version. </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 <c>EntityRecognizerArn</c> 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 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/security_iam_id-based-policy-examples.html#auth-role-permissions">Role-based 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 <c>StartEntitiesDetectionJob</c>. 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.FlywheelArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the flywheel associated with the model to use.</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. 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.Tag"> <summary> <para> <para>Tags to associate with the entities detection job. A tag is a key-value pair that adds 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.StartCOMPEntitiesDetectionJobCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the Amazon Web Services 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: <c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEntitiesDetectionJobCmdlet.Select"> <summary> 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.Comprehend.Model.StartEntitiesDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StartEntitiesDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEntitiesDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InputDataConfig parameter. The -PassThru parameter is deprecated, use -Select '^InputDataConfig' instead. This parameter will be removed in a future version. </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.StartCOMPEventsDetectionJobCmdlet"> <summary> Starts an asynchronous event detection job for a collection of documents. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEventsDetectionJobCmdlet.ClientRequestToken"> <summary> <para> <para>An 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.StartCOMPEventsDetectionJobCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEventsDetectionJobCmdlet.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.StartCOMPEventsDetectionJobCmdlet.JobName"> <summary> <para> <para>The identifier of the events detection job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEventsDetectionJobCmdlet.LanguageCode"> <summary> <para> <para>The language code of the input documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEventsDetectionJobCmdlet.OutputDataConfig"> <summary> <para> <para>Specifies where to send the output files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEventsDetectionJobCmdlet.Tag"> <summary> <para> <para>Tags to associate with the events detection job. A tag is a key-value pair that adds 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.StartCOMPEventsDetectionJobCmdlet.TargetEventType"> <summary> <para> <para>The types of events to detect in the input documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEventsDetectionJobCmdlet.Select"> <summary> 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.Comprehend.Model.StartEventsDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StartEventsDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPEventsDetectionJobCmdlet.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.StartCOMPFlywheelIterationCmdlet"> <summary> Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html"> Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPFlywheelIterationCmdlet.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.StartCOMPFlywheelIterationCmdlet.FlywheelArn"> <summary> <para> <para>The ARN of the flywheel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPFlywheelIterationCmdlet.Select"> <summary> 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.Comprehend.Model.StartFlywheelIterationResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StartFlywheelIterationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPFlywheelIterationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlywheelArn parameter. The -PassThru parameter is deprecated, use -Select '^FlywheelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPFlywheelIterationCmdlet.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 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/security_iam_id-based-policy-examples.html#auth-role-permissions">Role-based 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. 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.Tag"> <summary> <para> <para>Tags to associate with the key phrases detection job. A tag is a key-value pair that adds 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.StartCOMPKeyPhrasesDetectionJobCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the Amazon Web Services 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: <c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPKeyPhrasesDetectionJobCmdlet.Select"> <summary> 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.Comprehend.Model.StartKeyPhrasesDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StartKeyPhrasesDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPKeyPhrasesDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InputDataConfig parameter. The -PassThru parameter is deprecated, use -Select '^InputDataConfig' instead. This parameter will be removed in a future version. </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.StartCOMPPiiEntitiesDetectionJobCmdlet"> <summary> Starts an asynchronous PII entity detection job for a collection of documents. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPPiiEntitiesDetectionJobCmdlet.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.StartCOMPPiiEntitiesDetectionJobCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPPiiEntitiesDetectionJobCmdlet.InputDataConfig"> <summary> <para> <para>The input properties for a PII entities detection job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPPiiEntitiesDetectionJobCmdlet.JobName"> <summary> <para> <para>The identifier of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPPiiEntitiesDetectionJobCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents. Enter the language code for English (en) or Spanish (es).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPPiiEntitiesDetectionJobCmdlet.RedactionConfig_MaskCharacter"> <summary> <para> <para>A character that replaces each character in the redacted PII entity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPPiiEntitiesDetectionJobCmdlet.RedactionConfig_MaskMode"> <summary> <para> <para>Specifies whether the PII entity is redacted with the mask character or the entity type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPPiiEntitiesDetectionJobCmdlet.Mode"> <summary> <para> <para>Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPPiiEntitiesDetectionJobCmdlet.OutputDataConfig"> <summary> <para> <para>Provides configuration parameters for the output of PII entity detection jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPPiiEntitiesDetectionJobCmdlet.RedactionConfig_PiiEntityType"> <summary> <para> <para>An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPPiiEntitiesDetectionJobCmdlet.Tag"> <summary> <para> <para>Tags to associate with the PII entities detection job. A tag is a key-value pair that adds 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.StartCOMPPiiEntitiesDetectionJobCmdlet.Select"> <summary> 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.Comprehend.Model.StartPiiEntitiesDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StartPiiEntitiesDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPPiiEntitiesDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InputDataConfig parameter. The -PassThru parameter is deprecated, use -Select '^InputDataConfig' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPPiiEntitiesDetectionJobCmdlet.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 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/security_iam_id-based-policy-examples.html#auth-role-permissions">Role-based 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. 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.Tag"> <summary> <para> <para>Tags to associate with the sentiment detection job. A tag is a key-value pair that adds 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.StartCOMPSentimentDetectionJobCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the Amazon Web Services 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: <c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPSentimentDetectionJobCmdlet.Select"> <summary> 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.Comprehend.Model.StartSentimentDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StartSentimentDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPSentimentDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InputDataConfig parameter. The -PassThru parameter is deprecated, use -Select '^InputDataConfig' instead. This parameter will be removed in a future version. </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.StartCOMPTargetedSentimentDetectionJobCmdlet"> <summary> Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the <c>DescribeTargetedSentimentDetectionJob</c> operation to track the status of a job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTargetedSentimentDetectionJobCmdlet.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.StartCOMPTargetedSentimentDetectionJobCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the 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/security_iam_id-based-policy-examples.html#auth-role-permissions">Role-based permissions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTargetedSentimentDetectionJobCmdlet.InputDataConfig"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTargetedSentimentDetectionJobCmdlet.JobName"> <summary> <para> <para>The identifier of the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTargetedSentimentDetectionJobCmdlet.LanguageCode"> <summary> <para> <para>The language of the input documents. Currently, English is the only supported language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTargetedSentimentDetectionJobCmdlet.OutputDataConfig"> <summary> <para> <para>Specifies where to send the output files. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTargetedSentimentDetectionJobCmdlet.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.StartCOMPTargetedSentimentDetectionJobCmdlet.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.StartCOMPTargetedSentimentDetectionJobCmdlet.Tag"> <summary> <para> <para>Tags to associate with the targeted sentiment detection job. A tag is a key-value pair that adds 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.StartCOMPTargetedSentimentDetectionJobCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the 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: <c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTargetedSentimentDetectionJobCmdlet.Select"> <summary> 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.Comprehend.Model.StartTargetedSentimentDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StartTargetedSentimentDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTargetedSentimentDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InputDataConfig parameter. The -PassThru parameter is deprecated, use -Select '^InputDataConfig' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTargetedSentimentDetectionJobCmdlet.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 <c>DescribeTopicDetectionJob</c> 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 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/security_iam_id-based-policy-examples.html#auth-role-permissions">Role-based 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, <c>topic-terms.csv</c> that lists the terms associated with each topic, and <c>doc-topics.csv</c> 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.Tag"> <summary> <para> <para>Tags to associate with the topics detection job. A tag is a key-value pair that adds 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.StartCOMPTopicsDetectionJobCmdlet.VolumeKmsKeyId"> <summary> <para> <para>ID for the Amazon Web Services 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: <c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTopicsDetectionJobCmdlet.Select"> <summary> 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.Comprehend.Model.StartTopicsDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StartTopicsDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StartCOMPTopicsDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InputDataConfig parameter. The -PassThru parameter is deprecated, use -Select '^InputDataConfig' instead. This parameter will be removed in a future version. </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 <c>IN_PROGRESS</c> the job is marked for termination and put into the <c>STOP_REQUESTED</c> state. If the job completes before it can be stopped, it is put into the <c>COMPLETED</c> state; otherwise the job is stopped and put into the <c>STOPPED</c> state. </para><para> If the job is in the <c>COMPLETED</c> or <c>FAILED</c> state when you call the <c>StopDominantLanguageDetectionJob</c> 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.Select"> <summary> 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.Comprehend.Model.StopDominantLanguageDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StopDominantLanguageDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPDominantLanguageDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </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 <c>IN_PROGRESS</c> the job is marked for termination and put into the <c>STOP_REQUESTED</c> state. If the job completes before it can be stopped, it is put into the <c>COMPLETED</c> state; otherwise the job is stopped and put into the <c>STOPPED</c> state. </para><para> If the job is in the <c>COMPLETED</c> or <c>FAILED</c> state when you call the <c>StopDominantLanguageDetectionJob</c> 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.Select"> <summary> 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.Comprehend.Model.StopEntitiesDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StopEntitiesDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPEntitiesDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </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.StopCOMPEventsDetectionJobCmdlet"> <summary> Stops an events detection job in progress. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPEventsDetectionJobCmdlet.JobId"> <summary> <para> <para>The identifier of the events detection job to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPEventsDetectionJobCmdlet.Select"> <summary> 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.Comprehend.Model.StopEventsDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StopEventsDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPEventsDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPEventsDetectionJobCmdlet.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 <c>IN_PROGRESS</c> the job is marked for termination and put into the <c>STOP_REQUESTED</c> state. If the job completes before it can be stopped, it is put into the <c>COMPLETED</c> state; otherwise the job is stopped and put into the <c>STOPPED</c> state. </para><para> If the job is in the <c>COMPLETED</c> or <c>FAILED</c> state when you call the <c>StopDominantLanguageDetectionJob</c> 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.Select"> <summary> 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.Comprehend.Model.StopKeyPhrasesDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StopKeyPhrasesDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPKeyPhrasesDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </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.StopCOMPPiiEntitiesDetectionJobCmdlet"> <summary> Stops a PII entities detection job in progress. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPPiiEntitiesDetectionJobCmdlet.JobId"> <summary> <para> <para>The identifier of the PII entities detection job to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPPiiEntitiesDetectionJobCmdlet.Select"> <summary> 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.Comprehend.Model.StopPiiEntitiesDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StopPiiEntitiesDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPPiiEntitiesDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPPiiEntitiesDetectionJobCmdlet.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 <c>IN_PROGRESS</c>, the job is marked for termination and put into the <c>STOP_REQUESTED</c> state. If the job completes before it can be stopped, it is put into the <c>COMPLETED</c> state; otherwise the job is be stopped and put into the <c>STOPPED</c> state. </para><para> If the job is in the <c>COMPLETED</c> or <c>FAILED</c> state when you call the <c>StopDominantLanguageDetectionJob</c> 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.Select"> <summary> 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.Comprehend.Model.StopSentimentDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StopSentimentDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPSentimentDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </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.StopCOMPTargetedSentimentDetectionJobCmdlet"> <summary> Stops a targeted sentiment detection job in progress. <para> If the job state is <c>IN_PROGRESS</c>, the job is marked for termination and put into the <c>STOP_REQUESTED</c> state. If the job completes before it can be stopped, it is put into the <c>COMPLETED</c> state; otherwise the job is be stopped and put into the <c>STOPPED</c> state. </para><para> If the job is in the <c>COMPLETED</c> or <c>FAILED</c> state when you call the <c>StopDominantLanguageDetectionJob</c> 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.StopCOMPTargetedSentimentDetectionJobCmdlet.JobId"> <summary> <para> <para>The identifier of the targeted sentiment detection job to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPTargetedSentimentDetectionJobCmdlet.Select"> <summary> 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.Comprehend.Model.StopTargetedSentimentDetectionJobResponse). Specifying the name of a property of type Amazon.Comprehend.Model.StopTargetedSentimentDetectionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPTargetedSentimentDetectionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPTargetedSentimentDetectionJobCmdlet.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 <c>TRAINING</c>, the job is marked for termination and put into the <c>STOP_REQUESTED</c> state. If the training job completes before it can be stopped, it is put into the <c>TRAINED</c>; otherwise the training job is stopped and put into the <c>STOPPED</c> 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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.StopTrainingDocumentClassifierResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPTrainingDocumentClassifierCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DocumentClassifierArn parameter. The -PassThru parameter is deprecated, use -Select '^DocumentClassifierArn' instead. This parameter will be removed in a future version. </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 <c>TRAINING</c>, the job is marked for termination and put into the <c>STOP_REQUESTED</c> state. If the training job completes before it can be stopped, it is put into the <c>TRAINED</c>; otherwise the training job is stopped and putted into the <c>STOPPED</c> 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.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.StopTrainingEntityRecognizerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.StopCOMPTrainingEntityRecognizerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EntityRecognizerArn parameter. The -PassThru parameter is deprecated, use -Select '^EntityRecognizerArn' instead. This parameter will be removed in a future version. </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> <member name="T:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPEndpointCmdlet"> <summary> Updates information about the specified endpoint. For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPEndpointCmdlet.DesiredDataAccessRoleArn"> <summary> <para> <para>Data access role ARN to use in case the new model is encrypted with a customer CMK.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPEndpointCmdlet.DesiredInferenceUnit"> <summary> <para> <para> The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPEndpointCmdlet.DesiredModelArn"> <summary> <para> <para>The ARN of the new model to use when updating an existing endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPEndpointCmdlet.EndpointArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the endpoint being updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPEndpointCmdlet.FlywheelArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the flywheel</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPEndpointCmdlet.Select"> <summary> 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.Comprehend.Model.UpdateEndpointResponse). Specifying the name of a property of type Amazon.Comprehend.Model.UpdateEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointArn parameter. The -PassThru parameter is deprecated, use -Select '^EndpointArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPEndpointCmdlet.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.UpdateCOMPFlywheelCmdlet"> <summary> Update the configuration information for an existing flywheel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPFlywheelCmdlet.ActiveModelArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the active model version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPFlywheelCmdlet.DataAccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPFlywheelCmdlet.FlywheelArn"> <summary> <para> <para>The Amazon Resource Number (ARN) of the flywheel to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPFlywheelCmdlet.DataSecurityConfig_ModelKmsKeyId"> <summary> <para> <para>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:</para><ul><li><para>KMS Key ID: <c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key: <c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPFlywheelCmdlet.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.UpdateCOMPFlywheelCmdlet.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.UpdateCOMPFlywheelCmdlet.DataSecurityConfig_VolumeKmsKeyId"> <summary> <para> <para>ID for the KMS key that Amazon Comprehend uses to encrypt the volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPFlywheelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FlywheelProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.UpdateFlywheelResponse). Specifying the name of a property of type Amazon.Comprehend.Model.UpdateFlywheelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPFlywheelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlywheelArn parameter. The -PassThru parameter is deprecated, use -Select '^FlywheelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.UpdateCOMPFlywheelCmdlet.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.WriteCOMPResourcePolicyCmdlet"> <summary> Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.WriteCOMPResourcePolicyCmdlet.PolicyRevisionId"> <summary> <para> <para>The revision ID that Amazon Comprehend assigned to the policy that you are updating. If you are creating a new policy that has no prior version, don't use this parameter. Amazon Comprehend creates the revision ID for you.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.WriteCOMPResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the custom model to attach the policy to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.WriteCOMPResourcePolicyCmdlet.ResourcePolicy"> <summary> <para> <para>The JSON resource-based policy to attach to your custom model. Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:</para><para><c>"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"</c></para><para>To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:</para><para><c>'{"attribute": "value", "attribute": ["value"]}'</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.WriteCOMPResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PolicyRevisionId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.PutResourcePolicyResponse). Specifying the name of a property of type Amazon.Comprehend.Model.PutResourcePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.WriteCOMPResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COMP.WriteCOMPResourcePolicyCmdlet.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> |