Kafka / Client / list_cluster_operations_v2

list_cluster_operations_v2#

Kafka.Client.list_cluster_operations_v2(**kwargs)#

Returns a list of all the operations that have been performed on the specified MSK cluster.

See also: AWS API Documentation

Request Syntax

response = client.list_cluster_operations_v2(
    ClusterArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

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

  • MaxResults (integer) – The maxResults of the query.

  • NextToken (string) – The nextToken of the query.

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

    • NextToken (string) –

      If the response of ListClusterOperationsV2 is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListClusterOperationsV2.

Exceptions