Skip to content

List Flow Operation Results

networkfirewall_list_flow_operation_results R Documentation

Returns the results of a specific flow operation

Description

Returns the results of a specific flow operation.

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_operation_results(FirewallArn,
  FlowOperationId, NextToken, MaxResults, AvailabilityZone)

Arguments

FirewallArn

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

[required] A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
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.
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.

Value

A list with the following syntax:

list(
  FirewallArn = "string",
  AvailabilityZone = "string",
  FlowOperationId = "string",
  FlowOperationStatus = "COMPLETED"|"IN_PROGRESS"|"FAILED"|"COMPLETED_WITH_ERRORS",
  StatusMessage = "string",
  FlowRequestTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  Flows = list(
    list(
      SourceAddress = list(
        AddressDefinition = "string"
      ),
      DestinationAddress = list(
        AddressDefinition = "string"
      ),
      SourcePort = "string",
      DestinationPort = "string",
      Protocol = "string",
      Age = 123,
      PacketCount = 123,
      ByteCount = 123
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_flow_operation_results(
  FirewallArn = "string",
  FlowOperationId = "string",
  NextToken = "string",
  MaxResults = 123,
  AvailabilityZone = "string"
)