Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1492497398.3 KB

Retrieves the details of a private connection.

post/DescribePrivateConnection

Request body

privateConnectionNamestring required

The unique name of a private connection within your account.

Response

Success

namestring required

The name of the private connection.

type'SERVICE_MANAGED' | 'SELF_MANAGED' required

The type of the private connection, indicating whether it is service-managed or self-managed.

status'ACTIVE' | 'CREATE_IN_PROGRESS' | 'CREATE_FAILED' | 'DELETE_IN_PROGRESS' | 'DELETE_FAILED' required

The current status of the private connection.

resourceGatewayIdstring

The identifier or ARN of the VPC Lattice resource gateway.

hostAddressstring

The IP address or DNS name of the target resource.

vpcIdstring

The identifier of the VPC the resource gateway is created in.

resourceConfigurationIdstring

The identifier or ARN of the VPC Lattice resource configuration.

certificateExpiryTimestring date-time

The date and time the connection's certificate expires, in UTC format.

dnsResolution'PUBLIC' | 'IN_VPC'

The DNS resolution mode for the resource gateway.

failureMessagestring

A message describing why the private connection entered a failed state, if applicable.

tagsobject

The tags attached to the private connection.