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

************
ListProjects
************



.. py:class:: DeviceFarm.Paginator.ListProjects

  ::

    
    paginator = client.get_paginator('list_projects')

  
  

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

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

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


    **Request Syntax**
    ::

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

      Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project 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**

      
      ::

        {
            'projects': [
                {
                    'arn': 'string',
                    'name': 'string',
                    'defaultJobTimeoutMinutes': 123,
                    'created': datetime(2015, 1, 1),
                    'vpcConfig': {
                        'securityGroupIds': [
                            'string',
                        ],
                        'subnetIds': [
                            'string',
                        ],
                        'vpcId': 'string'
                    },
                    'environmentVariables': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'executionRoleArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Represents the result of a list projects request.

        
        

        - **projects** *(list) --* 

          Information about the projects.

          
          

          - *(dict) --* 

            Represents an operating-system neutral workspace for running and managing tests.

            
            

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

              The project's ARN.

              
            

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

              The project's name.

              
            

            - **defaultJobTimeoutMinutes** *(integer) --* 

              The default number of minutes (at the project level) a test run executes before it times out. The default value is 150 minutes.

              
            

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

              When the project was created.

              
            

            - **vpcConfig** *(dict) --* 

              The VPC security groups and subnets that are attached to a project.

              
              

              - **securityGroupIds** *(list) --* 

                An array of one or more security groups IDs in your Amazon VPC.

                
                

                - *(string) --* 
            
              

              - **subnetIds** *(list) --* 

                An array of one or more subnet IDs in your Amazon VPC.

                
                

                - *(string) --* 
            
              

              - **vpcId** *(string) --* 

                The ID of the Amazon VPC.

                
          
            

            - **environmentVariables** *(list) --* 

              Environment variables associated with the project.

              
              

              - *(dict) --* 

                Information about an environment variable for a project or a run.

                
                

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

                  The name of the environment variable.

                  
                

                - **value** *(string) --* 

                  The value of the environment variable.

                  
            
          
            

            - **executionRoleArn** *(string) --* 

              The IAM execution role associated with the project.

              
        
      
        

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

          A token to resume pagination.

          
    