Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
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.
Synopsis
- data GetBulkPublishDetails = GetBulkPublishDetails' {}
- newGetBulkPublishDetails :: Text -> GetBulkPublishDetails
- getBulkPublishDetails_identityPoolId :: Lens' GetBulkPublishDetails Text
- data GetBulkPublishDetailsResponse = GetBulkPublishDetailsResponse' {}
- newGetBulkPublishDetailsResponse :: Int -> GetBulkPublishDetailsResponse
- getBulkPublishDetailsResponse_bulkPublishCompleteTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime)
- getBulkPublishDetailsResponse_bulkPublishStartTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime)
- getBulkPublishDetailsResponse_bulkPublishStatus :: Lens' GetBulkPublishDetailsResponse (Maybe BulkPublishStatus)
- getBulkPublishDetailsResponse_failureMessage :: Lens' GetBulkPublishDetailsResponse (Maybe Text)
- getBulkPublishDetailsResponse_identityPoolId :: Lens' GetBulkPublishDetailsResponse (Maybe Text)
- getBulkPublishDetailsResponse_httpStatus :: Lens' GetBulkPublishDetailsResponse Int
Creating a Request
data GetBulkPublishDetails Source #
The input for the GetBulkPublishDetails operation.
See: newGetBulkPublishDetails
smart constructor.
GetBulkPublishDetails' | |
|
Instances
newGetBulkPublishDetails Source #
Create a value of GetBulkPublishDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBulkPublishDetails
, getBulkPublishDetails_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.
Request Lenses
getBulkPublishDetails_identityPoolId :: 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
data GetBulkPublishDetailsResponse Source #
The output for the GetBulkPublishDetails operation.
See: newGetBulkPublishDetailsResponse
smart constructor.
GetBulkPublishDetailsResponse' | |
|
Instances
newGetBulkPublishDetailsResponse Source #
Create a value of GetBulkPublishDetailsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bulkPublishCompleteTime:GetBulkPublishDetailsResponse'
, getBulkPublishDetailsResponse_bulkPublishCompleteTime
- If BulkPublishStatus is SUCCEEDED, the time the last bulk publish
operation completed.
$sel:bulkPublishStartTime:GetBulkPublishDetailsResponse'
, getBulkPublishDetailsResponse_bulkPublishStartTime
- The date/time at which the last bulk publish was initiated.
$sel:bulkPublishStatus:GetBulkPublishDetailsResponse'
, getBulkPublishDetailsResponse_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.
$sel:failureMessage:GetBulkPublishDetailsResponse'
, getBulkPublishDetailsResponse_failureMessage
- If BulkPublishStatus is FAILED this field will contain the error message
that caused the bulk publish to fail.
GetBulkPublishDetails
, getBulkPublishDetailsResponse_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.
$sel:httpStatus:GetBulkPublishDetailsResponse'
, getBulkPublishDetailsResponse_httpStatus
- The response's http status code.
Response Lenses
getBulkPublishDetailsResponse_bulkPublishCompleteTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime) Source #
If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.
getBulkPublishDetailsResponse_bulkPublishStartTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime) Source #
The date/time at which the last bulk publish was initiated.
getBulkPublishDetailsResponse_bulkPublishStatus :: 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.
getBulkPublishDetailsResponse_failureMessage :: Lens' GetBulkPublishDetailsResponse (Maybe Text) Source #
If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.
getBulkPublishDetailsResponse_identityPoolId :: 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.
getBulkPublishDetailsResponse_httpStatus :: Lens' GetBulkPublishDetailsResponse Int Source #
The response's http status code.