ListLoggingConfigurations
Note
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Returns an array of LoggingConfiguration objects.
Request Syntax
{
"Limit": number
,
"NextMarker": "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.
- Limit
-
Specifies the number of
LoggingConfigurations
that you want AWS WAF to return for this request. If you have moreLoggingConfigurations
than the number that you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofLoggingConfigurations
.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- NextMarker
-
If you specify a value for
Limit
and you have moreLoggingConfigurations
than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofLoggingConfigurations
. For the second and subsequentListLoggingConfigurations
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofListLoggingConfigurations
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
.*\S.*
Required: No
Response Syntax
{
"LoggingConfigurations": [
{
"LogDestinationConfigs": [ "string" ],
"RedactedFields": [
{
"Data": "string",
"Type": "string"
}
],
"ResourceArn": "string"
}
],
"NextMarker": "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.
- LoggingConfigurations
-
An array of LoggingConfiguration objects.
Type: Array of LoggingConfiguration objects
- NextMarker
-
If you have more
LoggingConfigurations
than the number that you specified forLimit
in the request, the response includes aNextMarker
value. To list moreLoggingConfigurations
, submit anotherListLoggingConfigurations
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
.*\S.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- WAFInternalErrorException
-
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
- WAFInvalidParameterException
-
The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet
,IPSet
,Rule
, orWebACL
) using an action other thanINSERT
orDELETE
. -
You tried to create a
WebACL
with aDefaultAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to create a
RateBasedRule
with aRateKey
value other thanIP
. -
You tried to update a
WebACL
with aWafAction
Type
other thanALLOW
,BLOCK
, orCOUNT
. -
You tried to update a
ByteMatchSet
with aFieldToMatch
Type
other than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSet
with aField
ofHEADER
but no value forData
. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
HTTP Status Code: 400
-
- WAFNonexistentItemException
-
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: