Request Parameters Response Elements Errors Examples See Also

DescribeVpcEndpoints

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.

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

The filters.

ip-address-type - The IP address type (ipv4 | ipv6).
service-name - The name of the service.
service-region - The Region of the service.
tag: - 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 | Resource | ServiceNetwork).

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 1,000, we return only 1,000 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

The IDs of the VPC endpoints.

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 VPC endpoints.

Type: Array of VpcEndpoint objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

Examples

Example

This example describes all of your endpoints.

Sample Request


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

Sample Response



    8d3e7656-3328-451d-8c86-7156example
    
        
            {"Version":"2008-10-17","Statement":[{"Effect":"Allow","Principal":"*","Action":"*","Resource":"*"}]}
            
                rtb-3d560345
            
            
            com.amazonaws.us-east-1.dynamodb
            true
            
            vpce-032a826a
            
            
            Gateway
            vpc-aabb1122
            2017-09-05T20:41:28Z
            available
            
                
                    Name
                    TeamA
                
            
        
        
            {"Statement": [{"Action": "*", "Effect": "Allow", "Principal": "*", "Resource": "*"}]}
            
            
                
                    Z7HUB22UULQXV
                    vpce-0f89a33420c1931d7-bluzidnv.elasticloadbalancing.us-east-1.vpce.amazonaws.com
                
                
                    Z7HUB22UULQXV
                    vpce-0f89a33420c1931d7-bluzidnv-us-east-1b.elasticloadbalancing.us-east-1.vpce.amazonaws.com
                
                
                    Z7HUB22UULQXV
                    vpce-0f89a33420c1931d7-bluzidnv-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com
                
            
            com.amazonaws.us-east-1.elasticloadbalancing
            false
            
                
                    default
                    sg-54e8bf31
                
            
            vpce-0f89a33420c1931d7
            
                subnet-d6fcaa8d
                subnet-7b16de0c
            
            
                eni-2ec2b084
                eni-1b4a65cf
            
            Interface
            vpc-1a2b3c4d
            2017-09-05T17:55:27.583Z
            available
            
                
                    Name
                    TeamA
                
            
        
        
            2020-11-11T08:06:03.522Z
            
                eni-111111222222333aad
            
            123456789012
            false
            com.amazonaws.vpce.us-east-1.vpce-svc-abcd33a1c4321c123
            available
            
                subnet-aaaabbbb333322211
            
            
            vpce-22223333bbbbaaaa1
            GatewayLoadBalancer
            vpc-abcabcabc12312312