Table of Contents
A low-level client representing Amazon Voice ID
Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide describes the APIs used for this service.
import boto3
client = boto3.client('voice-id')
These are the available methods:
Check if an operation can be paginated.
Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.
See also: AWS API Documentation
Request Syntax
response = client.create_domain(
ClientToken='string',
Description='string',
Name='string',
ServerSideEncryptionConfiguration={
'KmsKeyId': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
The idempotency token for creating a new domain. If not provided, Amazon Web Services SDK populates this field.
This field is autopopulated if not provided.
[REQUIRED]
The name of the domain.
[REQUIRED]
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 VoiceID encryption at rest for more details on how the KMS Key is used.
The identifier of the KMS Key you want Voice ID to use to encrypt your data.
A list of tags you want added to the domain.
A tag that can be assigned to a Voice ID resource.
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 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'.
dict
Response Syntax
{
'Domain': {
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'DomainId': 'string',
'DomainStatus': 'ACTIVE'|'PENDING'|'SUSPENDED',
'Name': 'string',
'ServerSideEncryptionConfiguration': {
'KmsKeyId': 'string'
},
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Domain (dict) --
Information about the newly created domain.
Arn (string) --
The Amazon Resource Name (ARN) for the domain.
CreatedAt (datetime) --
The timestamp at which the domain is created.
Description (string) --
The client-provided description of the domain.
DomainId (string) --
The service-generated identifier for the domain.
DomainStatus (string) --
The current status of the domain.
Name (string) --
The client-provided name for the domain.
ServerSideEncryptionConfiguration (dict) --
The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data.
KmsKeyId (string) --
The identifier of the KMS Key you want Voice ID to use to encrypt your data.
UpdatedAt (datetime) --
The timestamp showing the domain's last update.
Exceptions
Deletes the specified domain from the Amazon Connect Voice ID system.
See also: AWS API Documentation
Request Syntax
response = client.delete_domain(
DomainId='string'
)
[REQUIRED]
The identifier of the domain you want to delete.
Exceptions
Deletes the specified fraudster from the Amazon Connect Voice ID system.
See also: AWS API Documentation
Request Syntax
response = client.delete_fraudster(
DomainId='string',
FraudsterId='string'
)
[REQUIRED]
The identifier of the domain containing the fraudster.
[REQUIRED]
The identifier of the fraudster you want to delete.
None
Exceptions
Deletes the specified speaker from the Amazon Connect Voice ID system.
See also: AWS API Documentation
Request Syntax
response = client.delete_speaker(
DomainId='string',
SpeakerId='string'
)
[REQUIRED]
The identifier of the domain containing the speaker.
[REQUIRED]
The identifier of the speaker you want to delete.
None
Exceptions
Describes the specified domain.
See also: AWS API Documentation
Request Syntax
response = client.describe_domain(
DomainId='string'
)
[REQUIRED]
The identifier of the domain you are describing.
{
'Domain': {
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'DomainId': 'string',
'DomainStatus': 'ACTIVE'|'PENDING'|'SUSPENDED',
'Name': 'string',
'ServerSideEncryptionConfiguration': {
'KmsKeyId': 'string'
},
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
Information about the specified domain.
The Amazon Resource Name (ARN) for the domain.
The timestamp at which the domain is created.
The client-provided description of the domain.
The service-generated identifier for the domain.
The current status of the domain.
The client-provided name for the domain.
The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data.
The identifier of the KMS Key you want Voice ID to use to encrypt your data.
The timestamp showing the domain's last update.
Exceptions
Describes the specified fraudster.
See also: AWS API Documentation
Request Syntax
response = client.describe_fraudster(
DomainId='string',
FraudsterId='string'
)
[REQUIRED]
The identifier of the domain containing the fraudster.
[REQUIRED]
The identifier of the fraudster you are describing.
dict
Response Syntax
{
'Fraudster': {
'CreatedAt': datetime(2015, 1, 1),
'DomainId': 'string',
'GeneratedFraudsterId': 'string'
}
}
Response Structure
(dict) --
Fraudster (dict) --
Information about the specified fraudster.
CreatedAt (datetime) --
The timestamp when Voice ID identified the fraudster.
DomainId (string) --
The identifier for the domain containing the fraudster.
GeneratedFraudsterId (string) --
The service-generated identifier for the fraudster.
Exceptions
Describes the specified fraudster registration job.
See also: AWS API Documentation
Request Syntax
response = client.describe_fraudster_registration_job(
DomainId='string',
JobId='string'
)
[REQUIRED]
The identifier for the domain containing the fraudster registration job.
[REQUIRED]
The identifier for the fraudster registration job you are describing.
dict
Response Syntax
{
'Job': {
'CreatedAt': datetime(2015, 1, 1),
'DataAccessRoleArn': 'string',
'DomainId': 'string',
'EndedAt': datetime(2015, 1, 1),
'FailureDetails': {
'Message': 'string',
'StatusCode': 123
},
'InputDataConfig': {
'S3Uri': 'string'
},
'JobId': 'string',
'JobName': 'string',
'JobProgress': {
'PercentComplete': 123
},
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
'OutputDataConfig': {
'KmsKeyId': 'string',
'S3Uri': 'string'
},
'RegistrationConfig': {
'DuplicateRegistrationAction': 'SKIP'|'REGISTER_AS_NEW',
'FraudsterSimilarityThreshold': 123
}
}
}
Response Structure
(dict) --
Job (dict) --
Contains details about the specified fraudster registration job.
CreatedAt (datetime) --
A timestamp showing the creation time of the fraudster registration job.
DataAccessRoleArn (string) --
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.
DomainId (string) --
The identifier of the domain containing the fraudster registration job.
EndedAt (datetime) --
A timestamp showing when the fraudster registration job ended.
FailureDetails (dict) --
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.
Message (string) --
A description of the error that caused the batch job failure.
StatusCode (integer) --
An HTTP status code representing the nature of the error.
InputDataConfig (dict) --
The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration job requests.
S3Uri (string) --
The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.
JobId (string) --
The service-generated identifier for the fraudster registration job.
JobName (string) --
The client-provied name for the fraudster registration job.
JobProgress (dict) --
Shows the completed percentage of registration requests listed in the input file.
PercentComplete (integer) --
Shows the completed percentage of enrollment or registration requests listed in the input file.
JobStatus (string) --
The current status of the fraudster registration job.
OutputDataConfig (dict) --
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.
KmsKeyId (string) --
the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster registration job.
S3Uri (string) --
The S3 path of the folder to which Voice ID writes the job output file, which 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 .
RegistrationConfig (dict) --
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.
DuplicateRegistrationAction (string) --
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.
FraudsterSimilarityThreshold (integer) --
The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.
Exceptions
Describes the specified speaker.
See also: AWS API Documentation
Request Syntax
response = client.describe_speaker(
DomainId='string',
SpeakerId='string'
)
[REQUIRED]
The identifier of the domain that contains the speaker.
[REQUIRED]
The identifier of the speaker you are describing.
dict
Response Syntax
{
'Speaker': {
'CreatedAt': datetime(2015, 1, 1),
'CustomerSpeakerId': 'string',
'DomainId': 'string',
'GeneratedSpeakerId': 'string',
'Status': 'ENROLLED'|'EXPIRED'|'OPTED_OUT'|'PENDING',
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Speaker (dict) --
Information about the specified speaker.
CreatedAt (datetime) --
A timestamp showing when the speaker is created.
CustomerSpeakerId (string) --
The client-provided identifier for the speaker.
DomainId (string) --
The identifier of the domain that contains the speaker.
GeneratedSpeakerId (string) --
The service-generated identifier for the speaker.
Status (string) --
The current status of the speaker.
UpdatedAt (datetime) --
A timestamp showing the speaker's last update.
Exceptions
Describes the specified speaker enrollment job.
See also: AWS API Documentation
Request Syntax
response = client.describe_speaker_enrollment_job(
DomainId='string',
JobId='string'
)
[REQUIRED]
The identifier of the domain containing the speaker enrollment job.
[REQUIRED]
The identifier of the speaker enrollment job you are describing.
dict
Response Syntax
{
'Job': {
'CreatedAt': datetime(2015, 1, 1),
'DataAccessRoleArn': 'string',
'DomainId': 'string',
'EndedAt': datetime(2015, 1, 1),
'EnrollmentConfig': {
'ExistingEnrollmentAction': 'SKIP'|'OVERWRITE',
'FraudDetectionConfig': {
'FraudDetectionAction': 'IGNORE'|'FAIL',
'RiskThreshold': 123
}
},
'FailureDetails': {
'Message': 'string',
'StatusCode': 123
},
'InputDataConfig': {
'S3Uri': 'string'
},
'JobId': 'string',
'JobName': 'string',
'JobProgress': {
'PercentComplete': 123
},
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
'OutputDataConfig': {
'KmsKeyId': 'string',
'S3Uri': 'string'
}
}
}
Response Structure
(dict) --
Job (dict) --
Contains details about the specified speaker enrollment job.
CreatedAt (datetime) --
A timestamp showing the creation of the speaker enrollment job.
DataAccessRoleArn (string) --
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.
DomainId (string) --
The identifier of the domain that contains the speaker enrollment job.
EndedAt (datetime) --
A timestamp showing when the speaker enrollment job ended.
EnrollmentConfig (dict) --
The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.
ExistingEnrollmentAction (string) --
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.
FraudDetectionConfig (dict) --
The fraud detection configuration to use for the speaker enrollment job.
FraudDetectionAction (string) --
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.
RiskThreshold (integer) --
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.
FailureDetails (dict) --
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.
Message (string) --
A description of the error that caused the batch job failure.
StatusCode (integer) --
An HTTP status code representing the nature of the error.
InputDataConfig (dict) --
The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
S3Uri (string) --
The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.
JobId (string) --
The service-generated identifier for the speaker enrollment job.
JobName (string) --
The client-provided name for the speaker enrollment job.
JobProgress (dict) --
Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.
PercentComplete (integer) --
Shows the completed percentage of enrollment or registration requests listed in the input file.
JobStatus (string) --
The current status of the speaker enrollment job.
OutputDataConfig (dict) --
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.
KmsKeyId (string) --
the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster registration job.
S3Uri (string) --
The S3 path of the folder to which Voice ID writes the job output file, which 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 .
Exceptions
Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
See also: AWS API Documentation
Request Syntax
response = client.evaluate_session(
DomainId='string',
SessionNameOrId='string'
)
[REQUIRED]
The identifier of the domain where the session started.
[REQUIRED]
The session identifier, or name of the session, that you want to evaluate. In Voice ID integration, this is the Contact-Id.
dict
Response Syntax
{
'AuthenticationResult': {
'AudioAggregationEndedAt': datetime(2015, 1, 1),
'AudioAggregationStartedAt': datetime(2015, 1, 1),
'AuthenticationResultId': 'string',
'Configuration': {
'AcceptanceThreshold': 123
},
'CustomerSpeakerId': 'string',
'Decision': 'ACCEPT'|'REJECT'|'NOT_ENOUGH_SPEECH'|'SPEAKER_NOT_ENROLLED'|'SPEAKER_OPTED_OUT'|'SPEAKER_ID_NOT_PROVIDED',
'GeneratedSpeakerId': 'string',
'Score': 123
},
'DomainId': 'string',
'FraudDetectionResult': {
'AudioAggregationEndedAt': datetime(2015, 1, 1),
'AudioAggregationStartedAt': datetime(2015, 1, 1),
'Configuration': {
'RiskThreshold': 123
},
'Decision': 'HIGH_RISK'|'LOW_RISK'|'NOT_ENOUGH_SPEECH',
'FraudDetectionResultId': 'string',
'Reasons': [
'KNOWN_FRAUDSTER',
],
'RiskDetails': {
'KnownFraudsterRisk': {
'GeneratedFraudsterId': 'string',
'RiskScore': 123
}
}
},
'SessionId': 'string',
'SessionName': 'string',
'StreamingStatus': 'PENDING_CONFIGURATION'|'ONGOING'|'ENDED'
}
Response Structure
(dict) --
AuthenticationResult (dict) --
Details resulting from the authentication process, such as authentication decision and authentication score.
AudioAggregationEndedAt (datetime) --
A timestamp indicating when audio aggregation ended for this authentication result.
AudioAggregationStartedAt (datetime) --
A timestamp indicating when audio aggregation started for this authentication result.
AuthenticationResultId (string) --
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.
Configuration (dict) --
The AuthenticationConfiguration used to generate this authentication result.
AcceptanceThreshold (integer) --
The minimum threshold needed to successfully authenticate a speaker.
CustomerSpeakerId (string) --
The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId is provided for the session.
Decision (string) --
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
GeneratedSpeakerId (string) --
The service-generated identifier for the speaker whose authentication result is produced.
Score (integer) --
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 .
DomainId (string) --
The identifier of the domain containing the session.
FraudDetectionResult (dict) --
Details resulting from the fraud detection process, such as fraud detection decision and risk score.
AudioAggregationEndedAt (datetime) --
A timestamp indicating when audio aggregation ended for this fraud detection result.
AudioAggregationStartedAt (datetime) --
A timestamp indicating when audio aggregation started for this fraud detection result.
Configuration (dict) --
The FraudDetectionConfiguration used to generate this fraud detection result.
RiskThreshold (integer) --
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.
Decision (string) --
The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
FraudDetectionResultId (string) --
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.
Reasons (list) --
The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is HIGH_RISK , and only has one possible value: KNOWN_FRAUDSTER .
RiskDetails (dict) --
Details about each risk analyzed for this speaker.
KnownFraudsterRisk (dict) --
The details resulting from 'Known Fraudster Risk' analysis of the speaker.
GeneratedFraudsterId (string) --
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 .
RiskScore (integer) --
The score indicating the likelihood the speaker is a known fraudster.
SessionId (string) --
The service-generated identifier of the session.
SessionName (string) --
The client-provided name of the session.
StreamingStatus (string) --
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, once 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.
Exceptions
Create a paginator for an operation.
Returns an object that can wait for some condition.
Lists all the domains in the Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_domains(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'DomainSummaries': [
{
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'DomainId': 'string',
'DomainStatus': 'ACTIVE'|'PENDING'|'SUSPENDED',
'Name': 'string',
'ServerSideEncryptionConfiguration': {
'KmsKeyId': 'string'
},
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DomainSummaries (list) --
A list containing details about each domain in the Amazon Web Services account.
(dict) --
Contains a summary of information about a domain.
Arn (string) --
The Amazon Resource Name (ARN) for the domain.
CreatedAt (datetime) --
The timestamp showing when the domain is created.
Description (string) --
The client-provided description of the domain.
DomainId (string) --
The service-generated identifier for the domain.
DomainStatus (string) --
The current status of the domain.
Name (string) --
The client-provided name for the domain.
ServerSideEncryptionConfiguration (dict) --
The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data..
KmsKeyId (string) --
The identifier of the KMS Key you want Voice ID to use to encrypt your data.
UpdatedAt (datetime) --
The timestamp showing the domain's last update.
NextToken (string) --
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.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.list_fraudster_registration_jobs(
DomainId='string',
JobStatus='SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The identifier of the domain containing the fraudster registration Jobs.
dict
Response Syntax
{
'JobSummaries': [
{
'CreatedAt': datetime(2015, 1, 1),
'DomainId': 'string',
'EndedAt': datetime(2015, 1, 1),
'FailureDetails': {
'Message': 'string',
'StatusCode': 123
},
'JobId': 'string',
'JobName': 'string',
'JobProgress': {
'PercentComplete': 123
},
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
JobSummaries (list) --
A list containing details about each specified fraudster registration job.
(dict) --
Contains a summary of information about a fraudster registration job.
CreatedAt (datetime) --
A timestamp showing when the fraudster registration job is created.
DomainId (string) --
The identifier of the domain containing the fraudster registration job.
EndedAt (datetime) --
A timestamp showing when the fraudster registration job ended.
FailureDetails (dict) --
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.
Message (string) --
A description of the error that caused the batch job failure.
StatusCode (integer) --
An HTTP status code representing the nature of the error.
JobId (string) --
The service-generated identifier for the fraudster registration job.
JobName (string) --
The client-provied name for the fraudster registration job.
JobProgress (dict) --
Shows the completed percentage of registration requests listed in the input file.
PercentComplete (integer) --
Shows the completed percentage of enrollment or registration requests listed in the input file.
JobStatus (string) --
The current status of the fraudster registration job.
NextToken (string) --
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.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.list_speaker_enrollment_jobs(
DomainId='string',
JobStatus='SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The identifier of the domain containing the speaker enrollment jobs.
dict
Response Syntax
{
'JobSummaries': [
{
'CreatedAt': datetime(2015, 1, 1),
'DomainId': 'string',
'EndedAt': datetime(2015, 1, 1),
'FailureDetails': {
'Message': 'string',
'StatusCode': 123
},
'JobId': 'string',
'JobName': 'string',
'JobProgress': {
'PercentComplete': 123
},
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
JobSummaries (list) --
A list containing details about each specified speaker enrollment job.
(dict) --
Contains a summary of information about a speaker enrollment job.
CreatedAt (datetime) --
A timestamp showing the creation time of the speaker enrollment job.
DomainId (string) --
The identifier of the domain that contains the speaker enrollment job.
EndedAt (datetime) --
A timestamp showing when the speaker enrollment job ended.
FailureDetails (dict) --
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.
Message (string) --
A description of the error that caused the batch job failure.
StatusCode (integer) --
An HTTP status code representing the nature of the error.
JobId (string) --
The service-generated identifier for the speaker enrollment job.
JobName (string) --
The client-provided name for the speaker enrollment job.
JobProgress (dict) --
Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.
PercentComplete (integer) --
Shows the completed percentage of enrollment or registration requests listed in the input file.
JobStatus (string) --
The current status of the speaker enrollment job.
NextToken (string) --
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.
Exceptions
Lists all speakers in a specified domain.
See also: AWS API Documentation
Request Syntax
response = client.list_speakers(
DomainId='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The identifier of the domain.
dict
Response Syntax
{
'NextToken': 'string',
'SpeakerSummaries': [
{
'CreatedAt': datetime(2015, 1, 1),
'CustomerSpeakerId': 'string',
'DomainId': 'string',
'GeneratedSpeakerId': 'string',
'Status': 'ENROLLED'|'EXPIRED'|'OPTED_OUT'|'PENDING',
'UpdatedAt': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
NextToken (string) --
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.
SpeakerSummaries (list) --
A list containing details about each speaker in the Amazon Web Services account.
(dict) --
Contains a summary of information about a speaker.
CreatedAt (datetime) --
A timestamp showing the speaker's creation time.
CustomerSpeakerId (string) --
The client-provided identifier for the speaker.
DomainId (string) --
The identifier of the domain that contains the speaker.
GeneratedSpeakerId (string) --
The service-generated identifier for the speaker.
Status (string) --
The current status of the speaker.
UpdatedAt (datetime) --
A timestamp showing the speaker's last update.
Exceptions
Lists all tags associated with a specified Voice ID resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list the tags.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The list of tags associated with the specified resource.
A tag that can be assigned to a Voice ID resource.
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 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'.
Exceptions
Opts out a speaker from Voice ID system. A speaker can be opted out regardless of whether or not they already exist in the system. 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 the system.
See also: AWS API Documentation
Request Syntax
response = client.opt_out_speaker(
DomainId='string',
SpeakerId='string'
)
[REQUIRED]
The identifier of the domain containing the speaker.
[REQUIRED]
The identifier of the speaker you want opted-out.
dict
Response Syntax
{
'Speaker': {
'CreatedAt': datetime(2015, 1, 1),
'CustomerSpeakerId': 'string',
'DomainId': 'string',
'GeneratedSpeakerId': 'string',
'Status': 'ENROLLED'|'EXPIRED'|'OPTED_OUT'|'PENDING',
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Speaker (dict) --
Details about the opted-out speaker.
CreatedAt (datetime) --
A timestamp showing when the speaker is created.
CustomerSpeakerId (string) --
The client-provided identifier for the speaker.
DomainId (string) --
The identifier of the domain that contains the speaker.
GeneratedSpeakerId (string) --
The service-generated identifier for the speaker.
Status (string) --
The current status of the speaker.
UpdatedAt (datetime) --
A timestamp showing the speaker's last update.
Exceptions
Starts a new batch fraudster registration job using provided details.
See also: AWS API Documentation
Request Syntax
response = client.start_fraudster_registration_job(
ClientToken='string',
DataAccessRoleArn='string',
DomainId='string',
InputDataConfig={
'S3Uri': 'string'
},
JobName='string',
OutputDataConfig={
'KmsKeyId': 'string',
'S3Uri': 'string'
},
RegistrationConfig={
'DuplicateRegistrationAction': 'SKIP'|'REGISTER_AS_NEW',
'FraudsterSimilarityThreshold': 123
}
)
The idempotency token for starting a new fraudster registration job. If not provided, Amazon Web Services SDK populates this field.
This field is autopopulated if not provided.
[REQUIRED]
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.
[REQUIRED]
The identifier of the domain containing the fraudster registration job and in which the fraudsters are registered.
[REQUIRED]
The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration requests.
The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.
[REQUIRED]
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.
the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster registration job.
The S3 path of the folder to which Voice ID writes the job output file, which 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 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.
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 minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.
dict
Response Syntax
{
'Job': {
'CreatedAt': datetime(2015, 1, 1),
'DataAccessRoleArn': 'string',
'DomainId': 'string',
'EndedAt': datetime(2015, 1, 1),
'FailureDetails': {
'Message': 'string',
'StatusCode': 123
},
'InputDataConfig': {
'S3Uri': 'string'
},
'JobId': 'string',
'JobName': 'string',
'JobProgress': {
'PercentComplete': 123
},
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
'OutputDataConfig': {
'KmsKeyId': 'string',
'S3Uri': 'string'
},
'RegistrationConfig': {
'DuplicateRegistrationAction': 'SKIP'|'REGISTER_AS_NEW',
'FraudsterSimilarityThreshold': 123
}
}
}
Response Structure
(dict) --
Job (dict) --
Details about the started fraudster registration job.
CreatedAt (datetime) --
A timestamp showing the creation time of the fraudster registration job.
DataAccessRoleArn (string) --
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.
DomainId (string) --
The identifier of the domain containing the fraudster registration job.
EndedAt (datetime) --
A timestamp showing when the fraudster registration job ended.
FailureDetails (dict) --
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.
Message (string) --
A description of the error that caused the batch job failure.
StatusCode (integer) --
An HTTP status code representing the nature of the error.
InputDataConfig (dict) --
The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration job requests.
S3Uri (string) --
The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.
JobId (string) --
The service-generated identifier for the fraudster registration job.
JobName (string) --
The client-provied name for the fraudster registration job.
JobProgress (dict) --
Shows the completed percentage of registration requests listed in the input file.
PercentComplete (integer) --
Shows the completed percentage of enrollment or registration requests listed in the input file.
JobStatus (string) --
The current status of the fraudster registration job.
OutputDataConfig (dict) --
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.
KmsKeyId (string) --
the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster registration job.
S3Uri (string) --
The S3 path of the folder to which Voice ID writes the job output file, which 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 .
RegistrationConfig (dict) --
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.
DuplicateRegistrationAction (string) --
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.
FraudsterSimilarityThreshold (integer) --
The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.
Exceptions
Starts a new batch speaker enrollment job using specified details.
See also: AWS API Documentation
Request Syntax
response = client.start_speaker_enrollment_job(
ClientToken='string',
DataAccessRoleArn='string',
DomainId='string',
EnrollmentConfig={
'ExistingEnrollmentAction': 'SKIP'|'OVERWRITE',
'FraudDetectionConfig': {
'FraudDetectionAction': 'IGNORE'|'FAIL',
'RiskThreshold': 123
}
},
InputDataConfig={
'S3Uri': 'string'
},
JobName='string',
OutputDataConfig={
'KmsKeyId': 'string',
'S3Uri': 'string'
}
)
The idempotency token for starting a new speaker enrollment Job. If not provided, Amazon Web Services SDK populates this field.
This field is autopopulated if not provided.
[REQUIRED]
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 documentation for the permissions needed in this role.
[REQUIRED]
The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.
The enrollment config that contains details such as the action to take when a speaker is already enrolled in the Voice ID system or when a speaker is identified as a fraudster.
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.
The fraud detection configuration to use for the speaker enrollment job.
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.
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.
[REQUIRED]
The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.
The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.
[REQUIRED]
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.
the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster registration job.
The S3 path of the folder to which Voice ID writes the job output file, which 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 .
dict
Response Syntax
{
'Job': {
'CreatedAt': datetime(2015, 1, 1),
'DataAccessRoleArn': 'string',
'DomainId': 'string',
'EndedAt': datetime(2015, 1, 1),
'EnrollmentConfig': {
'ExistingEnrollmentAction': 'SKIP'|'OVERWRITE',
'FraudDetectionConfig': {
'FraudDetectionAction': 'IGNORE'|'FAIL',
'RiskThreshold': 123
}
},
'FailureDetails': {
'Message': 'string',
'StatusCode': 123
},
'InputDataConfig': {
'S3Uri': 'string'
},
'JobId': 'string',
'JobName': 'string',
'JobProgress': {
'PercentComplete': 123
},
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
'OutputDataConfig': {
'KmsKeyId': 'string',
'S3Uri': 'string'
}
}
}
Response Structure
(dict) --
Job (dict) --
Details about the started speaker enrollment job.
CreatedAt (datetime) --
A timestamp showing the creation of the speaker enrollment job.
DataAccessRoleArn (string) --
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.
DomainId (string) --
The identifier of the domain that contains the speaker enrollment job.
EndedAt (datetime) --
A timestamp showing when the speaker enrollment job ended.
EnrollmentConfig (dict) --
The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.
ExistingEnrollmentAction (string) --
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.
FraudDetectionConfig (dict) --
The fraud detection configuration to use for the speaker enrollment job.
FraudDetectionAction (string) --
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.
RiskThreshold (integer) --
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.
FailureDetails (dict) --
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.
Message (string) --
A description of the error that caused the batch job failure.
StatusCode (integer) --
An HTTP status code representing the nature of the error.
InputDataConfig (dict) --
The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
S3Uri (string) --
The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.
JobId (string) --
The service-generated identifier for the speaker enrollment job.
JobName (string) --
The client-provided name for the speaker enrollment job.
JobProgress (dict) --
Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.
PercentComplete (integer) --
Shows the completed percentage of enrollment or registration requests listed in the input file.
JobStatus (string) --
The current status of the speaker enrollment job.
OutputDataConfig (dict) --
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.
KmsKeyId (string) --
the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster registration job.
S3Uri (string) --
The S3 path of the folder to which Voice ID writes the job output file, which 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 .
Exceptions
Tags an Amazon Connect Voice ID resource with the provided list of tags.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.
[REQUIRED]
The list of tags to assign to the specified resource.
A tag that can be assigned to a Voice ID resource.
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 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'.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes specified tags from a specified Amazon Connect Voice ID resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags from.
[REQUIRED]
The list of tag keys you want to remove from the specified resource.
dict
Response Syntax
{}
Response Structure
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.update_domain(
Description='string',
DomainId='string',
Name='string',
ServerSideEncryptionConfiguration={
'KmsKeyId': 'string'
}
)
[REQUIRED]
The identifier of the domain to be updated.
[REQUIRED]
The name of the domain.
[REQUIRED]
The configuration, containing the KMS Key Identifier, to be used by Voice ID for the server-side encryption of your data. Note that all the existing data in the domain are still encrypted using the existing key, only the data added to domain after updating the key is encrypted using the new key.
The identifier of the KMS Key you want Voice ID to use to encrypt your data.
dict
Response Syntax
{
'Domain': {
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'DomainId': 'string',
'DomainStatus': 'ACTIVE'|'PENDING'|'SUSPENDED',
'Name': 'string',
'ServerSideEncryptionConfiguration': {
'KmsKeyId': 'string'
},
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Domain (dict) --
Details about the updated domain
Arn (string) --
The Amazon Resource Name (ARN) for the domain.
CreatedAt (datetime) --
The timestamp at which the domain is created.
Description (string) --
The client-provided description of the domain.
DomainId (string) --
The service-generated identifier for the domain.
DomainStatus (string) --
The current status of the domain.
Name (string) --
The client-provided name for the domain.
ServerSideEncryptionConfiguration (dict) --
The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data.
KmsKeyId (string) --
The identifier of the KMS Key you want Voice ID to use to encrypt your data.
UpdatedAt (datetime) --
The timestamp showing the domain's last update.
Exceptions
The available paginators are: