getLogDeliveryConfiguration method

Future<GetLogDeliveryConfigurationResponse> getLogDeliveryConfiguration({ required String userPoolId, })

Given a user pool ID, returns the logging configuration. User pools can export message-delivery error and threat-protection activity logs to external Amazon Web Services services. For more information, see Exporting user pool logs.

Learn more

• Signing Amazon Web Services API Requests
• Using the Amazon Cognito user pools API and user pool endpoints

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

Parameter userPoolId : The ID of the user pool that has the logging configuration that you want to view.

Implementation

Future<GetLogDeliveryConfigurationResponse> getLogDeliveryConfiguration({
  required String userPoolId,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target':
        'AWSCognitoIdentityProviderService.GetLogDeliveryConfiguration'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'UserPoolId': userPoolId,
    },
  );

  return GetLogDeliveryConfigurationResponse.fromJson(jsonResponse.body);
}