DescribeLoggingConfiguration
Returns the logging configuration for the specified firewall.
Request Syntax
{
"FirewallArn": "string",
"FirewallName": "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.
- FirewallArn
-
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^arn:aws.*Required: No
- FirewallName
-
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-zA-Z0-9-]+$Required: No
Response Syntax
{
"FirewallArn": "string",
"LoggingConfiguration": {
"LogDestinationConfigs": [
{
"LogDestination": {
"string" : "string"
},
"LogDestinationType": "string",
"LogType": "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.
- FirewallArn
-
The Amazon Resource Name (ARN) of the firewall.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^arn:aws.* - LoggingConfiguration
-
Defines how AWS Network Firewall performs logging for a Firewall.
Type: LoggingConfiguration object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.
HTTP Status Code: 500
- InvalidRequestException
-
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
HTTP Status Code: 400
-
- ResourceNotFoundException
-
Unable to locate a resource using the parameters that you provided.
HTTP Status Code: 400
- ThrottlingException
-
Unable to process the request due to throttling limitations.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
