High-level information about a rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
Parameters:
-
rule_group_name
(Optional[ResourceName], default:
None
)
–
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
-
rule_group_arn
(Optional[ResourceArn], default:
None
)
–
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
-
type
(Optional[RuleGroupType], default:
None
)
–
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.
This setting is required for requests that do not include the RuleGroupARN.
Raises:
-
InternalServerError
–
Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.
-
InvalidRequestException
–
The operation failed because of a problem with your request. Examples include:
-
You specified an unsupported parameter name or value.
-
You tried to update a property with a value that isn't among the available types.
-
Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.
-
ResourceNotFoundException
–
Unable to locate a resource using the parameters that you provided.
-
ThrottlingException
–
Unable to process the request due to throttling limitations.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_network_firewall/_services/network_firewall.py
| def describe_rule_group_metadata(
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,
) -> "capo_network_firewall.types.describe_rule_group_metadata_response.DescribeRuleGroupMetadataResponse":
"""<p>High-level information about a rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </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 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>
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>
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_metadata_request.DescribeRuleGroupMetadataRequest]",
) -> OperationResponse[
"capo_network_firewall.types.describe_rule_group_metadata_response.DescribeRuleGroupMetadataResponse"
]:
import capo_network_firewall._operations.network_firewall_20201112.describe_rule_group_metadata
output, http_response = (
capo_network_firewall._operations.network_firewall_20201112.describe_rule_group_metadata.describe_rule_group_metadata(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeRuleGroupMetadata")
)
input_: capo_network_firewall.types.describe_rule_group_metadata_request.DescribeRuleGroupMetadataRequest = {}
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
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|