Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetLoggingConfiguration

Returns the LoggingConfiguration for the specified web ACL.

Request Syntax


{
   "LogScope": "string",
   "LogType": "string",
   "ResourceArn": "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.

LogScope

The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage.

The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from AWS services in the Amazon Security Lake user guide.

Default: CUSTOMER

Type: String

Valid Values: CUSTOMER | SECURITY_LAKE

Required: No

LogType

Used to distinguish between various logging options. Currently, there is one option.

Default: WAF_LOGS

Type: String

Valid Values: WAF_LOGS

Required: No

ResourceArn

The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: .*\S.*

Required: Yes

Response Syntax


{
   "LoggingConfiguration": { 
      "LogDestinationConfigs": [ "string" ],
      "LoggingFilter": { 
         "DefaultBehavior": "string",
         "Filters": [ 
            { 
               "Behavior": "string",
               "Conditions": [ 
                  { 
                     "ActionCondition": { 
                        "Action": "string"
                     },
                     "LabelNameCondition": { 
                        "LabelName": "string"
                     }
                  }
               ],
               "Requirement": "string"
            }
         ]
      },
      "LogScope": "string",
      "LogType": "string",
      "ManagedByFirewallManager": boolean,
      "RedactedFields": [ 
         { 
            "AllQueryArguments": { 
            },
            "Body": { 
               "OversizeHandling": "string"
            },
            "Cookies": { 
               "MatchPattern": { 
                  "All": { 
                  },
                  "ExcludedCookies": [ "string" ],
                  "IncludedCookies": [ "string" ]
               },
               "MatchScope": "string",
               "OversizeHandling": "string"
            },
            "HeaderOrder": { 
               "OversizeHandling": "string"
            },
            "Headers": { 
               "MatchPattern": { 
                  "All": { 
                  },
                  "ExcludedHeaders": [ "string" ],
                  "IncludedHeaders": [ "string" ]
               },
               "MatchScope": "string",
               "OversizeHandling": "string"
            },
            "JA3Fingerprint": { 
               "FallbackBehavior": "string"
            },
            "JsonBody": { 
               "InvalidFallbackBehavior": "string",
               "MatchPattern": { 
                  "All": { 
                  },
                  "IncludedPaths": [ "string" ]
               },
               "MatchScope": "string",
               "OversizeHandling": "string"
            },
            "Method": { 
            },
            "QueryString": { 
            },
            "SingleHeader": { 
               "Name": "string"
            },
            "SingleQueryArgument": { 
               "Name": "string"
            },
            "UriPath": { 
            }
         }
      ],
      "ResourceArn": "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.

LoggingConfiguration

The LoggingConfiguration for the specified web ACL.

Type: LoggingConfiguration object

Errors

For information about the errors that are common to all actions, see Common Errors.

WAFInternalErrorException

Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request.

HTTP Status Code: 500

WAFInvalidOperationException

The operation isn't valid.

HTTP Status Code: 400

WAFInvalidParameterException

The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

You specified a parameter name or value that isn't valid.
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

HTTP Status Code: 400

WAFNonexistentItemException

AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

HTTP Status Code: 400