SetLogDeliveryConfiguration
Sets up or modifies the detailed activity logging configuration of a user pool.
Request Syntax
{
"LogConfigurations": [
{
"CloudWatchLogsConfiguration": {
"LogGroupArn": "string
"
},
"EventSource": "string
",
"LogLevel": "string
"
}
],
"UserPoolId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- LogConfigurations
-
A collection of all of the detailed activity logging configurations for a user pool.
Type: Array of LogConfigurationType objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: Yes
- UserPoolId
-
The ID of the user pool where you want to configure detailed activity logging .
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+
Required: Yes
Response Syntax
{
"LogDeliveryConfiguration": {
"LogConfigurations": [
{
"CloudWatchLogsConfiguration": {
"LogGroupArn": "string"
},
"EventSource": "string",
"LogLevel": "string"
}
],
"UserPoolId": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- LogDeliveryConfiguration
-
The detailed activity logging configuration that you applied to the requested user pool.
Type: LogDeliveryConfigurationType object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user isn't authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service can't find the requested resource.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: