An image file from a managed login branding style in a user pool.
This data type is a request parameter of CreateManagedLoginBranding and UpdateManagedLoginBranding, and a response parameter of DescribeManagedLoginBranding.
Contents
- Category
-
The category that the image corresponds to in your managed login configuration. Managed login has asset categories for different types of logos, backgrounds, and icons.
Type: String
Valid Values:
FAVICON_ICO | FAVICON_SVG | EMAIL_GRAPHIC | SMS_GRAPHIC | AUTH_APP_GRAPHIC | PASSWORD_GRAPHIC | PASSKEY_GRAPHIC | PAGE_HEADER_LOGO | PAGE_HEADER_BACKGROUND | PAGE_FOOTER_LOGO | PAGE_FOOTER_BACKGROUND | PAGE_BACKGROUND | FORM_BACKGROUND | FORM_LOGO | IDP_BUTTON_ICONRequired: Yes
- ColorMode
-
The display-mode target of the asset: light, dark, or browser-adaptive. For example, Amazon Cognito displays a dark-mode image only when the browser or application is in dark mode, but displays a browser-adaptive file in all contexts.
Type: String
Valid Values:
LIGHT | DARK | DYNAMICRequired: Yes
- Extension
-
The file type of the image file.
Type: String
Valid Values:
ICO | JPEG | PNG | SVG | WEBPRequired: Yes
- Bytes
-
The image file, in Base64-encoded binary.
Type: Base64-encoded binary data object
Length Constraints: Maximum length of 1000000.
Required: No
- ResourceId
-
The ID of the asset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Pattern:
^[\w\- ]+$Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
