:doc:`LicenseManagerUserSubscriptions <../../license-manager-user-subscriptions>` / Paginator / ListInstances

*************
ListInstances
*************



.. py:class:: LicenseManagerUserSubscriptions.Paginator.ListInstances

  ::

    
    paginator = client.get_paginator('list_instances')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`LicenseManagerUserSubscriptions.Client.list_instances`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListInstances>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Filters=[
              {
                  'Attribute': 'string',
                  'Operation': 'string',
                  'Value': 'string'
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Filters: list
    :param Filters: 

      You can use the following filters to streamline results:

       

      
      * Status
       
      * InstanceId
      

      

    
      - *(dict) --* 

        A filter name and value pair that is used to return more specific results from a describe or list operation. You can use filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

        

      
        - **Attribute** *(string) --* 

          The name of an attribute to use as a filter.

          

        
        - **Operation** *(string) --* 

          The type of search (For example, eq, geq, leq)

          

        
        - **Value** *(string) --* 

          Value of the filter.

          

        
      
  
    :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**

      
      ::

        {
            'InstanceSummaries': [
                {
                    'InstanceId': 'string',
                    'Status': 'string',
                    'Products': [
                        'string',
                    ],
                    'LastStatusCheckDate': 'string',
                    'StatusMessage': 'string',
                    'OwnerAccountId': 'string',
                    'IdentityProvider': {
                        'ActiveDirectoryIdentityProvider': {
                            'DirectoryId': 'string',
                            'ActiveDirectorySettings': {
                                'DomainName': 'string',
                                'DomainIpv4List': [
                                    'string',
                                ],
                                'DomainIpv6List': [
                                    'string',
                                ],
                                'DomainCredentialsProvider': {
                                    'SecretsManagerCredentialsProvider': {
                                        'SecretId': 'string'
                                    }
                                },
                                'DomainNetworkSettings': {
                                    'Subnets': [
                                        'string',
                                    ]
                                }
                            },
                            'ActiveDirectoryType': 'SELF_MANAGED'|'AWS_MANAGED',
                            'IsSharedActiveDirectory': True|False
                        }
                    }
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **InstanceSummaries** *(list) --* 

          An array of ``InstanceSummary`` resources that contain details about the instances that provide user-based subscriptions and also meet the request criteria.

          
          

          - *(dict) --* 

            Describes an EC2 instance providing user-based subscriptions.

            
            

            - **InstanceId** *(string) --* 

              The ID of the EC2 instance, which provides user-based subscriptions.

              
            

            - **Status** *(string) --* 

              The status of an EC2 instance resource.

              
            

            - **Products** *(list) --* 

              A list of provided user-based subscription products.

              
              

              - *(string) --* 
          
            

            - **LastStatusCheckDate** *(string) --* 

              The date of the last status check.

              
            

            - **StatusMessage** *(string) --* 

              The status message for an EC2 instance.

              
            

            - **OwnerAccountId** *(string) --* 

              The AWS Account ID of the owner of this resource.

              
            

            - **IdentityProvider** *(dict) --* 

              The ``IdentityProvider`` resource specifies details about the identity provider.

              .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``ActiveDirectoryIdentityProvider``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


            
              

              - **ActiveDirectoryIdentityProvider** *(dict) --* 

                The ``ActiveDirectoryIdentityProvider`` resource contains settings and other details about a specific Active Directory identity provider.

                
                

                - **DirectoryId** *(string) --* 

                  The directory ID for an Active Directory identity provider.

                  
                

                - **ActiveDirectorySettings** *(dict) --* 

                  The ``ActiveDirectorySettings`` resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.

                  
                  

                  - **DomainName** *(string) --* 

                    The domain name for the Active Directory.

                    
                  

                  - **DomainIpv4List** *(list) --* 

                    A list of domain IPv4 addresses that are used for the Active Directory.

                    
                    

                    - *(string) --* 
                
                  

                  - **DomainIpv6List** *(list) --* 

                    A list of domain IPv6 addresses that are used for the Active Directory.

                    
                    

                    - *(string) --* 
                
                  

                  - **DomainCredentialsProvider** *(dict) --* 

                    Points to the ``CredentialsProvider`` resource that contains information about the credential provider for user administration.

                    .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``SecretsManagerCredentialsProvider``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                                        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


                  
                    

                    - **SecretsManagerCredentialsProvider** *(dict) --* 

                      Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.

                      
                      

                      - **SecretId** *(string) --* 

                        The ID of the Secrets Manager secret that contains credentials.

                        
                  
                
                  

                  - **DomainNetworkSettings** *(dict) --* 

                    The ``DomainNetworkSettings`` resource contains an array of subnets that apply for the Active Directory.

                    
                    

                    - **Subnets** *(list) --* 

                      Contains a list of subnets that apply for the Active Directory domain.

                      
                      

                      - *(string) --* 
                  
                
              
                

                - **ActiveDirectoryType** *(string) --* 

                  The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.

                  
                

                - **IsSharedActiveDirectory** *(boolean) --* 

                  Whether this directory is shared from an Amazon Web Services Managed Active Directory. The default value is false.

                  
            
          
        
      
    