ec2_start_network_insights_analysis {aws.ecx}

Start Network Insights Analysis

Description

Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.

Usage

ec2_start_network_insights_analysis(
  NetworkInsightsPathId,
  ClientToken,
  FilterInArn = NULL,
  DryRun = NULL,
  TagSpecification = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

NetworkInsightsPathId

Character. The ID of the path.

ClientToken

Character. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

FilterInArn

List. The Amazon Resource Names (ARN) of the resources that the path must traverse.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

TagSpecification

List. The tags to apply.[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

NetworkInsightsPathId

The ID of the path.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

FilterInArn

The Amazon Resource Names (ARN) of the resources that the path must traverse.

DryRun

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.

TagSpecification

The tags to apply.