amazonka-voice-id-2.0: Amazon Voice ID SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.VoiceId.StartSpeakerEnrollmentJob

Description

Starts a new batch speaker enrollment job using specified details.

Synopsis

Creating a Request

data StartSpeakerEnrollmentJob Source #

See: newStartSpeakerEnrollmentJob smart constructor.

Constructors

StartSpeakerEnrollmentJob' 

Fields

  • clientToken :: Maybe Text

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

  • enrollmentConfig :: Maybe 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.

  • jobName :: Maybe (Sensitive Text)

    A name for your speaker enrollment job.

  • dataAccessRoleArn :: Text

    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.

  • domainId :: Text

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

  • inputDataConfig :: InputDataConfig

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

  • outputDataConfig :: 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.

Instances

Instances details
ToJSON StartSpeakerEnrollmentJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

ToHeaders StartSpeakerEnrollmentJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

ToPath StartSpeakerEnrollmentJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

ToQuery StartSpeakerEnrollmentJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

AWSRequest StartSpeakerEnrollmentJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

Generic StartSpeakerEnrollmentJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

Associated Types

type Rep StartSpeakerEnrollmentJob :: Type -> Type #

Show StartSpeakerEnrollmentJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

NFData StartSpeakerEnrollmentJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

Eq StartSpeakerEnrollmentJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

Hashable StartSpeakerEnrollmentJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

type AWSResponse StartSpeakerEnrollmentJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

type Rep StartSpeakerEnrollmentJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

type Rep StartSpeakerEnrollmentJob = D1 ('MetaData "StartSpeakerEnrollmentJob" "Amazonka.VoiceId.StartSpeakerEnrollmentJob" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" 'False) (C1 ('MetaCons "StartSpeakerEnrollmentJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "enrollmentConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnrollmentConfig)) :*: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :*: ((S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputDataConfig) :*: S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputDataConfig)))))

newStartSpeakerEnrollmentJob Source #

Create a value of StartSpeakerEnrollmentJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:StartSpeakerEnrollmentJob', startSpeakerEnrollmentJob_clientToken - The idempotency token for starting a new speaker enrollment Job. If not provided, Amazon Web Services SDK populates this field.

StartSpeakerEnrollmentJob, startSpeakerEnrollmentJob_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.

StartSpeakerEnrollmentJob, startSpeakerEnrollmentJob_jobName - A name for your speaker enrollment job.

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

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

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

StartSpeakerEnrollmentJob, startSpeakerEnrollmentJob_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.

Request Lenses

startSpeakerEnrollmentJob_clientToken :: Lens' StartSpeakerEnrollmentJob (Maybe Text) Source #

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

startSpeakerEnrollmentJob_enrollmentConfig :: Lens' StartSpeakerEnrollmentJob (Maybe EnrollmentConfig) Source #

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.

startSpeakerEnrollmentJob_dataAccessRoleArn :: Lens' StartSpeakerEnrollmentJob Text Source #

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.

startSpeakerEnrollmentJob_domainId :: Lens' StartSpeakerEnrollmentJob Text Source #

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

startSpeakerEnrollmentJob_inputDataConfig :: Lens' StartSpeakerEnrollmentJob InputDataConfig Source #

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

startSpeakerEnrollmentJob_outputDataConfig :: Lens' StartSpeakerEnrollmentJob OutputDataConfig Source #

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.

Destructuring the Response

data StartSpeakerEnrollmentJobResponse Source #

See: newStartSpeakerEnrollmentJobResponse smart constructor.

Constructors

StartSpeakerEnrollmentJobResponse' 

Fields

Instances

Instances details
Generic StartSpeakerEnrollmentJobResponse Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

Associated Types

type Rep StartSpeakerEnrollmentJobResponse :: Type -> Type #

Show StartSpeakerEnrollmentJobResponse Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

NFData StartSpeakerEnrollmentJobResponse Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

Eq StartSpeakerEnrollmentJobResponse Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

type Rep StartSpeakerEnrollmentJobResponse Source # 
Instance details

Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob

type Rep StartSpeakerEnrollmentJobResponse = D1 ('MetaData "StartSpeakerEnrollmentJobResponse" "Amazonka.VoiceId.StartSpeakerEnrollmentJob" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" 'False) (C1 ('MetaCons "StartSpeakerEnrollmentJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "job") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SpeakerEnrollmentJob)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartSpeakerEnrollmentJobResponse Source #

Create a value of StartSpeakerEnrollmentJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:job:StartSpeakerEnrollmentJobResponse', startSpeakerEnrollmentJobResponse_job - Details about the started speaker enrollment job.

$sel:httpStatus:StartSpeakerEnrollmentJobResponse', startSpeakerEnrollmentJobResponse_httpStatus - The response's http status code.

Response Lenses