VoiceID / Client / list_speakers

list_speakers#

VoiceID.Client.list_speakers(**kwargs)#

Lists all speakers in a specified domain.

Request Syntax

response = client.list_speakers(
    DomainId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

DomainId (string) –
[REQUIRED]

The identifier of the domain.
MaxResults (integer) – The maximum number of results that are returned per call. You can use NextToken to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.
NextToken (string) – If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'SpeakerSummaries': [
        {
            '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) –
- NextToken (string) –
  
  If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
- SpeakerSummaries (list) –
  
  A list containing details about each speaker in the Amazon Web Services account.
  - (dict) –
    
    Contains a summary of information about a speaker.
    - CreatedAt (datetime) –
      
      A timestamp showing the speaker’s creation time.
    - 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 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 showing the speaker’s last update.

Exceptions

VoiceID.Client.exceptions.ResourceNotFoundException
VoiceID.Client.exceptions.ValidationException
VoiceID.Client.exceptions.InternalServerException
VoiceID.Client.exceptions.ThrottlingException
VoiceID.Client.exceptions.AccessDeniedException