Smaws_Client_VoiceID.Typestype nonrec watchlist_summary = {updated_at : timestamp option;The timestamp of when the watchlist was last updated.
*)created_at : timestamp option;The timestamp of when the watchlist was created.
*)default_watchlist : boolean_ option;Whether the specified watchlist is the default watchlist of a domain.
*)description : watchlist_description option;The description of the watchlist.
*)name : watchlist_name option;The name for the watchlist.
*)watchlist_id : watchlist_id option;The identifier of the watchlist.
*)domain_id : domain_id option;The identifier of the domain that contains the watchlist.
*)}Contains a summary of information about a watchlist.
type nonrec watchlist_summaries = watchlist_summary listtype nonrec watchlist_details = {default_watchlist_id : watchlist_id;The identifier of the default watchlist.
*)}Details of the watchlists in a domain.
type nonrec watchlist = {updated_at : timestamp option;The timestamp of when the watchlist was updated.
*)created_at : timestamp option;The timestamp of when the watchlist was created.
*)default_watchlist : boolean_ option;Whether the specified watchlist is the default watchlist of a domain.
*)description : watchlist_description option;The description of the watchlist.
*)name : watchlist_name option;The name for the watchlist.
*)watchlist_id : watchlist_id option;The identifier of the watchlist.
*)domain_id : domain_id option;The identifier of the domain that contains the watchlist.
*)}Contains all the information about a watchlist.
type nonrec voice_spoofing_risk = {risk_score : score;The score indicating the likelihood of speaker’s voice being spoofed.
*)}The details resulting from 'Voice Spoofing Risk' analysis of the speaker.
The request failed one or more validations; check the error message for more details.
The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
type nonrec resource_not_found_exception = {resource_type : resource_type option;The type of resource which cannot not be found. Possible types are BATCH_JOB, COMPLIANCE_CONSENT, DOMAIN, FRAUDSTER, SESSION and SPEAKER.
message : string_ option;}The specified resource cannot be found. Check the ResourceType and error message for more details.
The request failed due to an unknown error on the server side.
type nonrec conflict_exception = {conflict_type : conflict_type option;The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:
DOMAIN_NOT_ACTIVE: The domain is not active.CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT: You cannot change the speaker ID after an enrollment has been requested.ENROLLMENT_ALREADY_EXISTS: There is already an enrollment for this session.SPEAKER_NOT_SET: You must set the speaker ID before requesting an enrollment.SPEAKER_OPTED_OUT: You cannot request an enrollment for an opted out speaker.CONCURRENT_CHANGES: The request could not be processed as the resource was modified by another request during execution.message : string_ option;}The request failed due to a conflict. Check the ConflictType and error message for more details.
You do not have sufficient permissions to perform this action. Check the error message and try again.
type nonrec update_watchlist_response = {watchlist : watchlist option;Details about the updated watchlist.
*)}type nonrec update_watchlist_request = {description : watchlist_description option;A brief description about this watchlist.
*)name : watchlist_name option;The name of the watchlist.
*)watchlist_id : watchlist_id;The identifier of the watchlist to be updated.
*)domain_id : domain_id;The identifier of the domain that contains the watchlist.
*)}type nonrec tag_key_list = tag_key listtype nonrec untag_resource_request = {tag_keys : tag_key_list;The list of tag keys you want to remove from the specified resource.
*)resource_arn : amazon_resource_name;The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags from.
*)}type nonrec tag = {value : tag_value;The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag 'Department':'Sales', the value is 'Sales'.
*)key : tag_key;The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag 'Department':'Sales', the key is 'Department'.
*)}The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
type nonrec tag_list = tag listtype nonrec tag_resource_request = {resource_arn : amazon_resource_name;The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.
*)}The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
type nonrec enrollment_job_fraud_detection_config_watchlist_ids =
watchlist_id listtype nonrec enrollment_job_fraud_detection_config = {watchlist_ids : enrollment_job_fraud_detection_config_watchlist_ids option;The identifier of watchlists against which fraud detection is performed.
*)risk_threshold : score option;Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.
*)fraud_detection_action : fraud_detection_action option;The action to take when the given speaker is flagged by the fraud detection system. The default value is FAIL, which fails the speaker enrollment. Changing this value to IGNORE results in the speaker being enrolled even if they are flagged by the fraud detection system.
}The fraud detection configuration to be used during the batch speaker enrollment job.
type nonrec enrollment_config = {fraud_detection_config : enrollment_job_fraud_detection_config option;The fraud detection configuration to use for the speaker enrollment job.
*)existing_enrollment_action : existing_enrollment_action option;The action to take when the specified speaker is already enrolled in the specified domain. The default value is SKIP, which skips the enrollment for the existing speaker. Setting the value to OVERWRITE replaces the existing voice prints and enrollment audio stored for that speaker with new data generated from the latest audio.
}Contains configurations defining enrollment behavior for the batch job.
type nonrec input_data_config = {s3_uri : s3_uri;The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.
*)}The configuration containing input file information for a batch job.
type nonrec output_data_config = {kms_key_id : kms_key_id option;The identifier of the KMS key you want Voice ID to use to encrypt the output file of a speaker enrollment job/fraudster registration job.
*)s3_uri : s3_uri;The S3 path of the folder where Voice ID writes the job output file. It has a *.out extension. For example, if the input file name is input-file.json and the output folder path is s3://output-bucket/output-folder, the full output file path is s3://output-bucket/output-folder/job-Id/input-file.json.out.
}The configuration containing output file information for a batch job.
type nonrec failure_details = {message : string_ option;A description of the error that caused the batch job failure.
*)status_code : integer option;An HTTP status code representing the nature of the error.
*)}Contains error details for a failed batch job.
type nonrec job_progress = {percent_complete : score option;Shows the completed percentage of enrollment or registration requests listed in the input file.
*)}Indicates the completion progress for a batch job.
type nonrec speaker_enrollment_job = {job_progress : job_progress option;Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.
*)failure_details : failure_details option;Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.
ended_at : timestamp option;A timestamp of when the speaker enrollment job ended.
*)created_at : timestamp option;A timestamp of when the speaker enrollment job was created.
*)output_data_config : output_data_config option;The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.
*)input_data_config : input_data_config option;The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
*)enrollment_config : enrollment_config option;The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.
data_access_role_arn : iam_role_arn option;The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file.
*)domain_id : domain_id option;The identifier of the domain that contains the speaker enrollment job.
*)job_status : speaker_enrollment_job_status option;The current status of the speaker enrollment job.
*)job_id : job_id option;The service-generated identifier for the speaker enrollment job.
*)job_name : job_name option;The client-provided name for the speaker enrollment job.
*)}Contains all the information about a speaker enrollment job.
type nonrec start_speaker_enrollment_job_response = {job : speaker_enrollment_job option;Details about the started speaker enrollment job.
*)}type nonrec start_speaker_enrollment_job_request = {output_data_config : output_data_config;The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.
*)input_data_config : input_data_config;The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.
*)enrollment_config : enrollment_config option;The enrollment config that contains details such as the action to take when a speaker is already enrolled in Voice ID or when a speaker is identified as a fraudster.
*)data_access_role_arn : iam_role_arn;The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file. Refer to Batch enrollment using audio data from prior calls for the permissions needed in this role.
*)domain_id : domain_id;The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.
*)job_name : job_name option;A name for your speaker enrollment job.
*)client_token : client_token_string option;A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
*)}type nonrec registration_config_watchlist_ids = watchlist_id listtype nonrec registration_config = {watchlist_ids : registration_config_watchlist_ids option;The identifiers of watchlists that a fraudster is registered to. If a watchlist isn't provided, the fraudsters are registered to the default watchlist.
*)fraudster_similarity_threshold : score option;The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.
*)duplicate_registration_action : duplicate_registration_action option;The action to take when a fraudster is identified as a duplicate. The default action is SKIP, which skips registering the duplicate fraudster. Setting the value to REGISTER_AS_NEW always registers a new fraudster into the specified domain.
}The registration configuration to be used during the batch fraudster registration job.
type nonrec fraudster_registration_job = {job_progress : job_progress option;Shows the completed percentage of registration requests listed in the input file.
*)failure_details : failure_details option;Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.
ended_at : timestamp option;A timestamp of when the fraudster registration job ended.
*)created_at : timestamp option;A timestamp of when the fraudster registration job was created.
*)output_data_config : output_data_config option;The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS key ID in order to encrypt the file.
*)input_data_config : input_data_config option;The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration job requests.
*)registration_config : registration_config option;The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.
*)data_access_role_arn : iam_role_arn option;The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file.
*)domain_id : domain_id option;The identifier of the domain that contains the fraudster registration job.
*)job_status : fraudster_registration_job_status option;The current status of the fraudster registration job.
*)job_id : job_id option;The service-generated identifier for the fraudster registration job.
*)job_name : job_name option;The client-provided name for the fraudster registration job.
*)}Contains all the information about a fraudster registration job.
type nonrec start_fraudster_registration_job_response = {job : fraudster_registration_job option;Details about the started fraudster registration job.
*)}type nonrec start_fraudster_registration_job_request = {output_data_config : output_data_config;The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.
*)input_data_config : input_data_config;The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration requests.
*)registration_config : registration_config option;The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.
*)data_access_role_arn : iam_role_arn;The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the Job output file. Refer to the Create and edit a fraudster watchlist documentation for the permissions needed in this role.
*)domain_id : domain_id;The identifier of the domain that contains the fraudster registration job and in which the fraudsters are registered.
*)job_name : job_name option;The name of the new fraudster registration job.
*)client_token : client_token_string option;A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
*)}type nonrec speaker = {last_accessed_at : timestamp option;The timestamp of when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.
*)updated_at : timestamp option;A timestamp of the speaker's last update.
*)created_at : timestamp option;A timestamp of when the speaker was created.
*)status : speaker_status option;The current status of the speaker.
*)generated_speaker_id : generated_speaker_id option;The service-generated identifier for the speaker.
*)customer_speaker_id : customer_speaker_id option;The client-provided identifier for the speaker.
*)domain_id : domain_id option;The identifier of the domain that contains the speaker.
*)}Contains all the information about a speaker.
type nonrec opt_out_speaker_response = {speaker : speaker option;Details about the opted-out speaker.
*)}type nonrec opt_out_speaker_request = {speaker_id : speaker_id;The identifier of the speaker you want opted-out.
*)domain_id : domain_id;The identifier of the domain that contains the speaker.
*)}type nonrec list_watchlists_response = {next_token : string_ option;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.
watchlist_summaries : watchlist_summaries option;A list that contains details about each watchlist in the Amazon Web Services account.
*)}type nonrec list_watchlists_request = {next_token : next_token option;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.
max_results : max_results_for_list option;The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.
domain_id : domain_id;The identifier of the domain.
*)}type nonrec speaker_summary = {last_accessed_at : timestamp option;The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.
*)updated_at : timestamp option;A timestamp showing the speaker's last update.
*)created_at : timestamp option;A timestamp showing the speaker's creation time.
*)status : speaker_status option;The current status of the speaker.
*)generated_speaker_id : generated_speaker_id option;The service-generated identifier for the speaker.
*)customer_speaker_id : customer_speaker_id option;The client-provided identifier for the speaker.
*)domain_id : domain_id option;The identifier of the domain that contains the speaker.
*)}Contains a summary of information about a speaker.
type nonrec speaker_summaries = speaker_summary listtype nonrec list_speakers_response = {next_token : string_ option;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.
speaker_summaries : speaker_summaries option;A list containing details about each speaker in the Amazon Web Services account.
*)}type nonrec list_speakers_request = {next_token : next_token option;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.
max_results : max_results_for_list option;The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.
domain_id : domain_id;The identifier of the domain.
*)}type nonrec speaker_enrollment_job_summary = {job_progress : job_progress option;Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.
*)failure_details : failure_details option;Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.
ended_at : timestamp option;A timestamp of when the speaker enrollment job ended.
*)created_at : timestamp option;A timestamp of when of the speaker enrollment job was created.
*)domain_id : domain_id option;The identifier of the domain that contains the speaker enrollment job.
*)job_status : speaker_enrollment_job_status option;The current status of the speaker enrollment job.
*)job_id : job_id option;The service-generated identifier for the speaker enrollment job.
*)job_name : job_name option;The client-provided name for the speaker enrollment job.
*)}Contains a summary of information about a speaker enrollment job.
type nonrec speaker_enrollment_job_summaries =
speaker_enrollment_job_summary listtype nonrec list_speaker_enrollment_jobs_response = {next_token : string_ option;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.
job_summaries : speaker_enrollment_job_summaries option;A list containing details about each specified speaker enrollment job.
*)}type nonrec list_speaker_enrollment_jobs_request = {next_token : next_token option;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.
max_results : max_results_for_list option;The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.
job_status : speaker_enrollment_job_status option;Provides the status of your speaker enrollment Job.
*)domain_id : domain_id;The identifier of the domain that contains the speaker enrollment jobs.
*)}type nonrec response_watchlist_ids = watchlist_id listtype nonrec fraudster_summary = {watchlist_ids : response_watchlist_ids option;The identifier of the watchlists the fraudster is a part of.
*)created_at : timestamp option;The timestamp of when the fraudster summary was created.
*)generated_fraudster_id : generated_fraudster_id option;The service-generated identifier for the fraudster.
*)domain_id : domain_id option;The identifier of the domain that contains the fraudster summary.
*)}Contains a summary of information about a fraudster.
type nonrec fraudster_summaries = fraudster_summary listtype nonrec list_fraudsters_response = {next_token : string_ option;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.
fraudster_summaries : fraudster_summaries option;A list that contains details about each fraudster in the Amazon Web Services account.
*)}type nonrec list_fraudsters_request = {next_token : next_token option;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.
max_results : max_results_for_list option;The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.
watchlist_id : watchlist_id option;The identifier of the watchlist. If provided, all fraudsters in the watchlist are listed. If not provided, all fraudsters in the domain are listed.
*)domain_id : domain_id;The identifier of the domain.
*)}type nonrec fraudster_registration_job_summary = {job_progress : job_progress option;Shows the completed percentage of registration requests listed in the input file.
*)failure_details : failure_details option;Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.
ended_at : timestamp option;A timestamp of when the fraudster registration job ended.
*)created_at : timestamp option;A timestamp of when the fraudster registration job was created.
*)domain_id : domain_id option;The identifier of the domain that contains the fraudster registration job.
*)job_status : fraudster_registration_job_status option;The current status of the fraudster registration job.
*)job_id : job_id option;The service-generated identifier for the fraudster registration job.
*)job_name : job_name option;The client-provided name for the fraudster registration job.
*)}Contains a summary of information about a fraudster registration job.
type nonrec fraudster_registration_job_summaries =
fraudster_registration_job_summary listtype nonrec list_fraudster_registration_jobs_response = {next_token : string_ option;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.
job_summaries : fraudster_registration_job_summaries option;A list containing details about each specified fraudster registration job.
*)}type nonrec list_fraudster_registration_jobs_request = {next_token : next_token option;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.
max_results : max_results_for_list option;The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.
job_status : fraudster_registration_job_status option;Provides the status of your fraudster registration job.
*)domain_id : domain_id;The identifier of the domain that contains the fraudster registration Jobs.
*)}type nonrec authentication_configuration = {acceptance_threshold : score;The minimum threshold needed to successfully authenticate a speaker.
*)}The configuration used to authenticate a speaker during a session.
type nonrec authentication_result = {configuration : authentication_configuration option;The AuthenticationConfiguration used to generate this authentication result.
score : score option;The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either ACCEPT or REJECT.
decision : authentication_decision option;The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
*)generated_speaker_id : generated_speaker_id option;The service-generated identifier for the speaker whose authentication result is produced.
*)customer_speaker_id : customer_speaker_id option;The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId is provided for the session.
audio_aggregation_ended_at : timestamp option;A timestamp of when audio aggregation ended for this authentication result.
*)audio_aggregation_started_at : timestamp option;A timestamp of when audio aggregation started for this authentication result.
*)authentication_result_id : unique_id_large option;The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, AcceptanceThreshold changes, or SpeakerId changes, Voice ID always returns cached Authentication Result for this API.
}The authentication result produced by Voice ID, processed against the current session state and streamed audio of the speaker.
type nonrec fraud_detection_configuration = {watchlist_id : watchlist_id option;The identifier of the watchlist against which fraud detection is performed.
*)risk_threshold : score option;Threshold value for determining whether the speaker is a fraudster. If the detected risk score calculated by Voice ID is higher than the threshold, the speaker is considered a fraudster.
*)}The configuration used for performing fraud detection over a speaker during a session.
type nonrec fraud_detection_reasons = fraud_detection_reason listtype nonrec known_fraudster_risk = {generated_fraudster_id : generated_fraudster_id option;The identifier of the fraudster that is the closest match to the speaker. If there are no fraudsters registered in a given domain, or if there are no fraudsters with a non-zero RiskScore, this value is null.
risk_score : score;The score indicating the likelihood the speaker is a known fraudster.
*)}Contains details produced as a result of performing known fraudster risk analysis on a speaker.
type nonrec fraud_risk_details = {voice_spoofing_risk : voice_spoofing_risk;The details resulting from 'Voice Spoofing Risk' analysis of the speaker.
*)known_fraudster_risk : known_fraudster_risk;The details resulting from 'Known Fraudster Risk' analysis of the speaker.
*)}Details regarding various fraud risk analyses performed against the current session state and streamed audio of the speaker.
type nonrec fraud_detection_result = {risk_details : fraud_risk_details option;Details about each risk analyzed for this speaker. Currently, this contains KnownFraudsterRisk and VoiceSpoofingRisk details.
*)reasons : fraud_detection_reasons option;The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is HIGH_RISK, and the following possible values: KNOWN_FRAUDSTER and VOICE_SPOOFING.
decision : fraud_detection_decision option;The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
*)configuration : fraud_detection_configuration option;The FraudDetectionConfiguration used to generate this fraud detection result.
audio_aggregation_ended_at : timestamp option;A timestamp of when audio aggregation ended for this fraud detection result.
*)audio_aggregation_started_at : timestamp option;A timestamp of when audio aggregation started for this fraud detection result.
*)fraud_detection_result_id : unique_id_large option;The unique identifier for this fraud detection result. Given there can be multiple fraud detections for a given session, this field helps in identifying if the returned result is from previous streaming activity or a new result. Note that in the absence of any new streaming activity or risk threshold changes, Voice ID always returns cached Fraud Detection result for this API.
*)}The fraud detection result produced by Voice ID, processed against the current session state and streamed audio of the speaker.
type nonrec evaluate_session_response = {fraud_detection_result : fraud_detection_result option;Details resulting from the fraud detection process, such as fraud detection decision and risk score.
*)authentication_result : authentication_result option;Details resulting from the authentication process, such as authentication decision and authentication score.
*)streaming_status : streaming_status option;The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.
session_name : session_name option;The client-provided name of the session.
*)session_id : session_id option;The service-generated identifier of the session.
*)domain_id : domain_id option;The identifier of the domain that contains the session.
*)}type nonrec evaluate_session_request = {session_name_or_id : session_name_or_id;The session identifier, or name of the session, that you want to evaluate. In Voice ID integration, this is the Contact-Id.
*)domain_id : domain_id;The identifier of the domain where the session started.
*)}type nonrec fraudster = {watchlist_ids : response_watchlist_ids option;The identifier of the watchlists the fraudster is a part of.
*)created_at : timestamp option;The timestamp of when Voice ID identified the fraudster.
*)generated_fraudster_id : generated_fraudster_id option;The service-generated identifier for the fraudster.
*)domain_id : domain_id option;The identifier of the domain that contains the fraudster.
*)}Contains all the information about a fraudster.
type nonrec disassociate_fraudster_request = {fraudster_id : fraudster_id;The identifier of the fraudster to be disassociated from the watchlist.
*)watchlist_id : watchlist_id;The identifier of the watchlist that you want to disassociate from the fraudster.
*)domain_id : domain_id;The identifier of the domain that contains the fraudster.
*)}type nonrec describe_watchlist_response = {watchlist : watchlist option;Information about the specified watchlist.
*)}type nonrec describe_watchlist_request = {watchlist_id : watchlist_id;The identifier of the watchlist that you are describing.
*)domain_id : domain_id;The identifier of the domain that contains the watchlist.
*)}type nonrec describe_speaker_enrollment_job_response = {job : speaker_enrollment_job option;Contains details about the specified speaker enrollment job.
*)}type nonrec describe_speaker_response = {speaker : speaker option;Information about the specified speaker.
*)}type nonrec describe_speaker_request = {speaker_id : speaker_id;The identifier of the speaker you are describing.
*)domain_id : domain_id;The identifier of the domain that contains the speaker.
*)}type nonrec describe_fraudster_registration_job_response = {job : fraudster_registration_job option;Contains details about the specified fraudster registration job.
*)}type nonrec describe_fraudster_response = {fraudster : fraudster option;Information about the specified fraudster.
*)}type nonrec describe_fraudster_request = {fraudster_id : fraudster_id;The identifier of the fraudster you are describing.
*)domain_id : domain_id;The identifier of the domain that contains the fraudster.
*)}type nonrec delete_watchlist_request = {watchlist_id : watchlist_id;The identifier of the watchlist to be deleted.
*)domain_id : domain_id;The identifier of the domain that contains the watchlist.
*)}type nonrec delete_speaker_request = {speaker_id : speaker_id;The identifier of the speaker you want to delete.
*)domain_id : domain_id;The identifier of the domain that contains the speaker.
*)}type nonrec delete_fraudster_request = {fraudster_id : fraudster_id;The identifier of the fraudster you want to delete.
*)domain_id : domain_id;The identifier of the domain that contains the fraudster.
*)}type nonrec create_watchlist_response = {watchlist : watchlist option;Information about the newly created watchlist.
*)}type nonrec create_watchlist_request = {client_token : client_token_string option;A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
*)description : watchlist_description option;A brief description of this watchlist.
*)name : watchlist_name;The name of the watchlist.
*)domain_id : domain_id;The identifier of the domain that contains the watchlist.
*)}type nonrec associate_fraudster_request = {fraudster_id : fraudster_id;The identifier of the fraudster to be associated with the watchlist.
*)watchlist_id : watchlist_id;The identifier of the watchlist you want to associate with the fraudster.
*)domain_id : domain_id;The identifier of the domain that contains the fraudster.
*)}type nonrec server_side_encryption_configuration = {kms_key_id : kms_key_id;The identifier of the KMS key to use to encrypt data stored by Voice ID. Voice ID doesn't support asymmetric customer managed keys.
*)}The configuration containing information about the customer managed key used for encrypting customer data.
type nonrec server_side_encryption_update_details = {message : string_ option;Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains the cause of the failure.
*)update_status : server_side_encryption_update_status option;Status of the server-side encryption update. During an update, if there is an issue with the domain's current or old KMS key ID, such as an inaccessible or disabled key, then the status is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call with the existing server-side encryption configuration will re-attempt this update process.
*)old_kms_key_id : kms_key_id option;The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration was updated to a new KMS key ID.
*)}Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain’s data can only be accessed using the new KMS key.
type nonrec domain = {watchlist_details : watchlist_details option;The watchlist details of a domain. Contains the default watchlist ID of the domain.
*)server_side_encryption_update_details : server_side_encryption_update_details
option;Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.
*)updated_at : timestamp option;The timestamp of when the domain was last update.
*)created_at : timestamp option;The timestamp of when the domain was created.
*)server_side_encryption_configuration : server_side_encryption_configuration
option;The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.
*)domain_status : domain_status option;The current status of the domain.
*)description : description option;The description of the domain.
*)name : domain_name option;The name for the domain.
*)arn : arn option;The Amazon Resource Name (ARN) for the domain.
*)domain_id : domain_id option;The identifier of the domain.
*)}Contains all the information about a domain.
type nonrec update_domain_request = {server_side_encryption_configuration : server_side_encryption_configuration;The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Changing the domain's associated KMS key immediately triggers an asynchronous process to remove dependency on the old KMS key, such that the domain's data can only be accessed using the new KMS key. The domain's ServerSideEncryptionUpdateDetails contains the details for this process.
description : description option;A brief description about this domain.
*)name : domain_name;The name of the domain.
*)domain_id : domain_id;The identifier of the domain to be updated.
*)}type nonrec domain_summary = {watchlist_details : watchlist_details option;Provides information about watchlistDetails and DefaultWatchlistID.
server_side_encryption_update_details : server_side_encryption_update_details
option;Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.
*)updated_at : timestamp option;The timestamp of when the domain was last updated.
*)created_at : timestamp option;The timestamp of when the domain was created.
*)server_side_encryption_configuration : server_side_encryption_configuration
option;The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.
*)domain_status : domain_status option;The current status of the domain.
*)description : description option;The description of the domain.
*)name : domain_name option;The client-provided name for the domain.
*)arn : arn option;The Amazon Resource Name (ARN) for the domain.
*)domain_id : domain_id option;The identifier of the domain.
*)}Contains a summary of information about a domain.
type nonrec domain_summaries = domain_summary listtype nonrec list_domains_response = {next_token : string_ option;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.
domain_summaries : domain_summaries option;A list containing details about each domain in the Amazon Web Services account.
*)}type nonrec list_domains_request = {next_token : next_token option;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.
max_results : max_results_for_list_domain_fe option;The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.
}type nonrec domain_resource = Smaws_Lib.CoreTypes.Resource.ttype nonrec describe_domain_response = {domain : domain option;Information about the specified domain.
*)}type nonrec describe_domain_request = {domain_id : domain_id;The identifier of the domain that you are describing.
*)}type nonrec delete_domain_request = {domain_id : domain_id;The identifier of the domain you want to delete.
*)}type nonrec create_domain_response = {domain : domain option;Information about the newly created domain.
*)}type nonrec create_domain_request = {client_token : client_token_string option;A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
*)server_side_encryption_configuration : server_side_encryption_configuration;The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Refer to Amazon Connect Voice ID encryption at rest for more details on how the KMS key is used.
*)description : description option;A brief description of this domain.
*)name : domain_name;The name of the domain.
*)}