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

Network.AWS.CognitoSync.BulkPublish

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.

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

bulkPublish #

Arguments

:: Text	`bpIdentityPoolId`
-> BulkPublish

Creates a value of BulkPublish with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bpIdentityPoolId - 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 BulkPublish #

The input for the BulkPublish operation.

See: bulkPublish smart constructor.

Instances

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

Request Lenses

bpIdentityPoolId :: Lens' BulkPublish 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

bulkPublishResponse #

Arguments

:: Int	`bprsResponseStatus`
-> BulkPublishResponse

Creates a value of BulkPublishResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bprsIdentityPoolId - 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.
bprsResponseStatus - -- | The response status code.

data BulkPublishResponse #

The output for the BulkPublish operation.

See: bulkPublishResponse smart constructor.

Instances

Eq BulkPublishResponse #
Methods (==) :: BulkPublishResponse -> BulkPublishResponse -> Bool # (/=) :: BulkPublishResponse -> BulkPublishResponse -> Bool #
Data BulkPublishResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BulkPublishResponse -> c BulkPublishResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BulkPublishResponse # toConstr :: BulkPublishResponse -> Constr # dataTypeOf :: BulkPublishResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c BulkPublishResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BulkPublishResponse) # gmapT :: (forall b. Data b => b -> b) -> BulkPublishResponse -> BulkPublishResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BulkPublishResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BulkPublishResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> BulkPublishResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> BulkPublishResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> BulkPublishResponse -> m BulkPublishResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BulkPublishResponse -> m BulkPublishResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BulkPublishResponse -> m BulkPublishResponse #
Read BulkPublishResponse #
Methods readsPrec :: Int -> ReadS BulkPublishResponse # readList :: ReadS [BulkPublishResponse] # readPrec :: ReadPrec BulkPublishResponse # readListPrec :: ReadPrec [BulkPublishResponse] #
Show BulkPublishResponse #
Methods showsPrec :: Int -> BulkPublishResponse -> ShowS # show :: BulkPublishResponse -> String # showList :: [BulkPublishResponse] -> ShowS #
Generic BulkPublishResponse #
Associated Types type Rep BulkPublishResponse :: * -> * # Methods from :: BulkPublishResponse -> Rep BulkPublishResponse x # to :: Rep BulkPublishResponse x -> BulkPublishResponse #
NFData BulkPublishResponse #
Methods rnf :: BulkPublishResponse -> () #
type Rep BulkPublishResponse #
type Rep BulkPublishResponse = D1 (MetaData "BulkPublishResponse" "Network.AWS.CognitoSync.BulkPublish" "amazonka-cognito-sync-1.4.5-6kgm8A380gaABwgTunDxt8" False) (C1 (MetaCons "BulkPublishResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_bprsIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_bprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

bprsIdentityPoolId :: Lens' BulkPublishResponse (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.

bprsResponseStatus :: Lens' BulkPublishResponse Int #

- | The response status code.