Network.AWS.CognitoSync.GetBulkPublishDetails

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

http://docs.aws.amazon.com/cognitosync/latest/APIReference/API_GetBulkPublishDetails.html

Request

data GetBulkPublishDetails

Instances

Eq GetBulkPublishDetails

Ord GetBulkPublishDetails

Read GetBulkPublishDetails

Show GetBulkPublishDetails

IsString GetBulkPublishDetails

ToJSON GetBulkPublishDetails

Monoid GetBulkPublishDetails

AWSRequest GetBulkPublishDetails

ToQuery GetBulkPublishDetails

ToHeaders GetBulkPublishDetails

ToPath GetBulkPublishDetails

type Rs GetBulkPublishDetails = GetBulkPublishDetailsResponse

type Sv GetBulkPublishDetails = CognitoSync

Request constructor

getBulkPublishDetails

Arguments

:: Text

gbpdIdentityPoolId

-> GetBulkPublishDetails

GetBulkPublishDetails constructor.

The fields accessible through corresponding lenses are:

• gbpdIdentityPoolId :: Text

Request lenses

gbpdIdentityPoolId :: Lens' GetBulkPublishDetails Text

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

data GetBulkPublishDetailsResponse

Instances

Eq GetBulkPublishDetailsResponse

Read GetBulkPublishDetailsResponse

Show GetBulkPublishDetailsResponse

FromJSON GetBulkPublishDetailsResponse

Response constructor

getBulkPublishDetailsResponse :: GetBulkPublishDetailsResponse

GetBulkPublishDetailsResponse constructor.

The fields accessible through corresponding lenses are:

• gbpdrBulkPublishCompleteTime :: Maybe UTCTime
• gbpdrBulkPublishStartTime :: Maybe UTCTime
• gbpdrBulkPublishStatus :: Maybe BulkPublishStatus
• gbpdrFailureMessage :: Maybe Text
• gbpdrIdentityPoolId :: Maybe Text

Response lenses

gbpdrBulkPublishCompleteTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime)

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

gbpdrBulkPublishStartTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime)

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

gbpdrBulkPublishStatus :: Lens' GetBulkPublishDetailsResponse (Maybe 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.

gbpdrFailureMessage :: Lens' GetBulkPublishDetailsResponse (Maybe Text)

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

gbpdrIdentityPoolId :: Lens' GetBulkPublishDetailsResponse (Maybe Text)

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.