:doc:`DataZone <../../datazone>` / Client / list_projects

*************
list_projects
*************



.. py:method:: DataZone.Client.list_projects(**kwargs)

  

  Lists Amazon DataZone projects.

  

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


  **Request Syntax**
  ::

    response = client.list_projects(
        domainIdentifier='string',
        userIdentifier='string',
        groupIdentifier='string',
        name='string',
        nextToken='string',
        maxResults=123
    )
    
  :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 nextToken: string
  :param nextToken: 

    When the number of projects is greater than the default value for the ``MaxResults`` parameter, or if you explicitly specify a value for ``MaxResults`` that is less than the number of projects, the response includes a pagination token named ``NextToken``. You can specify this ``NextToken`` value in a subsequent call to ``ListProjects`` to list the next set of projects.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of projects to return in a single call to ``ListProjects``. When the number of projects to be listed is greater than the value of ``MaxResults``, the response contains a ``NextToken`` value that you can use in a subsequent call to ``ListProjects`` to list the next set of projects.

    

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

        When the number of projects is greater than the default value for the ``MaxResults`` parameter, or if you explicitly specify a value for ``MaxResults`` that is less than the number of projects, the response includes a pagination token named ``NextToken``. You can specify this ``NextToken`` value in a subsequent call to ``ListProjects`` to list the next set of projects.

        
  
  **Exceptions**
  
  *   :py:class:`DataZone.Client.exceptions.InternalServerException`

  
  *   :py:class:`DataZone.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DataZone.Client.exceptions.ThrottlingException`

  
  *   :py:class:`DataZone.Client.exceptions.ValidationException`

  
  *   :py:class:`DataZone.Client.exceptions.UnauthorizedException`

  