start_network_insights_analysis ¶

def start_network_insights_analysis(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    network_insights_path_id: Optional[
        "capo_ec2.types.network_insights_path_id.NetworkInsightsPathId"
    ] = None,
    additional_accounts: Optional[
        "capo_ec2.types.value_string_list.ValueStringList"
    ] = None,
    filter_in_arns: Optional["capo_ec2.types.arn_list.ArnList"] = None,
    filter_out_arns: Optional["capo_ec2.types.arn_list.ArnList"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
    client_token: Optional["capo_ec2.types.string.String"] = None,
) -> "capo_ec2.types.start_network_insights_analysis_result.StartNetworkInsightsAnalysisResult":
    """<p>Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.</p>

    Args:
        network_insights_path_id: <p>The ID of the path.</p>
        additional_accounts: <p>The member accounts that contain resources that the path can traverse.</p>
        filter_in_arns: <p>The Amazon Resource Names (ARN) of the resources that the path must traverse.</p>
        filter_out_arns: <p>The Amazon Resource Names (ARN) of the resources that the path will ignore.</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>
        tag_specifications: <p>The tags to apply.</p>
        client_token: <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">How to ensure idempotency</a>.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.start_network_insights_analysis_request.StartNetworkInsightsAnalysisRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.start_network_insights_analysis_result.StartNetworkInsightsAnalysisResult"
    ]:
        import capo_ec2._operations.amazon_ec2.start_network_insights_analysis

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartNetworkInsightsAnalysis")
    )
    input_: capo_ec2.types.start_network_insights_analysis_request.StartNetworkInsightsAnalysisRequest = {}
    if network_insights_path_id is not None:
        input_["network_insights_path_id"] = network_insights_path_id
    if additional_accounts is not None:
        input_["additional_accounts"] = additional_accounts
    if filter_in_arns is not None:
        input_["filter_in_arns"] = filter_in_arns
    if filter_out_arns is not None:
        input_["filter_out_arns"] = filter_out_arns
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output