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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sets the necessary configuration for push sync.

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 SetIdentityPoolConfiguration Source #

The input for the SetIdentityPoolConfiguration operation.

See: newSetIdentityPoolConfiguration smart constructor.

Constructors

SetIdentityPoolConfiguration'
Fields cognitoStreams :: Maybe CognitoStreams Options to apply to this identity pool for Amazon Cognito streams. pushSync :: Maybe PushSync Options to apply to this identity pool for push synchronization. identityPoolId :: Text A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify.

Instances

Instances details

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

newSetIdentityPoolConfiguration Source #

Arguments

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

Create a value of SetIdentityPoolConfiguration 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:cognitoStreams:SetIdentityPoolConfiguration', setIdentityPoolConfiguration_cognitoStreams - Options to apply to this identity pool for Amazon Cognito streams.

$sel:pushSync:SetIdentityPoolConfiguration', setIdentityPoolConfiguration_pushSync - Options to apply to this identity pool for push synchronization.

$sel:identityPoolId:SetIdentityPoolConfiguration', setIdentityPoolConfiguration_identityPoolId - A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify.

Request Lenses

setIdentityPoolConfiguration_cognitoStreams :: Lens' SetIdentityPoolConfiguration (Maybe CognitoStreams) Source #

Options to apply to this identity pool for Amazon Cognito streams.

setIdentityPoolConfiguration_pushSync :: Lens' SetIdentityPoolConfiguration (Maybe PushSync) Source #

Options to apply to this identity pool for push synchronization.

setIdentityPoolConfiguration_identityPoolId :: Lens' SetIdentityPoolConfiguration Text Source #

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify.

Destructuring the Response

data SetIdentityPoolConfigurationResponse Source #

The output for the SetIdentityPoolConfiguration operation

See: newSetIdentityPoolConfigurationResponse smart constructor.

Constructors

SetIdentityPoolConfigurationResponse'
Fields identityPoolId :: Maybe Text A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. cognitoStreams :: Maybe CognitoStreams Options to apply to this identity pool for Amazon Cognito streams. pushSync :: Maybe PushSync Options to apply to this identity pool for push synchronization. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newSetIdentityPoolConfigurationResponse Source #

Arguments

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

Create a value of SetIdentityPoolConfigurationResponse 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:SetIdentityPoolConfiguration', setIdentityPoolConfigurationResponse_identityPoolId - A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.

$sel:cognitoStreams:SetIdentityPoolConfiguration', setIdentityPoolConfigurationResponse_cognitoStreams - Options to apply to this identity pool for Amazon Cognito streams.

$sel:pushSync:SetIdentityPoolConfiguration', setIdentityPoolConfigurationResponse_pushSync - Options to apply to this identity pool for push synchronization.

$sel:httpStatus:SetIdentityPoolConfigurationResponse', setIdentityPoolConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

setIdentityPoolConfigurationResponse_identityPoolId :: Lens' SetIdentityPoolConfigurationResponse (Maybe Text) Source #

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.

setIdentityPoolConfigurationResponse_cognitoStreams :: Lens' SetIdentityPoolConfigurationResponse (Maybe CognitoStreams) Source #

Options to apply to this identity pool for Amazon Cognito streams.

setIdentityPoolConfigurationResponse_pushSync :: Lens' SetIdentityPoolConfigurationResponse (Maybe PushSync) Source #

Options to apply to this identity pool for push synchronization.

setIdentityPoolConfigurationResponse_httpStatus :: Lens' SetIdentityPoolConfigurationResponse Int Source #

The response's http status code.