CognitoIdentityProvider / Client / get_ui_customization

get_ui_customization#

CognitoIdentityProvider.Client.get_ui_customization(**kwargs)#

Gets the user interface (UI) Customization information for a particular app client’s app UI, if any such information exists for the client. If nothing is set for the particular client, but there is an existing pool level customization (the app clientId is ALL), then that information is returned. If nothing is present, then an empty shape is returned.

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.

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

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