CognitoIdentityProvider / Client / set_ui_customization

set_ui_customization#

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'
)
Parameters:

  • UserPoolId (string) –

    [REQUIRED]

    The user pool ID for the user pool.

  • ClientId (string) – The client ID for the client app.

  • CSS (string) – The CSS values in the UI customization.

  • ImageFile (bytes) – The uploaded logo image for the UI customization.

Return type:

dict

Returns:

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 ID of the user pool with hosted UI customizations.

      • ClientId (string) –

        The app client ID for your UI customization. When this value isn’t present, the customization applies to all user pool app clients that don’t have client-level settings..

      • ImageUrl (string) –

        A URL path to the hosted logo image of your UI customization.

      • CSS (string) –

        The CSS values in the UI customization. To get a template with your UI customization options, make a GetUiCustomization request.

      • CSSVersion (string) –

        The CSS version number.

      • LastModifiedDate (datetime) –

        The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

      • CreationDate (datetime) –

        The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Exceptions