AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
For .NET Core this operation is only available in asynchronous form. Please refer to SetUICustomizationAsync.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public abstract SetUICustomizationResponse SetUICustomization( SetUICustomizationRequest request )
Container for the necessary parameters to execute the SetUICustomization service method.
Exception | Condition |
---|---|
InternalErrorException | This exception is thrown when Amazon Cognito encounters an internal error. |
InvalidParameterException | This exception is thrown when the Amazon Cognito service encounters an invalid parameter. |
NotAuthorizedException | This exception is thrown when a user isn't authorized. |
ResourceNotFoundException | This exception is thrown when the Amazon Cognito service can't find the requested resource. |
TooManyRequestsException | This exception is thrown when the user has made too many requests for a given operation. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5