@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateEntityRecognizerRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateEntityRecognizerRequest() |
Modifier and Type | Method and Description |
---|---|
CreateEntityRecognizerRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getClientRequestToken()
A unique identifier for the request.
|
String |
getDataAccessRoleArn()
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
EntityRecognizerInputDataConfig |
getInputDataConfig()
Specifies the format and location of the input data.
|
String |
getLanguageCode()
You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
German ("de"), or Portuguese ("pt").
|
String |
getModelKmsKeyId()
ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models.
|
String |
getModelPolicy()
The JSON resource-based policy to attach to your custom entity recognizer model.
|
String |
getRecognizerName()
The name given to the newly created recognizer.
|
List<Tag> |
getTags()
Tags to associate with the entity recognizer.
|
String |
getVersionName()
The version name given to the newly created recognizer.
|
String |
getVolumeKmsKeyId()
ID for the Amazon Web Services 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(String clientRequestToken)
A unique identifier for the request.
|
void |
setDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the 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(String languageCode)
You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
German ("de"), or Portuguese ("pt").
|
void |
setModelKmsKeyId(String modelKmsKeyId)
ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models.
|
void |
setModelPolicy(String modelPolicy)
The JSON resource-based policy to attach to your custom entity recognizer model.
|
void |
setRecognizerName(String recognizerName)
The name given to the newly created recognizer.
|
void |
setTags(Collection<Tag> tags)
Tags to associate with the entity recognizer.
|
void |
setVersionName(String versionName)
The version name given to the newly created recognizer.
|
void |
setVolumeKmsKeyId(String volumeKmsKeyId)
ID for the Amazon Web Services 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.
|
String |
toString()
Returns a string representation of this object.
|
CreateEntityRecognizerRequest |
withClientRequestToken(String clientRequestToken)
A unique identifier for the request.
|
CreateEntityRecognizerRequest |
withDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the 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: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
German ("de"), or Portuguese ("pt").
|
CreateEntityRecognizerRequest |
withLanguageCode(String languageCode)
You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"),
German ("de"), or Portuguese ("pt").
|
CreateEntityRecognizerRequest |
withModelKmsKeyId(String modelKmsKeyId)
ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models.
|
CreateEntityRecognizerRequest |
withModelPolicy(String modelPolicy)
The JSON resource-based policy to attach to your custom entity recognizer model.
|
CreateEntityRecognizerRequest |
withRecognizerName(String recognizerName)
The name given to the newly created recognizer.
|
CreateEntityRecognizerRequest |
withTags(Collection<Tag> tags)
Tags to associate with the entity recognizer.
|
CreateEntityRecognizerRequest |
withTags(Tag... tags)
Tags to associate with the entity recognizer.
|
CreateEntityRecognizerRequest |
withVersionName(String versionName)
The version name given to the newly created recognizer.
|
CreateEntityRecognizerRequest |
withVolumeKmsKeyId(String volumeKmsKeyId)
ID for the Amazon Web Services 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.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setRecognizerName(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.
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 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.
public CreateEntityRecognizerRequest withRecognizerName(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.
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 void setVersionName(String versionName)
The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/Region.
versionName
- The version name given to the newly created recognizer. Version names can be a maximum of 256 characters.
Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique
among all models with the same recognizer name in the account/Region.public String getVersionName()
The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/Region.
public CreateEntityRecognizerRequest withVersionName(String versionName)
The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/Region.
versionName
- The version name given to the newly created recognizer. Version names can be a maximum of 256 characters.
Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique
among all models with the same recognizer name in the account/Region.public void setDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
dataAccessRoleArn
- The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input
data.public String getDataAccessRoleArn()
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
public CreateEntityRecognizerRequest withDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
dataAccessRoleArn
- The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input
data.public List<Tag> getTags()
Tags to associate with the entity recognizer. 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(Collection<Tag> tags)
Tags to associate with the entity recognizer. 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 associate with the entity recognizer. 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 associate with the entity recognizer. 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.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- Tags to associate with the entity recognizer. 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(Collection<Tag> tags)
Tags to associate with the entity recognizer. 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 associate with the entity recognizer. 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 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 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.
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.
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 void setClientRequestToken(String clientRequestToken)
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
clientRequestToken
- A unique identifier for the request. If you don't set the client request token, Amazon Comprehend
generates one.public String getClientRequestToken()
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
public CreateEntityRecognizerRequest withClientRequestToken(String clientRequestToken)
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
clientRequestToken
- A unique identifier for the request. If you don't set the client request token, Amazon Comprehend
generates one.public void setLanguageCode(String languageCode)
You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.
languageCode
- You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian
("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or
image input files, you must specify English as the language. All training documents must be in the same
language.LanguageCode
public String getLanguageCode()
You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.
LanguageCode
public CreateEntityRecognizerRequest withLanguageCode(String languageCode)
You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.
languageCode
- You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian
("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or
image input files, you must specify English as the language. All training documents must be in the same
language.LanguageCode
public CreateEntityRecognizerRequest withLanguageCode(LanguageCode languageCode)
You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.
languageCode
- You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian
("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or
image input files, you must specify English as the language. All training documents must be in the same
language.LanguageCode
public void setVolumeKmsKeyId(String volumeKmsKeyId)
ID for the Amazon Web Services 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"
volumeKmsKeyId
- ID for the Amazon Web Services 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 String getVolumeKmsKeyId()
ID for the Amazon Web Services 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"
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(String volumeKmsKeyId)
ID for the Amazon Web Services 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"
volumeKmsKeyId
- ID for the Amazon Web Services 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 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 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.
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.
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 void setModelKmsKeyId(String modelKmsKeyId)
ID for the 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"
modelKmsKeyId
- ID for the 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"
public String getModelKmsKeyId()
ID for the 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"
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 withModelKmsKeyId(String modelKmsKeyId)
ID for the 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"
modelKmsKeyId
- ID for the 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"
public void setModelPolicy(String modelPolicy)
The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another Amazon Web Services account to import your custom model.
Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, 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"]}'
modelPolicy
- The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy
to allow another Amazon Web Services account to import your custom model.
Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, 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"]}'
public String getModelPolicy()
The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another Amazon Web Services account to import your custom model.
Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, 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"]}'
Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, 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"]}'
public CreateEntityRecognizerRequest withModelPolicy(String modelPolicy)
The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another Amazon Web Services account to import your custom model.
Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, 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"]}'
modelPolicy
- The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy
to allow another Amazon Web Services account to import your custom model.
Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, 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"]}'
public String toString()
toString
in class Object
Object.toString()
public CreateEntityRecognizerRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()