AWS.Tools.Textract.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Textract</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.TXT.AddTXTResourceTagCmdlet"> <summary> Adds one or more tags to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.AddTXTResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) that specifies the resource to be tagged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.AddTXTResourceTagCmdlet.Tag"> <summary> <para> <para>A set of tags (key-value pairs) that you want to assign to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.AddTXTResourceTagCmdlet.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.Textract.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.AddTXTResourceTagCmdlet.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.TXT.AddTXTResourceTagCmdlet.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.TXT.FindTXTDocumentTextCmdlet"> <summary> Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be in one of the following image formats: JPEG, PNG, PDF, or TIFF. <c>DetectDocumentText</c> returns the detected text in an array of <a>Block</a> objects. <para> Each document page has as an associated <c>Block</c> of type PAGE. Each PAGE <c>Block</c> object is the parent of LINE <c>Block</c> objects that represent the lines of detected text on a page. A LINE <c>Block</c> object is a parent for each word that makes up the line. Words are represented by <c>Block</c> objects of type WORD. </para><para><c>DetectDocumentText</c> is a synchronous operation. To analyze documents asynchronously, use <a>StartDocumentTextDetection</a>. </para><para> For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html">Document Text Detection</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.FindTXTDocumentTextCmdlet.S3Object_Bucket"> <summary> <para> <para>The name of the S3 bucket. Note that the # character is not valid in the file name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.FindTXTDocumentTextCmdlet.Document_Byte"> <summary> <para> <para>A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.</para><para>If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the <c>Bytes</c> field. </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.TXT.FindTXTDocumentTextCmdlet.S3Object_Name"> <summary> <para> <para>The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.FindTXTDocumentTextCmdlet.S3Object_Version"> <summary> <para> <para>If the bucket has versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.FindTXTDocumentTextCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Blocks'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Textract.Model.DetectDocumentTextResponse). Specifying the name of a property of type Amazon.Textract.Model.DetectDocumentTextResponse 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.TXT.GetTXTAdapterCmdlet"> <summary> Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTAdapterCmdlet.AdapterId"> <summary> <para> <para>A string containing a unique ID for the adapter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTAdapterCmdlet.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.Textract.Model.GetAdapterResponse). Specifying the name of a property of type Amazon.Textract.Model.GetAdapterResponse 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.TXT.GetTXTAdapterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AdapterId parameter. The -PassThru parameter is deprecated, use -Select '^AdapterId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TXT.GetTXTAdapterListCmdlet"> <summary> Lists all adapters that match the specified filtration criteria.<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.TXT.GetTXTAdapterListCmdlet.AfterCreationTime"> <summary> <para> <para>Specifies the lower bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created after the specified creation time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTAdapterListCmdlet.BeforeCreationTime"> <summary> <para> <para>Specifies the upper bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created before the specified creation time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTAdapterListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return when listing adapters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTAdapterListCmdlet.NextToken"> <summary> <para> <para>Identifies the next page of results to return when listing adapters.</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.TXT.GetTXTAdapterListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Adapters'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Textract.Model.ListAdaptersResponse). Specifying the name of a property of type Amazon.Textract.Model.ListAdaptersResponse 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.TXT.GetTXTAdapterListCmdlet.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.TXT.GetTXTAdapterVersionCmdlet"> <summary> Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTAdapterVersionCmdlet.AdapterId"> <summary> <para> <para>A string specifying a unique ID for the adapter version you want to retrieve information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTAdapterVersionCmdlet.AdapterVersion"> <summary> <para> <para>A string specifying the adapter version you want to retrieve information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTAdapterVersionCmdlet.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.Textract.Model.GetAdapterVersionResponse). Specifying the name of a property of type Amazon.Textract.Model.GetAdapterVersionResponse 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.TXT.GetTXTAdapterVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AdapterId parameter. The -PassThru parameter is deprecated, use -Select '^AdapterId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.TXT.GetTXTAdapterVersionListCmdlet"> <summary> List all version of an adapter that meet the specified filtration criteria.<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.TXT.GetTXTAdapterVersionListCmdlet.AdapterId"> <summary> <para> <para>A string containing a unique ID for the adapter to match for when listing adapter versions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTAdapterVersionListCmdlet.AfterCreationTime"> <summary> <para> <para>Specifies the lower bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTAdapterVersionListCmdlet.BeforeCreationTime"> <summary> <para> <para>Specifies the upper bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTAdapterVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return when listing adapter versions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTAdapterVersionListCmdlet.NextToken"> <summary> <para> <para>Identifies the next page of results to return when listing adapter versions.</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.TXT.GetTXTAdapterVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AdapterVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Textract.Model.ListAdapterVersionsResponse). Specifying the name of a property of type Amazon.Textract.Model.ListAdapterVersionsResponse 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.TXT.GetTXTAdapterVersionListCmdlet.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.TXT.GetTXTDocumentAnalysisCmdlet"> <summary> Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document. <para> You start asynchronous text analysis by calling <a>StartDocumentAnalysis</a>, which returns a job identifier (<c>JobId</c>). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to <c>StartDocumentAnalysis</c>. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <c>GetDocumentAnalysis</c>, and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartDocumentAnalysis</c>. </para><para><c>GetDocumentAnalysis</c> returns an array of <a>Block</a> objects. The following types of information are returned: </para><ul><li><para> Form data (key-value pairs). The related information is returned in two <a>Block</a> objects, each of type <c>KEY_VALUE_SET</c>: a KEY <c>Block</c> object and a VALUE <c>Block</c> object. For example, <i>Name: Ana Silva Carolina</i> contains a key and value. <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is the value. </para></li><li><para> Table and table cell data. A TABLE <c>Block</c> object contains information about a detected table. A CELL <c>Block</c> object is returned for each cell in a table. </para></li><li><para> Lines and words of text. A LINE <c>Block</c> object contains one or more WORD <c>Block</c> objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of the <c>StartDocumentAnalysis</c><c>FeatureTypes</c> input parameter). </para></li><li><para> Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object. </para></li><li><para> Query Results. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score. </para></li></ul><note><para> While processing a document with queries, look out for <c>INVALID_REQUEST_PARAMETERS</c> output. This indicates that either the per page query limit has been exceeded or that the operation is trying to query a page in the document which doesn’t exist. </para></note><para> Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT <c>Block</c> object contains information about a selection element, including the selection status. </para><para> Use the <c>MaxResults</c> parameter to limit the number of blocks that are returned. If there are more results than specified in <c>MaxResults</c>, the value of <c>NextToken</c> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <c>GetDocumentAnalysis</c>, and populate the <c>NextToken</c> request parameter with the token value that's returned from the previous call to <c>GetDocumentAnalysis</c>. </para><para> For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text Analysis</a>. </para><br/><br/>In the AWS.Tools.Textract module, 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.TXT.GetTXTDocumentAnalysisCmdlet.JobId"> <summary> <para> <para>A unique identifier for the text-detection job. The <c>JobId</c> is returned from <c>StartDocumentAnalysis</c>. A <c>JobId</c> value is only valid for 7 days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTDocumentAnalysisCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTDocumentAnalysisCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.</para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.Textract module, 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.TXT.GetTXTDocumentAnalysisCmdlet.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.Textract.Model.GetDocumentAnalysisResponse). Specifying the name of a property of type Amazon.Textract.Model.GetDocumentAnalysisResponse 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.TXT.GetTXTDocumentAnalysisCmdlet.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.TXT.GetTXTDocumentAnalysisCmdlet.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.TXT.GetTXTDocumentTextDetectionCmdlet"> <summary> Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text. <para> You start asynchronous text detection by calling <a>StartDocumentTextDetection</a>, which returns a job identifier (<c>JobId</c>). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to <c>StartDocumentTextDetection</c>. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <c>GetDocumentTextDetection</c>, and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartDocumentTextDetection</c>. </para><para><c>GetDocumentTextDetection</c> returns an array of <a>Block</a> objects. </para><para> Each document page has as an associated <c>Block</c> of type PAGE. Each PAGE <c>Block</c> object is the parent of LINE <c>Block</c> objects that represent the lines of detected text on a page. A LINE <c>Block</c> object is a parent for each word that makes up the line. Words are represented by <c>Block</c> objects of type WORD. </para><para> Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in <c>MaxResults</c>, the value of <c>NextToken</c> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <c>GetDocumentTextDetection</c>, and populate the <c>NextToken</c> request parameter with the token value that's returned from the previous call to <c>GetDocumentTextDetection</c>. </para><para> For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html">Document Text Detection</a>. </para><br/><br/>In the AWS.Tools.Textract module, 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.TXT.GetTXTDocumentTextDetectionCmdlet.JobId"> <summary> <para> <para>A unique identifier for the text detection job. The <c>JobId</c> is returned from <c>StartDocumentTextDetection</c>. A <c>JobId</c> value is only valid for 7 days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTDocumentTextDetectionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTDocumentTextDetectionCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.</para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.Textract module, 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.TXT.GetTXTDocumentTextDetectionCmdlet.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.Textract.Model.GetDocumentTextDetectionResponse). Specifying the name of a property of type Amazon.Textract.Model.GetDocumentTextDetectionResponse 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.TXT.GetTXTDocumentTextDetectionCmdlet.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.TXT.GetTXTDocumentTextDetectionCmdlet.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.TXT.GetTXTExpenseAnalysisCmdlet"> <summary> Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts. <para> You start asynchronous invoice/receipt analysis by calling <a>StartExpenseAnalysis</a>, which returns a job identifier (<c>JobId</c>). Upon completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to <c>StartExpenseAnalysis</c>. To get the results of the invoice/receipt analysis operation, first ensure that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <c>GetExpenseAnalysis</c>, and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartExpenseAnalysis</c>. </para><para> Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in <c>MaxResults</c>, the value of <c>NextToken</c> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <c>GetExpenseAnalysis</c>, and populate the <c>NextToken</c> request parameter with the token value that's returned from the previous call to <c>GetExpenseAnalysis</c>. </para><para> For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/invoices-receipts.html">Analyzing Invoices and Receipts</a>. </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.TXT.GetTXTExpenseAnalysisCmdlet.JobId"> <summary> <para> <para>A unique identifier for the text detection job. The <c>JobId</c> is returned from <c>StartExpenseAnalysis</c>. A <c>JobId</c> value is only valid for 7 days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTExpenseAnalysisCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per paginated call. The largest value you can specify is 20. If you specify a value greater than 20, a maximum of 20 results is returned. The default value is 20.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTExpenseAnalysisCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.</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.TXT.GetTXTExpenseAnalysisCmdlet.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.Textract.Model.GetExpenseAnalysisResponse). Specifying the name of a property of type Amazon.Textract.Model.GetExpenseAnalysisResponse 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.TXT.GetTXTExpenseAnalysisCmdlet.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.TXT.GetTXTExpenseAnalysisCmdlet.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.TXT.GetTXTLendingAnalysisCmdlet"> <summary> Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document. <para> You start asynchronous text analysis by calling <c>StartLendingAnalysis</c>, which returns a job identifier (<c>JobId</c>). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to <c>StartLendingAnalysis</c>. </para><para> To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLendingAnalysis, and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartLendingAnalysis</c>. </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.TXT.GetTXTLendingAnalysisCmdlet.JobId"> <summary> <para> <para>A unique identifier for the lending or text-detection job. The <c>JobId</c> is returned from <c>StartLendingAnalysis</c>. A <c>JobId</c> value is only valid for 7 days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTLendingAnalysisCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per paginated call. The largest value that you can specify is 30. If you specify a value greater than 30, a maximum of 30 results is returned. The default value is 30.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTLendingAnalysisCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete, Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of lending results.</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.TXT.GetTXTLendingAnalysisCmdlet.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.Textract.Model.GetLendingAnalysisResponse). Specifying the name of a property of type Amazon.Textract.Model.GetLendingAnalysisResponse 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.TXT.GetTXTLendingAnalysisCmdlet.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.TXT.GetTXTLendingAnalysisCmdlet.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.TXT.GetTXTLendingAnalysisSummaryCmdlet"> <summary> Gets summarized results for the <c>StartLendingAnalysis</c> operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document. <para> You start asynchronous text analysis by calling <c>StartLendingAnalysis</c>, which returns a job identifier (<c>JobId</c>). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to <c>StartLendingAnalysis</c>. </para><para> To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call <c>GetLendingAnalysisSummary</c>, and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartLendingAnalysis</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTLendingAnalysisSummaryCmdlet.JobId"> <summary> <para> <para> A unique identifier for the lending or text-detection job. The <c>JobId</c> is returned from StartLendingAnalysis. A <c>JobId</c> value is only valid for 7 days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTLendingAnalysisSummaryCmdlet.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.Textract.Model.GetLendingAnalysisSummaryResponse). Specifying the name of a property of type Amazon.Textract.Model.GetLendingAnalysisSummaryResponse 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.TXT.GetTXTLendingAnalysisSummaryCmdlet.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.TXT.GetTXTResourceTagCmdlet"> <summary> Lists all tags for an Amazon Textract resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) that specifies the resource to list tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.GetTXTResourceTagCmdlet.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.Textract.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Textract.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.TXT.GetTXTResourceTagCmdlet.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.TXT.InvokeTXTAnalyzeIDCmdlet"> <summary> Analyzes identity documents for relevant information. This information is extracted and returned as <c>IdentityDocumentFields</c>, which records both the normalized field and value of the extracted text. Unlike other Amazon Textract operations, <c>AnalyzeID</c> doesn't return any Geometry data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.InvokeTXTAnalyzeIDCmdlet.DocumentPage"> <summary> <para> <para>The document being passed to AnalyzeID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.InvokeTXTAnalyzeIDCmdlet.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.Textract.Model.AnalyzeIDResponse). Specifying the name of a property of type Amazon.Textract.Model.AnalyzeIDResponse 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.TXT.InvokeTXTAnalyzeIDCmdlet.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.TXT.InvokeTXTDocumentAnalysisCmdlet"> <summary> Analyzes an input document for relationships between detected items. <para> The types of information returned are as follows: </para><ul><li><para> Form data (key-value pairs). The related information is returned in two <a>Block</a> objects, each of type <c>KEY_VALUE_SET</c>: a KEY <c>Block</c> object and a VALUE <c>Block</c> object. For example, <i>Name: Ana Silva Carolina</i> contains a key and value. <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is the value. </para></li><li><para> Table and table cell data. A TABLE <c>Block</c> object contains information about a detected table. A CELL <c>Block</c> object is returned for each cell in a table. </para></li><li><para> Lines and words of text. A LINE <c>Block</c> object contains one or more WORD <c>Block</c> objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of <c>FeatureTypes</c>). </para></li><li><para> Signatures. A SIGNATURE <c>Block</c> object contains the location information of a signature in a document. If used in conjunction with forms or tables, a signature can be given a Key-Value pairing or be detected in the cell of a table. </para></li><li><para> Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object. </para></li><li><para> Query Result. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score. </para></li></ul><para> Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT <c>Block</c> object contains information about a selection element, including the selection status. </para><para> You can choose which type of analysis to perform by specifying the <c>FeatureTypes</c> list. </para><para> The output is returned in a list of <c>Block</c> objects. </para><para><c>AnalyzeDocument</c> is a synchronous operation. To analyze documents asynchronously, use <a>StartDocumentAnalysis</a>. </para><para> For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text Analysis</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.InvokeTXTDocumentAnalysisCmdlet.AdaptersConfig_Adapter"> <summary> <para> <para>A list of adapters to be used when analyzing the specified document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.InvokeTXTDocumentAnalysisCmdlet.S3Object_Bucket"> <summary> <para> <para>The name of the S3 bucket. Note that the # character is not valid in the file name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.InvokeTXTDocumentAnalysisCmdlet.Document_Byte"> <summary> <para> <para>A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.</para><para>If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the <c>Bytes</c> field. </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.TXT.InvokeTXTDocumentAnalysisCmdlet.DataAttributes_ContentClassifier"> <summary> <para> <para>Sets whether the input image is free of personally identifiable information or adult content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.InvokeTXTDocumentAnalysisCmdlet.FeatureType"> <summary> <para> <para>A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of <c>FeatureTypes</c>). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.InvokeTXTDocumentAnalysisCmdlet.HumanLoopConfig_FlowDefinitionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the flow definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.InvokeTXTDocumentAnalysisCmdlet.HumanLoopConfig_HumanLoopName"> <summary> <para> <para>The name of the human workflow used for this image. This should be kept unique within a region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.InvokeTXTDocumentAnalysisCmdlet.S3Object_Name"> <summary> <para> <para>The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.InvokeTXTDocumentAnalysisCmdlet.QueriesConfig_Query"> <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.TXT.InvokeTXTDocumentAnalysisCmdlet.S3Object_Version"> <summary> <para> <para>If the bucket has versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.InvokeTXTDocumentAnalysisCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Blocks'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Textract.Model.AnalyzeDocumentResponse). Specifying the name of a property of type Amazon.Textract.Model.AnalyzeDocumentResponse 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.TXT.InvokeTXTDocumentAnalysisCmdlet.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.TXT.InvokeTXTExpenseAnalysisCmdlet"> <summary> <c>AnalyzeExpense</c> synchronously analyzes an input document for financially related relationships between text. <para> Information is returned as <c>ExpenseDocuments</c> and seperated as follows: </para><ul><li><para><c>LineItemGroups</c>- A data set containing <c>LineItems</c> which store information about the lines of text, such as an item purchased and its price on a receipt. </para></li><li><para><c>SummaryFields</c>- Contains all other information a receipt, such as header information or the vendors name. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.InvokeTXTExpenseAnalysisCmdlet.S3Object_Bucket"> <summary> <para> <para>The name of the S3 bucket. Note that the # character is not valid in the file name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.InvokeTXTExpenseAnalysisCmdlet.Document_Byte"> <summary> <para> <para>A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.</para><para>If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the <c>Bytes</c> field. </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.TXT.InvokeTXTExpenseAnalysisCmdlet.S3Object_Name"> <summary> <para> <para>The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.InvokeTXTExpenseAnalysisCmdlet.S3Object_Version"> <summary> <para> <para>If the bucket has versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.InvokeTXTExpenseAnalysisCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExpenseDocuments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Textract.Model.AnalyzeExpenseResponse). Specifying the name of a property of type Amazon.Textract.Model.AnalyzeExpenseResponse 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.TXT.InvokeTXTExpenseAnalysisCmdlet.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.TXT.NewTXTAdapterCmdlet"> <summary> Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is <c>QUERIES</c>. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterCmdlet.AdapterName"> <summary> <para> <para>The name to be assigned to the adapter being created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterCmdlet.AutoUpdate"> <summary> <para> <para>Controls whether or not the adapter should automatically update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapter requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterCmdlet.Description"> <summary> <para> <para>The description to be assigned to the adapter being created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterCmdlet.FeatureType"> <summary> <para> <para>The type of feature that the adapter is being trained on. Currrenly, supported feature types are: <c>QUERIES</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterCmdlet.Tag"> <summary> <para> <para>A list of tags to be added to the adapter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AdapterId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Textract.Model.CreateAdapterResponse). Specifying the name of a property of type Amazon.Textract.Model.CreateAdapterResponse 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.TXT.NewTXTAdapterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AdapterName parameter. The -PassThru parameter is deprecated, use -Select '^AdapterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterCmdlet.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.TXT.NewTXTAdapterVersionCmdlet"> <summary> Creates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterVersionCmdlet.AdapterId"> <summary> <para> <para>A string containing a unique ID for the adapter that will receive a new version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterVersionCmdlet.ManifestS3Object_Bucket"> <summary> <para> <para>The name of the S3 bucket. Note that the # character is not valid in the file name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterVersionCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapterVersion requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterVersionCmdlet.KMSKeyId"> <summary> <para> <para>The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterVersionCmdlet.ManifestS3Object_Name"> <summary> <para> <para>The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterVersionCmdlet.OutputConfig_S3Bucket"> <summary> <para> <para>The name of the bucket your output will go to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterVersionCmdlet.OutputConfig_S3Prefix"> <summary> <para> <para>The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterVersionCmdlet.Tag"> <summary> <para> <para>A set of tags (key-value pairs) that you want to attach to the adapter version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterVersionCmdlet.ManifestS3Object_Version"> <summary> <para> <para>If the bucket has versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterVersionCmdlet.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.Textract.Model.CreateAdapterVersionResponse). Specifying the name of a property of type Amazon.Textract.Model.CreateAdapterVersionResponse 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.TXT.NewTXTAdapterVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AdapterId parameter. The -PassThru parameter is deprecated, use -Select '^AdapterId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.NewTXTAdapterVersionCmdlet.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.TXT.RemoveTXTAdapterCmdlet"> <summary> Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.RemoveTXTAdapterCmdlet.AdapterId"> <summary> <para> <para>A string containing a unique ID for the adapter to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.RemoveTXTAdapterCmdlet.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.Textract.Model.DeleteAdapterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.RemoveTXTAdapterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AdapterId parameter. The -PassThru parameter is deprecated, use -Select '^AdapterId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.RemoveTXTAdapterCmdlet.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.TXT.RemoveTXTAdapterVersionCmdlet"> <summary> Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.RemoveTXTAdapterVersionCmdlet.AdapterId"> <summary> <para> <para>A string containing a unique ID for the adapter version that will be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.RemoveTXTAdapterVersionCmdlet.AdapterVersion"> <summary> <para> <para>Specifies the adapter version to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.RemoveTXTAdapterVersionCmdlet.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.Textract.Model.DeleteAdapterVersionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.RemoveTXTAdapterVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AdapterId parameter. The -PassThru parameter is deprecated, use -Select '^AdapterId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.RemoveTXTAdapterVersionCmdlet.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.TXT.RemoveTXTResourceTagCmdlet"> <summary> Removes any tags with the specified keys from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.RemoveTXTResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) that specifies the resource to be untagged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.RemoveTXTResourceTagCmdlet.TagKey"> <summary> <para> <para>Specifies the tags to be removed from the resource specified by the ResourceARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.RemoveTXTResourceTagCmdlet.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.Textract.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.RemoveTXTResourceTagCmdlet.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.TXT.RemoveTXTResourceTagCmdlet.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.TXT.StartTXTDocumentAnalysisCmdlet"> <summary> Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements. <para><c>StartDocumentAnalysis</c> can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use <a>DocumentLocation</a> to specify the bucket name and file name of the document. </para><para><c>StartDocumentAnalysis</c> returns a job identifier (<c>JobId</c>) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in <c>NotificationChannel</c>. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <a>GetDocumentAnalysis</a>, and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartDocumentAnalysis</c>. </para><para> For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html">Document Text Analysis</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentAnalysisCmdlet.AdaptersConfig_Adapter"> <summary> <para> <para>A list of adapters to be used when analyzing the specified document.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentAnalysisCmdlet.S3Object_Bucket"> <summary> <para> <para>The name of the S3 bucket. Note that the # character is not valid in the file name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentAnalysisCmdlet.ClientRequestToken"> <summary> <para> <para>The idempotent token that you use to identify the start request. If you use the same token with multiple <c>StartDocumentAnalysis</c> requests, the same <c>JobId</c> is returned. Use <c>ClientRequestToken</c> to prevent the same job from being accidentally started more than once. For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/api-async.html">Calling Amazon Textract Asynchronous Operations</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentAnalysisCmdlet.FeatureType"> <summary> <para> <para>A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to <c>FeatureTypes</c>. All lines and words detected in the document are included in the response (including text that isn't related to the value of <c>FeatureTypes</c>). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentAnalysisCmdlet.JobTag"> <summary> <para> <para>An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use <c>JobTag</c> to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentAnalysisCmdlet.KMSKeyId"> <summary> <para> <para>The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentAnalysisCmdlet.S3Object_Name"> <summary> <para> <para>The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentAnalysisCmdlet.QueriesConfig_Query"> <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.TXT.StartTXTDocumentAnalysisCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentAnalysisCmdlet.OutputConfig_S3Bucket"> <summary> <para> <para>The name of the bucket your output will go to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentAnalysisCmdlet.OutputConfig_S3Prefix"> <summary> <para> <para>The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentAnalysisCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic that Amazon Textract posts the completion status to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentAnalysisCmdlet.S3Object_Version"> <summary> <para> <para>If the bucket has versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentAnalysisCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Textract.Model.StartDocumentAnalysisResponse). Specifying the name of a property of type Amazon.Textract.Model.StartDocumentAnalysisResponse 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.TXT.StartTXTDocumentAnalysisCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FeatureType parameter. The -PassThru parameter is deprecated, use -Select '^FeatureType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentAnalysisCmdlet.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.TXT.StartTXTDocumentTextDetectionCmdlet"> <summary> Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text. <para><c>StartDocumentTextDetection</c> can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use <a>DocumentLocation</a> to specify the bucket name and file name of the document. </para><para><c>StartTextDetection</c> returns a job identifier (<c>JobId</c>) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in <c>NotificationChannel</c>. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <a>GetDocumentTextDetection</a>, and pass the job identifier (<c>JobId</c>) from the initial call to <c>StartDocumentTextDetection</c>. </para><para> For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html">Document Text Detection</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentTextDetectionCmdlet.S3Object_Bucket"> <summary> <para> <para>The name of the S3 bucket. Note that the # character is not valid in the file name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentTextDetectionCmdlet.ClientRequestToken"> <summary> <para> <para>The idempotent token that's used to identify the start request. If you use the same token with multiple <c>StartDocumentTextDetection</c> requests, the same <c>JobId</c> is returned. Use <c>ClientRequestToken</c> to prevent the same job from being accidentally started more than once. For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/api-async.html">Calling Amazon Textract Asynchronous Operations</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentTextDetectionCmdlet.JobTag"> <summary> <para> <para>An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use <c>JobTag</c> to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentTextDetectionCmdlet.KMSKeyId"> <summary> <para> <para>The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentTextDetectionCmdlet.S3Object_Name"> <summary> <para> <para>The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentTextDetectionCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentTextDetectionCmdlet.OutputConfig_S3Bucket"> <summary> <para> <para>The name of the bucket your output will go to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentTextDetectionCmdlet.OutputConfig_S3Prefix"> <summary> <para> <para>The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentTextDetectionCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic that Amazon Textract posts the completion status to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentTextDetectionCmdlet.S3Object_Version"> <summary> <para> <para>If the bucket has versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTDocumentTextDetectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Textract.Model.StartDocumentTextDetectionResponse). Specifying the name of a property of type Amazon.Textract.Model.StartDocumentTextDetectionResponse 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.TXT.StartTXTDocumentTextDetectionCmdlet.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.TXT.StartTXTExpenseAnalysisCmdlet"> <summary> Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names. <para><c>StartExpenseAnalysis</c> can analyze text in documents that are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use the <a>DocumentLocation</a> parameter to specify the name of your S3 bucket and the name of the document in that bucket. </para><para><c>StartExpenseAnalysis</c> returns a job identifier (<c>JobId</c>) that you will provide to <c>GetExpenseAnalysis</c> to retrieve the results of the operation. When the analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the <c>NotificationChannel</c>. To obtain the results of the invoice and receipt analysis operation, ensure that the status value published to the Amazon SNS topic is <c>SUCCEEDED</c>. If so, call <a>GetExpenseAnalysis</a>, and pass the job identifier (<c>JobId</c>) that was returned by your call to <c>StartExpenseAnalysis</c>. </para><para> For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/invoice-receipts.html">Analyzing Invoices and Receipts</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTExpenseAnalysisCmdlet.S3Object_Bucket"> <summary> <para> <para>The name of the S3 bucket. Note that the # character is not valid in the file name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTExpenseAnalysisCmdlet.ClientRequestToken"> <summary> <para> <para>The idempotent token that's used to identify the start request. If you use the same token with multiple <c>StartDocumentTextDetection</c> requests, the same <c>JobId</c> is returned. Use <c>ClientRequestToken</c> to prevent the same job from being accidentally started more than once. For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/api-async.html">Calling Amazon Textract Asynchronous Operations</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTExpenseAnalysisCmdlet.JobTag"> <summary> <para> <para>An identifier you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use <c>JobTag</c> to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTExpenseAnalysisCmdlet.KMSKeyId"> <summary> <para> <para>The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTExpenseAnalysisCmdlet.S3Object_Name"> <summary> <para> <para>The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTExpenseAnalysisCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTExpenseAnalysisCmdlet.OutputConfig_S3Bucket"> <summary> <para> <para>The name of the bucket your output will go to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTExpenseAnalysisCmdlet.OutputConfig_S3Prefix"> <summary> <para> <para>The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTExpenseAnalysisCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic that Amazon Textract posts the completion status to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTExpenseAnalysisCmdlet.S3Object_Version"> <summary> <para> <para>If the bucket has versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTExpenseAnalysisCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Textract.Model.StartExpenseAnalysisResponse). Specifying the name of a property of type Amazon.Textract.Model.StartExpenseAnalysisResponse 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.TXT.StartTXTExpenseAnalysisCmdlet.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.TXT.StartTXTLendingAnalysisCmdlet"> <summary> Starts the classification and analysis of an input document. <c>StartLendingAnalysis</c> initiates the classification and analysis of a packet of lending documents. <c>StartLendingAnalysis</c> operates on a document file located in an Amazon S3 bucket. <para><c>StartLendingAnalysis</c> can analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF. Use <c>DocumentLocation</c> to specify the bucket name and the file name of the document. </para><para><c>StartLendingAnalysis</c> returns a job identifier (<c>JobId</c>) that you use to get the results of the operation. When the text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in <c>NotificationChannel</c>. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If the status is SUCCEEDED you can call either <c>GetLendingAnalysis</c> or <c>GetLendingAnalysisSummary</c> and provide the <c>JobId</c> to obtain the results of the analysis. </para><para> If using <c>OutputConfig</c> to specify an Amazon S3 bucket, the output will be contained within the specified prefix in a directory labeled with the job-id. In the directory there are 3 sub-directories: </para><ul><li><para> detailedResponse (contains the GetLendingAnalysis response) </para></li><li><para> summaryResponse (for the GetLendingAnalysisSummary response) </para></li><li><para> splitDocuments (documents split across logical boundaries) </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTLendingAnalysisCmdlet.S3Object_Bucket"> <summary> <para> <para>The name of the S3 bucket. Note that the # character is not valid in the file name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTLendingAnalysisCmdlet.ClientRequestToken"> <summary> <para> <para>The idempotent token that you use to identify the start request. If you use the same token with multiple <c>StartLendingAnalysis</c> requests, the same <c>JobId</c> is returned. Use <c>ClientRequestToken</c> to prevent the same job from being accidentally started more than once. For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/api-sync.html">Calling Amazon Textract Asynchronous Operations</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTLendingAnalysisCmdlet.JobTag"> <summary> <para> <para>An identifier that you specify to be included in the completion notification published to the Amazon SNS topic. For example, you can use <c>JobTag</c> to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTLendingAnalysisCmdlet.KMSKeyId"> <summary> <para> <para>The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side, using SSE-S3. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTLendingAnalysisCmdlet.S3Object_Name"> <summary> <para> <para>The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTLendingAnalysisCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTLendingAnalysisCmdlet.OutputConfig_S3Bucket"> <summary> <para> <para>The name of the bucket your output will go to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTLendingAnalysisCmdlet.OutputConfig_S3Prefix"> <summary> <para> <para>The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTLendingAnalysisCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic that Amazon Textract posts the completion status to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTLendingAnalysisCmdlet.S3Object_Version"> <summary> <para> <para>If the bucket has versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.StartTXTLendingAnalysisCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Textract.Model.StartLendingAnalysisResponse). Specifying the name of a property of type Amazon.Textract.Model.StartLendingAnalysisResponse 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.TXT.StartTXTLendingAnalysisCmdlet.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.TXT.UpdateTXTAdapterCmdlet"> <summary> Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.UpdateTXTAdapterCmdlet.AdapterId"> <summary> <para> <para>A string containing a unique ID for the adapter that will be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.UpdateTXTAdapterCmdlet.AdapterName"> <summary> <para> <para>The new name to be applied to the adapter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.UpdateTXTAdapterCmdlet.AutoUpdate"> <summary> <para> <para>The new auto-update status to be applied to the adapter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.UpdateTXTAdapterCmdlet.Description"> <summary> <para> <para>The new description to be applied to the adapter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.UpdateTXTAdapterCmdlet.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.Textract.Model.UpdateAdapterResponse). Specifying the name of a property of type Amazon.Textract.Model.UpdateAdapterResponse 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.TXT.UpdateTXTAdapterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AdapterId parameter. The -PassThru parameter is deprecated, use -Select '^AdapterId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.TXT.UpdateTXTAdapterCmdlet.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> |