getUICustomization method

Future<GetUICustomizationResponse> getUICustomization({
  1. required String userPoolId,
  2. String? clientId,
})

Given a user pool ID or app client, returns information about classic hosted UI branding that you applied, if any. Returns user-pool level branding information if no app client branding is applied, or if you don't specify an app client ID. Returns an empty object if you haven't applied hosted UI branding to either the client or the user pool. For more information, see Hosted UI (classic) branding.

May throw InternalErrorException. May throw InvalidParameterException. May throw NotAuthorizedException. May throw OperationNotEnabledException. May throw ResourceNotFoundException. May throw TooManyRequestsException.

Parameter userPoolId : The ID of the user pool that you want to query for branding settings.

Parameter clientId : The ID of the app client that you want to query for branding settings.

Implementation

Future<GetUICustomizationResponse> getUICustomization({
  required String userPoolId,
  String? clientId,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSCognitoIdentityProviderService.GetUICustomization'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'UserPoolId': userPoolId,
      if (clientId != null) 'ClientId': clientId,
    },
  );

  return GetUICustomizationResponse.fromJson(jsonResponse.body);
}