:doc:`SSM <../../ssm>` / Paginator / DescribeInstanceProperties

**************************
DescribeInstanceProperties
**************************



.. py:class:: SSM.Paginator.DescribeInstanceProperties

  ::

    
    paginator = client.get_paginator('describe_instance_properties')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`SSM.Client.describe_instance_properties`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeInstanceProperties>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          InstancePropertyFilterList=[
              {
                  'key': 'InstanceIds'|'AgentVersion'|'PingStatus'|'PlatformTypes'|'DocumentName'|'ActivationIds'|'IamRole'|'ResourceType'|'AssociationStatus',
                  'valueSet': [
                      'string',
                  ]
              },
          ],
          FiltersWithOperator=[
              {
                  'Key': 'string',
                  'Values': [
                      'string',
                  ],
                  'Operator': 'Equal'|'NotEqual'|'BeginWith'|'LessThan'|'GreaterThan'
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type InstancePropertyFilterList: list
    :param InstancePropertyFilterList: 

      An array of instance property filters.

      

    
      - *(dict) --* 

        Describes a filter for a specific list of managed nodes. You can filter node information by using tags. You specify tags by using a key-value mapping.

        

      
        - **key** *(string) --* **[REQUIRED]** 

          The name of the filter.

          

        
        - **valueSet** *(list) --* **[REQUIRED]** 

          The filter values.

          

        
          - *(string) --* 

          
      
      
  
    :type FiltersWithOperator: list
    :param FiltersWithOperator: 

      The request filters to use with the operator.

      

    
      - *(dict) --* 

        The filters to describe or get information about your managed nodes.

        

      
        - **Key** *(string) --* **[REQUIRED]** 

          The filter key name to describe your managed nodes.

          

        
        - **Values** *(list) --* **[REQUIRED]** 

          The filter key name to describe your managed nodes.

          

        
          - *(string) --* 

          
      
        - **Operator** *(string) --* 

          The operator used by the filter call.

          

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

      
      ::

        {
            'InstanceProperties': [
                {
                    'Name': 'string',
                    'InstanceId': 'string',
                    'InstanceType': 'string',
                    'InstanceRole': 'string',
                    'KeyName': 'string',
                    'InstanceState': 'string',
                    'Architecture': 'string',
                    'IPAddress': 'string',
                    'LaunchTime': datetime(2015, 1, 1),
                    'PingStatus': 'Online'|'ConnectionLost'|'Inactive',
                    'LastPingDateTime': datetime(2015, 1, 1),
                    'AgentVersion': 'string',
                    'PlatformType': 'Windows'|'Linux'|'MacOS',
                    'PlatformName': 'string',
                    'PlatformVersion': 'string',
                    'ActivationId': 'string',
                    'IamRole': 'string',
                    'RegistrationDate': datetime(2015, 1, 1),
                    'ResourceType': 'string',
                    'ComputerName': 'string',
                    'AssociationStatus': 'string',
                    'LastAssociationExecutionDate': datetime(2015, 1, 1),
                    'LastSuccessfulAssociationExecutionDate': datetime(2015, 1, 1),
                    'AssociationOverview': {
                        'DetailedStatus': 'string',
                        'InstanceAssociationStatusAggregatedCount': {
                            'string': 123
                        }
                    },
                    'SourceId': 'string',
                    'SourceType': 'AWS::EC2::Instance'|'AWS::IoT::Thing'|'AWS::SSM::ManagedInstance'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **InstanceProperties** *(list) --* 

          Properties for the managed instances.

          
          

          - *(dict) --* 

            An object containing various properties of a managed node.

            
            

            - **Name** *(string) --* 

              The value of the EC2 ``Name`` tag associated with the node. If a ``Name`` tag hasn't been applied to the node, this value is blank.

              
            

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

              The ID of the managed node.

              
            

            - **InstanceType** *(string) --* 

              The instance type of the managed node. For example, t3.large.

              
            

            - **InstanceRole** *(string) --* 

              The instance profile attached to the node. If an instance profile isn't attached to the node, this value is blank.

              
            

            - **KeyName** *(string) --* 

              The name of the key pair associated with the node. If a key pair isnt't associated with the node, this value is blank.

              
            

            - **InstanceState** *(string) --* 

              The current state of the node.

              
            

            - **Architecture** *(string) --* 

              The CPU architecture of the node. For example, ``x86_64``.

              
            

            - **IPAddress** *(string) --* 

              The public IPv4 address assigned to the node. If a public IPv4 address isn't assigned to the node, this value is blank.

              
            

            - **LaunchTime** *(datetime) --* 

              The timestamp for when the node was launched.

              
            

            - **PingStatus** *(string) --* 

              Connection status of the SSM Agent on the managed node.

              
            

            - **LastPingDateTime** *(datetime) --* 

              The date and time when the SSM Agent last pinged the Systems Manager service.

              
            

            - **AgentVersion** *(string) --* 

              The version of SSM Agent running on your managed node.

              
            

            - **PlatformType** *(string) --* 

              The operating system platform type of the managed node. For example, Windows Server or Amazon Linux 2.

              
            

            - **PlatformName** *(string) --* 

              The name of the operating system platform running on your managed node.

              
            

            - **PlatformVersion** *(string) --* 

              The version of the OS platform running on your managed node.

              
            

            - **ActivationId** *(string) --* 

              The activation ID created by Systems Manager when the server or virtual machine (VM) was registered

              
            

            - **IamRole** *(string) --* 

              The IAM role used in the hybrid activation to register the node with Systems Manager.

              
            

            - **RegistrationDate** *(datetime) --* 

              The date the node was registered with Systems Manager.

              
            

            - **ResourceType** *(string) --* 

              The type of managed node.

              
            

            - **ComputerName** *(string) --* 

              The fully qualified host name of the managed node.

              
            

            - **AssociationStatus** *(string) --* 

              The status of the State Manager association applied to the managed node.

              
            

            - **LastAssociationExecutionDate** *(datetime) --* 

              The date the association was last run.

              
            

            - **LastSuccessfulAssociationExecutionDate** *(datetime) --* 

              The last date the association was successfully run.

              
            

            - **AssociationOverview** *(dict) --* 

              Status information about the aggregated associations.

              
              

              - **DetailedStatus** *(string) --* 

                Detailed status information about the aggregated associations.

                
              

              - **InstanceAssociationStatusAggregatedCount** *(dict) --* 

                The number of associations for the managed nodes.

                
                

                - *(string) --* 
                  

                  - *(integer) --* 
            
          
          
            

            - **SourceId** *(string) --* 

              The ID of the source resource.

              
            

            - **SourceType** *(string) --* 

              The type of the source resource.

              
        
      
    