Struct StartSpeakerEnrollmentJobInput

#[non_exhaustive]
pub struct StartSpeakerEnrollmentJobInput {
    pub client_token: Option<String>,
    pub job_name: Option<String>,
    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>,
}

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.

client_token: Option<String>

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

job_name: Option<String>

A name for your speaker enrollment job.

domain_id: Option<String>

The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.

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. Refer to Batch enrollment using audio data from prior calls for the permissions needed in this role.

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

input_data_config: Option<InputDataConfig>

The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment 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.

Implementations

impl StartSpeakerEnrollmentJobInput

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

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

A name for your speaker enrollment job.

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

The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.

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. Refer to Batch enrollment using audio data from prior calls for the permissions needed in this role.

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

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

The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment 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.

impl StartSpeakerEnrollmentJobInput

pub fn builder() -> StartSpeakerEnrollmentJobInputBuilder

Creates a new builder-style object to manufacture StartSpeakerEnrollmentJobInput.

Trait Implementations

impl Clone for StartSpeakerEnrollmentJobInput

fn clone(&self) -> StartSpeakerEnrollmentJobInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartSpeakerEnrollmentJobInput

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

Formats the value using the given formatter.

impl PartialEq for StartSpeakerEnrollmentJobInput

fn eq(&self, other: &StartSpeakerEnrollmentJobInput) -> 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 StartSpeakerEnrollmentJobInput