CognitoIdentityProvider / Client / get_ui_customization

get_ui_customization#

CognitoIdentityProvider.Client.get_ui_customization(**kwargs)#

Given a user pool ID or app client, returns information about classic hosted UI branding that you applied, if any. Returns user-pool level branding information if no app client branding is applied, or if you don’t specify an app client ID. Returns an empty object if you haven’t applied hosted UI branding to either the client or the user pool. For more information, see Hosted UI (classic) branding.

See also: AWS API Documentation

Request Syntax

response = client.get_ui_customization(
    UserPoolId='string',
    ClientId='string'
)
Parameters:

  • UserPoolId (string) –

    [REQUIRED]

    The ID of the user pool that you want to query for branding settings.

  • ClientId (string) – The ID of the app client that you want to query for branding settings.

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) –

      Information about the classic hosted UI custom CSS and logo-image branding that you applied to the user pool or app client.

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

      • 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