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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sets the UI customization information for a user pool's built-in app UI.

You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the ALL configuration.

To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.

Synopsis

data SetUICustomization = SetUICustomization' {
- clientId :: Maybe (Sensitive Text)
- css :: Maybe Text
- imageFile :: Maybe Base64
- userPoolId :: Text
}
newSetUICustomization :: Text -> SetUICustomization
setUICustomization_clientId :: Lens' SetUICustomization (Maybe Text)
setUICustomization_css :: Lens' SetUICustomization (Maybe Text)
setUICustomization_imageFile :: Lens' SetUICustomization (Maybe ByteString)
setUICustomization_userPoolId :: Lens' SetUICustomization Text
data SetUICustomizationResponse = SetUICustomizationResponse' {
- httpStatus :: Int
- uICustomization :: UICustomizationType
}
newSetUICustomizationResponse :: Int -> UICustomizationType -> SetUICustomizationResponse
setUICustomizationResponse_httpStatus :: Lens' SetUICustomizationResponse Int
setUICustomizationResponse_uICustomization :: Lens' SetUICustomizationResponse UICustomizationType

Creating a Request

data SetUICustomization Source #

See: newSetUICustomization smart constructor.

Constructors

SetUICustomization'
Fields clientId :: Maybe (Sensitive Text) The client ID for the client app. css :: Maybe Text The CSS values in the UI customization. imageFile :: Maybe Base64 The uploaded logo image for the UI customization. userPoolId :: Text The user pool ID for the user pool.

Instances

Instances details

Eq SetUICustomization Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization Methods (==) :: SetUICustomization -> SetUICustomization -> Bool # (/=) :: SetUICustomization -> SetUICustomization -> Bool #
Show SetUICustomization Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization Methods showsPrec :: Int -> SetUICustomization -> ShowS # show :: SetUICustomization -> String # showList :: [SetUICustomization] -> ShowS #
Generic SetUICustomization Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization Associated Types type Rep SetUICustomization :: Type -> Type # Methods from :: SetUICustomization -> Rep SetUICustomization x # to :: Rep SetUICustomization x -> SetUICustomization #
NFData SetUICustomization Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization Methods rnf :: SetUICustomization -> () #
Hashable SetUICustomization Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization Methods hashWithSalt :: Int -> SetUICustomization -> Int # hash :: SetUICustomization -> Int #
ToJSON SetUICustomization Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization Methods toJSON :: SetUICustomization -> Value # toEncoding :: SetUICustomization -> Encoding # toJSONList :: [SetUICustomization] -> Value # toEncodingList :: [SetUICustomization] -> Encoding #
AWSRequest SetUICustomization Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization Associated Types type AWSResponse SetUICustomization # Methods request :: SetUICustomization -> Request SetUICustomization # response :: MonadResource m => Logger -> Service -> Proxy SetUICustomization -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetUICustomization))) #
ToHeaders SetUICustomization Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization Methods toHeaders :: SetUICustomization -> [Header] #
ToPath SetUICustomization Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization Methods toPath :: SetUICustomization -> ByteString #
ToQuery SetUICustomization Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization Methods toQuery :: SetUICustomization -> QueryString #
type Rep SetUICustomization Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization type Rep SetUICustomization = D1 ('MetaData "SetUICustomization" "Amazonka.CognitoIdentityProvider.SetUICustomization" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "SetUICustomization'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "css") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "imageFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :*: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse SetUICustomization Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization type AWSResponse SetUICustomization = SetUICustomizationResponse

newSetUICustomization Source #

Arguments

:: Text	`$sel:userPoolId:SetUICustomization'`
-> SetUICustomization

Create a value of SetUICustomization 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:clientId:SetUICustomization', setUICustomization_clientId - The client ID for the client app.

$sel:css:SetUICustomization', setUICustomization_css - The CSS values in the UI customization.

$sel:imageFile:SetUICustomization', setUICustomization_imageFile - The uploaded logo image for the UI customization.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:userPoolId:SetUICustomization', setUICustomization_userPoolId - The user pool ID for the user pool.

Request Lenses

setUICustomization_clientId :: Lens' SetUICustomization (Maybe Text) Source #

The client ID for the client app.

setUICustomization_css :: Lens' SetUICustomization (Maybe Text) Source #

The CSS values in the UI customization.

setUICustomization_imageFile :: Lens' SetUICustomization (Maybe ByteString) Source #

The uploaded logo image for the UI customization.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

setUICustomization_userPoolId :: Lens' SetUICustomization Text Source #

The user pool ID for the user pool.

Destructuring the Response

data SetUICustomizationResponse Source #

See: newSetUICustomizationResponse smart constructor.

Constructors

SetUICustomizationResponse'
Fields httpStatus :: Int The response's http status code. uICustomization :: UICustomizationType The UI customization information.

Instances

Instances details

Eq SetUICustomizationResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization Methods (==) :: SetUICustomizationResponse -> SetUICustomizationResponse -> Bool # (/=) :: SetUICustomizationResponse -> SetUICustomizationResponse -> Bool #
Show SetUICustomizationResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization Methods showsPrec :: Int -> SetUICustomizationResponse -> ShowS # show :: SetUICustomizationResponse -> String # showList :: [SetUICustomizationResponse] -> ShowS #
Generic SetUICustomizationResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization Associated Types type Rep SetUICustomizationResponse :: Type -> Type # Methods from :: SetUICustomizationResponse -> Rep SetUICustomizationResponse x # to :: Rep SetUICustomizationResponse x -> SetUICustomizationResponse #
NFData SetUICustomizationResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization Methods rnf :: SetUICustomizationResponse -> () #
type Rep SetUICustomizationResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.SetUICustomization type Rep SetUICustomizationResponse = D1 ('MetaData "SetUICustomizationResponse" "Amazonka.CognitoIdentityProvider.SetUICustomization" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "SetUICustomizationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "uICustomization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UICustomizationType)))

newSetUICustomizationResponse Source #

Arguments

:: Int	`$sel:httpStatus:SetUICustomizationResponse'`
-> UICustomizationType	`$sel:uICustomization:SetUICustomizationResponse'`
-> SetUICustomizationResponse

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

$sel:uICustomization:SetUICustomizationResponse', setUICustomizationResponse_uICustomization - The UI customization information.

Response Lenses

setUICustomizationResponse_httpStatus :: Lens' SetUICustomizationResponse Int Source #

The response's http status code.

setUICustomizationResponse_uICustomization :: Lens' SetUICustomizationResponse UICustomizationType Source #

The UI customization information.