:doc:`GreengrassV2 <../../greengrassv2>` / Paginator / ListComponents

**************
ListComponents
**************



.. py:class:: GreengrassV2.Paginator.ListComponents

  ::

    
    paginator = client.get_paginator('list_components')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`GreengrassV2.Client.list_components`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/ListComponents>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          scope='PRIVATE'|'PUBLIC',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type scope: string
    :param scope: 

      The scope of the components to list.

       

      Default: ``PRIVATE``

      

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

      
      ::

        {
            'components': [
                {
                    'arn': 'string',
                    'componentName': 'string',
                    'latestVersion': {
                        'arn': 'string',
                        'componentVersion': 'string',
                        'creationTimestamp': datetime(2015, 1, 1),
                        'description': 'string',
                        'publisher': 'string',
                        'platforms': [
                            {
                                'name': 'string',
                                'attributes': {
                                    'string': 'string'
                                }
                            },
                        ]
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **components** *(list) --* 

          A list that summarizes each component.

          
          

          - *(dict) --* 

            Contains information about a component.

            
            

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

              The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of the component version.

              
            

            - **componentName** *(string) --* 

              The name of the component.

              
            

            - **latestVersion** *(dict) --* 

              The latest version of the component and its details.

              
              

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

                The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of the component version.

                
              

              - **componentVersion** *(string) --* 

                The version of the component.

                
              

              - **creationTimestamp** *(datetime) --* 

                The time at which the component was created, expressed in ISO 8601 format.

                
              

              - **description** *(string) --* 

                The description of the component version.

                
              

              - **publisher** *(string) --* 

                The publisher of the component version.

                
              

              - **platforms** *(list) --* 

                The platforms that the component version supports.

                
                

                - *(dict) --* 

                  Contains information about a platform that a component supports.

                  
                  

                  - **name** *(string) --* 

                    The friendly name of the platform. This name helps you identify the platform.

                     

                    If you omit this parameter, IoT Greengrass creates a friendly name from the ``os`` and ``architecture`` of the platform.

                    
                  

                  - **attributes** *(dict) --* 

                    A dictionary of attributes for the platform. The IoT Greengrass Core software defines the ``os`` and ``architecture`` by default. You can specify additional platform attributes for a core device when you deploy the Greengrass nucleus component. For more information, see the `Greengrass nucleus component <https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html>`__ in the *IoT Greengrass V2 Developer Guide*.

                    
                    

                    - *(string) --* 
                      

                      - *(string) --* 
                
              
              
            
          
        
      
        

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

          A token to resume pagination.

          
    