EC2 / Client / modify_traffic_mirror_session

modify_traffic_mirror_session#

EC2.Client.modify_traffic_mirror_session(**kwargs)#

Modifies a Traffic Mirror session.

See also: AWS API Documentation

Request Syntax

response = client.modify_traffic_mirror_session(
    TrafficMirrorSessionId='string',
    TrafficMirrorTargetId='string',
    TrafficMirrorFilterId='string',
    PacketLength=123,
    SessionNumber=123,
    VirtualNetworkId=123,
    Description='string',
    RemoveFields=[
        'packet-length'|'description'|'virtual-network-id',
    ],
    DryRun=True|False
)
Parameters:

  • TrafficMirrorSessionId (string) –

    [REQUIRED]

    The ID of the Traffic Mirror session.

  • TrafficMirrorTargetId (string) – The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

  • TrafficMirrorFilterId (string) – The ID of the Traffic Mirror filter.

  • PacketLength (integer) –

    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.

  • SessionNumber (integer) –

    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.

  • VirtualNetworkId (integer) – The virtual network ID of the Traffic Mirror session.

  • Description (string) – The description to assign to the Traffic Mirror session.

  • RemoveFields (list) –

    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.

    • (string) –

  • DryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'TrafficMirrorSession': {
        'TrafficMirrorSessionId': 'string',
        'TrafficMirrorTargetId': 'string',
        'TrafficMirrorFilterId': 'string',
        'NetworkInterfaceId': 'string',
        'OwnerId': 'string',
        'PacketLength': 123,
        'SessionNumber': 123,
        'VirtualNetworkId': 123,
        'Description': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • TrafficMirrorSession (dict) –

      Information about the Traffic Mirror session.

      • TrafficMirrorSessionId (string) –

        The ID for the Traffic Mirror session.

      • TrafficMirrorTargetId (string) –

        The ID of the Traffic Mirror target.

      • TrafficMirrorFilterId (string) –

        The ID of the Traffic Mirror filter.

      • NetworkInterfaceId (string) –

        The ID of the Traffic Mirror session’s network interface.

      • OwnerId (string) –

        The ID of the account that owns the Traffic Mirror session.

      • PacketLength (integer) –

        The number of bytes in each packet to mirror. These are the 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

      • SessionNumber (integer) –

        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.

      • VirtualNetworkId (integer) –

        The virtual network ID associated with the Traffic Mirror session.

      • Description (string) –

        The description of the Traffic Mirror session.

      • Tags (list) –

        The tags assigned to the Traffic Mirror session.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.