paws.security.identity (version 0.9.0)

cognitoidentityprovider_update_managed_login_branding: Configures the branding settings for a user pool style

Description

Configures the branding settings for a user pool style. This operation is the programmatic option for the configuration of a style in the branding designer.

See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_update_managed_login_branding/ for full documentation.

Usage

cognitoidentityprovider_update_managed_login_branding(
  UserPoolId = NULL,
  ManagedLoginBrandingId = NULL,
  UseCognitoProvidedValues = NULL,
  Settings = NULL,
  Assets = NULL
)

Arguments

UserPoolId

The ID of the user pool that contains the managed login branding style that you want to update.

ManagedLoginBrandingId

The ID of the managed login branding style that you want to update.

UseCognitoProvidedValues

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

When you specify true for this option, you must also omit values for Settings and Assets in the request.

Settings

A JSON file, encoded as a Document type, with the the settings that you want to apply to your style.

Assets

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.