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

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

Synopsis

Creating a Request

data GetBulkPublishDetails Source #

The input for the GetBulkPublishDetails operation.

See: newGetBulkPublishDetails smart constructor.

Constructors

GetBulkPublishDetails'
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

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

newGetBulkPublishDetails Source #

Arguments

:: Text	`$sel:identityPoolId:GetBulkPublishDetails'`
-> GetBulkPublishDetails

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:

$sel:identityPoolId: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.

Constructors

GetBulkPublishDetailsResponse'

Fields

bulkPublishStartTime :: Maybe POSIX
The date/time at which the last bulk publish was initiated.
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.
bulkPublishCompleteTime :: Maybe POSIX
If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.
failureMessage :: Maybe Text
If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.
bulkPublishStatus :: 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newGetBulkPublishDetailsResponse Source #

Arguments

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

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:bulkPublishStartTime:GetBulkPublishDetailsResponse', getBulkPublishDetailsResponse_bulkPublishStartTime - The date/time at which the last bulk publish was initiated.

$sel:identityPoolId: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:bulkPublishCompleteTime:GetBulkPublishDetailsResponse', getBulkPublishDetailsResponse_bulkPublishCompleteTime - If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.

$sel:failureMessage:GetBulkPublishDetailsResponse', getBulkPublishDetailsResponse_failureMessage - If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.

$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:httpStatus:GetBulkPublishDetailsResponse', getBulkPublishDetailsResponse_httpStatus - The response's http status code.

Response Lenses

getBulkPublishDetailsResponse_bulkPublishStartTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime) Source #

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

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_bulkPublishCompleteTime :: Lens' GetBulkPublishDetailsResponse (Maybe UTCTime) Source #

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

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_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_httpStatus :: Lens' GetBulkPublishDetailsResponse Int Source #

The response's http status code.