VoiceID / Client / describe_speaker

describe_speaker#

VoiceID.Client.describe_speaker(**kwargs)#

Describes the specified speaker.

See also: AWS API Documentation

Request Syntax

response = client.describe_speaker(
    DomainId='string',
    SpeakerId='string'
)
Parameters:
  • DomainId (string) –

    [REQUIRED]

    The identifier of the domain that contains the speaker.

  • SpeakerId (string) –

    [REQUIRED]

    The identifier of the speaker you are describing.

Return type:

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