Get Log Delivery Configuration

cognitoidentityprovider_get_log_delivery_configuration

R Documentation

Given a user pool ID, returns the logging configuration

Description

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.

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

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_get_log_delivery_configuration(UserPoolId)

Arguments

UserPoolId

[required] The ID of the user pool that has the logging configuration that you want to view.

Value

A list with the following syntax:

list(
  LogDeliveryConfiguration = list(
    UserPoolId = "string",
    LogConfigurations = list(
      list(
        LogLevel = "ERROR"|"INFO",
        EventSource = "userNotification"|"userAuthEvents",
        CloudWatchLogsConfiguration = list(
          LogGroupArn = "string"
        ),
        S3Configuration = list(
          BucketArn = "string"
        ),
        FirehoseConfiguration = list(
          StreamArn = "string"
        )
      )
    )
  )
)

Request syntax

svc$get_log_delivery_configuration(
  UserPoolId = "string"
)