Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.CognitoSync.GetBulkPublishDetails

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

getBulkPublishDetails #

Arguments

:: Text	`gbpdIdentityPoolId`
-> GetBulkPublishDetails

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:

gbpdIdentityPoolId - 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.

data GetBulkPublishDetails #

The input for the GetBulkPublishDetails operation.

See: getBulkPublishDetails smart constructor.

Instances

Eq GetBulkPublishDetails #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Methods (==) :: GetBulkPublishDetails -> GetBulkPublishDetails -> Bool # (/=) :: GetBulkPublishDetails -> GetBulkPublishDetails -> Bool #
Data GetBulkPublishDetails #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetBulkPublishDetails -> c GetBulkPublishDetails # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetBulkPublishDetails # toConstr :: GetBulkPublishDetails -> Constr # dataTypeOf :: GetBulkPublishDetails -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetBulkPublishDetails) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetBulkPublishDetails) # gmapT :: (forall b. Data b => b -> b) -> GetBulkPublishDetails -> GetBulkPublishDetails # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetBulkPublishDetails -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetBulkPublishDetails -> r # gmapQ :: (forall d. Data d => d -> u) -> GetBulkPublishDetails -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetBulkPublishDetails -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetBulkPublishDetails -> m GetBulkPublishDetails # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetBulkPublishDetails -> m GetBulkPublishDetails # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetBulkPublishDetails -> m GetBulkPublishDetails #
Read GetBulkPublishDetails #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Methods readsPrec :: Int -> ReadS GetBulkPublishDetails # readList :: ReadS [GetBulkPublishDetails] # readPrec :: ReadPrec GetBulkPublishDetails # readListPrec :: ReadPrec [GetBulkPublishDetails] #
Show GetBulkPublishDetails #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Methods showsPrec :: Int -> GetBulkPublishDetails -> ShowS # show :: GetBulkPublishDetails -> String # showList :: [GetBulkPublishDetails] -> ShowS #
Generic GetBulkPublishDetails #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Associated Types type Rep GetBulkPublishDetails :: * -> * # Methods from :: GetBulkPublishDetails -> Rep GetBulkPublishDetails x # to :: Rep GetBulkPublishDetails x -> GetBulkPublishDetails #
Hashable GetBulkPublishDetails #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Methods hashWithSalt :: Int -> GetBulkPublishDetails -> Int # hash :: GetBulkPublishDetails -> Int #
ToJSON GetBulkPublishDetails #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Methods toJSON :: GetBulkPublishDetails -> Value # toEncoding :: GetBulkPublishDetails -> Encoding # toJSONList :: [GetBulkPublishDetails] -> Value # toEncodingList :: [GetBulkPublishDetails] -> Encoding #
AWSRequest GetBulkPublishDetails #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Associated Types type Rs GetBulkPublishDetails :: * # Methods request :: GetBulkPublishDetails -> Request GetBulkPublishDetails # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetBulkPublishDetails -> ClientResponse -> m (Response GetBulkPublishDetails) #
ToHeaders GetBulkPublishDetails #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Methods toHeaders :: GetBulkPublishDetails -> [Header] #
ToPath GetBulkPublishDetails #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Methods toPath :: GetBulkPublishDetails -> ByteString #
ToQuery GetBulkPublishDetails #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Methods toQuery :: GetBulkPublishDetails -> QueryString #
NFData GetBulkPublishDetails #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Methods rnf :: GetBulkPublishDetails -> () #
type Rep GetBulkPublishDetails #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails type Rep GetBulkPublishDetails = D1 (MetaData "GetBulkPublishDetails" "Network.AWS.CognitoSync.GetBulkPublishDetails" "amazonka-cognito-sync-1.6.0-820vMFRNdxnC4eNkS0Kdf4" True) (C1 (MetaCons "GetBulkPublishDetails'" PrefixI True) (S1 (MetaSel (Just "_gbpdIdentityPoolId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs GetBulkPublishDetails #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails type Rs GetBulkPublishDetails = GetBulkPublishDetailsResponse

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.

Destructuring the Response

getBulkPublishDetailsResponse #

Arguments

:: Int	`gbpdrsResponseStatus`
-> GetBulkPublishDetailsResponse

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:

gbpdrsBulkPublishStartTime - The date/time at which the last bulk publish was initiated.
gbpdrsIdentityPoolId - 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 - If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.
gbpdrsFailureMessage - If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.
gbpdrsBulkPublishStatus - 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 - -- | The response status code.

data GetBulkPublishDetailsResponse #

The output for the GetBulkPublishDetails operation.

See: getBulkPublishDetailsResponse smart constructor.

Instances

Eq GetBulkPublishDetailsResponse #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Methods (==) :: GetBulkPublishDetailsResponse -> GetBulkPublishDetailsResponse -> Bool # (/=) :: GetBulkPublishDetailsResponse -> GetBulkPublishDetailsResponse -> Bool #
Data GetBulkPublishDetailsResponse #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetBulkPublishDetailsResponse -> c GetBulkPublishDetailsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetBulkPublishDetailsResponse # toConstr :: GetBulkPublishDetailsResponse -> Constr # dataTypeOf :: GetBulkPublishDetailsResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetBulkPublishDetailsResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetBulkPublishDetailsResponse) # gmapT :: (forall b. Data b => b -> b) -> GetBulkPublishDetailsResponse -> GetBulkPublishDetailsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetBulkPublishDetailsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetBulkPublishDetailsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GetBulkPublishDetailsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetBulkPublishDetailsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetBulkPublishDetailsResponse -> m GetBulkPublishDetailsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetBulkPublishDetailsResponse -> m GetBulkPublishDetailsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetBulkPublishDetailsResponse -> m GetBulkPublishDetailsResponse #
Read GetBulkPublishDetailsResponse #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Methods readsPrec :: Int -> ReadS GetBulkPublishDetailsResponse # readList :: ReadS [GetBulkPublishDetailsResponse] # readPrec :: ReadPrec GetBulkPublishDetailsResponse # readListPrec :: ReadPrec [GetBulkPublishDetailsResponse] #
Show GetBulkPublishDetailsResponse #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Methods showsPrec :: Int -> GetBulkPublishDetailsResponse -> ShowS # show :: GetBulkPublishDetailsResponse -> String # showList :: [GetBulkPublishDetailsResponse] -> ShowS #
Generic GetBulkPublishDetailsResponse #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Associated Types type Rep GetBulkPublishDetailsResponse :: * -> * # Methods from :: GetBulkPublishDetailsResponse -> Rep GetBulkPublishDetailsResponse x # to :: Rep GetBulkPublishDetailsResponse x -> GetBulkPublishDetailsResponse #
NFData GetBulkPublishDetailsResponse #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails Methods rnf :: GetBulkPublishDetailsResponse -> () #
type Rep GetBulkPublishDetailsResponse #
Instance details Defined in Network.AWS.CognitoSync.GetBulkPublishDetails type Rep GetBulkPublishDetailsResponse = D1 (MetaData "GetBulkPublishDetailsResponse" "Network.AWS.CognitoSync.GetBulkPublishDetails" "amazonka-cognito-sync-1.6.0-820vMFRNdxnC4eNkS0Kdf4" False) (C1 (MetaCons "GetBulkPublishDetailsResponse'" PrefixI True) ((S1 (MetaSel (Just "_gbpdrsBulkPublishStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 (MetaSel (Just "_gbpdrsIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_gbpdrsBulkPublishCompleteTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 (MetaSel (Just "_gbpdrsFailureMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_gbpdrsBulkPublishStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe BulkPublishStatus)) :*: S1 (MetaSel (Just "_gbpdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

gbpdrsBulkPublishStartTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime) #

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

gbpdrsIdentityPoolId :: 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.

gbpdrsBulkPublishCompleteTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime) #

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

gbpdrsFailureMessage :: Lens' GetBulkPublishDetailsResponse (Maybe Text) #

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

gbpdrsBulkPublishStatus :: 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.

gbpdrsResponseStatus :: Lens' GetBulkPublishDetailsResponse Int #

- | The response status code.