You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::DescribeClientVpnEndpointsRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DescribeClientVpnEndpointsRequest

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeClientVpnEndpointsRequest data as a hash:

{
  client_vpn_endpoint_ids: ["String"],
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #client_vpn_endpoint_ids ⇒ Array<String>

  The ID of the Client VPN endpoint.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #filters ⇒ Array<Types::Filter>

  One or more filters.

• #max_results ⇒ Integer

  The maximum number of results to return for the request in a single page.

• #next_token ⇒ String

  The token to retrieve the next page of results.

Instance Attribute Details

#client_vpn_endpoint_ids ⇒ Array<String>

The ID of the Client VPN endpoint.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9881

class DescribeClientVpnEndpointsRequest < Struct.new(
  :client_vpn_endpoint_ids,
  :max_results,
  :next_token,
  :filters,
  :dry_run)
  include Aws::Structure
end

#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.

Returns:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9881

class DescribeClientVpnEndpointsRequest < Struct.new(
  :client_vpn_endpoint_ids,
  :max_results,
  :next_token,
  :filters,
  :dry_run)
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

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

Returns:

• (Array<Types::Filter>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9881

class DescribeClientVpnEndpointsRequest < Struct.new(
  :client_vpn_endpoint_ids,
  :max_results,
  :next_token,
  :filters,
  :dry_run)
  include Aws::Structure
end

#max_results ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9881

class DescribeClientVpnEndpointsRequest < Struct.new(
  :client_vpn_endpoint_ids,
  :max_results,
  :next_token,
  :filters,
  :dry_run)
  include Aws::Structure
end

#next_token ⇒ String

The token to retrieve the next page of results.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9881

class DescribeClientVpnEndpointsRequest < Struct.new(
  :client_vpn_endpoint_ids,
  :max_results,
  :next_token,
  :filters,
  :dry_run)
  include Aws::Structure
end