untag_resource ¶

untag_resource(
    resource_arn: ResourceArn,
    tag_keys: TagKeyList,
    *,
    config_overrides: Optional[WAFClientConfig] = None,
) -> UntagResourceResponse

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.

Parameters:

resource_arn (ResourceArn) –
tag_keys (TagKeyList) –

Raises:

WAFBadRequestException –
WAFInternalErrorException –

The operation failed because of a system problem, even though the request was valid. Retry your request.
WAFInvalidParameterException –
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 –

The operation failed because the referenced object doesn't exist.
WAFTagOperationException –
WAFTagOperationInternalErrorException –
UnknownServiceError –

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

Source code in docs_src/capo_waf/_services/waf.py

def untag_resource(
    self,
    resource_arn: "capo_waf.types.resource_arn.ResourceArn",
    tag_keys: "capo_waf.types.tag_key_list.TagKeyList",
    *,
    config_overrides: Optional[WAFClientConfig] = None,
) -> "capo_waf.types.untag_resource_response.UntagResourceResponse":
    """<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></p>

    Args:
        resource_arn: <p></p>
        tag_keys: <p></p>

    Raises:
        capo_waf.errors.waf_bad_request_exception.WAFBadRequestException: <p></p>
        capo_waf.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.errors.waf_invalid_parameter_exception.WAFInvalidParameterException: <p>The operation failed because AWS WAF didn't recognize a parameter in the request. For example:</p> <ul> <li> <p>You specified an invalid parameter name.</p> </li> <li> <p>You specified an invalid value.</p> </li> <li> <p>You tried to update an object (<code>ByteMatchSet</code>, <code>IPSet</code>, <code>Rule</code>, or <code>WebACL</code>) using an action other than <code>INSERT</code> or <code>DELETE</code>.</p> </li> <li> <p>You tried to create a <code>WebACL</code> with a <code>DefaultAction</code> <code>Type</code> other than <code>ALLOW</code>, <code>BLOCK</code>, or <code>COUNT</code>.</p> </li> <li> <p>You tried to create a <code>RateBasedRule</code> with a <code>RateKey</code> value other than <code>IP</code>.</p> </li> <li> <p>You tried to update a <code>WebACL</code> with a <code>WafAction</code> <code>Type</code> other than <code>ALLOW</code>, <code>BLOCK</code>, or <code>COUNT</code>.</p> </li> <li> <p>You tried to update a <code>ByteMatchSet</code> with a <code>FieldToMatch</code> <code>Type</code> other than HEADER, METHOD, QUERY_STRING, URI, or BODY.</p> </li> <li> <p>You tried to update a <code>ByteMatchSet</code> with a <code>Field</code> of <code>HEADER</code> but no value for <code>Data</code>.</p> </li> <li> <p>Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.</p> </li> </ul>
        capo_waf.errors.waf_nonexistent_item_exception.WAFNonexistentItemException: <p>The operation failed because the referenced object doesn't exist.</p>
        capo_waf.errors.waf_tag_operation_exception.WAFTagOperationException: <p></p>
        capo_waf.errors.waf_tag_operation_internal_error_exception.WAFTagOperationInternalErrorException: <p></p>
        capo_waf.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_waf.types.untag_resource_request.UntagResourceRequest]",
    ) -> OperationResponse[
        "capo_waf.types.untag_resource_response.UntagResourceResponse"
    ]:
        import capo_waf._operations.awswaf_20150824.untag_resource

        output, http_response = (
            capo_waf._operations.awswaf_20150824.untag_resource.untag_resource(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UntagResource")
    )
    input_: capo_waf.types.untag_resource_request.UntagResourceRequest = {
        "resource_arn": resource_arn,
        "tag_keys": tag_keys,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output