describe_network_insights_analyses ¶

def describe_network_insights_analyses(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    network_insights_analysis_ids: Optional[
        "capo_ec2.types.network_insights_analysis_id_list.NetworkInsightsAnalysisIdList"
    ] = None,
    network_insights_path_id: Optional[
        "capo_ec2.types.network_insights_path_id.NetworkInsightsPathId"
    ] = None,
    analysis_start_time: Optional[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ] = None,
    analysis_end_time: Optional[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ] = 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_analyses_result.DescribeNetworkInsightsAnalysesResult":
    """<p>Describes one or more of your network insights analyses.</p>

    Args:
        network_insights_analysis_ids: <p>The ID of the network insights analyses. You must specify either analysis IDs or a path ID.</p>
        network_insights_path_id: <p>The ID of the path. You must specify either a path ID or analysis IDs.</p>
        analysis_start_time: <p>The time when the network insights analyses started.</p>
        analysis_end_time: <p>The time when the network insights analyses ended.</p>
        filters: <p>The filters. The following are the possible values:</p> <ul> <li> <p>path-found - A Boolean value that indicates whether a feasible path is found.</p> </li> <li> <p>status - The status of the analysis (running | succeeded | failed).</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.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_network_insights_analyses_request.DescribeNetworkInsightsAnalysesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_network_insights_analyses_result.DescribeNetworkInsightsAnalysesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_network_insights_analyses

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_network_insights_analyses.describe_network_insights_analyses(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeNetworkInsightsAnalyses")
    )
    input_: capo_ec2.types.describe_network_insights_analyses_request.DescribeNetworkInsightsAnalysesRequest = {}
    if network_insights_analysis_ids is not None:
        input_["network_insights_analysis_ids"] = network_insights_analysis_ids
    if network_insights_path_id is not None:
        input_["network_insights_path_id"] = network_insights_path_id
    if analysis_start_time is not None:
        input_["analysis_start_time"] = analysis_start_time
    if analysis_end_time is not None:
        input_["analysis_end_time"] = analysis_end_time
    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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output