Amazon Comprehend

Managed natural language processing for entities, sentiment, PII and custom text models.

Provider: aws
Kind: AI service
Category: Compute
Official docs: https://docs.aws.amazon.com/comprehend/latest/dg/guidelines-and-limits.html

Properties · 5 set by this component

property	type	values	required	kind default	this component
analysisMode · component property	enum	synchronous \| batch \| asynchronous	no	synchronous	inherited
auth	enum	api-key \| oauth \| iam \| none	no	—	▸ iam
contentFiltering	boolean	—	no	—	inherited
customModels · component property	boolean	—	no	false	inherited
customerManagedKeys	boolean	—	no	—	▸ false
dataResidency · advanced	enum	us \| eu \| asia \| global	no	—	inherited
dataRetentionDays	integer	—	no	—	inherited
keyStore	boolean	—	no	false	inherited
managed	boolean	—	no	false	▸ true
maxActiveAsyncJobs · component property	integer	—	no	10	inherited
maxDocumentSizeKb · component property	integer	—	no	100	inherited
maxDocumentsPerBatch · component property	integer	—	no	25	inherited
modality	enum	text \| vision \| speech \| multimodal \| structured \| image \| video \| audio \| embedding \| rerank	no	—	▸ text
publicEndpoint	boolean	—	no	—	▸ true
quotaUnitsPerMinute	integer	—	no	—	inherited
rateLimitRpm · advanced	integer	—	no	—	inherited
rateLimitTpm · advanced	integer	—	no	—	inherited
viaGateway	boolean	—	no	false	inherited

Rules that apply · 2

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

AI API key not managedwarning

ai-api-key-unmanaged

This AI vendor is reached with an API key, and nothing in the design holds or rotates that key. It ends up in environment files or code, every caller shares it, and a single leak runs up the vendor bill until someone notices. Put the key in a key-management component, or say it is held there with keyStore.

— all of these hold:
— the node's `auth` is "api-key"
— the node's `keyStore` is false
— the node has at least one incoming edge from an app-server, worker or client
— this does not hold:
— the design contains a node of kind key-management

Stateful node without zone redundancyerror

stateful-node-without-zone-redundancy

A stateful compute node pinned to exactly one availability zone disappears with that zone, and its state goes with it. Nodes inside a cell are exempt, because there the cell is deliberately single-zone and redundancy comes from the other cells.

— all of these hold:
— the node's `stateless` is false
— the node sits inside exactly 1 availability-zone group
— this does not hold:
— the node sits inside at least one cell group

Use it in a design

nodes:
  - { id: "comprehend", component: "aws-comprehend" }

Other AI service products · 125

and 85 more → AI service page

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# Amazon Comprehend: managed NLP over UTF-8 text (entities, key phrases, language, sentiment, PII) with optional custom classifiers and entity recognizers.
3# "Guidelines and quotas" gives the built-in synchronous limits: 100 KB per document for entity, key-phrase and language detection, 25 documents per batch request, 10 active asynchronous jobs per operation, and dynamic throttling instead of a fixed request rate; "AI services opt-out policies" states content may be stored for service improvement unless an Organizations opt-out policy is set.
4schemaVersion: "1"
5type: "component"
6id: "aws-comprehend"
7kind: "ai-service"
8provider: "aws"
9docs: "https://docs.aws.amazon.com/comprehend/latest/dg/guidelines-and-limits.html"
10defaults:
11  auth: "iam"
12  managed: true
13  modality: "text"
14  publicEndpoint: true
15  customerManagedKeys: false
16properties:
17  analysisMode:
18    type: "enum"
19    values: ["synchronous", "batch", "asynchronous"]
20    default: "synchronous"
21  maxDocumentSizeKb:
22    type: "integer"
23    default: 100
24  maxDocumentsPerBatch:
25    type: "integer"
26    default: 25
27  maxActiveAsyncJobs:
28    type: "integer"
29    default: 10
30  customModels:
31    type: "boolean"
32    default: false

The same page as markdown, for an agent: /catalogue/components/aws-comprehend.md