ec2_describe_client_vpn_endpoints {aws.ecx}

Describe Client Vpn Endpoints

Description

Describes one or more Client VPN endpoints in the account.

Usage

ec2_describe_client_vpn_endpoints(
  ClientVpnEndpointId = NULL,
  MaxResults = NULL,
  NextToken = NULL,
  Filter = NULL,
  DryRun = 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

ClientVpnEndpointId

List. The ID of the Client VPN endpoint.[optional]

MaxResults

Integer. The maximum number of results to return for the request in a single page.[optional]

NextToken

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

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[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

ClientVpnEndpointId

The ID of the Client VPN endpoint.

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.

Filter

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

• endpoint-id - The ID of the Client VPN endpoint.

• transport-protocol - The transport protocol (tcp \| udp).

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.