import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { UpdateByteMatchSetRequest, UpdateByteMatchSetResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link UpdateByteMatchSetCommand}. */ export interface UpdateByteMatchSetCommandInput extends UpdateByteMatchSetRequest { } /** * @public * * The output of {@link UpdateByteMatchSetCommand}. */ export interface UpdateByteMatchSetCommandOutput extends UpdateByteMatchSetResponse, __MetadataBearer { } declare const UpdateByteMatchSetCommand_base: { new (input: UpdateByteMatchSetCommandInput): import("@smithy/core/client").CommandImpl; new (input: UpdateByteMatchSetCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** * *

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.

* *

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, * you specify the following values:

*
Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, * you delete the existing object and add a new one.
*
*
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.
*
*
The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify * the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.
*
*
Where to look, such as at the beginning or the end of a query string.
*
*
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
*

For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain * the string BadBot. You can then configure AWS WAF to block those requests.

To create and configure a ByteMatchSet, perform the following steps:

*
Create a ByteMatchSet. For more information, see CreateByteMatchSet.
*
*
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an * UpdateByteMatchSet request.
*
*
Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect * (for example, the header or the URI) and the value that you want AWS WAF to watch for.
*

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { WAFRegionalClient, UpdateByteMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import * // const { WAFRegionalClient, UpdateByteMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import * // import type { WAFRegionalClientConfig } from "@aws-sdk/client-waf-regional"; * const config = {}; // type is WAFRegionalClientConfig * const client = new WAFRegionalClient(config); * const input = { // UpdateByteMatchSetRequest * ByteMatchSetId: "STRING_VALUE", // required * ChangeToken: "STRING_VALUE", // required * Updates: [ // ByteMatchSetUpdates // required * { // ByteMatchSetUpdate * Action: "INSERT" || "DELETE", // required * ByteMatchTuple: { // ByteMatchTuple * FieldToMatch: { // FieldToMatch * Type: "URI" || "QUERY_STRING" || "HEADER" || "METHOD" || "BODY" || "SINGLE_QUERY_ARG" || "ALL_QUERY_ARGS", // required * Data: "STRING_VALUE", * }, * TargetString: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required * TextTransformation: "NONE" || "COMPRESS_WHITE_SPACE" || "HTML_ENTITY_DECODE" || "LOWERCASE" || "CMD_LINE" || "URL_DECODE", // required * PositionalConstraint: "EXACTLY" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CONTAINS_WORD", // required * }, * }, * ], * }; * const command = new UpdateByteMatchSetCommand(input); * const response = await client.send(command); * // { // UpdateByteMatchSetResponse * // ChangeToken: "STRING_VALUE", * // }; * * ``` * * @param UpdateByteMatchSetCommandInput - {@link UpdateByteMatchSetCommandInput} * @returns {@link UpdateByteMatchSetCommandOutput} * @see {@link UpdateByteMatchSetCommandInput} for command's `input` shape. * @see {@link UpdateByteMatchSetCommandOutput} for command's `response` shape. * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape. * * @throws {@link WAFInternalErrorException} (server fault) *

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

* * @throws {@link WAFInvalidAccountException} (client fault) *

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

* * @throws {@link WAFInvalidOperationException} (client fault) *

The operation failed because there was nothing to do. For example:

*
You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.
*
*
You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.
*
*
You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple * isn't in the specified WebACL.
*
*
You tried to add a Rule to a WebACL, but the Rule already exists in the * specified WebACL.
*
*
You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple * already exists in the specified WebACL.
*

* * @throws {@link WAFInvalidParameterException} (client fault) *

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.
*

* * @throws {@link WAFLimitsExceededException} (client fault) *

The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create * for an AWS account. For more information, see * Limits in the AWS WAF Developer Guide.

* * @throws {@link WAFNonexistentContainerException} (client fault) *

The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

*
You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.
*
*
You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.
*
*
You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.
*
*
You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet * that doesn't exist.
*

* * @throws {@link WAFNonexistentItemException} (client fault) *

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

* * @throws {@link WAFStaleDataException} (client fault) *

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

* * @throws {@link WAFRegionalServiceException} *

Base exception class for all service exceptions from WAFRegional service.

* * * @example To update a byte match set * ```javascript * // The following example deletes a ByteMatchTuple object (filters) in an byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5. * const input = { * ByteMatchSetId: "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", * ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", * Updates: [ * { * Action: "DELETE", * ByteMatchTuple: { * FieldToMatch: { * Data: "referer", * Type: "HEADER" * }, * PositionalConstraint: "CONTAINS", * TargetString: "badrefer1", * TextTransformation: "NONE" * } * } * ] * }; * const command = new UpdateByteMatchSetCommand(input); * const response = await client.send(command); * /* response is * { * ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" * } * *\/ * ``` * * @public */ export declare class UpdateByteMatchSetCommand extends UpdateByteMatchSetCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateByteMatchSetRequest; output: UpdateByteMatchSetResponse; }; sdk: { input: UpdateByteMatchSetCommandInput; output: UpdateByteMatchSetCommandOutput; }; }; }