Skip to content

List Flow Operations

networkfirewall_list_flow_operations R Documentation

Returns a list of all flow operations ran in a specific firewall

Description

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.

Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.

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.

Usage

networkfirewall_list_flow_operations(FirewallArn, AvailabilityZone,
  FlowOperationType, NextToken, MaxResults)

Arguments

FirewallArn

[required] The Amazon Resource Name (ARN) of the firewall.
AvailabilityZone

The ID of the Availability Zone where the firewall is located. For example, ⁠us-east-2a⁠.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
FlowOperationType

An optional string that defines whether any or all operation types are returned.
NextToken

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
MaxResults

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 NextToken value that you can use in a subsequent call to get the next batch of objects.

Value

A list with the following syntax:

list(
  FlowOperations = list(
    list(
      FlowOperationId = "string",
      FlowOperationType = "FLOW_FLUSH"|"FLOW_CAPTURE",
      FlowRequestTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      FlowOperationStatus = "COMPLETED"|"IN_PROGRESS"|"FAILED"|"COMPLETED_WITH_ERRORS"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_flow_operations(
  FirewallArn = "string",
  AvailabilityZone = "string",
  FlowOperationType = "FLOW_FLUSH"|"FLOW_CAPTURE",
  NextToken = "string",
  MaxResults = 123
)