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.CognitoIdentityProvider.UpdateIdentityProvider

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates IdP information for a user pool.

Synopsis

data UpdateIdentityProvider = UpdateIdentityProvider' {
- attributeMapping :: Maybe (HashMap Text Text)
- idpIdentifiers :: Maybe [Text]
- providerDetails :: Maybe (HashMap Text Text)
- userPoolId :: Text
- providerName :: Text
}
newUpdateIdentityProvider :: Text -> Text -> UpdateIdentityProvider
updateIdentityProvider_attributeMapping :: Lens' UpdateIdentityProvider (Maybe (HashMap Text Text))
updateIdentityProvider_idpIdentifiers :: Lens' UpdateIdentityProvider (Maybe [Text])
updateIdentityProvider_providerDetails :: Lens' UpdateIdentityProvider (Maybe (HashMap Text Text))
updateIdentityProvider_userPoolId :: Lens' UpdateIdentityProvider Text
updateIdentityProvider_providerName :: Lens' UpdateIdentityProvider Text
data UpdateIdentityProviderResponse = UpdateIdentityProviderResponse' {
- httpStatus :: Int
- identityProvider :: IdentityProviderType
}
newUpdateIdentityProviderResponse :: Int -> IdentityProviderType -> UpdateIdentityProviderResponse
updateIdentityProviderResponse_httpStatus :: Lens' UpdateIdentityProviderResponse Int
updateIdentityProviderResponse_identityProvider :: Lens' UpdateIdentityProviderResponse IdentityProviderType

Creating a Request

data UpdateIdentityProvider Source #

See: newUpdateIdentityProvider smart constructor.

Constructors

UpdateIdentityProvider'
Fields attributeMapping :: Maybe (HashMap Text Text) The IdP attribute mapping to be changed. idpIdentifiers :: Maybe [Text] A list of IdP identifiers. providerDetails :: Maybe (HashMap Text Text) The IdP details to be updated, such as `MetadataURL` and `MetadataFile`. userPoolId :: Text The user pool ID. providerName :: Text The IdP name.

Instances

Instances details

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

newUpdateIdentityProvider Source #

Arguments

:: Text	`UpdateIdentityProvider`
-> Text	`UpdateIdentityProvider`
-> UpdateIdentityProvider

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

UpdateIdentityProvider, updateIdentityProvider_attributeMapping - The IdP attribute mapping to be changed.

UpdateIdentityProvider, updateIdentityProvider_idpIdentifiers - A list of IdP identifiers.

UpdateIdentityProvider, updateIdentityProvider_providerDetails - The IdP details to be updated, such as MetadataURL and MetadataFile.

UpdateIdentityProvider, updateIdentityProvider_userPoolId - The user pool ID.

UpdateIdentityProvider, updateIdentityProvider_providerName - The IdP name.

Request Lenses

updateIdentityProvider_attributeMapping :: Lens' UpdateIdentityProvider (Maybe (HashMap Text Text)) Source #

The IdP attribute mapping to be changed.

updateIdentityProvider_idpIdentifiers :: Lens' UpdateIdentityProvider (Maybe [Text]) Source #

A list of IdP identifiers.

updateIdentityProvider_providerDetails :: Lens' UpdateIdentityProvider (Maybe (HashMap Text Text)) Source #

The IdP details to be updated, such as MetadataURL and MetadataFile.

updateIdentityProvider_userPoolId :: Lens' UpdateIdentityProvider Text Source #

The user pool ID.

updateIdentityProvider_providerName :: Lens' UpdateIdentityProvider Text Source #

The IdP name.

Destructuring the Response

data UpdateIdentityProviderResponse Source #

See: newUpdateIdentityProviderResponse smart constructor.

Constructors

UpdateIdentityProviderResponse'
Fields httpStatus :: Int The response's http status code. identityProvider :: IdentityProviderType The identity provider details.

Instances

Instances details

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

newUpdateIdentityProviderResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateIdentityProviderResponse'`
-> IdentityProviderType	`$sel:identityProvider:UpdateIdentityProviderResponse'`
-> UpdateIdentityProviderResponse

Create a value of UpdateIdentityProviderResponse 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:httpStatus:UpdateIdentityProviderResponse', updateIdentityProviderResponse_httpStatus - The response's http status code.

$sel:identityProvider:UpdateIdentityProviderResponse', updateIdentityProviderResponse_identityProvider - The identity provider details.

Response Lenses

updateIdentityProviderResponse_httpStatus :: Lens' UpdateIdentityProviderResponse Int Source #

The response's http status code.

updateIdentityProviderResponse_identityProvider :: Lens' UpdateIdentityProviderResponse IdentityProviderType Source #

The identity provider details.