Skip to content

describe_network_insights_paths async

describe_network_insights_paths(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    network_insights_path_ids: Optional[NetworkInsightsPathIdList] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[NetworkInsightsMaxResults] = None,
    dry_run: Optional[Boolean] = None,
    next_token: Optional[NextToken] = None,
) -> DescribeNetworkInsightsPathsResult

Describes one or more of your paths.

Parameters:

  • network_insights_path_ids (Optional[NetworkInsightsPathIdList], default: None ) –

    The IDs of the paths.

  • filters (Optional[FilterList], default: 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 (Optional[NetworkInsightsMaxResults], default: 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.

  • dry_run (Optional[Boolean], default: 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.

  • next_token (Optional[NextToken], default: None ) –

    The token for the next page of results.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def describe_network_insights_paths(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    network_insights_path_ids: Optional[
        "capo_ec2.types.network_insights_path_id_list.NetworkInsightsPathIdList"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.network_insights_max_results.NetworkInsightsMaxResults"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
) -> "capo_ec2.types.describe_network_insights_paths_result.DescribeNetworkInsightsPathsResult":
    """<p>Describes one or more of your paths.</p>

    Args:
        network_insights_path_ids: <p>The IDs of the paths.</p>
        filters: <p>The filters. The following are the possible values:</p> <ul> <li> <p>destination - The ID of the resource.</p> </li> <li> <p>filter-at-source.source-address - The source IPv4 address at the source.</p> </li> <li> <p>filter-at-source.source-port-range - The source port range at the source.</p> </li> <li> <p>filter-at-source.destination-address - The destination IPv4 address at the source.</p> </li> <li> <p>filter-at-source.destination-port-range - The destination port range at the source.</p> </li> <li> <p>filter-at-destination.source-address - The source IPv4 address at the destination.</p> </li> <li> <p>filter-at-destination.source-port-range - The source port range at the destination.</p> </li> <li> <p>filter-at-destination.destination-address - The destination IPv4 address at the destination.</p> </li> <li> <p>filter-at-destination.destination-port-range - The destination port range at the destination.</p> </li> <li> <p>protocol - The protocol.</p> </li> <li> <p>source - The ID of the resource.</p> </li> </ul>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        next_token: <p>The token for the next page of results.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.describe_network_insights_paths_request.DescribeNetworkInsightsPathsRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_network_insights_paths_result.DescribeNetworkInsightsPathsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_network_insights_paths

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.describe_network_insights_paths.async_describe_network_insights_paths(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeNetworkInsightsPaths")
    )
    input_: capo_ec2.types.describe_network_insights_paths_request.DescribeNetworkInsightsPathsRequest = {}
    if network_insights_path_ids is not None:
        input_["network_insights_path_ids"] = network_insights_path_ids
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output