Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . comprehend ]

list-entity-recognizers

Description

Gets 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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-entity-recognizers is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: EntityRecognizerPropertiesList

Synopsis

  list-entity-recognizers
[--filter <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--filter (structure)

Filters the list of entities returned. You can filter on Status , SubmitTimeBefore , or SubmitTimeAfter . You can only set one filter at a time.

Shorthand Syntax:

Status=string,SubmitTimeBefore=timestamp,SubmitTimeAfter=timestamp

JSON Syntax:

{
  "Status": "SUBMITTED"|"TRAINING"|"DELETING"|"STOP_REQUESTED"|"STOPPED"|"IN_ERROR"|"TRAINED",
  "SubmitTimeBefore": timestamp,
  "SubmitTimeAfter": timestamp
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

EntityRecognizerPropertiesList -> (list)

The list of properties of an entity recognizer.

(structure)

Describes information about an entity recognizer.

EntityRecognizerArn -> (string)

The Amazon Resource Name (ARN) that identifies the entity recognizer.

LanguageCode -> (string)

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

Status -> (string)

Provides the status of the entity recognizer.

Message -> (string)

A description of the status of the recognizer.

SubmitTime -> (timestamp)

The time that the recognizer was submitted for processing.

EndTime -> (timestamp)

The time that the recognizer creation completed.

TrainingStartTime -> (timestamp)

The time that training of the entity recognizer started.

TrainingEndTime -> (timestamp)

The time that training of the entity recognizer was completed.

InputDataConfig -> (structure)

The input data properties of an entity recognizer.

EntityTypes -> (list)

The entity types in the input data for an entity recognizer. A maximum of 12 entity types can be used at one time to train an entity recognizer.

(structure)

Information about an individual item on a list of entity types.

Type -> (string)

Entity type of an item on an entity type list.

Documents -> (structure)

S3 location of the documents folder for an entity recognizer

S3Uri -> (string)

Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.

Annotations -> (structure)

S3 location of the annotations file for an entity recognizer.

S3Uri -> (string)

Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.

EntityList -> (structure)

S3 location of the entity list for an entity recognizer.

S3Uri -> (string)

Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.

RecognizerMetadata -> (structure)

Provides information about an entity recognizer.

NumberOfTrainedDocuments -> (integer)

The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.

NumberOfTestDocuments -> (integer)

The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.

EvaluationMetrics -> (structure)

Detailed information about the accuracy of an entity recognizer.

Precision -> (double)

A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

Recall -> (double)

A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.

F1Score -> (double)

A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

EntityTypes -> (list)

Entity types from the metadata of an entity recognizer.

(structure)

Individual item from the list of entity types in the metadata of an entity recognizer.

Type -> (string)

Type of entity from the list of entity types in the metadata of an entity recognizer.

EvaluationMetrics -> (structure)

Detailed information about the accuracy of the entity recognizer for a specific item on the list of entity types.

Precision -> (double)

A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

Recall -> (double)

A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.

F1Score -> (double)

A measure of how accurate the recognizer results are for for a specific entity type in the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

NumberOfTrainMentions -> (integer)

Indicates the number of times the given entity type was seen in the training data.

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.

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"

VpcConfig -> (structure)

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC .

SecurityGroupIds -> (list)

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 .

(string)

Subnets -> (list)

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 .

(string)

NextToken -> (string)

Identifies the next page of results to return.