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.
New-COMPDocumentClassifier-DocumentClassifierName <String>-InputDataConfig_AugmentedManifest <AugmentedManifestsListItem[]>-ClientRequestToken <String>-DataAccessRoleArn <String>-InputDataConfig_DataFormat <DocumentClassifierDataFormat>-DocumentReaderConfig_DocumentReadAction <DocumentReadAction>-DocumentReaderConfig_DocumentReadMode <DocumentReadMode>-InputDataConfig_DocumentType <DocumentClassifierDocumentTypeFormat>-DocumentReaderConfig_FeatureType <String[]>-OutputDataConfig_FlywheelStatsS3Prefix <String>-OutputDataConfig_KmsKeyId <String>-InputDataConfig_LabelDelimiter <String>-LanguageCode <LanguageCode>-Mode <DocumentClassifierMode>-ModelKmsKeyId <String>-ModelPolicy <String>-Documents_S3Uri <String>-InputDataConfig_S3Uri <String>-OutputDataConfig_S3Uri <String>-VpcConfig_SecurityGroupId <String[]>-VpcConfig_Subnet <String[]>-Tag <Tag[]>-Documents_TestS3Uri <String>-InputDataConfig_TestS3Uri <String>-VersionName <String>-VolumeKmsKeyId <String>-Select <String>-PassThru <SwitchParameter>-Force <SwitchParameter>-ClientConfig <AmazonComprehendConfig>
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
TEXTRACT_DETECT_DOCUMENT_TEXT
- The Amazon Comprehend service uses the DetectDocumentText
API operation. TEXTRACT_ANALYZE_DOCUMENT
- The Amazon Comprehend service uses the AnalyzeDocument
API operation. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | InputDataConfig_DocumentReaderConfig_DocumentReadAction |
SERVICE_DEFAULT
- use the Amazon Comprehend service defaults for PDF files.FORCE_DOCUMENT_READ_ACTION
- Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | InputDataConfig_DocumentReaderConfig_DocumentReadMode |
TEXTRACT_ANALYZE_DOCUMENT
as the read action, you must specify one or both of the following values:TABLES
- Returns information about any tables that are detected in the input document. FORMS
- Returns information and the data from any forms that are detected in the input document. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | InputDataConfig_DocumentReaderConfig_FeatureTypes |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | InputDataConfig_Documents_S3Uri |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | InputDataConfig_Documents_TestS3Uri |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
DataFormat
to AUGMENTED_MANIFEST
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | InputDataConfig_AugmentedManifests |
COMPREHEND_CSV
: A two-column CSV file, where labels are provided in the first column, and documents are provided in the second. If you use this value, you must provide the S3Uri
parameter in your request.AUGMENTED_MANIFEST
: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its associated labels. If you use this value, you must provide the AugmentedManifests
parameter in your request.COMPREHEND_CSV
as the default. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
S3://bucketName/prefix
, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.This parameter is required if you set DataFormat
to COMPREHEND_CSV
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
"1234abcd-12ab-34cd-56ef-1234567890ab"
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:'{"attribute": "value", "attribute": ["value"]}'
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
"1234abcd-12ab-34cd-56ef-1234567890ab"
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
"alias/ExampleAlias"
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
OutputDataConfig
object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix and other output files. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri
field contains the location of the output file, called output.tar.gz
. It is a compressed archive that contains the confusion matrix. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
"1234abcd-12ab-34cd-56ef-1234567890ab"
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | VpcConfig_SecurityGroupIds |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | VpcConfig_Subnets |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z