get_bulk_publish_details

CognitoSync.Client.get_bulk_publish_details(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_bulk_publish_details(
    IdentityPoolId='string'
)

Parameters

IdentityPoolId (string) -- [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.

Return type

dict

Returns

Response Syntax

{
    'IdentityPoolId': 'string',
    'BulkPublishStartTime': datetime(2015, 1, 1),
    'BulkPublishCompleteTime': datetime(2015, 1, 1),
    'BulkPublishStatus': 'NOT_STARTED'|'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
    'FailureMessage': 'string'
}

Response Structure

• (dict) -- The output for the GetBulkPublishDetails operation.
  • IdentityPoolId (string) -- 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.
  • BulkPublishStartTime (datetime) -- The date/time at which the last bulk publish was initiated.
  • BulkPublishCompleteTime (datetime) -- If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.
  • BulkPublishStatus (string) -- 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.

  • FailureMessage (string) -- If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.

Exceptions

• CognitoSync.Client.exceptions.NotAuthorizedException
• CognitoSync.Client.exceptions.InvalidParameterException
• CognitoSync.Client.exceptions.ResourceNotFoundException
• CognitoSync.Client.exceptions.InternalErrorException