DescribeTrafficMirrorSessions
Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- 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 isUnauthorizedOperation.Type: Boolean
Required: No
- Filter.N
-
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.
Type: Array of Filter objects
Required: No
-
- MaxResults
-
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned
nextTokenvalue.Type: Integer
Valid Range: Minimum value of 5. Maximum value of 1000.
Required: No
- NextToken
-
The token for the next page of results.
Type: String
Required: No
- TrafficMirrorSessionId.N
-
The ID of the Traffic Mirror session.
Type: Array of strings
Required: No
Response Elements
The following elements are returned by the service.
- nextToken
-
The token to use to retrieve the next page of results. The value is
nullwhen there are no more results to return.Type: String
- requestId
-
The ID of the request.
Type: String
- trafficMirrorSessionSet
-
Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
Type: Array of TrafficMirrorSession objects
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
