:doc:`EKS <../../eks>` / Paginator / ListEksAnywhereSubscriptions

****************************
ListEksAnywhereSubscriptions
****************************



.. py:class:: EKS.Paginator.ListEksAnywhereSubscriptions

  ::

    
    paginator = client.get_paginator('list_eks_anywhere_subscriptions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`EKS.Client.list_eks_anywhere_subscriptions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ListEksAnywhereSubscriptions>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          includeStatus=[
              'CREATING'|'ACTIVE'|'UPDATING'|'EXPIRING'|'EXPIRED'|'DELETING',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type includeStatus: list
    :param includeStatus: 

      An array of subscription statuses to filter on.

      

    
      - *(string) --* 

      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'subscriptions': [
                {
                    'id': 'string',
                    'arn': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'effectiveDate': datetime(2015, 1, 1),
                    'expirationDate': datetime(2015, 1, 1),
                    'licenseQuantity': 123,
                    'licenseType': 'Cluster',
                    'term': {
                        'duration': 123,
                        'unit': 'MONTHS'
                    },
                    'status': 'string',
                    'autoRenew': True|False,
                    'licenseArns': [
                        'string',
                    ],
                    'licenses': [
                        {
                            'id': 'string',
                            'token': 'string'
                        },
                    ],
                    'tags': {
                        'string': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **subscriptions** *(list) --* 

          A list of all subscription objects in the region, filtered by includeStatus and paginated by nextToken and maxResults.

          
          

          - *(dict) --* 

            An EKS Anywhere subscription authorizing the customer to support for licensed clusters and access to EKS Anywhere Curated Packages.

            
            

            - **id** *(string) --* 

              UUID identifying a subscription.

              
            

            - **arn** *(string) --* 

              The Amazon Resource Name (ARN) for the subscription.

              
            

            - **createdAt** *(datetime) --* 

              The Unix timestamp in seconds for when the subscription was created.

              
            

            - **effectiveDate** *(datetime) --* 

              The Unix timestamp in seconds for when the subscription is effective.

              
            

            - **expirationDate** *(datetime) --* 

              The Unix timestamp in seconds for when the subscription will expire or auto renew, depending on the auto renew configuration of the subscription object.

              
            

            - **licenseQuantity** *(integer) --* 

              The number of licenses included in a subscription. Valid values are between 1 and 100.

              
            

            - **licenseType** *(string) --* 

              The type of licenses included in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster.

              
            

            - **term** *(dict) --* 

              An EksAnywhereSubscriptionTerm object.

              
              

              - **duration** *(integer) --* 

                The duration of the subscription term. Valid values are 12 and 36, indicating a 12 month or 36 month subscription.

                
              

              - **unit** *(string) --* 

                The term unit of the subscription. Valid value is ``MONTHS``.

                
          
            

            - **status** *(string) --* 

              The status of a subscription.

              
            

            - **autoRenew** *(boolean) --* 

              A boolean indicating whether or not a subscription will auto renew when it expires.

              
            

            - **licenseArns** *(list) --* 

              Amazon Web Services License Manager ARN associated with the subscription.

              
              

              - *(string) --* 
          
            

            - **licenses** *(list) --* 

              Includes all of the claims in the license token necessary to validate the license for extended support.

              
              

              - *(dict) --* 

                An EKS Anywhere license associated with a subscription.

                
                

                - **id** *(string) --* 

                  An id associated with an EKS Anywhere subscription license.

                  
                

                - **token** *(string) --* 

                  An optional license token that can be used for extended support verification.

                  
            
          
            

            - **tags** *(dict) --* 

              The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags do not propagate to any other resources associated with the subscription.

              
              

              - *(string) --* 

                One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.

                
                

                - *(string) --* 

                  The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key).

                  
          
        
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    