Skip to content

SetUICustomizationRequest

Source code in docs_src/capo_cognito_identity_provider/types/set_ui_customization_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class SetUICustomizationRequest(TypedDict, closed=True):
    user_pool_id: (
        "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType"
    )
    """<p>The ID of the user pool where you want to apply branding to the classic hosted UI.</p>"""
    client_id: NotRequired[
        "capo_cognito_identity_provider.types.client_id_type.ClientIdType"
    ]
    """<p>The ID of the app client that you want to customize. To apply a default style to all app clients not configured with client-level branding, set this parameter value to <code>ALL</code>.</p>"""
    css: NotRequired["capo_cognito_identity_provider.types.css_type.CSSType"]
    """<p>A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to your user pool <i>App clients</i> tab, select <i>Login pages</i>, edit <i>Hosted UI (classic) style</i>, and select the link to <code>CSS template.css</code>.</p>"""
    image_file: NotRequired[
        "capo_cognito_identity_provider.types.image_file_type.ImageFileType"
    ]
    """<p>The image that you want to set as your login in the classic hosted UI, as a Base64-formatted binary object.</p>"""

client_id instance-attribute 

client_id: NotRequired[ClientIdType]

The ID of the app client that you want to customize. To apply a default style to all app clients not configured with client-level branding, set this parameter value to ALL.

css instance-attribute 

css: NotRequired[CSSType]

A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to your user pool App clients tab, select Login pages, edit Hosted UI (classic) style, and select the link to CSS template.css.

image_file instance-attribute 

image_file: NotRequired[ImageFileType]

The image that you want to set as your login in the classic hosted UI, as a Base64-formatted binary object.

user_pool_id instance-attribute 

user_pool_id: UserPoolIdType

The ID of the user pool where you want to apply branding to the classic hosted UI.