[ aws . waf-regional ]
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.
See also: AWS API Documentation
list-logging-configurations
[--next-marker <value>]
[--limit <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--next-marker
(string)
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
.
--limit
(integer)
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
.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
LoggingConfigurations -> (list)
An array of LoggingConfiguration objects.
(structure)
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.
The Amazon Kinesis Data Firehose,
RedactedFields
information, and the web ACL Amazon Resource Name (ARN).ResourceArn -> (string)
The Amazon Resource Name (ARN) of the web ACL that you want to associate with
LogDestinationConfigs
.LogDestinationConfigs -> (list)
An array of Amazon Kinesis Data Firehose ARNs.
(string)
RedactedFields -> (list)
The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be
xxx
.(structure)
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.
Specifies where in a web request to look for
TargetString
.Type -> (string)
The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:
HEADER
: A specified request header, for example, the value of theUser-Agent
orReferer
header. If you chooseHEADER
for the type, specify the name of the header inData
.
METHOD
: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods:DELETE
,GET
,HEAD
,OPTIONS
,PATCH
,POST
, andPUT
.
QUERY_STRING
: A query string, which is the part of a URL that appears after a?
character, if any.
URI
: The part of a web request that identifies a resource, for example,/images/daily-ad.jpg
.
BODY
: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first8192
bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet .
SINGLE_QUERY_ARG
: The parameter in the query string that you will inspect, such as UserName or SalesRegion . The maximum length forSINGLE_QUERY_ARG
is 30 characters.
ALL_QUERY_ARGS
: Similar toSINGLE_QUERY_ARG
, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify inTargetString
.Data -> (string)
When the value of
Type
isHEADER
, enter the name of the header that you want AWS WAF to search, for example,User-Agent
orReferer
. The name of the header is not case sensitive.When the value of
Type
isSINGLE_QUERY_ARG
, enter the name of the parameter that you want AWS WAF to search, for example,UserName
orSalesRegion
. The parameter name is not case sensitive.If the value of
Type
is any other value, omitData
.NextMarker -> (string)
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.