Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14178465.7 KB

Get the status of the last BulkPublish operation for an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

post/identitypools/{IdentityPoolId}/getBulkPublishDetails

Path parameters

IdentityPoolIdstring required

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.

Response

Success

IdentityPoolIdstring

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.

BulkPublishStartTimestring date-time

The date/time at which the last bulk publish was initiated.

BulkPublishCompleteTimestring date-time

If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.

BulkPublishStatus'NOT_STARTED' | 'IN_PROGRESS' | 'FAILED' | 'SUCCEEDED'

Status of the last bulk publish operation, valid values are: <p>NOT_STARTED - No bulk publish has been requested for this identity pool</p> <p>IN_PROGRESS - Data is being published to the configured stream</p> <p>SUCCEEDED - All data for the identity pool has been published to the configured stream</p> <p>FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.</p>

FailureMessagestring

If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.