Skip to content

aws.ec2.describe_vpc_endpoints

Example SQL Queries

SELECT * FROM
aws.ec2.describe_vpc_endpoints;

Description

Describes your VPC endpoints. The default is to describe all your VPC endpoints. Alternatively, you can specify specific VPC endpoint IDs or filter the results to include only the VPC endpoints that match specific criteria.

Table Definition

Column NameColumn Data Type
dry_run Input Column

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.

BOOLEAN
filters Input Column

The filters.

  • ip-address-type - The IP address type (ipv4 | ipv6).

  • service-name - The name of the service.

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

  • 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 (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).

  • vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).

STRUCT(
"name" VARCHAR,
"values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the filter. Filter names are case-sensitive.

filters[].values[]
vpc_endpoint_ids Input Column

The IDs of the VPC endpoints.

VARCHAR[]
Show child fields
vpc_endpoint_ids[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
creation_timestamp

The date and time that the endpoint was created.

TIMESTAMP_S
dns_entries

(Interface endpoint) The DNS entries for the endpoint.

STRUCT(
"dns_name" VARCHAR,
"hosted_zone_id" VARCHAR
)[]
Show child fields
dns_entries[]
Show child fields
dns_entries[].dns_name

The DNS name.

dns_entries[].hosted_zone_id

The ID of the private hosted zone.

dns_options

The DNS options for the endpoint.

STRUCT(
"dns_record_ip_type" VARCHAR,
"private_dns_only_for_inbound_resolver_endpoint" BOOLEAN
)
Show child fields
dns_options.dns_record_ip_type

The DNS records created for the endpoint.

dns_options.private_dns_only_for_inbound_resolver_endpoint

Indicates whether to enable private DNS only for inbound endpoints.

groups

(Interface endpoint) Information about the security groups that are associated with the network interface.

STRUCT(
"group_id" VARCHAR,
"group_name" VARCHAR
)[]
Show child fields
groups[]
Show child fields
groups[].group_id

The ID of the security group.

groups[].group_name

The name of the security group.

ip_address_type

The IP address type for the endpoint.

VARCHAR
last_error

The last error that occurred for endpoint.

STRUCT(
"message" VARCHAR,
"code" VARCHAR
)
Show child fields
last_error.code

The error code for the VPC endpoint error.

last_error.message

The error message for the VPC endpoint error.

network_interface_ids

(Interface endpoint) The network interfaces for the endpoint.

VARCHAR[]
Show child fields
network_interface_ids[]
owner_id

The ID of the Amazon Web Services account that owns the endpoint.

VARCHAR
policy_document

The policy document associated with the endpoint, if applicable.

VARCHAR
private_dns_enabled

(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.

BOOLEAN
requester_managed

Indicates whether the endpoint is being managed by its service.

BOOLEAN
route_table_ids

(Gateway endpoint) The IDs of the route tables associated with the endpoint.

VARCHAR[]
Show child fields
route_table_ids[]
service_name

The name of the service to which the endpoint is associated.

VARCHAR
state

The state of the endpoint.

VARCHAR
subnet_ids

(Interface endpoint) The subnets for the endpoint.

VARCHAR[]
Show child fields
subnet_ids[]
tags

The tags assigned to the endpoint.

STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
Show child fields
tags[]
Show child fields
tags[].key

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

tags[].value

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

vpc_endpoint_id

The ID of the endpoint.

VARCHAR
vpc_endpoint_type

The type of endpoint.

VARCHAR
vpc_id

The ID of the VPC to which the endpoint is associated.

VARCHAR