managed_login_branding_by_clients

Creates, updates, deletes, gets or lists a managed_login_branding_by_clients resource.

Overview

Name	managed_login_branding_by_clients
Type	Resource
Id	aws.cognito_idp.managed_login_branding_by_clients

Fields

The following fields are returned by SELECT queries:

describe_managed_login_branding_by_client

Name	Datatype	Description
assets	array	An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.
creation_date	string (date-time)	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.
last_modified_date	string (date-time)	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.
managed_login_branding_id	string	The ID of the managed login branding style. (pattern: <code>^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$</code>)
settings	object	A JSON file, encoded as a Document type, with the the settings that you want to apply to your style. The following components are not currently implemented and reserved for future use: signUp instructions sessionTimerDisplay languageSelector (for localization, see Managed login localization)
use_cognito_provided_values	boolean	When true, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding editor. When you specify true for this option, you must also omit values for Settings and Assets in the request.
user_pool_id	string	The user pool where the branding style is assigned. (pattern: <code>[\w-]+_[0-9a-zA-Z]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_managed_login_branding_by_client	select	region		Given the ID of a user pool app client, returns detailed information about the style assigned to the app client.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_managed_login_branding_by_client

Given the ID of a user pool app client, returns detailed information about the style assigned to the app client.

SELECT
assets,
creation_date,
last_modified_date,
managed_login_branding_id,
settings,
use_cognito_provided_values,
user_pool_id
FROM aws.cognito_idp.managed_login_branding_by_clients
WHERE region = '{{ region }}' -- required
;