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

Class: Aws::EC2::Types::DescribeVpcEndpointsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

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

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

Contains the parameters for DescribeVpcEndpoints.

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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)


11288
11289
11290
11291
11292
11293
11294
11295
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11288

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

#filtersArray<Types::Filter>

One or more filters.

  • service-name: The name of the AWS service.

  • vpc-id: The ID of the VPC in which the endpoint resides.

  • vpc-endpoint-id: The ID of the endpoint.

  • vpc-endpoint-state: The state of the endpoint. (pending | available | deleting | deleted)

Returns:



11288
11289
11290
11291
11292
11293
11294
11295
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11288

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

#max_resultsInteger

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

Returns:

  • (Integer)


11288
11289
11290
11291
11292
11293
11294
11295
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11288

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

#next_tokenString

The token for the next set of items to return. (You received this token from a prior call.)

Returns:

  • (String)


11288
11289
11290
11291
11292
11293
11294
11295
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11288

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

#vpc_endpoint_idsArray<String>

One or more endpoint IDs.

Returns:

  • (Array<String>)


11288
11289
11290
11291
11292
11293
11294
11295
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11288

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