Skip to content

get_web_acl async

get_web_acl(
    web_acl_id: ResourceId,
    *,
    config_overrides: Optional[AsyncWAFRegionalClientConfig] = None,
) -> GetWebACLResponse

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 the WebACL that is specified by WebACLId.

Parameters:

Raises:

Examples:

To get a web ACL The following example returns the details of a web ACL with the ID createwebacl-1472061481310.

>>> await client.get_web_acl(web_acl_id='createwebacl-1472061481310')
Source code in docs_src/capo_waf_regional/_services/async_waf_regional.py
async def get_web_acl(
    self,
    web_acl_id: "capo_waf_regional.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[AsyncWAFRegionalClientConfig] = None,
) -> "capo_waf_regional.types.get_web_acl_response.GetWebACLResponse":
    """<note> <p>This is <b>AWS WAF Classic</b> documentation. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS WAF Classic</a> in the developer guide.</p> <p> <b>For the latest version of AWS WAF</b>, use the AWS WAFV2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. With the latest version, AWS WAF has a single set of endpoints for regional and global use. </p> </note> <p>Returns the <a>WebACL</a> that is specified by <code>WebACLId</code>.</p>

    Args:
        web_acl_id: <p>The <code>WebACLId</code> of the <a>WebACL</a> that you want to get. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>.</p>

    Raises:
        capo_waf_regional.errors.waf_internal_error_exception.WAFInternalErrorException: <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
        capo_waf_regional.errors.waf_invalid_account_exception.WAFInvalidAccountException: <p>The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.</p>
        capo_waf_regional.errors.waf_nonexistent_item_exception.WAFNonexistentItemException: <p>The operation failed because the referenced object doesn't exist.</p>
        capo_waf_regional.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To get a web ACL
        The following example returns the details of a web ACL with the ID createwebacl-1472061481310.

        >>> await client.get_web_acl(web_acl_id='createwebacl-1472061481310')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_waf_regional.types.get_web_acl_request.GetWebACLRequest]",
    ) -> AsyncOperationResponse[
        "capo_waf_regional.types.get_web_acl_response.GetWebACLResponse"
    ]:
        import capo_waf_regional._operations.awswaf_regional_20161128.get_web_acl

        (
            output,
            http_response,
        ) = await capo_waf_regional._operations.awswaf_regional_20161128.get_web_acl.async_get_web_acl(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetWebACL")
    )
    input_: capo_waf_regional.types.get_web_acl_request.GetWebACLRequest = {
        "web_acl_id": web_acl_id
    }

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