Skip to content

EC2  >  Operations  >  describe_vpc_endpoints

describe_vpc_endpoints

Operation

describe_vpc_endpoints async

describe_vpc_endpoints(request: DescribeVpcEndpointsInput | DescribeVpcEndpointsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeVpcEndpointsOutput
describe_vpc_endpoints(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpcEndpointsInputDict]) -> DescribeVpcEndpointsOutput

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeVpcEndpointsOutput

An instance of DescribeVpcEndpointsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeVpcEndpointsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeVpcEndpointsInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

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:<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 | Resource | ServiceNetwork | Tunnel).

max_results class-attribute instance-attribute
max_results: int | None = ...

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.

next_token class-attribute instance-attribute
next_token: str | None = ...

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

vpc_endpoint_ids class-attribute instance-attribute
vpc_endpoint_ids: list[str] | None = ...

The IDs of the VPC endpoints.

Dictionaries

DescribeVpcEndpointsInputDict

Bases: TypedDict

Dictionary form of DescribeVpcEndpointsInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

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:<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 | Resource | ServiceNetwork | Tunnel).

max_results instance-attribute
max_results: int | None

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.

next_token instance-attribute
next_token: str | None

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

vpc_endpoint_ids instance-attribute
vpc_endpoint_ids: Sequence[str] | None

The IDs of the VPC endpoints.

Output

DescribeVpcEndpointsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeVpcEndpointsOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

vpc_endpoints class-attribute instance-attribute
vpc_endpoints: list[VpcEndpoint] | None = ...

Information about the VPC endpoints.