describe_proxy_rule ¶

def describe_proxy_rule(
    self,
    proxy_rule_name: "capo_network_firewall.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[NetworkFirewallClientConfig] = None,
    proxy_rule_group_name: Optional[
        "capo_network_firewall.types.resource_name.ResourceName"
    ] = None,
    proxy_rule_group_arn: Optional[
        "capo_network_firewall.types.resource_arn.ResourceArn"
    ] = None,
) -> "capo_network_firewall.types.describe_proxy_rule_response.DescribeProxyRuleResponse":
    """<p>Returns the data objects for the specified proxy configuration for the specified proxy rule group.</p>

    Args:
        proxy_rule_name: <p>The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.</p>
        proxy_rule_group_name: <p>The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        proxy_rule_group_arn: <p>The Amazon Resource Name (ARN) of a proxy rule group.</p> <p>You must specify the ARN or the name, and you can specify both. </p>

    Raises:
        capo_network_firewall.errors.internal_server_error.InternalServerError: <p>Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request. </p>
        capo_network_firewall.errors.invalid_request_exception.InvalidRequestException: <p>The operation failed because of a problem with your request. Examples include: </p> <ul> <li> <p>You specified an unsupported parameter name or value.</p> </li> <li> <p>You tried to update a property with a value that isn't among the available types.</p> </li> <li> <p>Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.</p> </li> </ul>
        capo_network_firewall.errors.resource_not_found_exception.ResourceNotFoundException: <p>Unable to locate a resource using the parameters that you provided.</p>
        capo_network_firewall.errors.throttling_exception.ThrottlingException: <p>Unable to process the request due to throttling limitations.</p>
        capo_network_firewall.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_network_firewall.types.describe_proxy_rule_request.DescribeProxyRuleRequest]",
    ) -> OperationResponse[
        "capo_network_firewall.types.describe_proxy_rule_response.DescribeProxyRuleResponse"
    ]:
        import capo_network_firewall._operations.network_firewall_20201112.describe_proxy_rule

        output, http_response = (
            capo_network_firewall._operations.network_firewall_20201112.describe_proxy_rule.describe_proxy_rule(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeProxyRule")
    )
    input_: capo_network_firewall.types.describe_proxy_rule_request.DescribeProxyRuleRequest = {
        "proxy_rule_name": proxy_rule_name
    }
    if proxy_rule_group_name is not None:
        input_["proxy_rule_group_name"] = proxy_rule_group_name
    if proxy_rule_group_arn is not None:
        input_["proxy_rule_group_arn"] = proxy_rule_group_arn

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