Amazonka.VoiceId.Types.AuthenticationResult

Documentation

data AuthenticationResult

The authentication result produced by Voice ID, processed against the current session state and streamed audio of the speaker.

See: newAuthenticationResult smart constructor.

Constructors

AuthenticationResult'

Fields

• audioAggregationEndedAt :: Maybe POSIX

  A timestamp indicating when audio aggregation ended for this authentication result.

• audioAggregationStartedAt :: Maybe POSIX

  A timestamp indicating when audio aggregation started for this authentication result.

• authenticationResultId :: Maybe Text

  The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, AcceptanceThreshold changes, or SpeakerId changes, Voice ID always returns cached Authentication Result for this API.

• configuration :: Maybe AuthenticationConfiguration

  The AuthenticationConfiguration used to generate this authentication result.

• customerSpeakerId :: Maybe (Sensitive Text)

  The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId is provided for the session.

• decision :: Maybe AuthenticationDecision

  The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.

• generatedSpeakerId :: Maybe Text

  The service-generated identifier for the speaker whose authentication result is produced.

• score :: Maybe Natural

  The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either ACCEPT or REJECT.

Instances

FromJSON AuthenticationResult

Defined in Amazonka.VoiceId.Types.AuthenticationResult

Methods

parseJSON :: Value -> Parser AuthenticationResult

parseJSONList :: Value -> Parser [AuthenticationResult]

Generic AuthenticationResult

Defined in Amazonka.VoiceId.Types.AuthenticationResult

Associated Types

type Rep AuthenticationResult :: Type -> Type

Methods

from :: AuthenticationResult -> Rep AuthenticationResult x

to :: Rep AuthenticationResult x -> AuthenticationResult

Show AuthenticationResult

Defined in Amazonka.VoiceId.Types.AuthenticationResult

Methods

showsPrec :: Int -> AuthenticationResult -> ShowS

show :: AuthenticationResult -> String

showList :: [AuthenticationResult] -> ShowS

NFData AuthenticationResult

Defined in Amazonka.VoiceId.Types.AuthenticationResult

Methods

rnf :: AuthenticationResult -> ()

Eq AuthenticationResult

Defined in Amazonka.VoiceId.Types.AuthenticationResult

Methods

(==) :: AuthenticationResult -> AuthenticationResult -> Bool

(/=) :: AuthenticationResult -> AuthenticationResult -> Bool

Hashable AuthenticationResult

Defined in Amazonka.VoiceId.Types.AuthenticationResult

Methods

hashWithSalt :: Int -> AuthenticationResult -> Int

hash :: AuthenticationResult -> Int

type Rep AuthenticationResult

Defined in Amazonka.VoiceId.Types.AuthenticationResult

type Rep AuthenticationResult = D1 ('MetaData "AuthenticationResult" "Amazonka.VoiceId.Types.AuthenticationResult" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" 'False) (C1 ('MetaCons "AuthenticationResult'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "audioAggregationEndedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "audioAggregationStartedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "authenticationResultId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationConfiguration)))) :*: ((S1 ('MetaSel ('Just "customerSpeakerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "decision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationDecision))) :*: (S1 ('MetaSel ('Just "generatedSpeakerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))

newAuthenticationResult :: AuthenticationResult

Create a value of AuthenticationResult 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:audioAggregationEndedAt:AuthenticationResult', authenticationResult_audioAggregationEndedAt - A timestamp indicating when audio aggregation ended for this authentication result.

$sel:audioAggregationStartedAt:AuthenticationResult', authenticationResult_audioAggregationStartedAt - A timestamp indicating when audio aggregation started for this authentication result.

$sel:authenticationResultId:AuthenticationResult', authenticationResult_authenticationResultId - The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, AcceptanceThreshold changes, or SpeakerId changes, Voice ID always returns cached Authentication Result for this API.

$sel:configuration:AuthenticationResult', authenticationResult_configuration - The AuthenticationConfiguration used to generate this authentication result.

$sel:customerSpeakerId:AuthenticationResult', authenticationResult_customerSpeakerId - The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId is provided for the session.

$sel:decision:AuthenticationResult', authenticationResult_decision - The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.

$sel:generatedSpeakerId:AuthenticationResult', authenticationResult_generatedSpeakerId - The service-generated identifier for the speaker whose authentication result is produced.

$sel:score:AuthenticationResult', authenticationResult_score - The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either ACCEPT or REJECT.

authenticationResult_audioAggregationEndedAt :: Lens' AuthenticationResult (Maybe UTCTime)

A timestamp indicating when audio aggregation ended for this authentication result.

authenticationResult_audioAggregationStartedAt :: Lens' AuthenticationResult (Maybe UTCTime)

A timestamp indicating when audio aggregation started for this authentication result.

authenticationResult_authenticationResultId :: Lens' AuthenticationResult (Maybe Text)

The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, AcceptanceThreshold changes, or SpeakerId changes, Voice ID always returns cached Authentication Result for this API.

authenticationResult_configuration :: Lens' AuthenticationResult (Maybe AuthenticationConfiguration)

The AuthenticationConfiguration used to generate this authentication result.

authenticationResult_customerSpeakerId :: Lens' AuthenticationResult (Maybe Text)

The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId is provided for the session.

authenticationResult_decision :: Lens' AuthenticationResult (Maybe AuthenticationDecision)

The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.

authenticationResult_generatedSpeakerId :: Lens' AuthenticationResult (Maybe Text)

The service-generated identifier for the speaker whose authentication result is produced.

authenticationResult_score :: Lens' AuthenticationResult (Maybe Natural)

The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either ACCEPT or REJECT.