# Amazon Cognito Sync API > Amazon Cognito Sync API on Apizie: 17 endpoints (Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers…, Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has…, Posts updates to records and adds and deletes records for a dataset and user. The sync count in the record…, Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone.…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:amazonaws-cognito-sync` - Category: Cloud - Status: byok - Source: https://github.com/mermade/aws2openapi - Page: https://zieapi.vercel.app/api/cloud/amazonaws-cognito-sync - OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-cognito-sync/openapi.json Amazon Cognito Sync Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android.… ## Endpoints ### Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/bulk-publish` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique… | ### Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/describe-dataset` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique… | | IdentityId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique… | | DatasetName | string | yes | A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). | ### Posts updates to records and adds and deletes records for a dataset and user. The sync count in the record… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/update-records` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique… | | IdentityId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique… | | DatasetName | string | yes | A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). | | x-amz-Client-Context | string | no | Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet… | | body | object | yes | JSON request body | ### Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone.… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/delete-dataset` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique… | | IdentityId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique… | | DatasetName | string | yes | A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). | ### Gets usage details (for example, data storage) about a particular identity pool. This API can only be called… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/describe-identity-pool-usage` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique… | ### Gets usage information for an identity, including number of datasets and data usage. This API can be called… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/describe-identity-usage` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique… | | IdentityId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique… | ### Get the status of the last BulkPublish operation for an identity pool. This API can only be called with… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/get-bulk-publish-details` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique… | ### Gets the events and the corresponding Lambda functions associated with an identity pool. This API can only… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/get-cognito-events` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | The Cognito Identity Pool ID for the request | ### Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/set-cognito-events` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | The Cognito Identity Pool to use when configuring Cognito Events | | body | object | yes | JSON request body | ### Gets the configuration settings of an identity pool. This API can only be called with developer credentials.… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/get-identity-pool-configuration` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for… | ### Sets the necessary configuration for push sync. This API can only be called with developer credentials. You… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/set-identity-pool-configuration` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to… | | body | object | yes | JSON request body | ### Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data.… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/list-datasets` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique… | | IdentityId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique… | | nextToken | string | no | A pagination token for obtaining the next page of results. | | maxResults | integer | no | The maximum number of results to be returned. | ### Gets a list of identity pools registered with Cognito. ListIdentityPoolUsage can only be called with… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/list-identity-pool-usage` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | nextToken | string | no | A pagination token for obtaining the next page of results. | | maxResults | integer | no | The maximum number of results to be returned. | ### Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With… `GET https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/list-records` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique… | | IdentityId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique… | | DatasetName | string | yes | A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). | | lastSyncCount | integer | no | The last server sync count for this record. | | nextToken | string | no | A pagination token for obtaining the next page of results. | | maxResults | integer | no | The maximum number of results to be returned. | | syncSessionToken | string | no | A token containing a session ID, identity ID, and expiration. | ### Registers a device to receive push sync notifications. This API can only be called with temporary… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/register-device` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that… | | IdentityId | string | yes | The unique ID for this identity. | | body | object | yes | JSON request body | ### Subscribes to receive notifications when a dataset is modified by another device. This API can only be… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/subscribe-to-dataset` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which… | | IdentityId | string | yes | Unique ID for this identity. | | DatasetName | string | yes | The name of the dataset to subcribe to. | | DeviceId | string | yes | The unique ID generated for this device by Cognito. | ### Unsubscribes from receiving notifications when a dataset is modified by another device. This API can only be… `POST https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/unsubscribe-from-dataset` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | region | string | no | The AWS region | | IdentityPoolId | string | yes | A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which… | | IdentityId | string | yes | Unique ID for this identity. | | DatasetName | string | yes | The name of the dataset from which to unsubcribe. | | DeviceId | string | yes | The unique ID generated for this device by Cognito. | ## Example ``` curl "https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/bulk-publish" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Amazon Cognito Sync API? Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-cognito-sync/bulk-publish with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Amazon Cognito Sync API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon Cognito Sync itself also needs your own key from amazonaws.com. ### Can AI agents use the Amazon Cognito Sync API? Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-cognito-sync. ### What is the status of the Amazon Cognito Sync API? Needs your own provider key (bring your own key)