Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribePrivateConnection

Retrieves details of an existing Private Connection.

Request Syntax


GET /v1/private-connections/name HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

name

The name of the Private Connection.

Length Constraints: Minimum length of 3. Maximum length of 30.

Pattern: [a-z0-9]([a-z0-9-]*[a-z0-9])?

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "certificateExpiryTime": "string",
   "hostAddress": "string",
   "name": "string",
   "resourceConfigurationId": "string",
   "resourceGatewayId": "string",
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "type": "string",
   "vpcId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

certificateExpiryTime

The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated.

Type: Timestamp

hostAddress

IP address or DNS name of the target resource. Only present for service-managed Private Connections.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Pattern: [a-zA-Z0-9.:\-]+

name

The name of the Private Connection.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 30.

Pattern: [a-z0-9]([a-z0-9-]*[a-z0-9])?

resourceConfigurationId

The Resource Configuration ARN. Only present for self-managed Private Connections.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: (arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}|rcfg-[0-9a-z]{17})

resourceGatewayId

The service-managed Resource Gateway ARN. Only present for service-managed Private Connections.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourcegateway/rgw-[0-9a-z]{17}

status

The status of the Private Connection.

Type: String

Valid Values: ACTIVE | CREATE_IN_PROGRESS | CREATE_FAILED | DELETE_IN_PROGRESS | DELETE_FAILED

tags

Tags associated with the Private Connection.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]*

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]*

type

The type of the Private Connection.

Type: String

Valid Values: SELF_MANAGED | SERVICE_MANAGED

vpcId

VPC identifier of the service-managed Resource Gateway. Only present for service-managed Private Connections.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 50.

Pattern: vpc-(([0-9a-z]{8})|([0-9a-z]{17}))

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

Access to the requested resource is denied due to insufficient permissions.

message: Detailed error message describing why access was denied.

HTTP Status Code: 403

ConflictException

The request conflicts with the current state of the resource.

message: Detailed error message describing the conflict.

HTTP Status Code: 409

ContentSizeExceededException

This exception is thrown when the content size exceeds the allowed limit.

HTTP Status Code: 413

InternalServerException

This exception is thrown when an unexpected error occurs in the processing of a request.

HTTP Status Code: 500

InvalidParameterException

One or more parameters provided in the request are invalid.

message: Detailed error message describing which parameter is invalid and why.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource could not be found.

message: Detailed error message describing which resource was not found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would exceed the service quota limit.

message: Detailed error message describing which quota was exceeded.

HTTP Status Code: 402

ThrottlingException

The request was throttled due to too many requests. Please slow down and try again.

message: Detailed error message describing the throttling condition.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

fieldList: A list of specific failures encountered while validating the input. A member can appear in this list more than once if it failed to satisfy multiple constraints.
message: A summary of the validation failure.

HTTP Status Code: 400