Skip to content

describe_vpc_endpoint_connections

Operation

describe_vpc_endpoint_connections

describe_vpc_endpoint_connections(request: DescribeVpcEndpointConnectionsInput | DescribeVpcEndpointConnectionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpcEndpointConnectionsInputDict]) -> DescribeVpcEndpointConnectionsOutput

Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.

Parameters:

Name Type Description Default
request DescribeVpcEndpointConnectionsInput | DescribeVpcEndpointConnectionsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeVpcEndpointConnectionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeVpcEndpointConnectionsOutput

An instance of DescribeVpcEndpointConnectionsOutput.

describe_vpc_endpoint_connections async

describe_vpc_endpoint_connections(request: DescribeVpcEndpointConnectionsInput | DescribeVpcEndpointConnectionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeVpcEndpointConnectionsInputDict]) -> DescribeVpcEndpointConnectionsOutput

Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.

Parameters:

Name Type Description Default
request DescribeVpcEndpointConnectionsInput | DescribeVpcEndpointConnectionsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeVpcEndpointConnectionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeVpcEndpointConnectionsOutput

An instance of DescribeVpcEndpointConnectionsOutput.

Input

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

DescribeVpcEndpointConnectionsInputDict

Bases: TypedDict

Dictionary form of DescribeVpcEndpointConnectionsInput.

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-id - The ID of the service.

  • vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns the endpoint.

  • vpc-endpoint-region - The Region of the endpoint or cross-region to find endpoints for other Regions.

  • vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).

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

max_results instance-attribute
max_results: int | None

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.

next_token instance-attribute
next_token: str | None

The token to retrieve the next page of results.

DescribeVpcEndpointConnectionsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeVpcEndpointConnectionsInput 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-id - The ID of the service.

  • vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns the endpoint.

  • vpc-endpoint-region - The Region of the endpoint or cross-region to find endpoints for other Regions.

  • vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).

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

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

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.

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

The token to retrieve the next page of results.

Output

DescribeVpcEndpointConnectionsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeVpcEndpointConnectionsOutput structure.

Attributes

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

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

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_endpoint_connections class-attribute instance-attribute
vpc_endpoint_connections: list[VpcEndpointConnection] | None = ...

Information about the VPC endpoint connections.