ec2_describe_network_insights_analyses {aws.ecx}

Describe Network Insights Analyses

Description

Describes one or more of your network insights analyses.

Usage

ec2_describe_network_insights_analyses(
  NetworkInsightsAnalysisId = NULL,
  NetworkInsightsPathId = NULL,
  AnalysisStartTime = NULL,
  AnalysisEndTime = NULL,
  Filter = NULL,
  MaxResults = NULL,
  DryRun = NULL,
  NextToken = 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

NetworkInsightsAnalysisId

List. The ID of the network insights analyses. You must specify either analysis IDs or a path ID.[optional]

NetworkInsightsPathId

Character. The ID of the path. You must specify either a path ID or analysis IDs.[optional]

AnalysisStartTime

Character. The time when the network insights analyses started.[optional]

AnalysisEndTime

Character. The time when the network insights analyses ended.[optional]

Filter

Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]

MaxResults

Integer. The maximum number of results to return with a single call.[optional]

DryRun

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

NextToken

Characters. The token for the next page of results[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

NetworkInsightsAnalysisId

The ID of the network insights analyses. You must specify either analysis IDs or a path ID.

NetworkInsightsPathId

The ID of the path. You must specify either a path ID or analysis IDs.

AnalysisStartTime

The time when the network insights analyses started.

AnalysisEndTime

The time when the network insights analyses ended.

Filter

The filters. The following are possible values:

• PathFound - A Boolean value that indicates whether a feasible path is found.

• Status - The status of the analysis (running \| succeeded \| failed).

MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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.