Skip to content

create_regex_pattern_set async

create_regex_pattern_set(
    name: EntityName,
    scope: Scope,
    regular_expression_list: RegularExpressionList,
    *,
    config_overrides: Optional[AsyncWAFV2ClientConfig] = None,
    description: Optional[EntityDescription] = None,
    tags: Optional[TagList] = None,
) -> CreateRegexPatternSetResponse

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.

Parameters:

  • name (EntityName) –

    The name of the set. You cannot change the name after you create the set.

  • scope (Scope) –

    Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.

    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

    • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    • API and SDKs - For all calls, use the Region endpoint us-east-1.

  • description (Optional[EntityDescription], default: None ) –

    A description of the set that helps with identification.

  • regular_expression_list (RegularExpressionList) –

    Array of regular expression strings.

  • tags (Optional[TagList], default: None ) –

    An array of key:value pairs to associate with the resource.

Raises:

  • WAFDuplicateItemException –

    WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.

  • WAFInternalErrorException –

    Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

  • WAFInvalidOperationException –

    The operation isn't valid.

  • WAFInvalidParameterException –

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

    • You specified a parameter name or value that isn't valid.

    • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

    • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

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

  • WAFLimitsExceededException –

    WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.

  • WAFOptimisticLockException –

    WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

  • WAFTagOperationException –

    An error occurred during the tagging operation. Retry your request.

  • WAFTagOperationInternalErrorException –

    WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_wafv2/_services/async_wafv2.py
async def create_regex_pattern_set(
    self,
    name: "capo_wafv2.types.entity_name.EntityName",
    scope: "capo_wafv2.types.scope.Scope",
    regular_expression_list: "capo_wafv2.types.regular_expression_list.RegularExpressionList",
    *,
    config_overrides: Optional[AsyncWAFV2ClientConfig] = None,
    description: Optional[
        "capo_wafv2.types.entity_description.EntityDescription"
    ] = None,
    tags: Optional["capo_wafv2.types.tag_list.TagList"] = None,
) -> "capo_wafv2.types.create_regex_pattern_set_response.CreateRegexPatternSetResponse":
    """<p>Creates a <a>RegexPatternSet</a>, which you reference in a <a>RegexPatternSetReferenceStatement</a>, to have WAF inspect a web request component for the specified patterns.</p>

    Args:
        name: <p>The name of the set. You cannot change the name after you create the set.</p>
        scope: <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>
        description: <p>A description of the set that helps with identification. </p>
        regular_expression_list: <p>Array of regular expression strings. </p>
        tags: <p>An array of key:value pairs to associate with the resource.</p>

    Raises:
        capo_wafv2.errors.waf_duplicate_item_exception.WAFDuplicateItemException: <p>WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.</p>
        capo_wafv2.errors.waf_internal_error_exception.WAFInternalErrorException: <p>Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request. </p>
        capo_wafv2.errors.waf_invalid_operation_exception.WAFInvalidOperationException: <p>The operation isn't valid. </p>
        capo_wafv2.errors.waf_invalid_parameter_exception.WAFInvalidParameterException: <p>The operation failed because WAF didn't recognize a parameter in the request. For example: </p> <ul> <li> <p>You specified a parameter name or value that isn't valid.</p> </li> <li> <p>Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. </p> </li> <li> <p>You tried to update a <code>WebACL</code> with a <code>DefaultAction</code> that isn't among the types available at <a>DefaultAction</a>.</p> </li> <li> <p>Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.</p> </li> </ul>
        capo_wafv2.errors.waf_limits_exceeded_exception.WAFLimitsExceededException: <p>WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of <code>WebACL</code> objects that you can create for an Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the <i>WAF Developer Guide</i>.</p>
        capo_wafv2.errors.waf_optimistic_lock_exception.WAFOptimisticLockException: <p>WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. </p>
        capo_wafv2.errors.waf_tag_operation_exception.WAFTagOperationException: <p>An error occurred during the tagging operation. Retry your request.</p>
        capo_wafv2.errors.waf_tag_operation_internal_error_exception.WAFTagOperationInternalErrorException: <p>WAF couldn’t perform your tagging operation because of an internal error. Retry your request.</p>
        capo_wafv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_wafv2.types.create_regex_pattern_set_request.CreateRegexPatternSetRequest]",
    ) -> AsyncOperationResponse[
        "capo_wafv2.types.create_regex_pattern_set_response.CreateRegexPatternSetResponse"
    ]:
        import capo_wafv2._operations.awswaf_20190729.create_regex_pattern_set

        (
            output,
            http_response,
        ) = await capo_wafv2._operations.awswaf_20190729.create_regex_pattern_set.async_create_regex_pattern_set(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateRegexPatternSet")
    )
    input_: capo_wafv2.types.create_regex_pattern_set_request.CreateRegexPatternSetRequest = {
        "name": name,
        "scope": scope,
        "regular_expression_list": regular_expression_list,
    }
    if description is not None:
        input_["description"] = description
    if tags is not None:
        input_["tags"] = tags

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output