Struct SpeakerEnrollmentJob

#[non_exhaustive]
pub struct SpeakerEnrollmentJob {
    pub job_name: Option<String>,
    pub job_id: Option<String>,
    pub job_status: Option<SpeakerEnrollmentJobStatus>,
    pub domain_id: Option<String>,
    pub data_access_role_arn: Option<String>,
    pub enrollment_config: Option<EnrollmentConfig>,
    pub input_data_config: Option<InputDataConfig>,
    pub output_data_config: Option<OutputDataConfig>,
    pub created_at: Option<DateTime>,
    pub ended_at: Option<DateTime>,
    pub failure_details: Option<FailureDetails>,
    pub job_progress: Option<JobProgress>,
}

Contains all the information about a speaker enrollment job.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_name: Option<String>

The client-provided name for the speaker enrollment job.

job_id: Option<String>

The service-generated identifier for the speaker enrollment job.

job_status: Option<SpeakerEnrollmentJobStatus>

The current status of the speaker enrollment job.

domain_id: Option<String>

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

data_access_role_arn: Option<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.

enrollment_config: Option<EnrollmentConfig>

The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.

input_data_config: Option<InputDataConfig>

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

output_data_config: Option<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.

created_at: Option<DateTime>

A timestamp of when the speaker enrollment job was created.

ended_at: Option<DateTime>

A timestamp of when the speaker enrollment job ended.

failure_details: Option<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.

job_progress: Option<JobProgress>

Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.

Implementations

impl SpeakerEnrollmentJob

pub fn job_name(&self) -> Option<&str>

The client-provided name for the speaker enrollment job.

pub fn job_id(&self) -> Option<&str>

The service-generated identifier for the speaker enrollment job.

pub fn job_status(&self) -> Option<&SpeakerEnrollmentJobStatus>

The current status of the speaker enrollment job.

pub fn domain_id(&self) -> Option<&str>

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

pub fn data_access_role_arn(&self) -> Option<&str>

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.

pub fn enrollment_config(&self) -> Option<&EnrollmentConfig>

The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.

pub fn input_data_config(&self) -> Option<&InputDataConfig>

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

pub fn output_data_config(&self) -> Option<&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.

pub fn created_at(&self) -> Option<&DateTime>

A timestamp of when the speaker enrollment job was created.

pub fn ended_at(&self) -> Option<&DateTime>

A timestamp of when the speaker enrollment job ended.

pub fn failure_details(&self) -> Option<&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.

pub fn job_progress(&self) -> Option<&JobProgress>

Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.

impl SpeakerEnrollmentJob

pub fn builder() -> SpeakerEnrollmentJobBuilder

Creates a new builder-style object to manufacture SpeakerEnrollmentJob.

Trait Implementations

impl Clone for SpeakerEnrollmentJob

fn clone(&self) -> SpeakerEnrollmentJob

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpeakerEnrollmentJob

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SpeakerEnrollmentJob

fn eq(&self, other: &SpeakerEnrollmentJob) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SpeakerEnrollmentJob