Kafka / Paginator / ListClusterOperationsV2

ListClusterOperationsV2

class Kafka.Paginator.ListClusterOperationsV2

paginator = client.get_paginator('list_cluster_operations_v2')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ClusterArn (string) – [REQUIRED] The arn of the cluster whose operations are being requested.

• 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

{
    'ClusterOperationInfoList': [
        {
            'ClusterArn': 'string',
            'ClusterType': 'PROVISIONED'|'SERVERLESS',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'OperationArn': 'string',
            'OperationState': 'string',
            'OperationType': 'string'
        },
    ],

}

Response Structure

• (dict) –

  HTTP Status Code 200: OK.

  • ClusterOperationInfoList (list) –

    An array of cluster operation information objects.

    • (dict) –

      Returns information about a cluster operation.

      • ClusterArn (string) –

        ARN of the cluster.

      • ClusterType (string) –

        Type of the backend cluster.

      • StartTime (datetime) –

        The time at which operation was started.

      • EndTime (datetime) –

        The time at which the operation finished.

      • OperationArn (string) –

        ARN of the cluster operation.

      • OperationState (string) –

        State of the cluster operation.

      • OperationType (string) –

        Type of the cluster operation.