Amazon Cognito Identity Provider
  1. Root
Amazon Cognito Identity Provider
  • Root
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
  1. Root

/

POST
/
Sets the user interface (UI) customization information for a user pool's built-in app UI.
You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration is used for every client that has no previously set UI customization. If you specify UI customization settings for a particular client, it will no longer return to the ALL configuration.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserPoolId": "string",
    "ClientId": "string",
    "CSS": "string",
    "ImageFile": "string"
}'
Response Response Example
200 - Example 1
{
    "UICustomization": {
        "UserPoolId": "string",
        "ClientId": "string",
        "ImageUrl": "string",
        "CSS": "string",
        "CSSVersion": "string",
        "LastModifiedDate": "string",
        "CreationDate": "string"
    }
}

Request

Header Params
X-Amz-Target
string 
required
Body Params application/json
UserPoolId
string 
required
The user pool ID for the user pool.
>= 1 characters<= 55 characters
Match pattern:
[\w-]+_[0-9a-zA-Z]+
ClientId
string <password>
optional
The client ID for the client app.
>= 1 characters<= 128 characters
Match pattern:
[\w+]+
CSS
string 
optional
The CSS values in the UI customization.
ImageFile
string 
optional
The uploaded logo image for the UI customization.
Examples

Responses

🟢200Success
application/json
Body
UICustomization
object 
required
The UI customization information.
UserPoolId
string 
optional
The user pool ID for the user pool.
>= 1 characters<= 55 characters
Match pattern:
[\w-]+_[0-9a-zA-Z]+
ClientId
string <password>
optional
The client ID for the client app.
>= 1 characters<= 128 characters
Match pattern:
[\w+]+
ImageUrl
string 
optional
The logo image for the UI customization.
CSS
string 
optional
The CSS values in the UI customization.
CSSVersion
string 
optional
The CSS version number.
LastModifiedDate
string <date-time>
optional
The last-modified date for the UI customization.
CreationDate
string <date-time>
optional
The creation date for the UI customization.
🟠480InvalidParameterException
🟠481ResourceNotFoundException
🟠482NotAuthorizedException
🟠483TooManyRequestsException
🟠484InternalErrorException
Modified at 2023-08-15 07:11:07
Previous
/
Next
/
Built with