describeManagedLoginBranding method

Future<DescribeManagedLoginBrandingResponse> describeManagedLoginBranding({
  1. required String managedLoginBrandingId,
  2. required String userPoolId,
  3. bool? returnMergedResources,
})

Given the ID of a managed login branding style, returns detailed information about the style.

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

Parameter managedLoginBrandingId : The ID of the managed login branding style that you want to get more information about.

Parameter userPoolId : The ID of the user pool that contains the managed login branding style that you want to get information about.

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<DescribeManagedLoginBrandingResponse> describeManagedLoginBranding({
  required String managedLoginBrandingId,
  required String userPoolId,
  bool? returnMergedResources,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target':
        'AWSCognitoIdentityProviderService.DescribeManagedLoginBranding'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'ManagedLoginBrandingId': managedLoginBrandingId,
      'UserPoolId': userPoolId,
      if (returnMergedResources != null)
        'ReturnMergedResources': returnMergedResources,
    },
  );

  return DescribeManagedLoginBrandingResponse.fromJson(jsonResponse.body);
}