Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.VoiceId.Types.SpeakerEnrollmentJobSummary

Description

Synopsis

Documentation

data SpeakerEnrollmentJobSummary Source #

Contains a summary of information about a speaker enrollment job.

See: newSpeakerEnrollmentJobSummary smart constructor.

Constructors

SpeakerEnrollmentJobSummary'

Fields

createdAt :: Maybe POSIX
A timestamp showing the creation time of the speaker enrollment job.
domainId :: Maybe Text
The identifier of the domain that contains the speaker enrollment job.
endedAt :: Maybe POSIX
A timestamp showing when the speaker enrollment job ended.
failureDetails :: Maybe 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.
jobId :: Maybe Text
The service-generated identifier for the speaker enrollment job.
jobName :: Maybe (Sensitive Text)
The client-provided name for the speaker enrollment job.
jobProgress :: Maybe JobProgress
Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.
jobStatus :: Maybe SpeakerEnrollmentJobStatus
The current status of the speaker enrollment job.

Instances

Instances details

FromJSON SpeakerEnrollmentJobSummary Source #
Instance details Defined in Amazonka.VoiceId.Types.SpeakerEnrollmentJobSummary Methods parseJSON :: Value -> Parser SpeakerEnrollmentJobSummary # parseJSONList :: Value -> Parser [SpeakerEnrollmentJobSummary] #
Generic SpeakerEnrollmentJobSummary Source #
Instance details Defined in Amazonka.VoiceId.Types.SpeakerEnrollmentJobSummary Associated Types type Rep SpeakerEnrollmentJobSummary :: Type -> Type # Methods from :: SpeakerEnrollmentJobSummary -> Rep SpeakerEnrollmentJobSummary x # to :: Rep SpeakerEnrollmentJobSummary x -> SpeakerEnrollmentJobSummary #
Show SpeakerEnrollmentJobSummary Source #
Instance details Defined in Amazonka.VoiceId.Types.SpeakerEnrollmentJobSummary Methods showsPrec :: Int -> SpeakerEnrollmentJobSummary -> ShowS # show :: SpeakerEnrollmentJobSummary -> String # showList :: [SpeakerEnrollmentJobSummary] -> ShowS #
NFData SpeakerEnrollmentJobSummary Source #
Instance details Defined in Amazonka.VoiceId.Types.SpeakerEnrollmentJobSummary Methods rnf :: SpeakerEnrollmentJobSummary -> () #
Eq SpeakerEnrollmentJobSummary Source #
Instance details Defined in Amazonka.VoiceId.Types.SpeakerEnrollmentJobSummary Methods (==) :: SpeakerEnrollmentJobSummary -> SpeakerEnrollmentJobSummary -> Bool # (/=) :: SpeakerEnrollmentJobSummary -> SpeakerEnrollmentJobSummary -> Bool #
Hashable SpeakerEnrollmentJobSummary Source #
Instance details Defined in Amazonka.VoiceId.Types.SpeakerEnrollmentJobSummary Methods hashWithSalt :: Int -> SpeakerEnrollmentJobSummary -> Int # hash :: SpeakerEnrollmentJobSummary -> Int #
type Rep SpeakerEnrollmentJobSummary Source #
Instance details Defined in Amazonka.VoiceId.Types.SpeakerEnrollmentJobSummary type Rep SpeakerEnrollmentJobSummary = D1 ('MetaData "SpeakerEnrollmentJobSummary" "Amazonka.VoiceId.Types.SpeakerEnrollmentJobSummary" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" 'False) (C1 ('MetaCons "SpeakerEnrollmentJobSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "endedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "failureDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FailureDetails)))) :: ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "jobProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobProgress)) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SpeakerEnrollmentJobStatus))))))

newSpeakerEnrollmentJobSummary :: SpeakerEnrollmentJobSummary Source #

Create a value of SpeakerEnrollmentJobSummary 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:createdAt:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_createdAt - A timestamp showing the creation time of the speaker enrollment job.

$sel:domainId:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_domainId - The identifier of the domain that contains the speaker enrollment job.

$sel:endedAt:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_endedAt - A timestamp showing when the speaker enrollment job ended.

$sel:failureDetails:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_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.

$sel:jobId:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_jobId - The service-generated identifier for the speaker enrollment job.

$sel:jobName:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_jobName - The client-provided name for the speaker enrollment job.

$sel:jobProgress:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_jobProgress - Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.

$sel:jobStatus:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_jobStatus - The current status of the speaker enrollment job.

speakerEnrollmentJobSummary_createdAt :: Lens' SpeakerEnrollmentJobSummary (Maybe UTCTime) Source #

A timestamp showing the creation time of the speaker enrollment job.

speakerEnrollmentJobSummary_domainId :: Lens' SpeakerEnrollmentJobSummary (Maybe Text) Source #

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

speakerEnrollmentJobSummary_endedAt :: Lens' SpeakerEnrollmentJobSummary (Maybe UTCTime) Source #

A timestamp showing when the speaker enrollment job ended.

speakerEnrollmentJobSummary_failureDetails :: Lens' SpeakerEnrollmentJobSummary (Maybe FailureDetails) Source #

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.

speakerEnrollmentJobSummary_jobId :: Lens' SpeakerEnrollmentJobSummary (Maybe Text) Source #

The service-generated identifier for the speaker enrollment job.

speakerEnrollmentJobSummary_jobName :: Lens' SpeakerEnrollmentJobSummary (Maybe Text) Source #

The client-provided name for the speaker enrollment job.

speakerEnrollmentJobSummary_jobProgress :: Lens' SpeakerEnrollmentJobSummary (Maybe JobProgress) Source #

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

speakerEnrollmentJobSummary_jobStatus :: Lens' SpeakerEnrollmentJobSummary (Maybe SpeakerEnrollmentJobStatus) Source #

The current status of the speaker enrollment job.