View Source AWS.VoiceID (aws-elixir v0.13.1)

Amazon Connect Voice ID provides real-time caller authentication and fraud screening.

This guide describes the APIs used for this service.

Link to this section Summary

Functions

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.

Deletes the specified domain from Voice ID.

Deletes the specified fraudster from Voice ID.

Deletes the specified speaker from Voice ID.

Describes the specified domain.

Describes the specified fraudster.

Describes the specified fraudster registration job.

Describes the specified speaker.

Describes the specified speaker enrollment job.

Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.

Lists all the domains in the Amazon Web Services account.

Lists all the fraudster registration jobs in the domain with the given JobStatus.

Lists all the speaker enrollment jobs in the domain with the specified JobStatus.

Lists all speakers in a specified domain.

Lists all tags associated with a specified Voice ID resource.

Opts out a speaker from Voice ID.

Starts a new batch fraudster registration job using provided details.

Starts a new batch speaker enrollment job using specified details.

Tags a Voice ID resource with the provided list of tags.

Removes specified tags from a specified Amazon Connect Voice ID resource.

Updates the specified domain.

Link to this section Functions

Link to this function

create_domain(client, input, options \\ [])

View Source

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.

Link to this function

delete_domain(client, input, options \\ [])

View Source

Deletes the specified domain from Voice ID.

Link to this function

delete_fraudster(client, input, options \\ [])

View Source

Deletes the specified fraudster from Voice ID.

Link to this function

delete_speaker(client, input, options \\ [])

View Source

Deletes the specified speaker from Voice ID.

Link to this function

describe_domain(client, input, options \\ [])

View Source

Describes the specified domain.

Link to this function

describe_fraudster(client, input, options \\ [])

View Source

Describes the specified fraudster.

Link to this function

describe_fraudster_registration_job(client, input, options \\ [])

View Source

Describes the specified fraudster registration job.

Link to this function

describe_speaker(client, input, options \\ [])

View Source

Describes the specified speaker.

Link to this function

describe_speaker_enrollment_job(client, input, options \\ [])

View Source

Describes the specified speaker enrollment job.

Link to this function

evaluate_session(client, input, options \\ [])

View Source

Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.

Link to this function

list_domains(client, input, options \\ [])

View Source

Lists all the domains in the Amazon Web Services account.

Link to this function

list_fraudster_registration_jobs(client, input, options \\ [])

View Source

Lists all the fraudster registration jobs in the domain with the given JobStatus.

If JobStatus is not provided, this lists all fraudster registration jobs in the given domain.

Link to this function

list_speaker_enrollment_jobs(client, input, options \\ [])

View Source

Lists all the speaker enrollment jobs in the domain with the specified JobStatus.

If JobStatus is not provided, this lists all jobs with all possible speaker enrollment job statuses.

Link to this function

list_speakers(client, input, options \\ [])

View Source

Lists all speakers in a specified domain.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists all tags associated with a specified Voice ID resource.

Link to this function

opt_out_speaker(client, input, options \\ [])

View Source

Opts out a speaker from Voice ID.

A speaker can be opted out regardless of whether or not they already exist in Voice ID. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in Voice ID.

Link to this function

start_fraudster_registration_job(client, input, options \\ [])

View Source

Starts a new batch fraudster registration job using provided details.

Link to this function

start_speaker_enrollment_job(client, input, options \\ [])

View Source

Starts a new batch speaker enrollment job using specified details.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Tags a Voice ID resource with the provided list of tags.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes specified tags from a specified Amazon Connect Voice ID resource.

Link to this function

update_domain(client, input, options \\ [])

View Source

Updates the specified domain.

This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.