describeManagedLoginBrandingByClient method

Future<DescribeManagedLoginBrandingByClientResponse> describeManagedLoginBrandingByClient({
  1. required String clientId,
  2. required String userPoolId,
  3. bool? returnMergedResources,
})

Given the ID of a user pool app client, returns detailed information about the style assigned to the app client.

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

Parameter clientId : The app client that's assigned to the branding style that you want more information about.

Parameter userPoolId : The ID of the user pool that contains the app client where you want more information about the managed login branding style.

Parameter returnMergedResources : When true, returns values for branding options that are unchanged from Amazon Cognito defaults. When false or when you omit this parameter, returns only values that you customized in your branding style.

Implementation

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

  return DescribeManagedLoginBrandingByClientResponse.fromJson(
      jsonResponse.body);
}