Vpc-connections - Amazon Managed Streaming for Apache Kafka
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Vpc-connections

URI

/v1/vpc-connections

HTTP methods

GET

Operation ID: ListVpcConnections

Lists all VPC connections.

Query parameters
NameTypeRequiredDescription
nextTokenStringFalse

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.

maxResultsStringFalse

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 codeResponse modelDescription
200 ListVpcConnectionsResponse

HTTP Status Code 200: OK.

400Error

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

401Error

The request is not authorized. The provided credentials couldn't be validated.

403Error

Access forbidden. Check your credentials and then retry your request.

404Error

The resource could not be found due to incorrect input. Correct the input, then retry the request.

429Error

429 response

500Error

There was an unexpected internal server error. Retrying your request might resolve the issue.

503Error

503 response

OPTIONS

Enable CORS by returning correct headers.

Responses
Status codeResponse modelDescription
200None

Default response for CORS method.

Schemas

Response bodies

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

Properties

Error

Returns information about an error.

PropertyTypeRequiredDescription
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.

PropertyTypeRequiredDescription
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

PropertyTypeRequiredDescription
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