EKS / Paginator / DescribeAddonVersions

DescribeAddonVersions

class EKS.Paginator.DescribeAddonVersions

paginator = client.get_paginator('describe_addon_versions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EKS.Client.describe_addon_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    kubernetesVersion='string',
    addonName='string',
    types=[
        'string',
    ],
    publishers=[
        'string',
    ],
    owners=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• kubernetesVersion (string) – The Kubernetes versions that you can use the add-on with.

• addonName (string) – The name of the add-on. The name must match one of the names returned by ListAddons.

• types (list) –

  The type of the add-on. For valid types, don’t specify a value for this property.

  • (string) –

• publishers (list) –

  The publisher of the add-on. For valid publishers, don’t specify a value for this property.

  • (string) –

• owners (list) –

  The owner of the add-on. For valid owners, don’t specify a value for this property.

  • (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

{
    'addons': [
        {
            'addonName': 'string',
            'type': 'string',
            'addonVersions': [
                {
                    'addonVersion': 'string',
                    'architecture': [
                        'string',
                    ],
                    'compatibilities': [
                        {
                            'clusterVersion': 'string',
                            'platformVersions': [
                                'string',
                            ],
                            'defaultVersion': True|False
                        },
                    ],
                    'requiresConfiguration': True|False,
                    'requiresIamPermissions': True|False
                },
            ],
            'publisher': 'string',
            'owner': 'string',
            'marketplaceInformation': {
                'productId': 'string',
                'productUrl': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • addons (list) –

    The list of available versions with Kubernetes version compatibility and other properties.

    • (dict) –

      Information about an add-on.

      • addonName (string) –

        The name of the add-on.

      • type (string) –

        The type of the add-on.

      • addonVersions (list) –

        An object representing information about available add-on versions and compatible Kubernetes versions.

        • (dict) –

          Information about an add-on version.

          • addonVersion (string) –

            The version of the add-on.

          • architecture (list) –

            The architectures that the version supports.

            • (string) –

          • compatibilities (list) –

            An object representing the compatibilities of a version.

            • (dict) –

              Compatibility information.

              • clusterVersion (string) –

                The supported Kubernetes version of the cluster.

              • platformVersions (list) –

                The supported compute platform.

                • (string) –

              • defaultVersion (boolean) –

                The supported default version.

          • requiresConfiguration (boolean) –

            Whether the add-on requires configuration.

          • requiresIamPermissions (boolean) –

            Indicates if the Addon requires IAM Permissions to operate, such as networking permissions.

      • publisher (string) –

        The publisher of the add-on.

      • owner (string) –

        The owner of the add-on.

      • marketplaceInformation (dict) –

        Information about the add-on from the Amazon Web Services Marketplace.

        • productId (string) –

          The product ID from the Amazon Web Services Marketplace.

        • productUrl (string) –

          The product URL from the Amazon Web Services Marketplace.

  • NextToken (string) –

    A token to resume pagination.