import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreateByteMatchSetRequest, CreateByteMatchSetResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CreateByteMatchSetCommand}. */ export interface CreateByteMatchSetCommandInput extends CreateByteMatchSetRequest { } /** * @public * * The output of {@link CreateByteMatchSetCommand}. */ export interface CreateByteMatchSetCommandOutput extends CreateByteMatchSetResponse, __MetadataBearer { } declare const CreateByteMatchSetCommand_base: { new (input: CreateByteMatchSetCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreateByteMatchSetCommandInput): 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.

*
*

Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a * web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. * For example, you can create a ByteMatchSet that matches any requests with User-Agent headers * that contain the string BadBot. You can then configure AWS WAF to reject those requests.

*

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

*
    *
  1. *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a * CreateByteMatchSet request.

    *
  2. *
  3. *

    Submit a CreateByteMatchSet request.

    *
  4. *
  5. *

    Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an * UpdateByteMatchSet request.

    *
  6. *
  7. *

    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.

    *
  8. *
*

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, CreateByteMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import * // const { WAFRegionalClient, CreateByteMatchSetCommand } = 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 = { // CreateByteMatchSetRequest * Name: "STRING_VALUE", // required * ChangeToken: "STRING_VALUE", // required * }; * const command = new CreateByteMatchSetCommand(input); * const response = await client.send(command); * // { // CreateByteMatchSetResponse * // ByteMatchSet: { // ByteMatchSet * // ByteMatchSetId: "STRING_VALUE", // required * // Name: "STRING_VALUE", * // ByteMatchTuples: [ // ByteMatchTuples // required * // { // ByteMatchTuple * // FieldToMatch: { // FieldToMatch * // Type: "URI" || "QUERY_STRING" || "HEADER" || "METHOD" || "BODY" || "SINGLE_QUERY_ARG" || "ALL_QUERY_ARGS", // required * // Data: "STRING_VALUE", * // }, * // TargetString: new Uint8Array(), // 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 * // }, * // ], * // }, * // ChangeToken: "STRING_VALUE", * // }; * * ``` * * @param CreateByteMatchSetCommandInput - {@link CreateByteMatchSetCommandInput} * @returns {@link CreateByteMatchSetCommandOutput} * @see {@link CreateByteMatchSetCommandInput} for command's `input` shape. * @see {@link CreateByteMatchSetCommandOutput} for command's `response` shape. * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape. * * @throws {@link WAFDisallowedNameException} (client fault) *

The name specified is invalid.

* * @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 WAFInvalidParameterException} (client fault) *

The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

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

* * * @public */ export declare class CreateByteMatchSetCommand extends CreateByteMatchSetCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateByteMatchSetRequest; output: CreateByteMatchSetResponse; }; sdk: { input: CreateByteMatchSetCommandInput; output: CreateByteMatchSetCommandOutput; }; }; }