Integer acceptanceThreshold
The minimum threshold needed to successfully authenticate a speaker.
Date audioAggregationEndedAt
A timestamp indicating when audio aggregation ended for this authentication result.
Date audioAggregationStartedAt
A timestamp indicating when audio aggregation started for this authentication result.
String authenticationResultId
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.
AuthenticationConfiguration configuration
The AuthenticationConfiguration used to generate this authentication result.
String customerSpeakerId
The client-provided identifier for the speaker whose authentication result is produced. Only present if a
SpeakerId is provided for the session.
String decision
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
String generatedSpeakerId
The service-generated identifier for the speaker whose authentication result is produced.
Integer score
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.
String conflictType
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.
String clientToken
The idempotency token for creating a new domain. If not provided, Amazon Web Services SDK populates this field.
String description
A brief description of the domain.
String name
The name of the domain.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
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.
List<E> tags
A list of tags you want added to the domain.
Domain domain
Information about the newly created domain.
String domainId
The identifier of the domain you want to delete.
String domainId
The identifier of the domain you are describing.
Domain domain
Information about the specified domain.
FraudsterRegistrationJob job
Contains details about the specified fraudster registration job.
Fraudster fraudster
Information about the specified fraudster.
SpeakerEnrollmentJob job
Contains details about the specified speaker enrollment job.
Speaker speaker
Information about the specified speaker.
String arn
The Amazon Resource Name (ARN) for the domain.
Date createdAt
The timestamp at which the domain is created.
String description
The client-provided description of the domain.
String domainId
The service-generated identifier for the domain.
String domainStatus
The current status of the domain.
String name
The client-provided name for the domain.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.
ServerSideEncryptionUpdateDetails serverSideEncryptionUpdateDetails
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.
Date updatedAt
The timestamp showing the domain's last update.
String arn
The Amazon Resource Name (ARN) for the domain.
Date createdAt
The timestamp showing when the domain is created.
String description
The client-provided description of the domain.
String domainId
The service-generated identifier for the domain.
String domainStatus
The current status of the domain.
String name
The client-provided name for the domain.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.
ServerSideEncryptionUpdateDetails serverSideEncryptionUpdateDetails
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.
Date updatedAt
The timestamp showing the domain's last update.
String existingEnrollmentAction
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.
EnrollmentJobFraudDetectionConfig fraudDetectionConfig
The fraud detection configuration to use for the speaker enrollment job.
String fraudDetectionAction
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.
Integer riskThreshold
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.
AuthenticationResult authenticationResult
Details resulting from the authentication process, such as authentication decision and authentication score.
String domainId
The identifier of the domain containing the session.
FraudDetectionResult fraudDetectionResult
Details resulting from the fraud detection process, such as fraud detection decision and risk score.
String sessionId
The service-generated identifier of the session.
String sessionName
The client-provided name of the session.
String streamingStatus
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.
Integer riskThreshold
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.
Date audioAggregationEndedAt
A timestamp indicating when audio aggregation ended for this fraud detection result.
Date audioAggregationStartedAt
A timestamp indicating when audio aggregation started for this fraud detection result.
FraudDetectionConfiguration configuration
The FraudDetectionConfiguration used to generate this fraud detection result.
String decision
The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
String fraudDetectionResultId
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.
List<E> reasons
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.
FraudRiskDetails riskDetails
Details about each risk analyzed for this speaker. Currently, this contains KnownFraudsterRisk and VoiceSpoofingRisk details.
KnownFraudsterRisk knownFraudsterRisk
The details resulting from 'Known Fraudster Risk' analysis of the speaker.
VoiceSpoofingRisk voiceSpoofingRisk
The details resulting from 'Voice Spoofing Risk' analysis of the speaker.
Date createdAt
A timestamp showing the creation time of the fraudster registration job.
String dataAccessRoleArn
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.
String domainId
The identifier of the domain containing the fraudster registration job.
Date endedAt
A timestamp showing when the fraudster registration job ended.
FailureDetails failureDetails
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.
InputDataConfig inputDataConfig
The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration job requests.
String jobId
The service-generated identifier for the fraudster registration job.
String jobName
The client-provided name for the fraudster registration job.
JobProgress jobProgress
Shows the completed percentage of registration requests listed in the input file.
String jobStatus
The current status of the fraudster registration job.
OutputDataConfig outputDataConfig
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.
RegistrationConfig registrationConfig
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.
Date createdAt
A timestamp showing when the fraudster registration job is created.
String domainId
The identifier of the domain containing the fraudster registration job.
Date endedAt
A timestamp showing when the fraudster registration job ended.
FailureDetails failureDetails
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.
String jobId
The service-generated identifier for the fraudster registration job.
String jobName
The client-provided name for the fraudster registration job.
JobProgress jobProgress
Shows the completed percentage of registration requests listed in the input file.
String jobStatus
The current status of the fraudster registration job.
String s3Uri
The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.
Integer percentComplete
Shows the completed percentage of enrollment or registration requests listed in the input file.
String generatedFraudsterId
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.
Integer riskScore
The score indicating the likelihood the speaker is a known fraudster.
Integer maxResults
The maximum number of domains to list per API call.
String nextToken
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.
List<E> domainSummaries
A list containing details about each domain in the Amazon Web Services account.
String nextToken
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.
String domainId
The identifier of the domain containing the fraudster registration Jobs.
String jobStatus
Provides the status of your fraudster registration job.
Integer maxResults
The maximum number of results that are returned per call. You can use NextToken to obtain further
pages of results. The default is 100; the maximum allowed page size is also 100.
String nextToken
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.
List<E> jobSummaries
A list containing details about each specified fraudster registration job.
String nextToken
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.
String domainId
The identifier of the domain containing the speaker enrollment jobs.
String jobStatus
Provides the status of your speaker enrollment Job.
Integer maxResults
The maximum number of results that are returned per call. You can use NextToken to obtain further
pages of results. The default is 100; the maximum allowed page size is also 100.
String nextToken
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.
List<E> jobSummaries
A list containing details about each specified speaker enrollment job.
String nextToken
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.
String domainId
The identifier of the domain.
Integer maxResults
The maximum number of results that are returned per call. You can use NextToken to obtain further
pages of results. The default is 100; the maximum allowed page size is also 100.
String nextToken
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.
String nextToken
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.
List<E> speakerSummaries
A list containing details about each speaker in the Amazon Web Services account.
String resourceArn
The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list the tags.
Speaker speaker
Details about the opted-out speaker.
String kmsKeyId
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.
String s3Uri
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.
String duplicateRegistrationAction
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.
Integer fraudsterSimilarityThreshold
The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.
String resourceType
The type of resource which cannot not be found. Possible types are BATCH_JOB,
COMPLIANCE_CONSENT, DOMAIN, FRAUDSTER, SESSION and
SPEAKER.
String kmsKeyId
The identifier of the KMS key to use to encrypt data stored by Voice ID. Voice ID doesn't support asymmetric customer managed keys.
String message
Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains the cause of the failure.
String oldKmsKeyId
The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration was updated to a new KMS key ID.
String updateStatus
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.
Date createdAt
A timestamp showing when the speaker is created.
String customerSpeakerId
The client-provided identifier for the speaker.
String domainId
The identifier of the domain that contains the speaker.
String generatedSpeakerId
The service-generated identifier for the speaker.
Date lastAccessedAt
The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.
String status
The current status of the speaker.
Date updatedAt
A timestamp showing the speaker's last update.
Date createdAt
A timestamp showing the creation of the speaker enrollment job.
String dataAccessRoleArn
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.
String domainId
The identifier of the domain that contains the speaker enrollment job.
Date endedAt
A timestamp showing when the speaker enrollment job ended.
EnrollmentConfig enrollmentConfig
The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the
FraudDetectionConfig to use.
FailureDetails failureDetails
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.
InputDataConfig inputDataConfig
The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
String jobId
The service-generated identifier for the speaker enrollment job.
String jobName
The client-provided name for the speaker enrollment job.
JobProgress jobProgress
Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.
String jobStatus
The current status of the speaker enrollment job.
OutputDataConfig outputDataConfig
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.
Date createdAt
A timestamp showing the creation time of the speaker enrollment job.
String domainId
The identifier of the domain that contains the speaker enrollment job.
Date endedAt
A timestamp showing when the speaker enrollment job ended.
FailureDetails failureDetails
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.
String jobId
The service-generated identifier for the speaker enrollment job.
String jobName
The client-provided name for the speaker enrollment job.
JobProgress jobProgress
Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.
String jobStatus
The current status of the speaker enrollment job.
Date createdAt
A timestamp showing the speaker's creation time.
String customerSpeakerId
The client-provided identifier for the speaker.
String domainId
The identifier of the domain that contains the speaker.
String generatedSpeakerId
The service-generated identifier for the speaker.
Date lastAccessedAt
The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.
String status
The current status of the speaker.
Date updatedAt
A timestamp showing the speaker's last update.
String clientToken
The idempotency token for starting a new fraudster registration job. If not provided, Amazon Web Services SDK populates this field.
String dataAccessRoleArn
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.
String domainId
The identifier of the domain containing the fraudster registration job and in which the fraudsters are registered.
InputDataConfig inputDataConfig
The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration requests.
String jobName
The name of the new fraudster registration job.
OutputDataConfig outputDataConfig
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.
RegistrationConfig registrationConfig
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.
FraudsterRegistrationJob job
Details about the started fraudster registration job.
String clientToken
The idempotency token for starting a new speaker enrollment Job. If not provided, Amazon Web Services SDK populates this field.
String dataAccessRoleArn
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.
String domainId
The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.
EnrollmentConfig enrollmentConfig
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.
InputDataConfig inputDataConfig
The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.
String jobName
A name for your speaker enrollment job.
OutputDataConfig outputDataConfig
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.
SpeakerEnrollmentJob job
Details about the started speaker enrollment job.
String 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'.
String 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'.
String description
A brief description of the domain.
String domainId
The identifier of the domain to be updated.
String name
The name of the domain.
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration
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.
Domain domain
Details about the updated domain
Integer riskScore
The score indicating the likelihood of speaker’s voice being spoofed.
Copyright © 2022. All rights reserved.