public class CreateEntityRecognizerRequest extends AmazonWebServiceRequest implements java.io.Serializable
Creates an entity recognizer using submitted files. After your
CreateEntityRecognizer
request is submitted, you can check job
status using the API.
Constructor and Description |
---|
CreateEntityRecognizerRequest() |
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.
|
EntityRecognizerInputDataConfig |
getInputDataConfig()
Specifies the format and location of the input data.
|
java.lang.String |
getLanguageCode()
You can specify any of the following languages supported by Amazon
Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian
("it"), German ("de"), or Portuguese ("pt").
|
java.lang.String |
getRecognizerName()
The name given to the newly created recognizer.
|
java.util.List<Tag> |
getTags()
Tags to be associated with the entity recognizer 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 entity
recognizer.
|
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 |
setInputDataConfig(EntityRecognizerInputDataConfig inputDataConfig)
Specifies the format and location of the input data.
|
void |
setLanguageCode(LanguageCode languageCode)
You can specify any of the following languages supported by Amazon
Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian
("it"), German ("de"), or Portuguese ("pt").
|
void |
setLanguageCode(java.lang.String languageCode)
You can specify any of the following languages supported by Amazon
Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian
("it"), German ("de"), or Portuguese ("pt").
|
void |
setRecognizerName(java.lang.String recognizerName)
The name given to the newly created recognizer.
|
void |
setTags(java.util.Collection<Tag> tags)
Tags to be associated with the entity recognizer 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 entity
recognizer.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateEntityRecognizerRequest |
withClientRequestToken(java.lang.String clientRequestToken)
A unique identifier for the request.
|
CreateEntityRecognizerRequest |
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.
|
CreateEntityRecognizerRequest |
withInputDataConfig(EntityRecognizerInputDataConfig inputDataConfig)
Specifies the format and location of the input data.
|
CreateEntityRecognizerRequest |
withLanguageCode(LanguageCode languageCode)
You can specify any of the following languages supported by Amazon
Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian
("it"), German ("de"), or Portuguese ("pt").
|
CreateEntityRecognizerRequest |
withLanguageCode(java.lang.String languageCode)
You can specify any of the following languages supported by Amazon
Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian
("it"), German ("de"), or Portuguese ("pt").
|
CreateEntityRecognizerRequest |
withRecognizerName(java.lang.String recognizerName)
The name given to the newly created recognizer.
|
CreateEntityRecognizerRequest |
withTags(java.util.Collection<Tag> tags)
Tags to be associated with the entity recognizer being created.
|
CreateEntityRecognizerRequest |
withTags(Tag... tags)
Tags to be associated with the entity recognizer being created.
|
CreateEntityRecognizerRequest |
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.
|
CreateEntityRecognizerRequest |
withVpcConfig(VpcConfig vpcConfig)
Configuration parameters for an optional private Virtual Private Cloud
(VPC) containing the resources you are using for your custom entity
recognizer.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.String getRecognizerName()
The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.
Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.
public void setRecognizerName(java.lang.String recognizerName)
The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.
Constraints:
Length: - 63
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
recognizerName
- The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.
public CreateEntityRecognizerRequest withRecognizerName(java.lang.String recognizerName)
The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.
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])*$
recognizerName
- The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.
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 CreateEntityRecognizerRequest 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 entity recognizer 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 entity recognizer 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 entity recognizer 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 entity recognizer 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 CreateEntityRecognizerRequest withTags(Tag... tags)
Tags to be associated with the entity recognizer 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 entity recognizer 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 CreateEntityRecognizerRequest withTags(java.util.Collection<Tag> tags)
Tags to be associated with the entity recognizer 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 entity recognizer 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 EntityRecognizerInputDataConfig getInputDataConfig()
Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.
Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.
public void setInputDataConfig(EntityRecognizerInputDataConfig inputDataConfig)
Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.
inputDataConfig
- Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.
public CreateEntityRecognizerRequest withInputDataConfig(EntityRecognizerInputDataConfig inputDataConfig)
Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.
Returns a reference to this object so that method calls can be chained together.
inputDataConfig
- Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.
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 CreateEntityRecognizerRequest 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()
You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), 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
You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.
LanguageCode
public void setLanguageCode(java.lang.String languageCode)
You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), 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
- You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.
LanguageCode
public CreateEntityRecognizerRequest withLanguageCode(java.lang.String languageCode)
You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), 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
- You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.
LanguageCode
public void setLanguageCode(LanguageCode languageCode)
You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), 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
- You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.
LanguageCode
public CreateEntityRecognizerRequest withLanguageCode(LanguageCode languageCode)
You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), 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
- You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), 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 CreateEntityRecognizerRequest 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 entity recognizer. 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 entity recognizer. 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 entity recognizer. 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 entity recognizer. For more information, see Amazon VPC.
public CreateEntityRecognizerRequest withVpcConfig(VpcConfig vpcConfig)
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. 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 entity recognizer. For more information, see Amazon VPC.
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.