Skip to content

EC2  >  Operations  >  describe_network_insights_paths

describe_network_insights_paths

Operation

describe_network_insights_paths async

describe_network_insights_paths(request: DescribeNetworkInsightsPathsInput | DescribeNetworkInsightsPathsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeNetworkInsightsPathsOutput
describe_network_insights_paths(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeNetworkInsightsPathsInputDict]) -> DescribeNetworkInsightsPathsOutput

Describes one or more of your paths.

Parameters:

Name Type Description Default
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
DescribeNetworkInsightsPathsOutput

An instance of DescribeNetworkInsightsPathsOutput.

Input

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

Model

DescribeNetworkInsightsPathsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeNetworkInsightsPathsInput 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 = ...

The filters. The following are the possible values:

  • destination - The ID of the resource.

  • filter-at-source.source-address - The source IPv4 address at the source.

  • filter-at-source.source-port-range - The source port range at the source.

  • filter-at-source.destination-address - The destination IPv4 address at the source.

  • filter-at-source.destination-port-range - The destination port range at the source.

  • filter-at-destination.source-address - The source IPv4 address at the destination.

  • filter-at-destination.source-port-range - The source port range at the destination.

  • filter-at-destination.destination-address - The destination IPv4 address at the destination.

  • filter-at-destination.destination-port-range - The destination port range at the destination.

  • protocol - The protocol.

  • source - The ID of the resource.

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.

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

The IDs of the paths.

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

The token for the next page of results.

Dictionaries

DescribeNetworkInsightsPathsInputDict

Bases: TypedDict

Dictionary form of DescribeNetworkInsightsPathsInput.

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

The filters. The following are the possible values:

  • destination - The ID of the resource.

  • filter-at-source.source-address - The source IPv4 address at the source.

  • filter-at-source.source-port-range - The source port range at the source.

  • filter-at-source.destination-address - The destination IPv4 address at the source.

  • filter-at-source.destination-port-range - The destination port range at the source.

  • filter-at-destination.source-address - The source IPv4 address at the destination.

  • filter-at-destination.source-port-range - The source port range at the destination.

  • filter-at-destination.destination-address - The destination IPv4 address at the destination.

  • filter-at-destination.destination-port-range - The destination port range at the destination.

  • protocol - The protocol.

  • source - The ID of the resource.

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.

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

The IDs of the paths.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

Output

DescribeNetworkInsightsPathsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeNetworkInsightsPathsOutput structure.

Attributes

network_insights_paths class-attribute instance-attribute
network_insights_paths: list[NetworkInsightsPath] | None = ...

Information about the paths.

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

The token to use to retrieve the next page of results. This 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.