:doc:`WellArchitected <../../wellarchitected>` / Client / list_profiles

*************
list_profiles
*************



.. py:method:: WellArchitected.Client.list_profiles(**kwargs)

  

  List profiles.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListProfiles>`_  


  **Request Syntax**
  ::

    response = client.list_profiles(
        ProfileNamePrefix='string',
        ProfileOwnerType='SELF'|'SHARED',
        NextToken='string',
        MaxResults=123
    )
    
  :type ProfileNamePrefix: string
  :param ProfileNamePrefix: 

    An optional string added to the beginning of each profile name returned in the results.

    

  
  :type ProfileOwnerType: string
  :param ProfileOwnerType: 

    Profile owner type.

    

  
  :type NextToken: string
  :param NextToken: 

    The token to use to retrieve the next set of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return for this request.

    

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

    
    ::

      {
          'ProfileSummaries': [
              {
                  'ProfileArn': 'string',
                  'ProfileVersion': 'string',
                  'ProfileName': 'string',
                  'ProfileDescription': 'string',
                  'Owner': 'string',
                  'CreatedAt': datetime(2015, 1, 1),
                  'UpdatedAt': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ProfileSummaries** *(list) --* 

        Profile summaries.

        
        

        - *(dict) --* 

          Summary of a profile.

          
          

          - **ProfileArn** *(string) --* 

            The profile ARN.

            
          

          - **ProfileVersion** *(string) --* 

            The profile version.

            
          

          - **ProfileName** *(string) --* 

            The profile name.

            
          

          - **ProfileDescription** *(string) --* 

            The profile description.

            
          

          - **Owner** *(string) --* 

            An Amazon Web Services account ID.

            
          

          - **CreatedAt** *(datetime) --* 

            The date and time recorded.

            
          

          - **UpdatedAt** *(datetime) --* 

            The date and time recorded.

            
      
    
      

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

        The token to use to retrieve the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`WellArchitected.Client.exceptions.ValidationException`

  
  *   :py:class:`WellArchitected.Client.exceptions.InternalServerException`

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

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

  