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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DescribeVpcEndpointsRequest

Includes:

Structure

Defined in:

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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #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 items to return for this request.

• #next_token ⇒ String

  The token for the next set of items to return.

• #vpc_endpoint_ids ⇒ Array<String>

  One or more endpoint IDs.

Instance Attribute Details

#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 'lib/aws-sdk-ec2/types.rb', line 13715

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

#filters ⇒ Array<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`)

Returns:

• (Array<Types::Filter>)

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

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

#max_results ⇒ Integer

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)

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

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

#next_token ⇒ String

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

Returns:

• (String)

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

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

#vpc_endpoint_ids ⇒ Array<String>

One or more endpoint IDs.

Returns:

• (Array<String>)

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

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