ec2_describe_traffic_mirror_sessions {aws.ecx}

Describe 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(
  TrafficMirrorSessionId = NULL,
  DryRun = NULL,
  Filter = NULL,
  MaxResults = NULL,
  NextToken = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

TrafficMirrorSessionId

List. The ID of the Traffic Mirror session.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

Filter

Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]

MaxResults

Integer. The maximum number of results to return with a single call.[optional]

NextToken

Characters. The token for the next page of results[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

TrafficMirrorSessionId

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.

Filter

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.