Module Smaws_Client_VoiceID

Voice ID client library built on EIO.

Types

module Types : sig ... end

Builders

val make_watchlist_summary : ?updated_at:Types.timestamp -> ?created_at:Types.timestamp -> ?default_watchlist:Types.boolean_ -> ?description:Types.watchlist_description -> ?name:Types.watchlist_name -> ?watchlist_id:Types.watchlist_id -> ?domain_id:Types.domain_id -> unit -> Types.watchlist_summary
val make_watchlist_details : default_watchlist_id:Types.watchlist_id -> unit -> Types.watchlist_details
val make_watchlist : ?updated_at:Types.timestamp -> ?created_at:Types.timestamp -> ?default_watchlist:Types.boolean_ -> ?description:Types.watchlist_description -> ?name:Types.watchlist_name -> ?watchlist_id:Types.watchlist_id -> ?domain_id:Types.domain_id -> unit -> Types.watchlist
val make_voice_spoofing_risk : risk_score:Types.score -> unit -> Types.voice_spoofing_risk
val make_update_watchlist_response : ?watchlist:Types.watchlist -> unit -> Types.update_watchlist_response
val make_update_watchlist_request : ?description:Types.watchlist_description -> ?name:Types.watchlist_name -> watchlist_id:Types.watchlist_id -> domain_id:Types.domain_id -> unit -> Types.update_watchlist_request
val make_untag_resource_response : unit -> unit
val make_untag_resource_request : tag_keys:Types.tag_key_list -> resource_arn:Types.amazon_resource_name -> unit -> Types.untag_resource_request
val make_tag_resource_response : unit -> unit
val make_tag : value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag
val make_tag_resource_request : tags:Types.tag_list -> resource_arn:Types.amazon_resource_name -> unit -> Types.tag_resource_request
val make_enrollment_job_fraud_detection_config : ?watchlist_ids:Types.enrollment_job_fraud_detection_config_watchlist_ids -> ?risk_threshold:Types.score -> ?fraud_detection_action:Types.fraud_detection_action -> unit -> Types.enrollment_job_fraud_detection_config
val make_enrollment_config : ?fraud_detection_config:Types.enrollment_job_fraud_detection_config -> ?existing_enrollment_action:Types.existing_enrollment_action -> unit -> Types.enrollment_config
val make_input_data_config : s3_uri:Types.s3_uri -> unit -> Types.input_data_config
val make_output_data_config : ?kms_key_id:Types.kms_key_id -> s3_uri:Types.s3_uri -> unit -> Types.output_data_config
val make_failure_details : ?message:Types.string_ -> ?status_code:Types.integer -> unit -> Types.failure_details
val make_job_progress : ?percent_complete:Types.score -> unit -> Types.job_progress
val make_speaker_enrollment_job : ?job_progress:Types.job_progress -> ?failure_details:Types.failure_details -> ?ended_at:Types.timestamp -> ?created_at:Types.timestamp -> ?output_data_config:Types.output_data_config -> ?input_data_config:Types.input_data_config -> ?enrollment_config:Types.enrollment_config -> ?data_access_role_arn:Types.iam_role_arn -> ?domain_id:Types.domain_id -> ?job_status:Types.speaker_enrollment_job_status -> ?job_id:Types.job_id -> ?job_name:Types.job_name -> unit -> Types.speaker_enrollment_job
val make_start_speaker_enrollment_job_response : ?job:Types.speaker_enrollment_job -> unit -> Types.start_speaker_enrollment_job_response
val make_start_speaker_enrollment_job_request : ?enrollment_config:Types.enrollment_config -> ?job_name:Types.job_name -> ?client_token:Types.client_token_string -> output_data_config:Types.output_data_config -> input_data_config:Types.input_data_config -> data_access_role_arn:Types.iam_role_arn -> domain_id:Types.domain_id -> unit -> Types.start_speaker_enrollment_job_request
val make_registration_config : ?watchlist_ids:Types.registration_config_watchlist_ids -> ?fraudster_similarity_threshold:Types.score -> ?duplicate_registration_action:Types.duplicate_registration_action -> unit -> Types.registration_config
val make_fraudster_registration_job : ?job_progress:Types.job_progress -> ?failure_details:Types.failure_details -> ?ended_at:Types.timestamp -> ?created_at:Types.timestamp -> ?output_data_config:Types.output_data_config -> ?input_data_config:Types.input_data_config -> ?registration_config:Types.registration_config -> ?data_access_role_arn:Types.iam_role_arn -> ?domain_id:Types.domain_id -> ?job_status:Types.fraudster_registration_job_status -> ?job_id:Types.job_id -> ?job_name:Types.job_name -> unit -> Types.fraudster_registration_job
val make_start_fraudster_registration_job_response : ?job:Types.fraudster_registration_job -> unit -> Types.start_fraudster_registration_job_response
val make_start_fraudster_registration_job_request : ?registration_config:Types.registration_config -> ?job_name:Types.job_name -> ?client_token:Types.client_token_string -> output_data_config:Types.output_data_config -> input_data_config:Types.input_data_config -> data_access_role_arn:Types.iam_role_arn -> domain_id:Types.domain_id -> unit -> Types.start_fraudster_registration_job_request
val make_speaker : ?last_accessed_at:Types.timestamp -> ?updated_at:Types.timestamp -> ?created_at:Types.timestamp -> ?status:Types.speaker_status -> ?generated_speaker_id:Types.generated_speaker_id -> ?customer_speaker_id:Types.customer_speaker_id -> ?domain_id:Types.domain_id -> unit -> Types.speaker
val make_opt_out_speaker_response : ?speaker:Types.speaker -> unit -> Types.opt_out_speaker_response
val make_opt_out_speaker_request : speaker_id:Types.speaker_id -> domain_id:Types.domain_id -> unit -> Types.opt_out_speaker_request
val make_list_watchlists_response : ?next_token:Types.string_ -> ?watchlist_summaries:Types.watchlist_summaries -> unit -> Types.list_watchlists_response
val make_list_watchlists_request : ?next_token:Types.next_token -> ?max_results:Types.max_results_for_list -> domain_id:Types.domain_id -> unit -> Types.list_watchlists_request
val make_list_tags_for_resource_response : ?tags:Types.tag_list -> unit -> Types.list_tags_for_resource_response
val make_list_tags_for_resource_request : resource_arn:Types.amazon_resource_name -> unit -> Types.list_tags_for_resource_request
val make_speaker_summary : ?last_accessed_at:Types.timestamp -> ?updated_at:Types.timestamp -> ?created_at:Types.timestamp -> ?status:Types.speaker_status -> ?generated_speaker_id:Types.generated_speaker_id -> ?customer_speaker_id:Types.customer_speaker_id -> ?domain_id:Types.domain_id -> unit -> Types.speaker_summary
val make_list_speakers_response : ?next_token:Types.string_ -> ?speaker_summaries:Types.speaker_summaries -> unit -> Types.list_speakers_response
val make_list_speakers_request : ?next_token:Types.next_token -> ?max_results:Types.max_results_for_list -> domain_id:Types.domain_id -> unit -> Types.list_speakers_request
val make_speaker_enrollment_job_summary : ?job_progress:Types.job_progress -> ?failure_details:Types.failure_details -> ?ended_at:Types.timestamp -> ?created_at:Types.timestamp -> ?domain_id:Types.domain_id -> ?job_status:Types.speaker_enrollment_job_status -> ?job_id:Types.job_id -> ?job_name:Types.job_name -> unit -> Types.speaker_enrollment_job_summary
val make_list_speaker_enrollment_jobs_response : ?next_token:Types.string_ -> ?job_summaries:Types.speaker_enrollment_job_summaries -> unit -> Types.list_speaker_enrollment_jobs_response
val make_list_speaker_enrollment_jobs_request : ?next_token:Types.next_token -> ?max_results:Types.max_results_for_list -> ?job_status:Types.speaker_enrollment_job_status -> domain_id:Types.domain_id -> unit -> Types.list_speaker_enrollment_jobs_request
val make_fraudster_summary : ?watchlist_ids:Types.response_watchlist_ids -> ?created_at:Types.timestamp -> ?generated_fraudster_id:Types.generated_fraudster_id -> ?domain_id:Types.domain_id -> unit -> Types.fraudster_summary
val make_list_fraudsters_response : ?next_token:Types.string_ -> ?fraudster_summaries:Types.fraudster_summaries -> unit -> Types.list_fraudsters_response
val make_list_fraudsters_request : ?next_token:Types.next_token -> ?max_results:Types.max_results_for_list -> ?watchlist_id:Types.watchlist_id -> domain_id:Types.domain_id -> unit -> Types.list_fraudsters_request
val make_fraudster_registration_job_summary : ?job_progress:Types.job_progress -> ?failure_details:Types.failure_details -> ?ended_at:Types.timestamp -> ?created_at:Types.timestamp -> ?domain_id:Types.domain_id -> ?job_status:Types.fraudster_registration_job_status -> ?job_id:Types.job_id -> ?job_name:Types.job_name -> unit -> Types.fraudster_registration_job_summary
val make_list_fraudster_registration_jobs_response : ?next_token:Types.string_ -> ?job_summaries:Types.fraudster_registration_job_summaries -> unit -> Types.list_fraudster_registration_jobs_response
val make_list_fraudster_registration_jobs_request : ?next_token:Types.next_token -> ?max_results:Types.max_results_for_list -> ?job_status:Types.fraudster_registration_job_status -> domain_id:Types.domain_id -> unit -> Types.list_fraudster_registration_jobs_request
val make_authentication_configuration : acceptance_threshold:Types.score -> unit -> Types.authentication_configuration
val make_fraud_detection_configuration : ?watchlist_id:Types.watchlist_id -> ?risk_threshold:Types.score -> unit -> Types.fraud_detection_configuration
val make_known_fraudster_risk : ?generated_fraudster_id:Types.generated_fraudster_id -> risk_score:Types.score -> unit -> Types.known_fraudster_risk
val make_fraud_risk_details : voice_spoofing_risk:Types.voice_spoofing_risk -> known_fraudster_risk:Types.known_fraudster_risk -> unit -> Types.fraud_risk_details
val make_evaluate_session_response : ?fraud_detection_result:Types.fraud_detection_result -> ?authentication_result:Types.authentication_result -> ?streaming_status:Types.streaming_status -> ?session_name:Types.session_name -> ?session_id:Types.session_id -> ?domain_id:Types.domain_id -> unit -> Types.evaluate_session_response
val make_evaluate_session_request : session_name_or_id:Types.session_name_or_id -> domain_id:Types.domain_id -> unit -> Types.evaluate_session_request
val make_fraudster : ?watchlist_ids:Types.response_watchlist_ids -> ?created_at:Types.timestamp -> ?generated_fraudster_id:Types.generated_fraudster_id -> ?domain_id:Types.domain_id -> unit -> Types.fraudster
val make_disassociate_fraudster_response : ?fraudster:Types.fraudster -> unit -> Types.disassociate_fraudster_response
val make_disassociate_fraudster_request : fraudster_id:Types.fraudster_id -> watchlist_id:Types.watchlist_id -> domain_id:Types.domain_id -> unit -> Types.disassociate_fraudster_request
val make_describe_watchlist_response : ?watchlist:Types.watchlist -> unit -> Types.describe_watchlist_response
val make_describe_watchlist_request : watchlist_id:Types.watchlist_id -> domain_id:Types.domain_id -> unit -> Types.describe_watchlist_request
val make_describe_speaker_enrollment_job_response : ?job:Types.speaker_enrollment_job -> unit -> Types.describe_speaker_enrollment_job_response
val make_describe_speaker_enrollment_job_request : job_id:Types.job_id -> domain_id:Types.domain_id -> unit -> Types.describe_speaker_enrollment_job_request
val make_describe_speaker_response : ?speaker:Types.speaker -> unit -> Types.describe_speaker_response
val make_describe_speaker_request : speaker_id:Types.speaker_id -> domain_id:Types.domain_id -> unit -> Types.describe_speaker_request
val make_describe_fraudster_registration_job_response : ?job:Types.fraudster_registration_job -> unit -> Types.describe_fraudster_registration_job_response
val make_describe_fraudster_registration_job_request : job_id:Types.job_id -> domain_id:Types.domain_id -> unit -> Types.describe_fraudster_registration_job_request
val make_describe_fraudster_response : ?fraudster:Types.fraudster -> unit -> Types.describe_fraudster_response
val make_describe_fraudster_request : fraudster_id:Types.fraudster_id -> domain_id:Types.domain_id -> unit -> Types.describe_fraudster_request
val make_delete_watchlist_request : watchlist_id:Types.watchlist_id -> domain_id:Types.domain_id -> unit -> Types.delete_watchlist_request
val make_delete_speaker_request : speaker_id:Types.speaker_id -> domain_id:Types.domain_id -> unit -> Types.delete_speaker_request
val make_delete_fraudster_request : fraudster_id:Types.fraudster_id -> domain_id:Types.domain_id -> unit -> Types.delete_fraudster_request
val make_create_watchlist_response : ?watchlist:Types.watchlist -> unit -> Types.create_watchlist_response
val make_create_watchlist_request : ?client_token:Types.client_token_string -> ?description:Types.watchlist_description -> name:Types.watchlist_name -> domain_id:Types.domain_id -> unit -> Types.create_watchlist_request
val make_associate_fraudster_response : ?fraudster:Types.fraudster -> unit -> Types.associate_fraudster_response
val make_associate_fraudster_request : fraudster_id:Types.fraudster_id -> watchlist_id:Types.watchlist_id -> domain_id:Types.domain_id -> unit -> Types.associate_fraudster_request
val make_server_side_encryption_configuration : kms_key_id:Types.kms_key_id -> unit -> Types.server_side_encryption_configuration
val make_server_side_encryption_update_details : ?message:Types.string_ -> ?update_status:Types.server_side_encryption_update_status -> ?old_kms_key_id:Types.kms_key_id -> unit -> Types.server_side_encryption_update_details
val make_domain : ?watchlist_details:Types.watchlist_details -> ?server_side_encryption_update_details: Types.server_side_encryption_update_details -> ?updated_at:Types.timestamp -> ?created_at:Types.timestamp -> ?server_side_encryption_configuration: Types.server_side_encryption_configuration -> ?domain_status:Types.domain_status -> ?description:Types.description -> ?name:Types.domain_name -> ?arn:Types.arn -> ?domain_id:Types.domain_id -> unit -> Types.domain
val make_update_domain_response : ?domain:Types.domain -> unit -> Types.update_domain_response
val make_update_domain_request : ?description:Types.description -> server_side_encryption_configuration: Types.server_side_encryption_configuration -> name:Types.domain_name -> domain_id:Types.domain_id -> unit -> Types.update_domain_request
val make_domain_summary : ?watchlist_details:Types.watchlist_details -> ?server_side_encryption_update_details: Types.server_side_encryption_update_details -> ?updated_at:Types.timestamp -> ?created_at:Types.timestamp -> ?server_side_encryption_configuration: Types.server_side_encryption_configuration -> ?domain_status:Types.domain_status -> ?description:Types.description -> ?name:Types.domain_name -> ?arn:Types.arn -> ?domain_id:Types.domain_id -> unit -> Types.domain_summary
val make_list_domains_response : ?next_token:Types.string_ -> ?domain_summaries:Types.domain_summaries -> unit -> Types.list_domains_response
val make_list_domains_request : ?next_token:Types.next_token -> ?max_results:Types.max_results_for_list_domain_fe -> unit -> Types.list_domains_request
val make_describe_domain_response : ?domain:Types.domain -> unit -> Types.describe_domain_response
val make_describe_domain_request : domain_id:Types.domain_id -> unit -> Types.describe_domain_request
val make_delete_domain_request : domain_id:Types.domain_id -> unit -> Types.delete_domain_request
val make_create_domain_response : ?domain:Types.domain -> unit -> Types.create_domain_response
val make_create_domain_request : ?tags:Types.tag_list -> ?client_token:Types.client_token_string -> ?description:Types.description -> server_side_encryption_configuration: Types.server_side_encryption_configuration -> name:Types.domain_name -> unit -> Types.create_domain_request

Operations

module CreateDomain : sig ... end

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.

module DeleteDomain : sig ... end

Deletes the specified domain from Voice ID.

module DescribeDomain : sig ... end

Describes the specified domain.

module ListDomains : sig ... end

Lists all the domains in the Amazon Web Services account.

module UpdateDomain : sig ... end

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.

module AssociateFraudster : sig ... end

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

module CreateWatchlist : sig ... end

Creates a watchlist that fraudsters can be a part of.

module DeleteFraudster : sig ... end

Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.

module DeleteSpeaker : sig ... end

Deletes the specified speaker from Voice ID.

module DeleteWatchlist : sig ... end

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.

module DescribeFraudster : sig ... end

Describes the specified fraudster.

Describes the specified fraudster registration job.

module DescribeSpeaker : sig ... end

Describes the specified speaker.

module DescribeSpeakerEnrollmentJob : sig ... end

Describes the specified speaker enrollment job.

module DescribeWatchlist : sig ... end

Describes the specified watchlist.

module DisassociateFraudster : sig ... end

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.

module EvaluateSession : sig ... end

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

module ListFraudsterRegistrationJobs : sig ... end

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.

module ListFraudsters : sig ... end

Lists all fraudsters in a specified watchlist or domain.

module ListSpeakerEnrollmentJobs : sig ... end

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.

module ListSpeakers : sig ... end

Lists all speakers in a specified domain.

module ListTagsForResource : sig ... end

Lists all tags associated with a specified Voice ID resource.

module ListWatchlists : sig ... end

Lists all watchlists in a specified domain.

module OptOutSpeaker : sig ... end

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.

module StartFraudsterRegistrationJob : sig ... end

Starts a new batch fraudster registration job using provided details.

module StartSpeakerEnrollmentJob : sig ... end

Starts a new batch speaker enrollment job using specified details.

module TagResource : sig ... end

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

module UntagResource : sig ... end

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

module UpdateWatchlist : sig ... end
module Json_serializers : sig ... end
module Json_deserializers : sig ... end