modify_traffic_mirror_session¶
Operation¶
async
¶
modify_traffic_mirror_session(input: ModifyTrafficMirrorSessionInput, plugins: list[Plugin] | None = None) -> ModifyTrafficMirrorSessionOutput
Modifies a Traffic Mirror session.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyTrafficMirrorSessionInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ModifyTrafficMirrorSessionOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyTrafficMirrorSessionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
description: str | None = ...
The description to assign to the Traffic Mirror session.
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
class-attribute
instance-attribute
¶
packet_length: int | None = ...
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.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
session_number: int | None = ...
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.
class-attribute
instance-attribute
¶
traffic_mirror_filter_id: str | None = ...
The ID of the Traffic Mirror filter.
class-attribute
instance-attribute
¶
traffic_mirror_session_id: str | None = ...
The ID of the Traffic Mirror session.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyTrafficMirrorSessionOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
class-attribute
instance-attribute
¶
Information about the Traffic Mirror session.