Menu
Amazon Cognito Sync
API Reference (API Version 2014-06-30)

GetBulkPublishDetails

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.

Request Syntax

Copy
POST /identitypools/IdentityPoolId/getBulkPublishDetails HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

IdentityPoolId

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.

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+:[0-9a-f-]+

Request Body

The request does not have a request body.

Response Syntax

Copy
HTTP/1.1 200 Content-type: application/json { "BulkPublishCompleteTime": number, "BulkPublishStartTime": number, "BulkPublishStatus": "string", "FailureMessage": "string", "IdentityPoolId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

BulkPublishCompleteTime

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

Type: Timestamp

BulkPublishStartTime

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

Type: Timestamp

BulkPublishStatus

Status of the last bulk publish operation, valid values are:

  • NOT_STARTED - No bulk publish has been requested for this identity pool

  • IN_PROGRESS - Data is being published to the configured stream

  • SUCCEEDED - All data for the identity pool has been published to the configured stream

  • FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.

Type: String

Valid Values: NOT_STARTED | IN_PROGRESS | FAILED | SUCCEEDED

FailureMessage

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

Type: String

IdentityPoolId

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+:[0-9a-f-]+

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalErrorException

Indicates an internal service error.

HTTP Status Code: 500

InvalidParameterException

Thrown when a request parameter does not comply with the associated constraints.

HTTP Status Code: 400

NotAuthorizedException

Thrown when a user is not authorized to access the requested resource.

HTTP Status Code: 403

ResourceNotFoundException

Thrown if the resource doesn't exist.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: