:doc:`DataZone <../../datazone>` / Paginator / ListProjects

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



.. py:class:: DataZone.Paginator.ListProjects

  ::

    
    paginator = client.get_paginator('list_projects')

  
  

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

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

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListProjects>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          domainIdentifier='string',
          userIdentifier='string',
          groupIdentifier='string',
          name='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type domainIdentifier: string
    :param domainIdentifier: **[REQUIRED]** 

      The identifier of the Amazon DataZone domain.

      

    
    :type userIdentifier: string
    :param userIdentifier: 

      The identifier of the Amazon DataZone user.

      

    
    :type groupIdentifier: string
    :param groupIdentifier: 

      The identifier of a group.

      

    
    :type name: string
    :param name: 

      The name of the project.

      

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

      
      ::

        {
            'items': [
                {
                    'domainId': 'string',
                    'id': 'string',
                    'name': 'string',
                    'description': 'string',
                    'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'MOVING',
                    'failureReasons': [
                        {
                            'code': 'string',
                            'message': 'string'
                        },
                    ],
                    'createdBy': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1),
                    'domainUnitId': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          The results of the ``ListProjects`` action.

          
          

          - *(dict) --* 

            The details of a Amazon DataZone project.

            
            

            - **domainId** *(string) --* 

              The identifier of a Amazon DataZone domain where the project exists.

              
            

            - **id** *(string) --* 

              The identifier of a project.

              
            

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

              The name of a project.

              
            

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

              The description of a project.

              
            

            - **projectStatus** *(string) --* 

              The status of the project.

              
            

            - **failureReasons** *(list) --* 

              Specifies the error message that is returned if the operation cannot be successfully completed.

              
              

              - *(dict) --* 

                Specifies the error message that is returned if the operation cannot be successfully completed.

                
                

                - **code** *(string) --* 

                  The code of the project deletion error.

                  
                

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

                  The message of the project deletion error.

                  
            
          
            

            - **createdBy** *(string) --* 

              The Amazon DataZone user who created the project.

              
            

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

              The timestamp of when a project was created.

              
            

            - **updatedAt** *(datetime) --* 

              The timestamp of when the project was updated.

              
            

            - **domainUnitId** *(string) --* 

              The ID of the domain unit.

              
        
      
        

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

          A token to resume pagination.

          
    