Kafka / Paginator / ListConfigurations

ListConfigurations#

class Kafka.Paginator.ListConfigurations#

paginator = client.get_paginator('list_configurations')

paginate(**kwargs)#

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

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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:

dict

Returns:

Response Syntax

{
    'Configurations': [
        {
            'Arn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'Description': 'string',
            'KafkaVersions': [
                'string',
            ],
            'LatestRevision': {
                'CreationTime': datetime(2015, 1, 1),
                'Description': 'string',
                'Revision': 123
            },
            'Name': 'string',
            'State': 'ACTIVE'|'DELETING'|'DELETE_FAILED'
        },
    ],

}

Response Structure

(dict) –

200 response
- Configurations (list) –
  
  An array of MSK configurations.
  - (dict) –
    
    Represents an MSK Configuration.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the configuration.
    - CreationTime (datetime) –
      
      The time when the configuration was created.
    - Description (string) –
      
      The description of the configuration.
    - KafkaVersions (list) –
      
      An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this array.
      - (string) –
    - LatestRevision (dict) –
      
      Latest revision of the configuration.
      - CreationTime (datetime) –
        
        The time when the configuration revision was created.
      - Description (string) –
        
        The description of the configuration revision.
      - Revision (integer) –
        
        The revision number.
    - Name (string) –
      
      The name of the configuration.
    - State (string) –
      
      The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.