CognitoIdentityProvider.Client.
set_ui_customization
(**kwargs)¶Sets the user interface (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 is used for every client that has no previously set UI customization. If you specify UI customization settings for a particular client, it will no longer return to the ALL
configuration.
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.set_ui_customization(
UserPoolId='string',
ClientId='string',
CSS='string',
ImageFile=b'bytes'
)
[REQUIRED]
The user pool ID for the user pool.
dict
Response Syntax
{
'UICustomization': {
'UserPoolId': 'string',
'ClientId': 'string',
'ImageUrl': 'string',
'CSS': 'string',
'CSSVersion': 'string',
'LastModifiedDate': datetime(2015, 1, 1),
'CreationDate': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
UICustomization (dict) --
The UI customization information.
UserPoolId (string) --
The user pool ID for the user pool.
ClientId (string) --
The client ID for the client app.
ImageUrl (string) --
The logo image for the UI customization.
CSS (string) --
The CSS values in the UI customization.
CSSVersion (string) --
The CSS version number.
LastModifiedDate (datetime) --
The last-modified date for the UI customization.
CreationDate (datetime) --
The creation date for the UI customization.
Exceptions
CognitoIdentityProvider.Client.exceptions.InvalidParameterException
CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
CognitoIdentityProvider.Client.exceptions.TooManyRequestsException
CognitoIdentityProvider.Client.exceptions.InternalErrorException