:doc:`IoTSiteWise <../../iotsitewise>` / Paginator / ListGateways

************
ListGateways
************



.. py:class:: IoTSiteWise.Paginator.ListGateways

  ::

    
    paginator = client.get_paginator('list_gateways')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`IoTSiteWise.Client.list_gateways`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListGateways>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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**

      
      ::

        {
            'gatewaySummaries': [
                {
                    'gatewayId': 'string',
                    'gatewayName': 'string',
                    'gatewayPlatform': {
                        'greengrass': {
                            'groupArn': 'string'
                        },
                        'greengrassV2': {
                            'coreDeviceThingName': 'string',
                            'coreDeviceOperatingSystem': 'LINUX_AARCH64'|'LINUX_AMD64'|'WINDOWS_AMD64'
                        },
                        'siemensIE': {
                            'iotCoreThingName': 'string'
                        }
                    },
                    'gatewayVersion': 'string',
                    'gatewayCapabilitySummaries': [
                        {
                            'capabilityNamespace': 'string',
                            'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'|'UNKNOWN'|'NOT_APPLICABLE'
                        },
                    ],
                    'creationDate': datetime(2015, 1, 1),
                    'lastUpdateDate': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **gatewaySummaries** *(list) --* 

          A list that summarizes each gateway.

          
          

          - *(dict) --* 

            Contains a summary of a gateway.

            
            

            - **gatewayId** *(string) --* 

              The ID of the gateway device.

              
            

            - **gatewayName** *(string) --* 

              The name of the gateway.

              
            

            - **gatewayPlatform** *(dict) --* 

              The gateway's platform configuration. You can only specify one platform type in a gateway.

               

              (Legacy only) For Greengrass V1 gateways, specify the ``greengrass`` parameter with a valid Greengrass group ARN.

               

              For Greengrass V2 gateways, specify the ``greengrassV2`` parameter with a valid core device thing name. If creating a V3 gateway ( ``gatewayVersion=3``), you must also specify the ``coreDeviceOperatingSystem``.

               

              For Siemens Industrial Edge gateways, specify the ``siemensIE`` parameter with a valid IoT Core thing name.

              
              

              - **greengrass** *(dict) --* 

                A gateway that runs on IoT Greengrass.

                
                

                - **groupArn** *(string) --* 

                  The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of the Greengrass group. For more information about how to find a group's ARN, see `ListGroups <https://docs.aws.amazon.com/greengrass/v1/apireference/listgroups-get.html>`__ and `GetGroup <https://docs.aws.amazon.com/greengrass/v1/apireference/getgroup-get.html>`__ in the *IoT Greengrass V1 API Reference*.

                  
            
              

              - **greengrassV2** *(dict) --* 

                A gateway that runs on IoT Greengrass V2.

                
                

                - **coreDeviceThingName** *(string) --* 

                  The name of the IoT thing for your IoT Greengrass V2 core device.

                  
                

                - **coreDeviceOperatingSystem** *(string) --* 

                  The operating system of the core device in IoT Greengrass V2. Specifying the operating system is required for MQTT-enabled, V3 gateways ( ``gatewayVersion`` ``3``) and not applicable for Classic stream, V2 gateways ( ``gatewayVersion`` ``2``).

                  
            
              

              - **siemensIE** *(dict) --* 

                A SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.

                
                

                - **iotCoreThingName** *(string) --* 

                  The name of the IoT Thing for your SiteWise Edge gateway.

                  
            
          
            

            - **gatewayVersion** *(string) --* 

              The version of the gateway. A value of ``3`` indicates an MQTT-enabled, V3 gateway, while ``2`` indicates a Classic streams, V2 gateway.

              
            

            - **gatewayCapabilitySummaries** *(list) --* 

              A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use `DescribeGatewayCapabilityConfiguration <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html>`__.

              
              

              - *(dict) --* 

                Contains a summary of a gateway capability configuration.

                
                

                - **capabilityNamespace** *(string) --* 

                  The namespace of the capability configuration. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace ``iotsitewise:opcuacollector:3``.

                  
                

                - **capabilitySyncStatus** *(string) --* 

                  The synchronization status of the gateway capability configuration. The sync status can be one of the following:

                   

                  
                  * ``IN_SYNC`` - The gateway is running with the latest configuration.
                   
                  * ``OUT_OF_SYNC`` - The gateway hasn't received the latest configuration.
                   
                  * ``SYNC_FAILED`` - The gateway rejected the latest configuration.
                   
                  * ``UNKNOWN`` - The gateway hasn't reported its sync status.
                   
                  * ``NOT_APPLICABLE`` - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.
                  

                  
            
          
            

            - **creationDate** *(datetime) --* 

              The date the gateway was created, in Unix epoch time.

              
            

            - **lastUpdateDate** *(datetime) --* 

              The date the gateway was last updated, in Unix epoch time.

              
        
      
        

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

          A token to resume pagination.

          
    