:doc:`IoT <../../iot>` / Paginator / ListCommands

************
ListCommands
************



.. py:class:: IoT.Paginator.ListCommands

  ::

    
    paginator = client.get_paginator('list_commands')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`IoT.Client.list_commands`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/ListCommands>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          namespace='AWS-IoT'|'AWS-IoT-FleetWise',
          commandParameterName='string',
          sortOrder='ASCENDING'|'DESCENDING',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type namespace: string
    :param namespace: 

      The namespace of the command. By default, the API returns all commands that have been created for both ``AWS-IoT`` and ``AWS-IoT-FleetWise`` namespaces. You can override this default value if you want to return all commands that have been created only for a specific namespace.

      

    
    :type commandParameterName: string
    :param commandParameterName: 

      A filter that can be used to display the list of commands that have a specific command parameter name.

      

    
    :type sortOrder: string
    :param sortOrder: 

      Specify whether to list the commands that you have created in the ascending or descending order. By default, the API returns all commands in the descending order based on the time that they were created.

      

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

      
      ::

        {
            'commands': [
                {
                    'commandArn': 'string',
                    'commandId': 'string',
                    'displayName': 'string',
                    'deprecated': True|False,
                    'createdAt': datetime(2015, 1, 1),
                    'lastUpdatedAt': datetime(2015, 1, 1),
                    'pendingDeletion': True|False
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **commands** *(list) --* 

          The list of commands.

          
          

          - *(dict) --* 

            Summary information about a particular command resource.

            
            

            - **commandArn** *(string) --* 

              The Amazon Resource Name (ARN) of the command.

              
            

            - **commandId** *(string) --* 

              The unique identifier of the command.

              
            

            - **displayName** *(string) --* 

              The display name of the command.

              
            

            - **deprecated** *(boolean) --* 

              Indicates whether the command has been deprecated.

              
            

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

              The timestamp, when the command was created.

              
            

            - **lastUpdatedAt** *(datetime) --* 

              The timestamp, when the command was last updated.

              
            

            - **pendingDeletion** *(boolean) --* 

              Indicates whether the command is pending deletion.

              
        
      
        

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

          A token to resume pagination.

          
    