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

Amazonka.VoiceId.Types.FraudDetectionResult

Description

Synopsis

Documentation

data FraudDetectionResult Source #

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

See: newFraudDetectionResult smart constructor.

Constructors

FraudDetectionResult'

Fields

reasons :: Maybe [FraudDetectionReason]
The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is HIGH_RISK, and only has one possible value: KNOWN_FRAUDSTER.
riskDetails :: Maybe FraudRiskDetails
Details about each risk analyzed for this speaker.
fraudDetectionResultId :: Maybe Text
The unique identifier for this fraud detection result. Given there can be multiple fraud detections for a given session, this field helps in identifying if the returned result is from previous streaming activity or a new result. Note that in the absence of any new streaming activity or risk threshold changes, Voice ID always returns cached Fraud Detection result for this API.
decision :: Maybe FraudDetectionDecision
The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
configuration :: Maybe FraudDetectionConfiguration
The FraudDetectionConfiguration used to generate this fraud detection result.
audioAggregationStartedAt :: Maybe POSIX
A timestamp indicating when audio aggregation started for this fraud detection result.
audioAggregationEndedAt :: Maybe POSIX
A timestamp indicating when audio aggregation ended for this fraud detection result.

Instances

Instances details

Eq FraudDetectionResult Source #
Instance details Defined in Amazonka.VoiceId.Types.FraudDetectionResult Methods (==) :: FraudDetectionResult -> FraudDetectionResult -> Bool # (/=) :: FraudDetectionResult -> FraudDetectionResult -> Bool #
Read FraudDetectionResult Source #
Instance details Defined in Amazonka.VoiceId.Types.FraudDetectionResult Methods readsPrec :: Int -> ReadS FraudDetectionResult # readList :: ReadS [FraudDetectionResult] # readPrec :: ReadPrec FraudDetectionResult # readListPrec :: ReadPrec [FraudDetectionResult] #
Show FraudDetectionResult Source #
Instance details Defined in Amazonka.VoiceId.Types.FraudDetectionResult Methods showsPrec :: Int -> FraudDetectionResult -> ShowS # show :: FraudDetectionResult -> String # showList :: [FraudDetectionResult] -> ShowS #
Generic FraudDetectionResult Source #
Instance details Defined in Amazonka.VoiceId.Types.FraudDetectionResult Associated Types type Rep FraudDetectionResult :: Type -> Type # Methods from :: FraudDetectionResult -> Rep FraudDetectionResult x # to :: Rep FraudDetectionResult x -> FraudDetectionResult #
NFData FraudDetectionResult Source #
Instance details Defined in Amazonka.VoiceId.Types.FraudDetectionResult Methods rnf :: FraudDetectionResult -> () #
Hashable FraudDetectionResult Source #
Instance details Defined in Amazonka.VoiceId.Types.FraudDetectionResult Methods hashWithSalt :: Int -> FraudDetectionResult -> Int # hash :: FraudDetectionResult -> Int #
FromJSON FraudDetectionResult Source #
Instance details Defined in Amazonka.VoiceId.Types.FraudDetectionResult Methods parseJSON :: Value -> Parser FraudDetectionResult # parseJSONList :: Value -> Parser [FraudDetectionResult] #
type Rep FraudDetectionResult Source #
Instance details Defined in Amazonka.VoiceId.Types.FraudDetectionResult type Rep FraudDetectionResult = D1 ('MetaData "FraudDetectionResult" "Amazonka.VoiceId.Types.FraudDetectionResult" "libZSservicesZSamazonka-voice-idZSamazonka-voice-id" 'False) (C1 ('MetaCons "FraudDetectionResult'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "reasons") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FraudDetectionReason])) :: (S1 ('MetaSel ('Just "riskDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FraudRiskDetails)) :: S1 ('MetaSel ('Just "fraudDetectionResultId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "decision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FraudDetectionDecision)) :: S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FraudDetectionConfiguration))) :: (S1 ('MetaSel ('Just "audioAggregationStartedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "audioAggregationEndedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newFraudDetectionResult :: FraudDetectionResult Source #

Create a value of FraudDetectionResult 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:reasons:FraudDetectionResult', fraudDetectionResult_reasons - The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is HIGH_RISK, and only has one possible value: KNOWN_FRAUDSTER.

$sel:riskDetails:FraudDetectionResult', fraudDetectionResult_riskDetails - Details about each risk analyzed for this speaker.

$sel:fraudDetectionResultId:FraudDetectionResult', fraudDetectionResult_fraudDetectionResultId - The unique identifier for this fraud detection result. Given there can be multiple fraud detections for a given session, this field helps in identifying if the returned result is from previous streaming activity or a new result. Note that in the absence of any new streaming activity or risk threshold changes, Voice ID always returns cached Fraud Detection result for this API.

$sel:decision:FraudDetectionResult', fraudDetectionResult_decision - The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.

$sel:configuration:FraudDetectionResult', fraudDetectionResult_configuration - The FraudDetectionConfiguration used to generate this fraud detection result.

$sel:audioAggregationStartedAt:FraudDetectionResult', fraudDetectionResult_audioAggregationStartedAt - A timestamp indicating when audio aggregation started for this fraud detection result.

$sel:audioAggregationEndedAt:FraudDetectionResult', fraudDetectionResult_audioAggregationEndedAt - A timestamp indicating when audio aggregation ended for this fraud detection result.

fraudDetectionResult_reasons :: Lens' FraudDetectionResult (Maybe [FraudDetectionReason]) Source #

The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is HIGH_RISK, and only has one possible value: KNOWN_FRAUDSTER.

fraudDetectionResult_riskDetails :: Lens' FraudDetectionResult (Maybe FraudRiskDetails) Source #

Details about each risk analyzed for this speaker.

fraudDetectionResult_fraudDetectionResultId :: Lens' FraudDetectionResult (Maybe Text) Source #

The unique identifier for this fraud detection result. Given there can be multiple fraud detections for a given session, this field helps in identifying if the returned result is from previous streaming activity or a new result. Note that in the absence of any new streaming activity or risk threshold changes, Voice ID always returns cached Fraud Detection result for this API.

fraudDetectionResult_decision :: Lens' FraudDetectionResult (Maybe FraudDetectionDecision) Source #

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

fraudDetectionResult_configuration :: Lens' FraudDetectionResult (Maybe FraudDetectionConfiguration) Source #

The FraudDetectionConfiguration used to generate this fraud detection result.

fraudDetectionResult_audioAggregationStartedAt :: Lens' FraudDetectionResult (Maybe UTCTime) Source #

A timestamp indicating when audio aggregation started for this fraud detection result.

fraudDetectionResult_audioAggregationEndedAt :: Lens' FraudDetectionResult (Maybe UTCTime) Source #

A timestamp indicating when audio aggregation ended for this fraud detection result.