Skip to content

Describe Network Insights Paths

ec2_describe_network_insights_paths R Documentation

Describes one or more of your paths

Description

Describes one or more of your paths.

Usage

ec2_describe_network_insights_paths(NetworkInsightsPathIds, Filters,
  MaxResults, DryRun, NextToken)

Arguments

NetworkInsightsPathIds

The IDs of the paths.

Filters

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.

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.

NextToken

The token for the next page of results.

Value

A list with the following syntax: 

list(
  NetworkInsightsPaths = list(
    list(
      NetworkInsightsPathId = "string",
      NetworkInsightsPathArn = "string",
      CreatedDate = as.POSIXct(
        "2015-01-01"
      ),
      Source = "string",
      Destination = "string",
      SourceArn = "string",
      DestinationArn = "string",
      SourceIp = "string",
      DestinationIp = "string",
      Protocol = "tcp"|"udp",
      DestinationPort = 123,
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      FilterAtSource = list(
        SourceAddress = "string",
        SourcePortRange = list(
          FromPort = 123,
          ToPort = 123
        ),
        DestinationAddress = "string",
        DestinationPortRange = list(
          FromPort = 123,
          ToPort = 123
        )
      ),
      FilterAtDestination = list(
        SourceAddress = "string",
        SourcePortRange = list(
          FromPort = 123,
          ToPort = 123
        ),
        DestinationAddress = "string",
        DestinationPortRange = list(
          FromPort = 123,
          ToPort = 123
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_network_insights_paths(
  NetworkInsightsPathIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  DryRun = TRUE|FALSE,
  NextToken = "string"
)