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

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

data BulkPublish Source #

The input for the BulkPublish operation.

See: newBulkPublish smart constructor.

Constructors

BulkPublish'
Fields identityPoolId :: 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.

Instances

Instances details

ToJSON BulkPublish Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Methods toJSON :: BulkPublish -> Value # toEncoding :: BulkPublish -> Encoding # toJSONList :: [BulkPublish] -> Value # toEncodingList :: [BulkPublish] -> Encoding #
ToHeaders BulkPublish Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Methods toHeaders :: BulkPublish -> [Header] #
ToPath BulkPublish Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Methods toPath :: BulkPublish -> ByteString #
ToQuery BulkPublish Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Methods toQuery :: BulkPublish -> QueryString #
AWSRequest BulkPublish Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Associated Types type AWSResponse BulkPublish # Methods request :: (Service -> Service) -> BulkPublish -> Request BulkPublish # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy BulkPublish -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BulkPublish))) #
Generic BulkPublish Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Associated Types type Rep BulkPublish :: Type -> Type # Methods from :: BulkPublish -> Rep BulkPublish x # to :: Rep BulkPublish x -> BulkPublish #
Read BulkPublish Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Methods readsPrec :: Int -> ReadS BulkPublish # readList :: ReadS [BulkPublish] # readPrec :: ReadPrec BulkPublish # readListPrec :: ReadPrec [BulkPublish] #
Show BulkPublish Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Methods showsPrec :: Int -> BulkPublish -> ShowS # show :: BulkPublish -> String # showList :: [BulkPublish] -> ShowS #
NFData BulkPublish Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Methods rnf :: BulkPublish -> () #
Eq BulkPublish Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Methods (==) :: BulkPublish -> BulkPublish -> Bool # (/=) :: BulkPublish -> BulkPublish -> Bool #
Hashable BulkPublish Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Methods hashWithSalt :: Int -> BulkPublish -> Int # hash :: BulkPublish -> Int #
type AWSResponse BulkPublish Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish type AWSResponse BulkPublish = BulkPublishResponse
type Rep BulkPublish Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish type Rep BulkPublish = D1 ('MetaData "BulkPublish" "Amazonka.CognitoSync.BulkPublish" "amazonka-cognito-sync-2.0-4eAo0O3jWiUGlkSwv2vKaB" 'False) (C1 ('MetaCons "BulkPublish'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newBulkPublish Source #

Arguments

:: Text	`BulkPublish`
-> BulkPublish

Create a value of BulkPublish 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:

BulkPublish, bulkPublish_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

bulkPublish_identityPoolId :: Lens' BulkPublish 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 BulkPublishResponse Source #

The output for the BulkPublish operation.

See: newBulkPublishResponse smart constructor.

Constructors

BulkPublishResponse'
Fields identityPoolId :: 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic BulkPublishResponse Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Associated Types type Rep BulkPublishResponse :: Type -> Type # Methods from :: BulkPublishResponse -> Rep BulkPublishResponse x # to :: Rep BulkPublishResponse x -> BulkPublishResponse #
Read BulkPublishResponse Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Methods readsPrec :: Int -> ReadS BulkPublishResponse # readList :: ReadS [BulkPublishResponse] # readPrec :: ReadPrec BulkPublishResponse # readListPrec :: ReadPrec [BulkPublishResponse] #
Show BulkPublishResponse Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Methods showsPrec :: Int -> BulkPublishResponse -> ShowS # show :: BulkPublishResponse -> String # showList :: [BulkPublishResponse] -> ShowS #
NFData BulkPublishResponse Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Methods rnf :: BulkPublishResponse -> () #
Eq BulkPublishResponse Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish Methods (==) :: BulkPublishResponse -> BulkPublishResponse -> Bool # (/=) :: BulkPublishResponse -> BulkPublishResponse -> Bool #
type Rep BulkPublishResponse Source #
Instance details Defined in Amazonka.CognitoSync.BulkPublish type Rep BulkPublishResponse = D1 ('MetaData "BulkPublishResponse" "Amazonka.CognitoSync.BulkPublish" "amazonka-cognito-sync-2.0-4eAo0O3jWiUGlkSwv2vKaB" 'False) (C1 ('MetaCons "BulkPublishResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newBulkPublishResponse Source #

Arguments

:: Int	`$sel:httpStatus:BulkPublishResponse'`
-> BulkPublishResponse

Create a value of BulkPublishResponse 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:

BulkPublish, bulkPublishResponse_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:BulkPublishResponse', bulkPublishResponse_httpStatus - The response's http status code.

Response Lenses

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

bulkPublishResponse_httpStatus :: Lens' BulkPublishResponse Int Source #

The response's http status code.