Skip to content

Describe Client Vpn Target Networks

ec2_describe_client_vpn_target_networks R Documentation

Describes the target networks associated with the specified Client VPN endpoint

Description

Describes the target networks associated with the specified Client VPN endpoint.

Usage

ec2_describe_client_vpn_target_networks(ClientVpnEndpointId,
  AssociationIds, MaxResults, NextToken, Filters, DryRun)

Arguments

ClientVpnEndpointId

[required] The ID of the Client VPN endpoint.

AssociationIds

The IDs of the target network associations.

MaxResults

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

NextToken

The token to retrieve the next page of results.

Filters

One or more filters. Filter names and values are case-sensitive.

  • association-id - The ID of the association.

  • target-network-id - The ID of the subnet specified as the target network.

  • vpc-id - The ID of the VPC in which the target network is located.

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.

Value

A list with the following syntax: 

list(
  ClientVpnTargetNetworks = list(
    list(
      AssociationId = "string",
      VpcId = "string",
      TargetNetworkId = "string",
      ClientVpnEndpointId = "string",
      Status = list(
        Code = "associating"|"associated"|"association-failed"|"disassociating"|"disassociated",
        Message = "string"
      ),
      SecurityGroups = list(
        "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_client_vpn_target_networks(
  ClientVpnEndpointId = "string",
  AssociationIds = list(
    "string"
  ),
  MaxResults = 123,
  NextToken = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  DryRun = TRUE|FALSE
)