describe_rule_group ¶

def describe_rule_group(
    self,
    *,
    config_overrides: Optional[NetworkFirewallClientConfig] = None,
    rule_group_name: Optional[
        "capo_network_firewall.types.resource_name.ResourceName"
    ] = None,
    rule_group_arn: Optional[
        "capo_network_firewall.types.resource_arn.ResourceArn"
    ] = None,
    type: Optional[
        "capo_network_firewall.types.rule_group_type.RuleGroupType"
    ] = None,
    analyze_rule_group: Optional[
        "capo_network_firewall.types.boolean.Boolean"
    ] = None,
) -> "capo_network_firewall.types.describe_rule_group_response.DescribeRuleGroupResponse":
    """<p>Returns the data objects for the specified rule group. </p>

    Args:
        rule_group_name: <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        rule_group_arn: <p>The Amazon Resource Name (ARN) of the rule group.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        type: <p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules. </p> <note> <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p> </note>
        analyze_rule_group: <p>Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to <code>TRUE</code>, Network Firewall runs the analysis.</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_rule_group_request.DescribeRuleGroupRequest]",
    ) -> OperationResponse[
        "capo_network_firewall.types.describe_rule_group_response.DescribeRuleGroupResponse"
    ]:
        import capo_network_firewall._operations.network_firewall_20201112.describe_rule_group

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRuleGroup")
    )
    input_: capo_network_firewall.types.describe_rule_group_request.DescribeRuleGroupRequest = {}
    if rule_group_name is not None:
        input_["rule_group_name"] = rule_group_name
    if rule_group_arn is not None:
        input_["rule_group_arn"] = rule_group_arn
    if type is not None:
        input_["type"] = type
    if analyze_rule_group is not None:
        input_["analyze_rule_group"] = analyze_rule_group

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