How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon Comprehend #X Amz Target=Comprehend 20171127.DescribeEntityRecognizer API

The #X Amz Target=Comprehend 20171127.DescribeEntityRecognizer API from Amazon Comprehend — 1 operation(s) for #x amz target=comprehend 20171127.describeentityrecognizer.

Amazon Comprehend #X Amz Target=Comprehend 20171127.DescribeEntityRecognizer API is one of 84 APIs that Amazon Comprehend publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include #X Amz Target=Comprehend 20171127.DescribeEntityRecognizer. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a getting-started guide, and a JSON-LD context.

This API exposes 1 operation across 1 path, and defines 45 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://comprehend.{region}.amazonaws.com, https://comprehend.{region}.amazonaws.com, http://comprehend.{region}.amazonaws.com.cn, https://comprehend.{region}.amazonaws.com.cn.

1 operations 1 paths 45 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://comprehend.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon Comprehend #X Amz Target=Comprehend 20171127.DescribeEntityRecognizer API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

#X Amz Target=Comprehend 20171127.DescribeEntityRecognizer 1
POST
/#X-Amz-Target=Comprehend_20171127.DescribeEntityRecognizer
Amazon Comprehend Describe Entity Recognizer
DescribeEntityRecognizer 8 params body → 200480481482483

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are EntityRecognizerProperties (18 properties), EntityRecognizerInputDataConfig (6 properties), AugmentedManifestsListItem (6 properties), EntityRecognizerMetadata (4 properties). Each schema is shown below with its type and property counts.

AttributeNamesList
array
EntityRecognizerDataFormat
string
SecurityGroupId
string
VersionName
string
EntityRecognizerProperties
object
Describes information about an entity recognizer.
18 properties
Timestamp
string
EntityRecognizerAugmentedManifestsList
array
EntityTypesListItem
object
An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.
1 property 1 required
IamRoleArn
string
EntityTypesEvaluationMetrics
object
Detailed information about the accuracy of an entity recognizer for a specific entity type.
3 properties
EntityRecognizerInputDataConfig
object
Specifies the format and location of the input data.
6 properties 1 required
Double
number
EntityRecognizerMetadata
object
Detailed information about an entity recognizer.
4 properties
Subnets
array
EntityRecognizerAnnotations
object
Describes the annotations associated with a entity recognizer.
2 properties 1 required
ModelStatus
string
InvalidRequestException
DescribeEntityRecognizerRequest
object
1 property 1 required
Integer
integer
EntityRecognizerEntityList
object
Describes the entity list submitted with an entity recognizer.
1 property 1 required
EntityRecognizerMetadataEntityTypesListItem
object
Individual item from the list of entity types in the metadata of an entity recognizer.
3 properties
EntityRecognizerEvaluationMetrics
object
Detailed information about the accuracy of an entity recognizer.
3 properties
AttributeNamesListItem
string
AugmentedManifestsListItem
object
An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMa…
6 properties 2 required
DescribeEntityRecognizerResponse
object
1 property
AnyLengthString
string
EntityTypeName
string
EntityRecognizerArn
string
Split
string
VpcConfig
object
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amaz…
2 properties 2 required
EntityTypesList
array
SecurityGroupIds
array
InternalServerException
EntityRecognizerMetadataEntityTypesList
array
SubnetId
string
ResourceNotFoundException
AugmentedManifestsDocumentTypeFormat
string
LanguageCode
string
EntityRecognizerDocuments
object
Describes the training documents submitted with an entity recognizer.
3 properties 1 required
ComprehendFlywheelArn
string
EntityRecognizerOutputDataConfig
object
Output data configuration.
1 property
KmsKeyId
string
InputFormat
string
TooManyRequestsException
S3Uri
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-comprehend-x-amz-target-comprehend-20171127-describeentityrecognizer-api-openapi.yml Raw ↑

Other APIs Amazon Comprehend publishes across the network.

Amazon Comprehend #X Amz Target=Comprehend 20171127.BatchDetectDominantLanguage API
Amazon Comprehend #X Amz Target=Comprehend 20171127.BatchDetectEntities API
Amazon Comprehend #X Amz Target=Comprehend 20171127.BatchDetectKeyPhrases API
Amazon Comprehend #X Amz Target=Comprehend 20171127.BatchDetectSentiment API
Amazon Comprehend #X Amz Target=Comprehend 20171127.BatchDetectSyntax API
Amazon Comprehend #X Amz Target=Comprehend 20171127.BatchDetectTargetedSentiment API
Amazon Comprehend #X Amz Target=Comprehend 20171127.ClassifyDocument API
Amazon Comprehend #X Amz Target=Comprehend 20171127.ContainsPiiEntities API
Amazon Comprehend #X Amz Target=Comprehend 20171127.CreateDataset API
Amazon Comprehend #X Amz Target=Comprehend 20171127.CreateDocumentClassifier API
Amazon Comprehend #X Amz Target=Comprehend 20171127.CreateEndpoint API
Amazon Comprehend #X Amz Target=Comprehend 20171127.CreateEntityRecognizer API
Where this information came from

This is an independent, third-party profile of Amazon Comprehend #X Amz Target=Comprehend 20171127.DescribeEntityRecognizer API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.