POST

/identitypools/{IdentityPoolId}/bulkpublish

http://cognito-sync.{region}.amazonaws.com/identitypools/{IdentityPoolId}/bulkpublish

<p>Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.</p><p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>

Access Token Required: API Key

Path Parameters

IdentityPoolIdstringrequired

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://cognito-sync.{region}.amazonaws.com/identitypools/{IdentityPoolId}/bulkpublish' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

1curl --request POST \ 2 --url 'http://cognito-sync.{region}.amazonaws.com/identitypools/{IdentityPoolId}/bulkpublish' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'