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,
  vpc_endpoint_ids: ["String"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "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)


17238
17239
17240
17241
17242
17243
17244
17245
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17238

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

#filtersArray<Types::Filter>

One or more filters.

  • service-name: The name of the 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)

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

Returns:



17238
17239
17240
17241
17242
17243
17244
17245
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17238

class DescribeVpcEndpointsRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_ids,
  :filters,
  :max_results,
  :next_token)
  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)


17238
17239
17240
17241
17242
17243
17244
17245
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17238

class DescribeVpcEndpointsRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_ids,
  :filters,
  :max_results,
  :next_token)
  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)


17238
17239
17240
17241
17242
17243
17244
17245
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17238

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

#vpc_endpoint_idsArray<String>

One or more endpoint IDs.

Returns:

  • (Array<String>)


17238
17239
17240
17241
17242
17243
17244
17245
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 17238

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