Clusters clusterArn Client-vpc-connections - Amazon Managed Streaming for Apache Kafka

Clusters clusterArn Client-vpc-connections

URI

/v1/clusters/clusterArn/client-vpc-connections

HTTP methods

GET

Operation ID: ListClientVpcConnections

List client VPC connections.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

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 ListClientVpcConnectionsResponse

Successful response.

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.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Responses
Status codeResponse modelDescription
200None

Default response for CORS method

Schemas

Response bodies

{ "clientVpcConnections": [ { "authentication": "string", "creationTime": "string", "owner": "string", "state": enum, "vpcConnectionArn": "string" } ], "nextToken": "string" }
{ "invalidParameter": "string", "message": "string" }

Properties

ClientVpcConnection

VPC Connection description

PropertyTypeRequiredDescription
authentication

string

False

The type of private link authentication.

creationTime

string

False

The time which the VPC Connnection is created.

owner

string

False

The Owner of the VPC Connection.

state

VpcConnectionState

False

State of the Remote VPC Connection.

vpcConnectionArn

string

True

The Amazon Resource Name (ARN) of the Remote VPC.

Error

Returns information about an error.

PropertyTypeRequiredDescription
invalidParameter

string

False

The parameter that caused the error.

message

string

False

The description of the error.

ListClientVpcConnectionsResponse

The response contains an array vpc connections.

PropertyTypeRequiredDescription
clientVpcConnections

Array of type ClientVpcConnection

False

An array of client vpc connections information objects.

nextToken

string

False

If the response of ListClientVpcConnections is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClientVpcConnections.

VpcConnectionState

State of the vpc connection

  • CREATING

  • AVAILABLE

  • INACTIVE

  • UPDATING

  • DEACTIVATING

  • DELETING

  • FAILED

  • REJECTED

  • REJECTING

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListClientVpcConnections