Skip to content

Describe Traffic Mirror Sessions

ec2_describe_traffic_mirror_sessions R Documentation

Describes one or more Traffic Mirror sessions

Description

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

Usage

ec2_describe_traffic_mirror_sessions(TrafficMirrorSessionIds, DryRun,
  Filters, MaxResults, NextToken)

Arguments

TrafficMirrorSessionIds

The ID of the Traffic Mirror session.

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Filters

One or more filters. The possible values are:

  • description: The Traffic Mirror session description.

  • network-interface-id: The ID of the Traffic Mirror session network interface.

  • owner-id: The ID of the account that owns the Traffic Mirror session.

  • packet-length: The assigned number of packets to mirror.

  • session-number: The assigned session number.

  • traffic-mirror-filter-id: The ID of the Traffic Mirror filter.

  • traffic-mirror-session-id: The ID of the Traffic Mirror session.

  • traffic-mirror-target-id: The ID of the Traffic Mirror target.

  • virtual-network-id: The virtual network ID of the Traffic Mirror session.

MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

NextToken

The token for the next page of results.

Value

A list with the following syntax: 

list(
  TrafficMirrorSessions = list(
    list(
      TrafficMirrorSessionId = "string",
      TrafficMirrorTargetId = "string",
      TrafficMirrorFilterId = "string",
      NetworkInterfaceId = "string",
      OwnerId = "string",
      PacketLength = 123,
      SessionNumber = 123,
      VirtualNetworkId = 123,
      Description = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_traffic_mirror_sessions(
  TrafficMirrorSessionIds = list(
    "string"
  ),
  DryRun = TRUE|FALSE,
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)