list_flow_operations ¶

def list_flow_operations(
    self,
    firewall_arn: "capo_network_firewall.types.resource_arn.ResourceArn",
    *,
    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,
    flow_operation_type: Optional[
        "capo_network_firewall.types.flow_operation_type.FlowOperationType"
    ] = None,
    next_token: Optional[
        "capo_network_firewall.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[
        "capo_network_firewall.types.pagination_max_results.PaginationMaxResults"
    ] = None,
) -> "capo_network_firewall.types.list_flow_operations_response.ListFlowOperationsResponse":
    """<p>Returns a list of all flow operations ran in a specific firewall. You can optionally narrow the request scope by specifying the operation type or Availability Zone associated with a firewall's flow operations. </p> <p>Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.</p> <p>A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort. </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_type: <p>An optional string that defines whether any or all operation types are returned.</p>
        next_token: <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
        max_results: <p>The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</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.list_flow_operations_request.ListFlowOperationsRequest]",
    ) -> OperationResponse[
        "capo_network_firewall.types.list_flow_operations_response.ListFlowOperationsResponse"
    ]:
        import capo_network_firewall._operations.network_firewall_20201112.list_flow_operations

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFlowOperations")
    )
    input_: capo_network_firewall.types.list_flow_operations_request.ListFlowOperationsRequest = {
        "firewall_arn": firewall_arn
    }
    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
    if flow_operation_type is not None:
        input_["flow_operation_type"] = flow_operation_type
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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