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.DetectEntities API

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

Amazon Comprehend #X Amz Target=Comprehend 20171127.DetectEntities 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.DetectEntities. 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 46 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 46 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.DetectEntities 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.DetectEntities 1
POST
/#X-Amz-Target=Comprehend_20171127.DetectEntities
Amazon Comprehend Detect Entities
DetectEntities 8 params body → 200480481482483484

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are Block (6 properties), Entity (6 properties), DetectEntitiesRequest (5 properties), DetectEntitiesResponse (5 properties). Each schema is shown below with its type and property counts.

ListOfExtractedCharacters
array
DocumentReadFeatureTypes
string
Specifies the type of Amazon Textract features to apply. If you chose TEXTRACTANALYZEDOCUMENT as the read action, you must specify one or both of the following…
ResourceUnavailableException
SemiStructuredDocumentBlob
string
RelationshipsListItem
object
List of child blocks for the current block.
2 properties
ListOfDocumentType
array
ListOfEntities
array
Block
object
Information about each word or line of text in the input document. For additional information, see Block in the Amazon Textract API reference.
6 properties
DocumentMetadata
object
Information about the document, discovered during text extraction.
2 properties
DocumentReaderConfig
object
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files. By default, Amazon Comprehend perform…
3 properties 1 required
Point
object
The X and Y coordinates of a point on a document page. For additional information, see Point in the Amazon Textract API reference.
2 properties
BoundingBox
object
The bounding box around the detected page or around an element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represen…
4 properties
InvalidRequestException
Integer
integer
ChildBlock
object
Nested block contained within a block.
3 properties
Entity
object
Provides information about an entity.
6 properties
TextSizeLimitExceededException
DetectEntitiesRequest
object
5 properties
EntityType
string
DetectEntitiesResponse
object
5 properties
ListOfRelationships
array
RelationshipType
string
BlockType
string
ListOfBlockReferences
array
CustomerInputString
string
PageBasedErrorCode
string
ListOfErrors
array
BlockReference
object
A reference to a block.
4 properties
Geometry
object
Information about the location of items on a document page. For additional information, see Geometry in the Amazon Textract API reference.
2 properties
Polygon
array
ListOfChildBlocks
array
DocumentReadAction
string
InternalServerException
String
string
DocumentType
string
DocumentReadMode
string
LanguageCode
string
Float
number
ListOfBlocks
array
UnsupportedLanguageException
DocumentTypeListItem
object
Document type for each page in the document.
2 properties
ListOfDocumentReadFeatureTypes
array
ExtractedCharactersListItem
object
Array of the number of characters extracted from each page.
2 properties
EntityRecognizerEndpointArn
string
ErrorsListItem
object
Text extraction encountered one or more page-level errors in the input document. The ErrorCode contains one of the following values: TEXTRACTBADPAGE - Amazon T…
3 properties
StringList
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-comprehend-x-amz-target-comprehend-20171127-detectentities-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.DetectEntities 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.