/AWS1/CL_VIDSPEAKERENROLLMEN00¶
Contains all the information about a speaker enrollment job.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_JOBNAME TYPE /AWS1/VIDJOBNAME /AWS1/VIDJOBNAME¶
The client-provided name for the speaker enrollment job.
IV_JOBID TYPE /AWS1/VIDJOBID /AWS1/VIDJOBID¶
The service-generated identifier for the speaker enrollment job.
IV_JOBSTATUS TYPE /AWS1/VIDSPEAKERENROLLMENTJO00 /AWS1/VIDSPEAKERENROLLMENTJO00¶
The current status of the speaker enrollment job.
IV_DOMAINID TYPE /AWS1/VIDDOMAINID /AWS1/VIDDOMAINID¶
The identifier of the domain that contains the speaker enrollment job.
IV_DATAACCESSROLEARN TYPE /AWS1/VIDIAMROLEARN /AWS1/VIDIAMROLEARN¶
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.
IO_ENROLLMENTCONFIG TYPE REF TO /AWS1/CL_VIDENROLLMENTCONFIG /AWS1/CL_VIDENROLLMENTCONFIG¶
The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the
FraudDetectionConfigto use.
IO_INPUTDATACONFIG TYPE REF TO /AWS1/CL_VIDINPUTDATACONFIG /AWS1/CL_VIDINPUTDATACONFIG¶
The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
IO_OUTPUTDATACONFIG TYPE REF TO /AWS1/CL_VIDOUTPUTDATACONFIG /AWS1/CL_VIDOUTPUTDATACONFIG¶
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.
IV_CREATEDAT TYPE /AWS1/VIDTIMESTAMP /AWS1/VIDTIMESTAMP¶
A timestamp of when the speaker enrollment job was created.
IV_ENDEDAT TYPE /AWS1/VIDTIMESTAMP /AWS1/VIDTIMESTAMP¶
A timestamp of when the speaker enrollment job ended.
IO_FAILUREDETAILS TYPE REF TO /AWS1/CL_VIDFAILUREDETAILS /AWS1/CL_VIDFAILUREDETAILS¶
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
JobStatusofCOMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.
IO_JOBPROGRESS TYPE REF TO /AWS1/CL_VIDJOBPROGRESS /AWS1/CL_VIDJOBPROGRESS¶
Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.
Queryable Attributes¶
JobName¶
The client-provided name for the speaker enrollment job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBNAME() |
Getter for JOBNAME, with configurable default |
ASK_JOBNAME() |
Getter for JOBNAME w/ exceptions if field has no value |
HAS_JOBNAME() |
Determine if JOBNAME has a value |
JobId¶
The service-generated identifier for the speaker enrollment job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBID() |
Getter for JOBID, with configurable default |
ASK_JOBID() |
Getter for JOBID w/ exceptions if field has no value |
HAS_JOBID() |
Determine if JOBID has a value |
JobStatus¶
The current status of the speaker enrollment job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBSTATUS() |
Getter for JOBSTATUS, with configurable default |
ASK_JOBSTATUS() |
Getter for JOBSTATUS w/ exceptions if field has no value |
HAS_JOBSTATUS() |
Determine if JOBSTATUS has a value |
DomainId¶
The identifier of the domain that contains the speaker enrollment job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOMAINID() |
Getter for DOMAINID, with configurable default |
ASK_DOMAINID() |
Getter for DOMAINID w/ exceptions if field has no value |
HAS_DOMAINID() |
Determine if DOMAINID has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATAACCESSROLEARN() |
Getter for DATAACCESSROLEARN, with configurable default |
ASK_DATAACCESSROLEARN() |
Getter for DATAACCESSROLEARN w/ exceptions if field has no v |
HAS_DATAACCESSROLEARN() |
Determine if DATAACCESSROLEARN has a value |
EnrollmentConfig¶
The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the
FraudDetectionConfigto use.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENROLLMENTCONFIG() |
Getter for ENROLLMENTCONFIG |
InputDataConfig¶
The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INPUTDATACONFIG() |
Getter for INPUTDATACONFIG |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OUTPUTDATACONFIG() |
Getter for OUTPUTDATACONFIG |
CreatedAt¶
A timestamp of when the speaker enrollment job was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
EndedAt¶
A timestamp of when the speaker enrollment job ended.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENDEDAT() |
Getter for ENDEDAT, with configurable default |
ASK_ENDEDAT() |
Getter for ENDEDAT w/ exceptions if field has no value |
HAS_ENDEDAT() |
Determine if ENDEDAT has a value |
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
JobStatusofCOMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILUREDETAILS() |
Getter for FAILUREDETAILS |
JobProgress¶
Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBPROGRESS() |
Getter for JOBPROGRESS |