Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Starts a new batch speaker enrollment job using specified details.
Synopsis
- data StartSpeakerEnrollmentJob = StartSpeakerEnrollmentJob' {}
- newStartSpeakerEnrollmentJob :: Text -> Text -> InputDataConfig -> OutputDataConfig -> StartSpeakerEnrollmentJob
- startSpeakerEnrollmentJob_clientToken :: Lens' StartSpeakerEnrollmentJob (Maybe Text)
- startSpeakerEnrollmentJob_jobName :: Lens' StartSpeakerEnrollmentJob (Maybe Text)
- startSpeakerEnrollmentJob_enrollmentConfig :: Lens' StartSpeakerEnrollmentJob (Maybe EnrollmentConfig)
- startSpeakerEnrollmentJob_dataAccessRoleArn :: Lens' StartSpeakerEnrollmentJob Text
- startSpeakerEnrollmentJob_domainId :: Lens' StartSpeakerEnrollmentJob Text
- startSpeakerEnrollmentJob_inputDataConfig :: Lens' StartSpeakerEnrollmentJob InputDataConfig
- startSpeakerEnrollmentJob_outputDataConfig :: Lens' StartSpeakerEnrollmentJob OutputDataConfig
- data StartSpeakerEnrollmentJobResponse = StartSpeakerEnrollmentJobResponse' {}
- newStartSpeakerEnrollmentJobResponse :: Int -> StartSpeakerEnrollmentJobResponse
- startSpeakerEnrollmentJobResponse_job :: Lens' StartSpeakerEnrollmentJobResponse (Maybe SpeakerEnrollmentJob)
- startSpeakerEnrollmentJobResponse_httpStatus :: Lens' StartSpeakerEnrollmentJobResponse Int
Creating a Request
data StartSpeakerEnrollmentJob Source #
See: newStartSpeakerEnrollmentJob
smart constructor.
StartSpeakerEnrollmentJob' | |
|
Instances
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.
$sel:jobName:StartSpeakerEnrollmentJob'
, startSpeakerEnrollmentJob_jobName
- A name for your speaker enrollment job.
$sel:enrollmentConfig:StartSpeakerEnrollmentJob'
, startSpeakerEnrollmentJob_enrollmentConfig
- The enrollment config that contains details such as the action to take
when a speaker is already enrolled in the Voice ID system or when a
speaker is identified as a fraudster.
$sel:dataAccessRoleArn: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
documentation for the permissions needed in this role.
$sel:domainId:StartSpeakerEnrollmentJob'
, startSpeakerEnrollmentJob_domainId
- The identifier of the domain that contains the speaker enrollment job
and in which the speakers are enrolled.
$sel:inputDataConfig:StartSpeakerEnrollmentJob'
, startSpeakerEnrollmentJob_inputDataConfig
- The input data config containing the S3 location for the input manifest
file that contains the list of speaker enrollment requests.
$sel:outputDataConfig: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_jobName :: Lens' StartSpeakerEnrollmentJob (Maybe Text) Source #
A name for your speaker enrollment job.
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 the Voice ID system 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 documentation 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.
StartSpeakerEnrollmentJobResponse' | |
|
Instances
Eq StartSpeakerEnrollmentJobResponse Source # | |
Show StartSpeakerEnrollmentJobResponse Source # | |
Generic StartSpeakerEnrollmentJobResponse Source # | |
NFData StartSpeakerEnrollmentJobResponse Source # | |
Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob rnf :: StartSpeakerEnrollmentJobResponse -> () # | |
type Rep StartSpeakerEnrollmentJobResponse Source # | |
Defined in Amazonka.VoiceId.StartSpeakerEnrollmentJob type Rep StartSpeakerEnrollmentJobResponse = D1 ('MetaData "StartSpeakerEnrollmentJobResponse" "Amazonka.VoiceId.StartSpeakerEnrollmentJob" "libZSservicesZSamazonka-voice-idZSamazonka-voice-id" '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
startSpeakerEnrollmentJobResponse_job :: Lens' StartSpeakerEnrollmentJobResponse (Maybe SpeakerEnrollmentJob) Source #
Details about the started speaker enrollment job.
startSpeakerEnrollmentJobResponse_httpStatus :: Lens' StartSpeakerEnrollmentJobResponse Int Source #
The response's http status code.