Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- getBulkPublishDetails :: Text -> GetBulkPublishDetails
- data GetBulkPublishDetails
- gbpdIdentityPoolId :: Lens' GetBulkPublishDetails Text
- getBulkPublishDetailsResponse :: Int -> GetBulkPublishDetailsResponse
- data GetBulkPublishDetailsResponse
- gbpdrsBulkPublishStartTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime)
- gbpdrsIdentityPoolId :: Lens' GetBulkPublishDetailsResponse (Maybe Text)
- gbpdrsBulkPublishCompleteTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime)
- gbpdrsFailureMessage :: Lens' GetBulkPublishDetailsResponse (Maybe Text)
- gbpdrsBulkPublishStatus :: Lens' GetBulkPublishDetailsResponse (Maybe BulkPublishStatus)
- gbpdrsResponseStatus :: Lens' GetBulkPublishDetailsResponse Int
Creating a Request
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:
data GetBulkPublishDetails Source
The input for the GetBulkPublishDetails operation.
See: getBulkPublishDetails
smart constructor.
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
getBulkPublishDetailsResponse Source
Creates a value of GetBulkPublishDetailsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetBulkPublishDetailsResponse Source
The output for the GetBulkPublishDetails operation.
See: getBulkPublishDetailsResponse
smart constructor.
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.
gbpdrsResponseStatus :: Lens' GetBulkPublishDetailsResponse Int Source
The response status code.