StartSpeakerEnrollmentJob - Amazon Voice ID

StartSpeakerEnrollmentJob

Starts a new batch speaker enrollment job using specified details.

Request Syntax

{ "ClientToken": "string", "DataAccessRoleArn": "string", "DomainId": "string", "EnrollmentConfig": { "ExistingEnrollmentAction": "string", "FraudDetectionConfig": { "FraudDetectionAction": "string", "RiskThreshold": number } }, "InputDataConfig": { "S3Uri": "string" }, "JobName": "string", "OutputDataConfig": { "KmsKeyId": "string", "S3Uri": "string" } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientToken

The idempotency token for starting a new speaker enrollment Job. If not provided, AWS SDK populates this field.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9-_]+$

Required: No

DataAccessRoleArn

The IAM role Amazon Resource Name (ARN) that grants VoiceID permissions to read input and write output files in your S3 buckets. Refer to Batch enrollment using audio data from prior calls for the permissions needed in this role.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$

Required: Yes

DomainId

The identifier of the domain that contains the speaker enrollment job.

Type: String

Length Constraints: Fixed length of 22.

Pattern: ^[a-zA-Z0-9]{22}$

Required: Yes

EnrollmentConfig

The enrollment config that contains details such as the action to take when a speaker is already enrolled in the VoiceID system or when a speaker is identified as a fraudster.

Type: EnrollmentConfig object

Required: No

InputDataConfig

The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.

Type: InputDataConfig object

Required: Yes

JobName

A name for your speaker enrollment job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$

Required: No

OutputDataConfig

The output data config containing the S3 location where VoiceID writes the job output file; you must also include a KMS Key ID to encrypt the file.

Type: OutputDataConfig object

Required: Yes

Response Syntax

{ "Job": { "CreatedAt": number, "DataAccessRoleArn": "string", "DomainId": "string", "EndedAt": number, "EnrollmentConfig": { "ExistingEnrollmentAction": "string", "FraudDetectionConfig": { "FraudDetectionAction": "string", "RiskThreshold": number } }, "FailureDetails": { "Message": "string", "StatusCode": number }, "InputDataConfig": { "S3Uri": "string" }, "JobId": "string", "JobName": "string", "JobProgress": { "PercentComplete": number }, "JobStatus": "string", "OutputDataConfig": { "KmsKeyId": "string", "S3Uri": "string" } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Job

Provides information about the speaker enrollment job.

Type: SpeakerEnrollmentJob object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action. Check the error message and try again.

HTTP Status Code: 400

ConflictException

The request failed due to a conflict. Check the ConflictType and error message for more details.

HTTP Status Code: 400

InternalServerException

There was an unknown internal error when processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found. Check the ResourceType and error message for more details.

HTTP Status Code: 400

ServiceQuotaExceededException

The request exceeded the service quota. Refer to VoiceID Service Quotas and try your request again.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.

HTTP Status Code: 400

ValidationException

The request failed one or more validations; check the error message and try again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: