amazonka-cognito-sync-1.2.0.1: Amazon Cognito Sync SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CognitoSync.GetBulkPublishDetails

Contents

Description

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: AWS API Reference for GetBulkPublishDetails.

Synopsis

Creating a Request

getBulkPublishDetails Source

Creates a value of GetBulkPublishDetails with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Request Lenses

gbpdIdentityPoolId :: Lens' GetBulkPublishDetails Text Source

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.

Destructuring the Response

Response Lenses

gbpdrsBulkPublishStartTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime) Source

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

gbpdrsIdentityPoolId :: Lens' GetBulkPublishDetailsResponse (Maybe Text) Source

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.

gbpdrsBulkPublishCompleteTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime) Source

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

gbpdrsFailureMessage :: Lens' GetBulkPublishDetailsResponse (Maybe Text) Source

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

gbpdrsBulkPublishStatus :: Lens' GetBulkPublishDetailsResponse (Maybe BulkPublishStatus) Source

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.