Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

DescribeVpcEndpoints

Describes one or more of your VPC endpoints.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DryRun

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.

Type: Boolean

Required: No

Filter.N

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)

Type: Array of Filter objects

Required: No

MaxResults

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.

Type: Integer

Required: No

NextToken

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

Type: String

Required: No

VpcEndpointId.N

One or more endpoint IDs.

Type: Array of strings

Required: No

Response Elements

The following elements are returned by the service.

nextToken

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Type: String

requestId

The ID of the request.

Type: String

vpcEndpointSet

Information about the endpoints.

Type: Array of VpcEndpoint objects

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Example

Example

This example describes all of your endpoints.

Sample Request

https://ec2.amazonaws.com/?Action=DescribeVpcEndpoints
&AUTHPARAMS

Sample Response

<DescribeVpcEndpointsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
    <requestId>8d3e7656-3328-451d-8c86-7156example</requestId>
    <vpcEndpointSet>
        <item>
            <policyDocument>{"Version":"2008-10-17","Statement":[{"Effect":"Allow","Principal":"*","Action":"*","Resource":"*"}]}</policyDocument>
            <routeTableIdSet>
                <item>rtb-3d560345</item>
            </routeTableIdSet>
            <dnsEntrySet/>
            <serviceName>com.amazonaws.us-east-1.dynamodb</serviceName>
            <privateDnsEnabled>true</privateDnsEnabled>
            <groupSet/>
            <vpcEndpointId>vpce-032a826a</vpcEndpointId>
            <subnetIdSet/>
            <networkInterfaceIdSet/>
            <vpcEndpointType>Gateway</vpcEndpointType>
            <vpcId>vpc-aabb1122</vpcId>
            <creationTimestamp>2017-09-05T20:41:28Z</creationTimestamp>
            <state>available</state>
        </item>
        <item>
            <policyDocument>{
  "Statement": [
    {
      "Action": "*", 
      "Effect": "Allow", 
      "Principal": "*", 
      "Resource": "*"
    }
  ]
}</policyDocument>
            <routeTableIdSet/>
            <dnsEntrySet>
                <item>
                    <hostedZoneId>Z7HUB22UULQXV</hostedZoneId>
                    <dnsName>vpce-0f89a33420c1931d7-bluzidnv.elasticloadbalancing.us-east-1.vpce.amazonaws.com</dnsName>
                </item>
                <item>
                    <hostedZoneId>Z7HUB22UULQXV</hostedZoneId>
                    <dnsName>vpce-0f89a33420c1931d7-bluzidnv-us-east-1b.elasticloadbalancing.us-east-1.vpce.amazonaws.com</dnsName>
                </item>
                <item>
                    <hostedZoneId>Z7HUB22UULQXV</hostedZoneId>
                    <dnsName>vpce-0f89a33420c1931d7-bluzidnv-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com</dnsName>
                </item>
            </dnsEntrySet>
            <serviceName>com.amazonaws.us-east-1.elasticloadbalancing</serviceName>
            <privateDnsEnabled>false</privateDnsEnabled>
            <groupSet>
                <item>
                    <groupName>default</groupName>
                    <groupId>sg-54e8bf31</groupId>
                </item>
            </groupSet>
            <vpcEndpointId>vpce-0f89a33420c1931d7</vpcEndpointId>
            <subnetIdSet>
                <item>subnet-d6fcaa8d</item>
                <item>subnet-7b16de0c</item>
            </subnetIdSet>
            <networkInterfaceIdSet>
                <item>eni-2ec2b084</item>
                <item>eni-1b4a65cf</item>
            </networkInterfaceIdSet>
            <vpcEndpointType>Interface</vpcEndpointType>
            <vpcId>vpc-1a2b3c4d</vpcId>
            <creationTimestamp>2017-09-05T17:55:27.583Z</creationTimestamp>
            <state>available</state>
        </item>
    </vpcEndpointSet>
</DescribeVpcEndpointsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: