:doc:`VoiceID <../../voice-id>` / Client / describe_speaker

****************
describe_speaker
****************



.. py:method:: VoiceID.Client.describe_speaker(**kwargs)

  

  Describes the specified speaker.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeSpeaker>`_  


  **Request Syntax**
  ::

    response = client.describe_speaker(
        DomainId='string',
        SpeakerId='string'
    )
    
  :type DomainId: string
  :param DomainId: **[REQUIRED]** 

    The identifier of the domain that contains the speaker.

    

  
  :type SpeakerId: string
  :param SpeakerId: **[REQUIRED]** 

    The identifier of the speaker you are describing.

    

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

    
    ::

      {
          'Speaker': {
              'CreatedAt': datetime(2015, 1, 1),
              'CustomerSpeakerId': 'string',
              'DomainId': 'string',
              'GeneratedSpeakerId': 'string',
              'LastAccessedAt': datetime(2015, 1, 1),
              'Status': 'ENROLLED'|'EXPIRED'|'OPTED_OUT'|'PENDING',
              'UpdatedAt': datetime(2015, 1, 1)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Speaker** *(dict) --* 

        Information about the specified speaker.

        
        

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

          A timestamp of when the speaker was created.

          
        

        - **CustomerSpeakerId** *(string) --* 

          The client-provided identifier for the speaker.

          
        

        - **DomainId** *(string) --* 

          The identifier of the domain that contains the speaker.

          
        

        - **GeneratedSpeakerId** *(string) --* 

          The service-generated identifier for the speaker.

          
        

        - **LastAccessedAt** *(datetime) --* 

          The timestamp of when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.

          
        

        - **Status** *(string) --* 

          The current status of the speaker.

          
        

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

          A timestamp of the speaker's last update.

          
    
  
  **Exceptions**
  
  *   :py:class:`VoiceID.Client.exceptions.ResourceNotFoundException`

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

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

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

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

  