Kafka / Paginator / ListClientVpcConnections


class Kafka.Paginator.ListClientVpcConnections#
paginator = client.get_paginator('list_client_vpc_connections')

Creates an iterator that will paginate through responses from Kafka.Client.list_client_vpc_connections().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • ClusterArn (string) –


    The Amazon Resource Name (ARN) of the cluster.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'ClientVpcConnections': [
            'Authentication': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'VpcConnectionArn': 'string',
            'Owner': '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.