Kafka / Paginator / ListVpcConnections


class Kafka.Paginator.ListVpcConnections#
paginator = client.get_paginator('list_vpc_connections')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

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

    'VpcConnections': [
            'VpcConnectionArn': 'string',
            'TargetClusterArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'Authentication': 'string',
            'VpcId': 'string',


Response Structure

  • (dict) –

    200 response

    • VpcConnections (list) –

      List of VPC connections.

      • (dict) –

        The VPC connection object.

        • VpcConnectionArn (string) –

          The ARN that identifies the Vpc Connection.

        • TargetClusterArn (string) –

          The ARN that identifies the Cluster which the Vpc Connection belongs to.

        • CreationTime (datetime) –

          Creation time of the Vpc Connection.

        • Authentication (string) –

          Information about the auth scheme of Vpc Connection.

        • VpcId (string) –

          The vpcId that belongs to the Vpc Connection.

        • State (string) –

          State of the Vpc Connection.