Kafka / Client / list_client_vpc_connections

list_client_vpc_connections#

Kafka.Client.list_client_vpc_connections(**kwargs)#

Returns a list of all the VPC connections in this Region.

Request Syntax

response = client.list_client_vpc_connections(
    ClusterArn='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

ClusterArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the cluster.
MaxResults (integer) – The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'ClientVpcConnections': [
        {
            'Authentication': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING',
            'VpcConnectionArn': 'string',
            'Owner': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

200 response
- ClientVpcConnections (list) –
  
  List of client VPC connections.
  - (dict) –
    
    The client VPC connection object.
    - Authentication (string) –
      
      Information about the auth scheme of Vpc Connection.
    - CreationTime (datetime) –
      
      Creation time of the Vpc Connection.
    - State (string) –
      
      State of the Vpc Connection.
    - VpcConnectionArn (string) –
      
      The ARN that identifies the Vpc Connection.
    - Owner (string) –
      
      The Owner of the Vpc Connection.
- NextToken (string) –
  
  The paginated results marker. When the result of a ListClientVpcConnections operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request.

Exceptions

Kafka.Client.exceptions.ServiceUnavailableException
Kafka.Client.exceptions.BadRequestException
Kafka.Client.exceptions.UnauthorizedException
Kafka.Client.exceptions.InternalServerErrorException
Kafka.Client.exceptions.ForbiddenException