ListLoggingConfigurationsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WAFRegionalClient, ListLoggingConfigurationsCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import
// const { WAFRegionalClient, ListLoggingConfigurationsCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import
const client = new WAFRegionalClient(config);
const input = { // ListLoggingConfigurationsRequest
  NextMarker: "STRING_VALUE",
  Limit: Number("int"),
};
const command = new ListLoggingConfigurationsCommand(input);
const response = await client.send(command);
// { // ListLoggingConfigurationsResponse
//   LoggingConfigurations: [ // LoggingConfigurations
//     { // LoggingConfiguration
//       ResourceArn: "STRING_VALUE", // required
//       LogDestinationConfigs: [ // LogDestinationConfigs // required
//         "STRING_VALUE",
//       ],
//       RedactedFields: [ // RedactedFields
//         { // FieldToMatch
//           Type: "URI" || "QUERY_STRING" || "HEADER" || "METHOD" || "BODY" || "SINGLE_QUERY_ARG" || "ALL_QUERY_ARGS", // required
//           Data: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
//   NextMarker: "STRING_VALUE",
// };

ListLoggingConfigurationsCommand Input

See ListLoggingConfigurationsCommandInput for more details

Parameter
Type
Description
Limit
number | undefined

Specifies the number of LoggingConfigurations that you want AWS WAF to return for this request. If you have more LoggingConfigurations than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of LoggingConfigurations.

NextMarker
string | undefined

If you specify a value for Limit and you have more LoggingConfigurations than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of LoggingConfigurations. For the second and subsequent ListLoggingConfigurations requests, specify the value of NextMarker from the previous response to get information about another batch of ListLoggingConfigurations.

ListLoggingConfigurationsCommand Output

See ListLoggingConfigurationsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
LoggingConfigurations
LoggingConfiguration[] | undefined

An array of LoggingConfiguration objects.

NextMarker
string | undefined

If you have more LoggingConfigurations than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more LoggingConfigurations, submit another ListLoggingConfigurations request, and specify the NextMarker value from the response in the NextMarker value in the next request.

Throws

Name
Fault
Details
WAFInternalErrorException
server

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidParameterException
client

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, or WebACL) using an action other than INSERT or DELETE.

  • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

  • You tried to create a RateBasedRule with a RateKey value other than IP.

  • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

  • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

  • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

WAFNonexistentItemException
client

The operation failed because the referenced object doesn't exist.

WAFRegionalServiceException
Base exception class for all service exceptions from WAFRegional service.