aws-elixir

View Source AWS.VoiceID (aws-elixir v1.0.4)

Amazon Connect Voice ID provides real-time caller authentication and fraud risk detection, which make voice interactions in contact centers more secure and efficient.

Link to this section Summary

Functions

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

Associates the fraudsters with the watchlist specified in the same domain.

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

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

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

Creates a watchlist that fraudsters can be a part of.

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

Deletes the specified domain from Voice ID.

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

Deletes the specified fraudster from Voice ID.

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

Deletes the specified speaker from Voice ID.

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

Deletes the specified watchlist from Voice ID.

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

Describes the specified domain.

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

Describes the specified fraudster.

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

Describes the specified fraudster registration job.

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

Describes the specified speaker.

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

Describes the specified speaker enrollment job.

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

Describes the specified watchlist.

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

Disassociates the fraudsters from the watchlist specified.

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

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

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

Lists all the domains in the Amazon Web Services account.

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

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

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

Lists all fraudsters in a specified watchlist or domain.

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

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

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

Lists all speakers in a specified domain.

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

Lists all tags associated with a specified Voice ID resource.

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

Lists all watchlists in a specified domain.

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

Opts out a speaker from Voice ID.

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

Starts a new batch fraudster registration job using provided details.

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

Starts a new batch speaker enrollment job using specified details.

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

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

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

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

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

Updates the specified domain.

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

Updates the specified watchlist.

Link to this section Functions

Link to this function

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

View Source

Associates the fraudsters with the watchlist specified in the same domain.

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.

Every domain is created with a default watchlist that fraudsters can be a part of.

Link to this function

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

View Source

Creates a watchlist that fraudsters can be a part of.

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.

This action disassociates the fraudster from any watchlists it is a part of.

Link to this function

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

View Source

Deletes the specified speaker from Voice ID.

Link to this function

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

View Source

Deletes the specified watchlist from Voice ID.

This API throws an exception when there are fraudsters in the watchlist that you are trying to delete. You must delete the fraudsters, and then delete the watchlist. Every domain has a default watchlist which cannot be deleted.

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

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

View Source

Describes the specified watchlist.

Link to this function

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

View Source

Disassociates the fraudsters from the watchlist specified.

Voice ID always expects a fraudster to be a part of at least one watchlist. If you try to disassociate a fraudster from its only watchlist, a ValidationException is thrown.

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_fraudsters(client, input, options \\ [])

View Source

Lists all fraudsters in a specified watchlist or 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

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

View Source

Lists all watchlists in a specified domain.

Link to this function

metadata()

View Source
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.

Link to this function

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

View Source

Updates the specified watchlist.

Every domain has a default watchlist which cannot be updated.