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

Copyright(c) 2013-2016 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.

Synopsis

Creating a Request

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 # 
Data 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 # 
Show GetBulkPublishDetails # 
Generic GetBulkPublishDetails # 
Hashable GetBulkPublishDetails # 
ToJSON GetBulkPublishDetails # 
NFData GetBulkPublishDetails # 

Methods

rnf :: GetBulkPublishDetails -> () #

AWSRequest GetBulkPublishDetails # 
ToQuery GetBulkPublishDetails # 
ToPath GetBulkPublishDetails # 
ToHeaders GetBulkPublishDetails # 
type Rep GetBulkPublishDetails # 
type Rep GetBulkPublishDetails = D1 (MetaData "GetBulkPublishDetails" "Network.AWS.CognitoSync.GetBulkPublishDetails" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" True) (C1 (MetaCons "GetBulkPublishDetails'" PrefixI True) (S1 (MetaSel (Just Symbol "_gbpdIdentityPoolId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs GetBulkPublishDetails # 

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 #

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 # 
Data GetBulkPublishDetailsResponse # 

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 # 
Show GetBulkPublishDetailsResponse # 
Generic GetBulkPublishDetailsResponse # 
NFData GetBulkPublishDetailsResponse # 
type Rep GetBulkPublishDetailsResponse # 
type Rep GetBulkPublishDetailsResponse = D1 (MetaData "GetBulkPublishDetailsResponse" "Network.AWS.CognitoSync.GetBulkPublishDetails" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" False) (C1 (MetaCons "GetBulkPublishDetailsResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gbpdrsBulkPublishStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) ((:*:) (S1 (MetaSel (Just Symbol "_gbpdrsIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gbpdrsBulkPublishCompleteTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))))) ((:*:) (S1 (MetaSel (Just Symbol "_gbpdrsFailureMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gbpdrsBulkPublishStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe BulkPublishStatus))) (S1 (MetaSel (Just Symbol "_gbpdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (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.