AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Textract StartExpenseAnalysis API operation.

Syntax

Start-TXTExpenseAnalysis
-S3Object_Bucket <String>
-ClientRequestToken <String>
-JobTag <String>
-KMSKeyId <String>
-S3Object_Name <String>
-NotificationChannel_RoleArn <String>
-OutputConfig_S3Bucket <String>
-OutputConfig_S3Prefix <String>
-NotificationChannel_SNSTopicArn <String>
-S3Object_Version <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonTextractConfig>

Description

Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names. StartExpenseAnalysis 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 DocumentLocation parameter to specify the name of your S3 bucket and the name of the document in that bucket. StartExpenseAnalysis returns a job identifier (JobId) that you will provide to GetExpenseAnalysis 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 NotificationChannel. To obtain the results of the invoice and receipt analysis operation, ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) that was returned by your call to StartExpenseAnalysis. For more information, see Analyzing Invoices and Receipts.

Parameters

-ClientConfig <AmazonTextractConfig>
Amazon.PowerShell.Cmdlets.TXT.AmazonTextractClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobTag <String>
An identifier you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KMSKeyId <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NotificationChannel_RoleArn <String>
The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NotificationChannel_SNSTopicArn <String>
The Amazon SNS topic that Amazon Textract posts the completion status to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputConfig_S3Bucket <String>
The name of the bucket your output will go to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputConfig_S3Prefix <String>
The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Object_Bucket <String>
The name of the S3 bucket. Note that the # character is not valid in the file name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentLocation_S3Object_Bucket
-S3Object_Name <String>
The file name of the input document. Image files may be in PDF, TIFF, JPEG, or PNG format.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentLocation_S3Object_Name
-S3Object_Version <String>
If the bucket has versioning enabled, you can specify the object version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentLocation_S3Object_Version
-Select <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.Textract.Model.StartExpenseAnalysisResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Textract.Model.StartExpenseAnalysisResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z