Kafka / Client / list_configurations

list_configurations#

Kafka.Client.list_configurations(**kwargs)#

Returns a list of all the MSK configurations in this Region.

Request Syntax

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

Parameters:

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

{
    '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'
        },
    ],
    'NextToken': 'string'
}

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.
- NextToken (string) –
  
  The paginated results marker. When the result of a ListConfigurations 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