:doc:`ChimeSDKVoice <../../chime-sdk-voice>` / Client / list_voice_profiles

*******************
list_voice_profiles
*******************



.. py:method:: ChimeSDKVoice.Client.list_voice_profiles(**kwargs)

  

  Lists the voice profiles in a voice profile domain.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceProfiles>`_  


  **Request Syntax**
  ::

    response = client.list_voice_profiles(
        VoiceProfileDomainId='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type VoiceProfileDomainId: string
  :param VoiceProfileDomainId: **[REQUIRED]** 

    The ID of the voice profile domain.

    

  
  :type NextToken: string
  :param NextToken: 

    The token used to retrieve the next page of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results in the request.

    

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

    
    ::

      {
          'VoiceProfiles': [
              {
                  'VoiceProfileId': 'string',
                  'VoiceProfileArn': 'string',
                  'VoiceProfileDomainId': 'string',
                  'CreatedTimestamp': datetime(2015, 1, 1),
                  'UpdatedTimestamp': datetime(2015, 1, 1),
                  'ExpirationTimestamp': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **VoiceProfiles** *(list) --* 

        The list of voice profiles.

        
        

        - *(dict) --* 

          A high-level summary of a voice profile.

          
          

          - **VoiceProfileId** *(string) --* 

            The ID of the voice profile in a voice profile summary.

            
          

          - **VoiceProfileArn** *(string) --* 

            The ARN of the voice profile in a voice profile summary.

            
          

          - **VoiceProfileDomainId** *(string) --* 

            The ID of the voice profile domain in a voice profile summary.

            
          

          - **CreatedTimestamp** *(datetime) --* 

            The time at which a voice profile summary was created.

            
          

          - **UpdatedTimestamp** *(datetime) --* 

            The time at which a voice profile summary was last updated.

            
          

          - **ExpirationTimestamp** *(datetime) --* 

            Extends the life of the voice profile. You can use ``UpdateVoiceProfile`` to refresh an existing voice profile's voice print and extend the life of the summary.

            
      
    
      

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

        The token used to retrieve the next page of results.

        
  
  **Exceptions**
  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.NotFoundException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.UnauthorizedClientException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ForbiddenException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.BadRequestException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ThrottledClientException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ServiceFailureException`

  