Synopsis
Calls the Amazon Comprehend CreateDocumentClassifier API operation.
Syntax
New-COMPDocumentClassifier-DocumentClassifierName <String>-ClientRequestToken <String>-DataAccessRoleArn <String>-OutputDataConfig_KmsKeyId <String>-LanguageCode <LanguageCode>-InputDataConfig_S3Uri <String>-OutputDataConfig_S3Uri <String>-VpcConfig_SecurityGroupId <String[]>-VpcConfig_Subnet <String[]>-Tag <Tag[]>-VolumeKmsKeyId <String>-Force <SwitchParameter>
Description
Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.
Parameters
-ClientRequestToken <String>
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? | False |
-DataAccessRoleArn <String>
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-DocumentClassifierName <String>
The name of the document classifier.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ) |
-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? | False |
-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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-LanguageCode <LanguageCode>
The language of the input documents. You can specify any of the primary 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? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
-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? | False |
-Tag <Tag[]>
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? | False |
| Aliases | Tags |
-VolumeKmsKeyId <String>
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? | False |
-VpcConfig_SecurityGroupId <String[]>
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? | False |
| Aliases | VpcConfig_SecurityGroupIds |
-VpcConfig_Subnet <String[]>
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? | False |
| Aliases | VpcConfig_Subnets |
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? | False |
-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? | False |
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
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? | False |
-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? | False |
-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? | False |
-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? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
Inputs
You can pipe a String object to this cmdlet for the DocumentClassifierName parameter.
Outputs
This cmdlet returns a System.String object.
The service call response (type Amazon.Comprehend.Model.CreateDocumentClassifierResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
