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.
Creates a new set of branding settings for a user pool style and associates it with an app client. This operation is the programmatic option for the creation of a new style in the branding designer.
Provides values for UI customization in a Settings JSON object and image files
in an Assets array. To send the JSON object Document type parameter
in Settings, you might need to update to the most recent version of your Amazon
Web Services SDK. To create a new style with default settings, set UseCognitoProvidedValues
to true and don't provide values for any other options.
This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
For .NET Core this operation is only available in asynchronous form. Please refer to CreateManagedLoginBrandingAsync.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public virtual CreateManagedLoginBrandingResponse CreateManagedLoginBranding( CreateManagedLoginBrandingRequest request )
Container for the necessary parameters to execute the CreateManagedLoginBranding service method.
| Exception | Condition |
|---|---|
| ConcurrentModificationException | This exception is thrown if two or more modifications are happening concurrently. |
| 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. |
| LimitExceededException | This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource. |
| ManagedLoginBrandingExistsException | This exception is thrown when you attempt to apply a managed login branding style to an app client that already has an assigned style. |
| 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 and newer, 3.5