describe-client-vpn-connections¶

Description¶

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

Synopsis¶

  describe-client-vpn-connections
--client-vpn-endpoint-id <value>
[--filters <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--client-vpn-endpoint-id (string)

The ID of the Client VPN endpoint.

--filters (list)

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.

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:

DescribeAvailabilityZones

DescribeImages

DescribeInstances

DescribeKeyPairs

DescribeSecurityGroups

DescribeSnapshots

DescribeSubnets

DescribeTags

DescribeVolumes

DescribeVpcs

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--dry-run | --no-dry-run (boolean)

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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To describe the connections to a Client VPN endpoint

The following describe-client-vpn-connections example displays details about the client connections to the specified Client VPN endpoint.

aws ec2 describe-client-vpn-connections \
    --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde

Output:

{
    "Connections": [
        {
            "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde",
            "Timestamp": "2019-08-12 07:58:34",
            "ConnectionId": "cvpn-connection-0e03eb24267165acd",
            "ConnectionEstablishedTime": "2019-08-12 07:57:14",
            "IngressBytes": "32302",
            "EgressBytes": "5696",
            "IngressPackets": "332",
            "EgressPackets": "67",
            "ClientIp": "172.31.0.225",
            "CommonName": "client1.domain.tld",
            "Status": {
                "Code": "terminated"
            },
            "ConnectionEndTime": "2019-08-12 07:58:34"
        },
        {
            "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde",
            "Timestamp": "2019-08-12 08:02:54",
            "ConnectionId": "cvpn-connection-00668867a40f18253",
            "ConnectionEstablishedTime": "2019-08-12 08:02:53",
            "IngressBytes": "2951",
            "EgressBytes": "2611",
            "IngressPackets": "9",
            "EgressPackets": "6",
            "ClientIp": "172.31.0.226",
            "CommonName": "client1.domain.tld",
            "Status": {
                "Code": "active"
            },
            "ConnectionEndTime": "-"
        }
    ]
}

For more information, see Client Connections in the AWS Client VPN Administrator Guide.

Output¶

Connections -> (list)

Information about the active and terminated client connections.

(structure)

Describes a client connection.

ClientVpnEndpointId -> (string)

The ID of the Client VPN endpoint to which the client is connected.

Timestamp -> (string)

The current date and time.

ConnectionId -> (string)

The ID of the client connection.

Username -> (string)

The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.

ConnectionEstablishedTime -> (string)

The date and time the client connection was established.

IngressBytes -> (string)

The number of bytes sent by the client.

EgressBytes -> (string)

The number of bytes received by the client.

IngressPackets -> (string)

The number of packets sent by the client.

EgressPackets -> (string)

The number of packets received by the client.

ClientIp -> (string)

The IP address of the client.

CommonName -> (string)

The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.

Status -> (structure)

The current state of the client connection.

Code -> (string)

The state of the client connection.

Message -> (string)

A message about the status of the client connection, if applicable.

ConnectionEndTime -> (string)

The date and time the client connection was terminated.

NextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Table of Contents

Feedback

User Guide