AWS Amazon Cognito Sync
Browse all Amazonaws APIs62
AI ReadinessAI-Aware (B-)62/100
Agent-ready OpenAPI document · curated by JenticStorageDocument ManagementAWS Signature v4 (HMAC)17 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Read, write, and synchronize per-user key-value datasets across a user's devices using Amazon Cognito Sync.
Use for: I need to sync a user setting across their phone and tablet, I want to store a small amount of per-user state in the AWS cloud, Retrieve all records in a Cognito Sync dataset, Get the count of datasets for an identity
Not supported: Does not handle large object storage, relational queries, or arbitrary application data - use only for small per-user key-value sync tied to a Cognito identity.
Jentic publishes the only available OpenAPI specification for Amazon Cognito Sync, keeping it validated and agent-ready. Amazon Cognito Sync stores and synchronizes user-scoped key-value data across a user's devices and the cloud. Each user has datasets containing string records that are merged on conflict and pushed to all signed-in devices via Amazon SNS push notifications. It is a legacy service - AWS now recommends AWS AppSync for new cross-device sync work - but it remains useful for apps already on Cognito Identity that need lightweight per-user state.
Install Jentic One Beta
Connect the Amazon Cognito Sync to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Amazon Cognito Sync, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Famazonaws.com%2Faws-cognito-sync" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Famazonaws.com%2Faws-cognito-sync" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Amazon Cognito Sync API.
Store and update user-scoped key-value records in named datasets
Synchronize records across devices via UpdateRecords and ListRecords
Trigger bulk publish of all dataset records to a configured Kinesis stream
Configure push synchronization so changes propagate via SNS
Subscribe and unsubscribe a device from dataset change notifications
Register events and Lambda handlers that fire on dataset updates
Use Cases
Patterns agents use Amazon Cognito Sync API for, with concrete tasks.
★ Cross-Device User Preferences
Mobile apps that already use Amazon Cognito Identity often need to keep user preferences such as theme, language, and feature toggles in sync across the user's devices. Cognito Sync stores these as records in named datasets, merges concurrent updates, and propagates changes via push notifications. Setup is a few hours once Cognito Identity is in place.
Call UpdateRecords on the 'preferences' dataset for an IdentityId, writing a record with key 'theme' and value 'dark', then read it back with ListRecords.
Game Save State Sync
Casual mobile games store progress, settings, and unlocked content per player. Cognito Sync persists this state in the cloud, makes it available when the player switches devices, and resolves conflicts deterministically by sync count. Bulk publish to Kinesis enables downstream analytics on aggregated game state.
Write a 'save_slot_1' record containing serialized game state to a 'gameSaves' dataset and verify it appears in ListRecords for the same identity.
Push-Driven Settings Propagation
Apps that need near-real-time propagation of dataset changes can configure push synchronization. When records update, Cognito Sync publishes via Amazon SNS to subscribed devices, which then pull the latest records. This keeps user-scoped configuration consistent without polling.
Call SetCognitoEvents to register a Lambda on dataset update, then SubscribeToDataset for a device's platform endpoint and confirm the event fires when UpdateRecords is called.
Agent-Managed Per-User State
An AI agent operating on behalf of a user can persist intermediate state (such as long-running task progress or preferences) in Cognito Sync datasets without standing up a database. Through Jentic, the agent loads the UpdateRecords schema and writes records keyed by identity, then reads them back when the user returns.
Use UpdateRecords to write {key: 'last_task', value: 'summary_v3'} to an 'agentState' dataset and read it back with ListRecords.
Key Endpoints
17 endpoints — jentic publishes the only available openapi specification for amazon cognito sync, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}
Update records in a dataset
GET
/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets
List datasets for an identity
POST
/identitypools/{IdentityPoolId}/bulkpublish
Trigger bulk publish of dataset data to Kinesis
GET
/identitypools/{IdentityPoolId}
Describe an identity pool's sync usage
POST
/identitypools/{IdentityPoolId}/configuration
Configure push sync settings for a pool
POST
/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}
Update records in a dataset
GET
/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets
List datasets for an identity
POST
/identitypools/{IdentityPoolId}/bulkpublish
Trigger bulk publish of dataset data to Kinesis
GET
/identitypools/{IdentityPoolId}
Describe an identity pool's sync usage
POST
/identitypools/{IdentityPoolId}/configuration
Configure push sync settings for a pool
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
A
Amazon Cognito Sync
- AI-Aware (B-)62/100
99
Foundational Compliance63
Developer Experience & Jentic Compatibility40
AI-Readiness & Agent Experience94
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
99
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
97%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
40
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: D-Signals: 4
60%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
0%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Amazon Cognito Sync by hand means signing every REST request with AWS Signature v4 HMAC and targeting the right regional host like cognito-sync.{region}.amazonaws.com before you can read or write a per-user dataset. Through Jentic you install once, import Amazon Cognito Sync from the API Directory, store the AWS access key and secret once, and your agent calls it.
Permission scoping
Cognito Sync puts the identity pool, identity, and dataset in the URL path (/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}), so a rule can pin your agent to one identity pool and nothing else. You also choose the operations it may call, so a read like ListDatasets can be allowed while DeleteDataset stays out unless you add it.
Credential isolation
Your AWS access key and secret are stored once, encrypted, by your own Jentic One instance and injected at execution time when the request is signed. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'sync a user's key-value records across devices' or 'list datasets for an identity', and Jentic returns the matching Cognito Sync operation with its input schema, so the agent calls the correct endpoint without browsing the AWS service reference.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Amazon Cognito Sync API through Jentic.
Why is there no official OpenAPI spec for Amazon Cognito Sync?
AWS does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Amazon Cognito Sync via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Amazon Cognito Sync API use?
AWS Signature v4 (HMAC) over the Cognito Identity credentials issued to the user's device. Jentic stores the underlying AWS credentials in its vault, signs requests for the agent, and never exposes the secret access key.
Can I store arbitrary blobs with the Amazon Cognito Sync API?
No. Cognito Sync records are limited to small string key-value pairs (up to 1 MB per dataset). For larger objects, store them in Amazon S3 and keep only the S3 key in the Cognito Sync record.
What are the rate limits for the Amazon Cognito Sync API?
Per-identity-pool rate limits apply to all sync operations and are enforced per AWS Region. Expect TooManyRequestsException under heavy concurrent UpdateRecords and back off exponentially; for analytics-style throughput, use BulkPublish to Kinesis instead.
How do I synchronize records across devices with Amazon Cognito Sync through Jentic?
Search Jentic for 'sync user records across devices', load the UpdateRecords schema, and execute it against /identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName} with the record patches. Other devices then call ListRecords to pull the latest state.
Should I use Amazon Cognito Sync for new applications?
AWS recommends AWS AppSync for new cross-device sync workloads because it supports richer data models and offline conflict resolution. Cognito Sync is still supported and is a reasonable fit for existing Cognito Identity apps that need lightweight key-value sync.
Can I limit what my agent is allowed to do with the Amazon Cognito Sync API?
Yes. Because you run Jentic One yourself, your own rules decide which Cognito Sync operations and credentials the agent may use. Cognito Sync puts the identity pool, identity, and dataset in the URL path, so a rule can pin your agent to a single identity pool and no other. You also pick the operations it may call, so a read like ListDatasets or ListRecords can be allowed while DeleteDataset stays out unless you explicitly add it.
GET STARTED