ListEntityRecognizerSummariesCommand

Suggest an Edit

Gets a list of summaries for the entity recognizers that you have created.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ComprehendClient, ListEntityRecognizerSummariesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
// const { ComprehendClient, ListEntityRecognizerSummariesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
const client = new ComprehendClient(config);
const input = { // ListEntityRecognizerSummariesRequest
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListEntityRecognizerSummariesCommand(input);
const response = await client.send(command);
// { // ListEntityRecognizerSummariesResponse
//   EntityRecognizerSummariesList: [ // EntityRecognizerSummariesList
//     { // EntityRecognizerSummary
//       RecognizerName: "STRING_VALUE",
//       NumberOfVersions: Number("int"),
//       LatestVersionCreatedAt: new Date("TIMESTAMP"),
//       LatestVersionName: "STRING_VALUE",
//       LatestVersionStatus: "SUBMITTED" || "TRAINING" || "DELETING" || "STOP_REQUESTED" || "STOPPED" || "IN_ERROR" || "TRAINED" || "TRAINED_WITH_WARNING",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListEntityRecognizerSummariesCommand Input

See ListEntityRecognizerSummariesCommandInput for more details

Parameter
Type
Description
MaxResults
number | undefined

The maximum number of results to return on each page. The default is 100.

NextToken
string | undefined

Identifies the next page of results to return.

ListEntityRecognizerSummariesCommand Output

See ListEntityRecognizerSummariesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
EntityRecognizerSummariesList
EntityRecognizerSummary[] | undefined

The list entity recognizer summaries.

NextToken
string | undefined

Identifies the next page of results to return.

Throws

Name
Fault
Details
InternalServerException
server

An internal server error occurred. Retry your request.

InvalidRequestException
client

The request is invalid.

TooManyRequestsException
client

The number of requests exceeds the limit. Resubmit your request later.

ComprehendServiceException
Base exception class for all service exceptions from Comprehend service.