Skip to content

get_vpc_link

Operation

get_vpc_link(request: GetVpcLinkInput | GetVpcLinkInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetVpcLinkInputDict]) -> GetVpcLinkOutput

Gets a specified VPC link under the caller's account in a region.

Parameters:

Name Type Description Default
request GetVpcLinkInput | GetVpcLinkInputDict | 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[GetVpcLinkInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetVpcLinkOutput

An instance of GetVpcLinkOutput.

get_vpc_link(request: GetVpcLinkInput | GetVpcLinkInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetVpcLinkInputDict]) -> GetVpcLinkOutput

Gets a specified VPC link under the caller's account in a region.

Parameters:

Name Type Description Default
request GetVpcLinkInput | GetVpcLinkInputDict | 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[GetVpcLinkInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetVpcLinkOutput

An instance of GetVpcLinkOutput.

Input

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

GetVpcLinkInputDict

Bases: TypedDict

Dictionary form of GetVpcLinkInput.

Attributes

vpc_link_id: Required[str]

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

GetVpcLinkInput dataclass

Bases: _SerdeShape

Gets a specified VPC link under the caller's account in a region.

Attributes

vpc_link_id: str | None = ...

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

Output

GetVpcLinkOutput dataclass

Bases: _SerdeShape

An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

Attributes

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

The description of the VPC link.

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

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

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

The name used to label and identify the VPC link.

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.

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

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

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

A description about the VPC link status.

tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

The collection of tags. Each tag element is associated with a given resource.

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

The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same Amazon Web Services account of the API owner.