Skip to content

Describe Client Vpn Connections

ec2_describe_client_vpn_connections R Documentation

Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint

Description

Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.

Usage

ec2_describe_client_vpn_connections(ClientVpnEndpointId, Filters,
  NextToken, MaxResults, DryRun)

Arguments

ClientVpnEndpointId

[required] The ID of the Client VPN endpoint.

Filters

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

  • connection-id - The ID of the connection.

  • username - For Active Directory client authentication, the user name of the client who established the client connection.

NextToken

The token to retrieve the next page of results.

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.

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(
  Connections = list(
    list(
      ClientVpnEndpointId = "string",
      Timestamp = "string",
      ConnectionId = "string",
      Username = "string",
      ConnectionEstablishedTime = "string",
      IngressBytes = "string",
      EgressBytes = "string",
      IngressPackets = "string",
      EgressPackets = "string",
      ClientIp = "string",
      CommonName = "string",
      Status = list(
        Code = "active"|"failed-to-terminate"|"terminating"|"terminated",
        Message = "string"
      ),
      ConnectionEndTime = "string",
      PostureComplianceStatuses = list(
        "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

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