Skip to content

describe_traffic_mirror_sessions

Operation

describe_traffic_mirror_sessions

describe_traffic_mirror_sessions(request: DescribeTrafficMirrorSessionsInput | DescribeTrafficMirrorSessionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTrafficMirrorSessionsInputDict]) -> DescribeTrafficMirrorSessionsOutput

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

Parameters:

Name Type Description Default
request DescribeTrafficMirrorSessionsInput | DescribeTrafficMirrorSessionsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeTrafficMirrorSessionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeTrafficMirrorSessionsOutput

An instance of DescribeTrafficMirrorSessionsOutput.

describe_traffic_mirror_sessions async

describe_traffic_mirror_sessions(request: DescribeTrafficMirrorSessionsInput | DescribeTrafficMirrorSessionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTrafficMirrorSessionsInputDict]) -> DescribeTrafficMirrorSessionsOutput

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

Parameters:

Name Type Description Default
request DescribeTrafficMirrorSessionsInput | DescribeTrafficMirrorSessionsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeTrafficMirrorSessionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeTrafficMirrorSessionsOutput

An instance of DescribeTrafficMirrorSessionsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeTrafficMirrorSessionsInputDict

Bases: TypedDict

Dictionary form of DescribeTrafficMirrorSessionsInput.

Attributes

dry_run 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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

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.

max_results instance-attribute
max_results: int | None

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

traffic_mirror_session_ids instance-attribute
traffic_mirror_session_ids: Sequence[str] | None

The ID of the Traffic Mirror session.

DescribeTrafficMirrorSessionsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeTrafficMirrorSessionsInput structure.

Attributes

dry_run 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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

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.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token for the next page of results.

traffic_mirror_session_ids class-attribute instance-attribute
traffic_mirror_session_ids: list[str] | None = ...

The ID of the Traffic Mirror session.

Output

DescribeTrafficMirrorSessionsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeTrafficMirrorSessionsOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.

traffic_mirror_sessions class-attribute instance-attribute
traffic_mirror_sessions: list[TrafficMirrorSession] | None = ...

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.