URI HTTP methods Schemas Properties See also

Vpc-connections

URI

/v1/vpc-connections

HTTP methods

GET

Operation ID: ListVpcConnections

Lists all VPC connections.

Query parameters
Name	Type	Required	Description
`nextToken`	String	False	The paginated results marker. When the result of the operation is truncated, the call returns `NextToken` in the response. To get the next batch, provide this token in your next request.
`maxResults`	String	False	The maximum number of results to return in the response (default maximum 100 results per API call). If there are more results, the response includes a `NextToken` parameter.

Responses
Status code	Response model	Description
`200`	`ListVpcConnectionsResponse`	HTTP Status Code 200: OK.
`400`	`Error`	The request isn't valid because the input is incorrect. Correct your input and then submit it again.
`401`	`Error`	The request is not authorized. The provided credentials couldn't be validated.
`403`	`Error`	Access forbidden. Check your credentials and then retry your request.
`404`	`Error`	The resource could not be found due to incorrect input. Correct the input, then retry the request.
`429`	`Error`	429 response
`500`	`Error`	There was an unexpected internal server error. Retrying your request might resolve the issue.
`503`	`Error`	503 response

OPTIONS

Enable CORS by returning correct headers.

Responses
Status code	Response model	Description
`200`	None	Default response for CORS method.

Schemas

Response bodies


{
  "nextToken": "string",
  "vpcConnections": [
    {
      "authentication": "string",
      "creationTime": "string",
      "state": enum,
      "targetClusterArn": "string",
      "vpcConnectionArn": "string",
      "vpcId": "string"
    }
  ]
}


{
  "invalidParameter": "string",
  "message": "string"
}

Properties

Error

Returns information about an error.

Property	Type	Required	Description
`invalidParameter`	string	False	The parameter that caused the error.
`message`	string	False	The description of the error.

ListVpcConnectionsResponse

The response contains an array of vpcConnections and a next token if the response is truncated.

Property	Type	Required	Description
`nextToken`	string	False	If the response of ListVpcConnections is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListVpcConnections.
`vpcConnections`	Array of type VpcConnection	False	An array of VPC Connection.

VpcConnection

Vpc Connection description

Property	Type	Required	Description
`authentication`	string	False	The type of private link authentication.
`creationTime`	string	False	The time which the VPC Connnection is created.
`state`	VpcConnectionState	False	State of the Remote VPC Connection.
`targetClusterArn`	string	True	The Amazon Resource Name (ARN) of the target cluster.
`vpcConnectionArn`	string	True	The Amazon Resource Name (ARN) of the Remote Vpc.
`vpcId`	string	False	The description of the vpcId.

VpcConnectionState

State of the vpc connection

CREATING
AVAILABLE
INACTIVE
UPDATING
DEACTIVATING
DELETING
FAILED
REJECTED
REJECTING