describe_flow_operation ¶

def describe_flow_operation(
    self,
    firewall_arn: "capo_network_firewall.types.resource_arn.ResourceArn",
    flow_operation_id: "capo_network_firewall.types.flow_operation_id.FlowOperationId",
    *,
    config_overrides: Optional[NetworkFirewallClientConfig] = None,
    availability_zone: Optional[
        "capo_network_firewall.types.availability_zone.AvailabilityZone"
    ] = None,
    vpc_endpoint_association_arn: Optional[
        "capo_network_firewall.types.resource_arn.ResourceArn"
    ] = None,
    vpc_endpoint_id: Optional[
        "capo_network_firewall.types.vpc_endpoint_id.VpcEndpointId"
    ] = None,
) -> "capo_network_firewall.types.describe_flow_operation_response.DescribeFlowOperationResponse":
    """<p>Returns key information about a specific flow operation.</p>

    Args:
        firewall_arn: <p>The Amazon Resource Name (ARN) of the firewall.</p>
        availability_zone: <p>The ID of the Availability Zone where the firewall is located. For example, <code>us-east-2a</code>.</p> <p>Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.</p>
        vpc_endpoint_association_arn: <p>The Amazon Resource Name (ARN) of a VPC endpoint association.</p>
        vpc_endpoint_id: <p>A unique identifier for the primary endpoint associated with a firewall.</p>
        flow_operation_id: <p>A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.</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_flow_operation_request.DescribeFlowOperationRequest]",
    ) -> OperationResponse[
        "capo_network_firewall.types.describe_flow_operation_response.DescribeFlowOperationResponse"
    ]:
        import capo_network_firewall._operations.network_firewall_20201112.describe_flow_operation

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeFlowOperation")
    )
    input_: capo_network_firewall.types.describe_flow_operation_request.DescribeFlowOperationRequest = {
        "firewall_arn": firewall_arn,
        "flow_operation_id": flow_operation_id,
    }
    if availability_zone is not None:
        input_["availability_zone"] = availability_zone
    if vpc_endpoint_association_arn is not None:
        input_["vpc_endpoint_association_arn"] = vpc_endpoint_association_arn
    if vpc_endpoint_id is not None:
        input_["vpc_endpoint_id"] = vpc_endpoint_id

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