Request Parameters Response Elements Errors See Also

ModifyTrafficMirrorSession

Modifies a Traffic Mirror session.

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.

Description

The description to assign to the Traffic Mirror session.

Type: String

Required: No

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.

Type: Boolean

Required: No

PacketLength

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.

For sessions with Network Load Balancer (NLB) traffic mirror targets, the default PacketLength will be set to 8500. Valid values are 1-8500. Setting a PacketLength greater than 8500 will result in an error response.

Type: Integer

Required: No

RemoveField.N

The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

Type: Array of strings

Valid Values: packet-length | description | virtual-network-id

Required: No

SessionNumber

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

Valid values are 1-32766.

Type: Integer

Required: No

TrafficMirrorFilterId

The ID of the Traffic Mirror filter.

Type: String

Required: No

TrafficMirrorSessionId

The ID of the Traffic Mirror session.

Type: String

Required: Yes

TrafficMirrorTargetId

The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

Type: String

Required: No

VirtualNetworkId

The virtual network ID of the Traffic Mirror session.

Type: Integer

Required: No

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

trafficMirrorSession

Information about the Traffic Mirror session.

Type: TrafficMirrorSession object

Errors

For information about the errors that are common to all actions, see Common client error codes.