A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-DocumentClassifierName <
String>
The name of the document classifier.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
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) |
A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.This parameter is required if you set DataFormat
to AUGMENTED_MANIFEST
.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | InputDataConfig_AugmentedManifests |
The format of your training data:
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.
If you don't specify a value, Amazon Comprehend uses
COMPREHEND_CSV
as the default.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-InputDataConfig_LabelDelimiter <
String>
Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-InputDataConfig_S3Uri <
String>
The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.For example, if you use the URI 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) |
-InputDataConfig_TestS3Uri <
String>
The Amazon S3 URI for the input data. The Amazon S3 bucket must be in the same AWS Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
- Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model.Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:"{\"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) |
-OutputDataConfig_KmsKeyId <
String>
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
- Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
- KMS Key Alias:
"alias/ExampleAlias"
- ARN of a KMS Key Alias:
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-OutputDataConfig_S3Uri <
String>
When you use the OutputDataConfig
object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.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) |
Changes the cmdlet behavior to return the value passed to the DocumentClassifierName parameter. The -PassThru parameter is deprecated, use -Select '^DocumentClassifierName' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is 'DocumentClassifierArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Comprehend.Model.CreateDocumentClassifierResponse). Specifying the name of a property of type Amazon.Comprehend.Model.CreateDocumentClassifierResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/AWS Region.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
- KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
- Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see
Security Groups for your VPC.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | VpcConfig_SecurityGroupIds |
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see
VPCs and Subnets.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | VpcConfig_Subnets |