DescribeVpcEndpoints

GET /?Action=DescribeVpcEndpoints
Description

Describes one or more Virtual Private Cloud (VPC) endpoints.
You can use the Filter.N parameter to filter the VPCs on the following properties:

  • service-name: The name of the prefix list corresponding to the service. For more information, see DescribePrefixLists.

  • vpc-id: The ID of the VPC.

  • vpc-endpoint-id: The ID of the VPC endpoint.

  • vpc-endpoint-state: The state of the VPC endpoint (pending | available | deleting | deleted).

Note

If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Body parameter

Required: false
Name: DescribeVpcEndpointsRequest

Name Description Required Schema Default Example

Filter.N

One or more filters. Example:
osc-cli fcu DescribeVpcEndpoints \
  --Filter.1.Name "vpc-endpoint-id" \
  --Filter.1.Value.1 "vpce-12345678"

false

Filter

VpcEndpointId.N

One or more IDs of VPC endpoints.

false

string

Responses
HTTP Code 200
HTTP Code Description Schema

200

DescribeVpcEndpointsResult

Response 200

Response 200

Name Description Required Schema Default Example

requestId

The ID of the request.

false

string

vpcEndpointSet.N

Information about one or more VPC endpoints.

false

VpcEndpoint