Returns the data objects for the specified firewall policy.
Parameters:
-
firewall_policy_name
(Optional[ResourceName], default:
None
)
–
The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
You must specify the ARN or the name, and you can specify both.
-
firewall_policy_arn
(Optional[ResourceArn], default:
None
)
–
The Amazon Resource Name (ARN) of the firewall policy.
You must specify the ARN or the name, and you can specify both.
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_firewall_policy(
self,
*,
config_overrides: Optional[NetworkFirewallClientConfig] = None,
firewall_policy_name: Optional[
"capo_network_firewall.types.resource_name.ResourceName"
] = None,
firewall_policy_arn: Optional[
"capo_network_firewall.types.resource_arn.ResourceArn"
] = None,
) -> "capo_network_firewall.types.describe_firewall_policy_response.DescribeFirewallPolicyResponse":
"""<p>Returns the data objects for the specified firewall policy. </p>
Args:
firewall_policy_name: <p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
firewall_policy_arn: <p>The Amazon Resource Name (ARN) of the firewall policy.</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_firewall_policy_request.DescribeFirewallPolicyRequest]",
) -> OperationResponse[
"capo_network_firewall.types.describe_firewall_policy_response.DescribeFirewallPolicyResponse"
]:
import capo_network_firewall._operations.network_firewall_20201112.describe_firewall_policy
output, http_response = (
capo_network_firewall._operations.network_firewall_20201112.describe_firewall_policy.describe_firewall_policy(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeFirewallPolicy")
)
input_: capo_network_firewall.types.describe_firewall_policy_request.DescribeFirewallPolicyRequest = {}
if firewall_policy_name is not None:
input_["firewall_policy_name"] = firewall_policy_name
if firewall_policy_arn is not None:
input_["firewall_policy_arn"] = firewall_policy_arn
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|