KafkaConnect / Paginator / ListCustomPlugins

ListCustomPlugins

class KafkaConnect.Paginator.ListCustomPlugins

paginator = client.get_paginator('list_custom_plugins')

paginate(**kwargs)

Creates an iterator that will paginate through responses from KafkaConnect.Client.list_custom_plugins().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• namePrefix (string) – Lists custom plugin names that start with the specified text 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:

dict

Returns:

Response Syntax

{
    'customPlugins': [
        {
            'creationTime': datetime(2015, 1, 1),
            'customPluginArn': 'string',
            'customPluginState': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING',
            'description': 'string',
            'latestRevision': {
                'contentType': 'JAR'|'ZIP',
                'creationTime': datetime(2015, 1, 1),
                'description': 'string',
                'fileDescription': {
                    'fileMd5': 'string',
                    'fileSize': 123
                },
                'location': {
                    's3Location': {
                        'bucketArn': 'string',
                        'fileKey': 'string',
                        'objectVersion': 'string'
                    }
                },
                'revision': 123
            },
            'name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • customPlugins (list) –

    An array of custom plugin descriptions.

    • (dict) –

      A summary of the custom plugin.

      • creationTime (datetime) –

        The time that the custom plugin was created.

      • customPluginArn (string) –

        The Amazon Resource Name (ARN) of the custom plugin.

      • customPluginState (string) –

        The state of the custom plugin.

      • description (string) –

        A description of the custom plugin.

      • latestRevision (dict) –

        The latest revision of the custom plugin.

        • contentType (string) –

          The format of the plugin file.

        • creationTime (datetime) –

          The time that the custom plugin was created.

        • description (string) –

          The description of the custom plugin.

        • fileDescription (dict) –

          Details about the custom plugin file.

          • fileMd5 (string) –

            The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.

          • fileSize (integer) –

            The size in bytes of the custom plugin file. You can use it to validate the file.

        • location (dict) –

          Information about the location of the custom plugin.

          • s3Location (dict) –

            The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.

            • bucketArn (string) –

              The Amazon Resource Name (ARN) of an S3 bucket.

            • fileKey (string) –

              The file key for an object in an S3 bucket.

            • objectVersion (string) –

              The version of an object in an S3 bucket.

        • revision (integer) –

          The revision of the custom plugin.

      • name (string) –

        The name of the custom plugin.

  • NextToken (string) –

    A token to resume pagination.