Skip to main content

entity_recognizers

Creates, updates, deletes, gets or lists an entity_recognizers resource.

Overview​

Nameentity_recognizers
TypeResource
Idaws.comprehend.entity_recognizers

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
data_access_role_arnstringThe Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
end_timestring (date-time)The time that the recognizer creation completed.
entity_recognizer_arnstringThe Amazon Resource Name (ARN) that identifies the entity recognizer. (pattern: <code>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]:[0-9]{12}:entity-recognizer/[a-zA-Z0-9](-[a-zA-Z0-9])(/version/[a-zA-Z0-9](-[a-zA-Z0-9])*)?</code>)
flywheel_arnstringThe Amazon Resource Number (ARN) of the flywheel (pattern: <code>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]:[0-9]{12}:flywheel/[a-zA-Z0-9](-[a-zA-Z0-9])*</code>)
input_data_configobjectThe input data properties of an entity recognizer.
language_codestringThe language of the input documents. All documents must be in the same language. Only English ("en") is currently supported. (en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW)
messagestringA description of the status of the recognizer.
model_kms_key_idstringID 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" (pattern: <code>^\p{ASCII}+$</code>)
output_data_configobjectOutput data configuration.
recognizer_metadataobjectProvides information about an entity recognizer.
source_model_arnstringThe Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account. (pattern: <code>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]:[0-9]{12}:entity-recognizer/[a-zA-Z0-9](-[a-zA-Z0-9])(/version/[a-zA-Z0-9](-[a-zA-Z0-9])*)?</code>)
statusstringProvides the status of the entity recognizer. (SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED, TRAINED_WITH_WARNING)
submit_timestring (date-time)The time that the recognizer was submitted for processing.
training_end_timestring (date-time)The time that training of the entity recognizer was completed.
training_start_timestring (date-time)The time that training of the entity recognizer started.
version_namestringThe version name you assigned to the entity recognizer. (pattern: <code>^[a-zA-Z0-9](-[a-zA-Z0-9])$</code>)
volume_kms_key_idstringID 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" (pattern: <code>^\p{ASCII}+$</code>)
vpc_configobjectConfiguration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_entity_recognizerselectregionProvides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
list_entity_recognizersselectregionGets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list. The results of this list are not in any particular order. Please get the list and sort locally if needed.
create_entity_recognizerinsertregion, RecognizerName, DataAccessRoleArn, InputDataConfig, LanguageCodeCreates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.
delete_entity_recognizerdeleteregionDeletes an entity recognizer. Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
stop_training_entity_recognizerexecregion, EntityRecognizerArnStops an entity recognizer training job while in progress. If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

SELECT
data_access_role_arn,
end_time,
entity_recognizer_arn,
flywheel_arn,
input_data_config,
language_code,
message,
model_kms_key_id,
output_data_config,
recognizer_metadata,
source_model_arn,
status,
submit_time,
training_end_time,
training_start_time,
version_name,
volume_kms_key_id,
vpc_config
FROM aws.comprehend.entity_recognizers
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.

INSERT INTO aws.comprehend.entity_recognizers (
RecognizerName,
VersionName,
DataAccessRoleArn,
Tags,
InputDataConfig,
ClientRequestToken,
LanguageCode,
VolumeKmsKeyId,
VpcConfig,
ModelKmsKeyId,
ModelPolicy,
region
)
SELECT 
'{{ RecognizerName }}' /* required */,
'{{ VersionName }}',
'{{ DataAccessRoleArn }}' /* required */,
'{{ Tags }}',
'{{ InputDataConfig }}' /* required */,
'{{ ClientRequestToken }}',
'{{ LanguageCode }}' /* required */,
'{{ VolumeKmsKeyId }}',
'{{ VpcConfig }}',
'{{ ModelKmsKeyId }}',
'{{ ModelPolicy }}',
'{{ region }}'
RETURNING
entity_recognizer_arn
;

DELETE examples​

Deletes an entity recognizer. Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.

DELETE FROM aws.comprehend.entity_recognizers
WHERE region = '{{ region }}' --required
;

Lifecycle Methods​

Stops an entity recognizer training job while in progress. If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

EXEC aws.comprehend.entity_recognizers.stop_training_entity_recognizer 
@region='{{ region }}' --required 
@@json=
'{
"EntityRecognizerArn": "{{ EntityRecognizerArn }}"
}'
;
Last updated on