:doc:`DeviceFarm <../../devicefarm>` / Paginator / ListSuites

**********
ListSuites
**********



.. py:class:: DeviceFarm.Paginator.ListSuites

  ::

    
    paginator = client.get_paginator('list_suites')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DeviceFarm.Client.list_suites`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/ListSuites>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          arn='string',
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': 'string'
          }
      )
      
    :type arn: string
    :param arn: **[REQUIRED]** 

      The job's Amazon Resource Name (ARN).

      

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

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'suites': [
                {
                    'arn': 'string',
                    'name': 'string',
                    'type': 'BUILTIN_FUZZ'|'APPIUM_JAVA_JUNIT'|'APPIUM_JAVA_TESTNG'|'APPIUM_PYTHON'|'APPIUM_NODE'|'APPIUM_RUBY'|'APPIUM_WEB_JAVA_JUNIT'|'APPIUM_WEB_JAVA_TESTNG'|'APPIUM_WEB_PYTHON'|'APPIUM_WEB_NODE'|'APPIUM_WEB_RUBY'|'INSTRUMENTATION'|'XCTEST'|'XCTEST_UI',
                    'created': datetime(2015, 1, 1),
                    'status': 'PENDING'|'PENDING_CONCURRENCY'|'PENDING_DEVICE'|'PROCESSING'|'SCHEDULING'|'PREPARING'|'RUNNING'|'COMPLETED'|'STOPPING',
                    'result': 'PENDING'|'PASSED'|'WARNED'|'FAILED'|'SKIPPED'|'ERRORED'|'STOPPED',
                    'started': datetime(2015, 1, 1),
                    'stopped': datetime(2015, 1, 1),
                    'counters': {
                        'total': 123,
                        'passed': 123,
                        'failed': 123,
                        'warned': 123,
                        'errored': 123,
                        'stopped': 123,
                        'skipped': 123
                    },
                    'message': 'string',
                    'deviceMinutes': {
                        'total': 123.0,
                        'metered': 123.0,
                        'unmetered': 123.0
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Represents the result of a list suites request.

        
        

        - **suites** *(list) --* 

          Information about the suites.

          
          

          - *(dict) --* 

            Represents a collection of one or more tests.

            
            

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

              The suite's ARN.

              
            

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

              The suite's name.

              
            

            - **type** *(string) --* 

              The suite's type.

               

              Must be one of the following values:

               

              
              * BUILTIN_FUZZ
               
              * APPIUM_JAVA_JUNIT
               
              * APPIUM_JAVA_TESTNG
               
              * APPIUM_PYTHON
               
              * APPIUM_NODE
               
              * APPIUM_RUBY
               
              * APPIUM_WEB_JAVA_JUNIT
               
              * APPIUM_WEB_JAVA_TESTNG
               
              * APPIUM_WEB_PYTHON
               
              * APPIUM_WEB_NODE
               
              * APPIUM_WEB_RUBY
               
              * INSTRUMENTATION
               
              * XCTEST
               
              * XCTEST_UI
              

              
            

            - **created** *(datetime) --* 

              When the suite was created.

              
            

            - **status** *(string) --* 

              The suite's status.

               

              Allowed values include:

               

              
              * PENDING
               
              * PENDING_CONCURRENCY
               
              * PENDING_DEVICE
               
              * PROCESSING
               
              * SCHEDULING
               
              * PREPARING
               
              * RUNNING
               
              * COMPLETED
               
              * STOPPING
              

              
            

            - **result** *(string) --* 

              The suite's result.

               

              Allowed values include:

               

              
              * PENDING
               
              * PASSED
               
              * WARNED
               
              * FAILED
               
              * SKIPPED
               
              * ERRORED
               
              * STOPPED
              

              
            

            - **started** *(datetime) --* 

              The suite's start time.

              
            

            - **stopped** *(datetime) --* 

              The suite's stop time.

              
            

            - **counters** *(dict) --* 

              The suite's result counters.

              
              

              - **total** *(integer) --* 

                The total number of entities.

                
              

              - **passed** *(integer) --* 

                The number of passed entities.

                
              

              - **failed** *(integer) --* 

                The number of failed entities.

                
              

              - **warned** *(integer) --* 

                The number of warned entities.

                
              

              - **errored** *(integer) --* 

                The number of errored entities.

                
              

              - **stopped** *(integer) --* 

                The number of stopped entities.

                
              

              - **skipped** *(integer) --* 

                The number of skipped entities.

                
          
            

            - **message** *(string) --* 

              A message about the suite's result.

              
            

            - **deviceMinutes** *(dict) --* 

              Represents the total (metered or unmetered) minutes used by the test suite.

              
              

              - **total** *(float) --* 

                When specified, represents the total minutes used by the resource to run tests.

                
              

              - **metered** *(float) --* 

                When specified, represents only the sum of metered minutes used by the resource to run tests.

                
              

              - **unmetered** *(float) --* 

                When specified, represents only the sum of unmetered minutes used by the resource to run tests.

                
          
        
      
        

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

          A token to resume pagination.

          
    