public class CreateDocumentClassifierRequest extends AmazonWebServiceRequest implements java.io.Serializable
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.
Constructor and Description |
---|
CreateDocumentClassifierRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getClientRequestToken()
A unique identifier for the request.
|
java.lang.String |
getDataAccessRoleArn()
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM)
role that grants Amazon Comprehend read access to your input data.
|
java.lang.String |
getDocumentClassifierName()
The name of the document classifier.
|
DocumentClassifierInputDataConfig |
getInputDataConfig()
Specifies the format and location of the input data for the job.
|
java.lang.String |
getLanguageCode()
The language of the input documents.
|
java.lang.String |
getMode()
Indicates the mode in which the classifier will be trained.
|
DocumentClassifierOutputDataConfig |
getOutputDataConfig()
Enables the addition of output results configuration parameters for
custom classifier jobs.
|
java.util.List<Tag> |
getTags()
Tags to be associated with the document classifier being created.
|
java.lang.String |
getVolumeKmsKeyId()
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.
|
VpcConfig |
getVpcConfig()
Configuration parameters for an optional private Virtual Private Cloud
(VPC) containing the resources you are using for your custom classifier.
|
int |
hashCode() |
void |
setClientRequestToken(java.lang.String clientRequestToken)
A unique identifier for the request.
|
void |
setDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM)
role that grants Amazon Comprehend read access to your input data.
|
void |
setDocumentClassifierName(java.lang.String documentClassifierName)
The name of the document classifier.
|
void |
setInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)
Specifies the format and location of the input data for the job.
|
void |
setLanguageCode(LanguageCode languageCode)
The language of the input documents.
|
void |
setLanguageCode(java.lang.String languageCode)
The language of the input documents.
|
void |
setMode(DocumentClassifierMode mode)
Indicates the mode in which the classifier will be trained.
|
void |
setMode(java.lang.String mode)
Indicates the mode in which the classifier will be trained.
|
void |
setOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)
Enables the addition of output results configuration parameters for
custom classifier jobs.
|
void |
setTags(java.util.Collection<Tag> tags)
Tags to be associated with the document classifier being created.
|
void |
setVolumeKmsKeyId(java.lang.String volumeKmsKeyId)
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.
|
void |
setVpcConfig(VpcConfig vpcConfig)
Configuration parameters for an optional private Virtual Private Cloud
(VPC) containing the resources you are using for your custom classifier.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateDocumentClassifierRequest |
withClientRequestToken(java.lang.String clientRequestToken)
A unique identifier for the request.
|
CreateDocumentClassifierRequest |
withDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM)
role that grants Amazon Comprehend read access to your input data.
|
CreateDocumentClassifierRequest |
withDocumentClassifierName(java.lang.String documentClassifierName)
The name of the document classifier.
|
CreateDocumentClassifierRequest |
withInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)
Specifies the format and location of the input data for the job.
|
CreateDocumentClassifierRequest |
withLanguageCode(LanguageCode languageCode)
The language of the input documents.
|
CreateDocumentClassifierRequest |
withLanguageCode(java.lang.String languageCode)
The language of the input documents.
|
CreateDocumentClassifierRequest |
withMode(DocumentClassifierMode mode)
Indicates the mode in which the classifier will be trained.
|
CreateDocumentClassifierRequest |
withMode(java.lang.String mode)
Indicates the mode in which the classifier will be trained.
|
CreateDocumentClassifierRequest |
withOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)
Enables the addition of output results configuration parameters for
custom classifier jobs.
|
CreateDocumentClassifierRequest |
withTags(java.util.Collection<Tag> tags)
Tags to be associated with the document classifier being created.
|
CreateDocumentClassifierRequest |
withTags(Tag... tags)
Tags to be associated with the document classifier being created.
|
CreateDocumentClassifierRequest |
withVolumeKmsKeyId(java.lang.String volumeKmsKeyId)
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.
|
CreateDocumentClassifierRequest |
withVpcConfig(VpcConfig vpcConfig)
Configuration parameters for an optional private Virtual Private Cloud
(VPC) containing the resources you are using for your custom classifier.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.String getDocumentClassifierName()
The name of the document classifier.
Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
The name of the document classifier.
public void setDocumentClassifierName(java.lang.String documentClassifierName)
The name of the document classifier.
Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
documentClassifierName
- The name of the document classifier.
public CreateDocumentClassifierRequest withDocumentClassifierName(java.lang.String documentClassifierName)
The name of the document classifier.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
documentClassifierName
- The name of the document classifier.
public java.lang.String getDataAccessRoleArn()
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
public void setDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
dataAccessRoleArn
- The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
public CreateDocumentClassifierRequest withDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
dataAccessRoleArn
- The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
public java.util.List<Tag> getTags()
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.
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.
public void setTags(java.util.Collection<Tag> tags)
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.
tags
- 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.
public CreateDocumentClassifierRequest withTags(Tag... tags)
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.
Returns a reference to this object so that method calls can be chained together.
tags
- 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.
public CreateDocumentClassifierRequest withTags(java.util.Collection<Tag> tags)
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.
Returns a reference to this object so that method calls can be chained together.
tags
- 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.
public DocumentClassifierInputDataConfig getInputDataConfig()
Specifies the format and location of the input data for the job.
Specifies the format and location of the input data for the job.
public void setInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)
Specifies the format and location of the input data for the job.
inputDataConfig
- Specifies the format and location of the input data for the job.
public CreateDocumentClassifierRequest withInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)
Specifies the format and location of the input data for the job.
Returns a reference to this object so that method calls can be chained together.
inputDataConfig
- Specifies the format and location of the input data for the job.
public DocumentClassifierOutputDataConfig getOutputDataConfig()
Enables the addition of output results configuration parameters for custom classifier jobs.
Enables the addition of output results configuration parameters for custom classifier jobs.
public void setOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)
Enables the addition of output results configuration parameters for custom classifier jobs.
outputDataConfig
- Enables the addition of output results configuration parameters for custom classifier jobs.
public CreateDocumentClassifierRequest withOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)
Enables the addition of output results configuration parameters for custom classifier jobs.
Returns a reference to this object so that method calls can be chained together.
outputDataConfig
- Enables the addition of output results configuration parameters for custom classifier jobs.
public java.lang.String getClientRequestToken()
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
public void setClientRequestToken(java.lang.String clientRequestToken)
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$
clientRequestToken
- A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
public CreateDocumentClassifierRequest withClientRequestToken(java.lang.String clientRequestToken)
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-]+$
clientRequestToken
- A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
public java.lang.String getLanguageCode()
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.
Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
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.
LanguageCode
public void setLanguageCode(java.lang.String languageCode)
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.
Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
languageCode
- 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.
LanguageCode
public CreateDocumentClassifierRequest withLanguageCode(java.lang.String languageCode)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
languageCode
- 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.
LanguageCode
public void setLanguageCode(LanguageCode languageCode)
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.
Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
languageCode
- 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.
LanguageCode
public CreateDocumentClassifierRequest withLanguageCode(LanguageCode languageCode)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
languageCode
- 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.
LanguageCode
public java.lang.String getVolumeKmsKeyId()
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"
Constraints:
Length: - 2048
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"
public void setVolumeKmsKeyId(java.lang.String volumeKmsKeyId)
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"
Constraints:
Length: - 2048
volumeKmsKeyId
- 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"
public CreateDocumentClassifierRequest withVolumeKmsKeyId(java.lang.String volumeKmsKeyId)
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"
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 2048
volumeKmsKeyId
- 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"
public VpcConfig getVpcConfig()
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
public void setVpcConfig(VpcConfig vpcConfig)
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
vpcConfig
- Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
public CreateDocumentClassifierRequest withVpcConfig(VpcConfig vpcConfig)
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
Returns a reference to this object so that method calls can be chained together.
vpcConfig
- Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
public java.lang.String getMode()
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 (|).
Constraints:
Allowed Values: MULTI_CLASS, MULTI_LABEL
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 (|).
DocumentClassifierMode
public void setMode(java.lang.String mode)
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 (|).
Constraints:
Allowed Values: MULTI_CLASS, MULTI_LABEL
mode
- 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 (|).
DocumentClassifierMode
public CreateDocumentClassifierRequest withMode(java.lang.String mode)
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 (|).
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: MULTI_CLASS, MULTI_LABEL
mode
- 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 (|).
DocumentClassifierMode
public void setMode(DocumentClassifierMode mode)
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 (|).
Constraints:
Allowed Values: MULTI_CLASS, MULTI_LABEL
mode
- 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 (|).
DocumentClassifierMode
public CreateDocumentClassifierRequest withMode(DocumentClassifierMode mode)
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 (|).
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: MULTI_CLASS, MULTI_LABEL
mode
- 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 (|).
DocumentClassifierMode
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.