Amazonka.FraudDetector.GetEventPredictionMetadata

Gets details of the past fraud predictions for the specified event ID, event type, detector ID, and detector version ID that was generated in the specified time period.

Creating a Request

data GetEventPredictionMetadata

See: newGetEventPredictionMetadata smart constructor.

Constructors

GetEventPredictionMetadata'

Fields

• eventId :: Text

  The event ID.

• eventTypeName :: Text

  The event type associated with the detector specified for the prediction.

• detectorId :: Text

  The detector ID.

• detectorVersionId :: Text

  The detector version ID.

• predictionTimestamp :: Text

  The timestamp that defines when the prediction was generated. The timestamp must be specified using ISO 8601 standard in UTC.

  We recommend calling ListEventPredictions first, and using the predictionTimestamp value in the response to provide an accurate prediction timestamp value.

Instances

ToJSON GetEventPredictionMetadata

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

Methods

toJSON :: GetEventPredictionMetadata -> Value

toEncoding :: GetEventPredictionMetadata -> Encoding

toJSONList :: [GetEventPredictionMetadata] -> Value

toEncodingList :: [GetEventPredictionMetadata] -> Encoding

ToHeaders GetEventPredictionMetadata

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

Methods

toHeaders :: GetEventPredictionMetadata -> [Header]

ToPath GetEventPredictionMetadata

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

Methods

toPath :: GetEventPredictionMetadata -> ByteString

ToQuery GetEventPredictionMetadata

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

Methods

toQuery :: GetEventPredictionMetadata -> QueryString

AWSRequest GetEventPredictionMetadata

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

Associated Types

type AWSResponse GetEventPredictionMetadata

Methods

request :: (Service -> Service) -> GetEventPredictionMetadata -> Request GetEventPredictionMetadata

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetEventPredictionMetadata -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetEventPredictionMetadata)))

Generic GetEventPredictionMetadata

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

Associated Types

type Rep GetEventPredictionMetadata :: Type -> Type

Methods

from :: GetEventPredictionMetadata -> Rep GetEventPredictionMetadata x

to :: Rep GetEventPredictionMetadata x -> GetEventPredictionMetadata

Read GetEventPredictionMetadata

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

Methods

readsPrec :: Int -> ReadS GetEventPredictionMetadata

readList :: ReadS [GetEventPredictionMetadata]

readPrec :: ReadPrec GetEventPredictionMetadata

readListPrec :: ReadPrec [GetEventPredictionMetadata]

Show GetEventPredictionMetadata

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

Methods

showsPrec :: Int -> GetEventPredictionMetadata -> ShowS

show :: GetEventPredictionMetadata -> String

showList :: [GetEventPredictionMetadata] -> ShowS

NFData GetEventPredictionMetadata

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

Methods

rnf :: GetEventPredictionMetadata -> ()

Eq GetEventPredictionMetadata

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

Methods

(==) :: GetEventPredictionMetadata -> GetEventPredictionMetadata -> Bool

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

Hashable GetEventPredictionMetadata

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

Methods

hashWithSalt :: Int -> GetEventPredictionMetadata -> Int

hash :: GetEventPredictionMetadata -> Int

type AWSResponse GetEventPredictionMetadata

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

type AWSResponse GetEventPredictionMetadata = GetEventPredictionMetadataResponse

type Rep GetEventPredictionMetadata

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

type Rep GetEventPredictionMetadata = D1 ('MetaData "GetEventPredictionMetadata" "Amazonka.FraudDetector.GetEventPredictionMetadata" "amazonka-frauddetector-2.0-CdXFXtLV8DgKo4Kta7Jw61" 'False) (C1 ('MetaCons "GetEventPredictionMetadata'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eventId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "eventTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "detectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "detectorVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "predictionTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetEventPredictionMetadata

Arguments

:: Text

GetEventPredictionMetadata

-> Text

GetEventPredictionMetadata

-> Text

GetEventPredictionMetadata

-> Text

GetEventPredictionMetadata

-> Text

GetEventPredictionMetadata

-> GetEventPredictionMetadata

Create a value of GetEventPredictionMetadata 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:

GetEventPredictionMetadata, getEventPredictionMetadata_eventId - The event ID.

GetEventPredictionMetadata, getEventPredictionMetadata_eventTypeName - The event type associated with the detector specified for the prediction.

GetEventPredictionMetadata, getEventPredictionMetadata_detectorId - The detector ID.

GetEventPredictionMetadata, getEventPredictionMetadata_detectorVersionId - The detector version ID.

GetEventPredictionMetadata, getEventPredictionMetadata_predictionTimestamp - The timestamp that defines when the prediction was generated. The timestamp must be specified using ISO 8601 standard in UTC.

We recommend calling ListEventPredictions first, and using the predictionTimestamp value in the response to provide an accurate prediction timestamp value.

Request Lenses

getEventPredictionMetadata_eventId :: Lens' GetEventPredictionMetadata Text

The event ID.

getEventPredictionMetadata_eventTypeName :: Lens' GetEventPredictionMetadata Text

The event type associated with the detector specified for the prediction.

getEventPredictionMetadata_detectorId :: Lens' GetEventPredictionMetadata Text

The detector ID.

getEventPredictionMetadata_detectorVersionId :: Lens' GetEventPredictionMetadata Text

The detector version ID.

getEventPredictionMetadata_predictionTimestamp :: Lens' GetEventPredictionMetadata Text

The timestamp that defines when the prediction was generated. The timestamp must be specified using ISO 8601 standard in UTC.

We recommend calling ListEventPredictions first, and using the predictionTimestamp value in the response to provide an accurate prediction timestamp value.

Destructuring the Response

data GetEventPredictionMetadataResponse

See: newGetEventPredictionMetadataResponse smart constructor.

Constructors

GetEventPredictionMetadataResponse'

Fields

• detectorId :: Maybe Text

  The detector ID.

• detectorVersionId :: Maybe Text

  The detector version ID.

• detectorVersionStatus :: Maybe Text

  The status of the detector version.

• entityId :: Maybe Text

  The entity ID.

• entityType :: Maybe Text

  The entity type.

• evaluatedExternalModels :: Maybe [EvaluatedExternalModel]

  External (Amazon SageMaker) models that were evaluated for generating predictions.

• evaluatedModelVersions :: Maybe [EvaluatedModelVersion]

  Model versions that were evaluated for generating predictions.

• eventId :: Maybe Text

  The event ID.

• eventTimestamp :: Maybe Text

  The timestamp for when the prediction was generated for the associated event ID.

• eventTypeName :: Maybe Text

  The event type associated with the detector specified for this prediction.

• eventVariables :: Maybe [EventVariableSummary]

  A list of event variables that influenced the prediction scores.

• outcomes :: Maybe [Text]

  The outcomes of the matched rule, based on the rule execution mode.

• predictionTimestamp :: Maybe Text

  The timestamp that defines when the prediction was generated.

• ruleExecutionMode :: Maybe RuleExecutionMode

  The execution mode of the rule used for evaluating variable values.

• rules :: Maybe [EvaluatedRule]

  List of rules associated with the detector version that were used for evaluating variable values.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetEventPredictionMetadataResponse

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

Associated Types

type Rep GetEventPredictionMetadataResponse :: Type -> Type

Methods

from :: GetEventPredictionMetadataResponse -> Rep GetEventPredictionMetadataResponse x

to :: Rep GetEventPredictionMetadataResponse x -> GetEventPredictionMetadataResponse

Show GetEventPredictionMetadataResponse

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

Methods

showsPrec :: Int -> GetEventPredictionMetadataResponse -> ShowS

show :: GetEventPredictionMetadataResponse -> String

showList :: [GetEventPredictionMetadataResponse] -> ShowS

NFData GetEventPredictionMetadataResponse

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

Methods

rnf :: GetEventPredictionMetadataResponse -> ()

Eq GetEventPredictionMetadataResponse

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

Methods

(==) :: GetEventPredictionMetadataResponse -> GetEventPredictionMetadataResponse -> Bool

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

type Rep GetEventPredictionMetadataResponse

Defined in Amazonka.FraudDetector.GetEventPredictionMetadata

type Rep GetEventPredictionMetadataResponse = D1 ('MetaData "GetEventPredictionMetadataResponse" "Amazonka.FraudDetector.GetEventPredictionMetadata" "amazonka-frauddetector-2.0-CdXFXtLV8DgKo4Kta7Jw61" 'False) (C1 ('MetaCons "GetEventPredictionMetadataResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "detectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "detectorVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "detectorVersionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "entityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "evaluatedExternalModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EvaluatedExternalModel]))) :*: (S1 ('MetaSel ('Just "evaluatedModelVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EvaluatedModelVersion])) :*: S1 ('MetaSel ('Just "eventId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "eventTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eventTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "eventVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventVariableSummary])) :*: S1 ('MetaSel ('Just "outcomes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "predictionTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ruleExecutionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleExecutionMode))) :*: (S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EvaluatedRule])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetEventPredictionMetadataResponse

Arguments

:: Int

$sel:httpStatus:GetEventPredictionMetadataResponse'

-> GetEventPredictionMetadataResponse

Create a value of GetEventPredictionMetadataResponse 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:

GetEventPredictionMetadata, getEventPredictionMetadataResponse_detectorId - The detector ID.

GetEventPredictionMetadata, getEventPredictionMetadataResponse_detectorVersionId - The detector version ID.

$sel:detectorVersionStatus:GetEventPredictionMetadataResponse', getEventPredictionMetadataResponse_detectorVersionStatus - The status of the detector version.

GetEventPredictionMetadataResponse, getEventPredictionMetadataResponse_entityId - The entity ID.

GetEventPredictionMetadataResponse, getEventPredictionMetadataResponse_entityType - The entity type.

$sel:evaluatedExternalModels:GetEventPredictionMetadataResponse', getEventPredictionMetadataResponse_evaluatedExternalModels - External (Amazon SageMaker) models that were evaluated for generating predictions.

$sel:evaluatedModelVersions:GetEventPredictionMetadataResponse', getEventPredictionMetadataResponse_evaluatedModelVersions - Model versions that were evaluated for generating predictions.

GetEventPredictionMetadata, getEventPredictionMetadataResponse_eventId - The event ID.

GetEventPredictionMetadataResponse, getEventPredictionMetadataResponse_eventTimestamp - The timestamp for when the prediction was generated for the associated event ID.

GetEventPredictionMetadata, getEventPredictionMetadataResponse_eventTypeName - The event type associated with the detector specified for this prediction.

GetEventPredictionMetadataResponse, getEventPredictionMetadataResponse_eventVariables - A list of event variables that influenced the prediction scores.

GetEventPredictionMetadataResponse, getEventPredictionMetadataResponse_outcomes - The outcomes of the matched rule, based on the rule execution mode.

GetEventPredictionMetadata, getEventPredictionMetadataResponse_predictionTimestamp - The timestamp that defines when the prediction was generated.

$sel:ruleExecutionMode:GetEventPredictionMetadataResponse', getEventPredictionMetadataResponse_ruleExecutionMode - The execution mode of the rule used for evaluating variable values.

$sel:rules:GetEventPredictionMetadataResponse', getEventPredictionMetadataResponse_rules - List of rules associated with the detector version that were used for evaluating variable values.

$sel:httpStatus:GetEventPredictionMetadataResponse', getEventPredictionMetadataResponse_httpStatus - The response's http status code.

Response Lenses

getEventPredictionMetadataResponse_detectorId :: Lens' GetEventPredictionMetadataResponse (Maybe Text)

The detector ID.

getEventPredictionMetadataResponse_detectorVersionId :: Lens' GetEventPredictionMetadataResponse (Maybe Text)

The detector version ID.

getEventPredictionMetadataResponse_detectorVersionStatus :: Lens' GetEventPredictionMetadataResponse (Maybe Text)

The status of the detector version.

getEventPredictionMetadataResponse_entityId :: Lens' GetEventPredictionMetadataResponse (Maybe Text)

The entity ID.

getEventPredictionMetadataResponse_entityType :: Lens' GetEventPredictionMetadataResponse (Maybe Text)

The entity type.

getEventPredictionMetadataResponse_evaluatedExternalModels :: Lens' GetEventPredictionMetadataResponse (Maybe [EvaluatedExternalModel])

External (Amazon SageMaker) models that were evaluated for generating predictions.

getEventPredictionMetadataResponse_evaluatedModelVersions :: Lens' GetEventPredictionMetadataResponse (Maybe [EvaluatedModelVersion])

Model versions that were evaluated for generating predictions.

getEventPredictionMetadataResponse_eventId :: Lens' GetEventPredictionMetadataResponse (Maybe Text)

The event ID.

getEventPredictionMetadataResponse_eventTimestamp :: Lens' GetEventPredictionMetadataResponse (Maybe Text)

The timestamp for when the prediction was generated for the associated event ID.

getEventPredictionMetadataResponse_eventTypeName :: Lens' GetEventPredictionMetadataResponse (Maybe Text)

The event type associated with the detector specified for this prediction.

getEventPredictionMetadataResponse_eventVariables :: Lens' GetEventPredictionMetadataResponse (Maybe [EventVariableSummary])

A list of event variables that influenced the prediction scores.

getEventPredictionMetadataResponse_outcomes :: Lens' GetEventPredictionMetadataResponse (Maybe [Text])

The outcomes of the matched rule, based on the rule execution mode.

getEventPredictionMetadataResponse_predictionTimestamp :: Lens' GetEventPredictionMetadataResponse (Maybe Text)

The timestamp that defines when the prediction was generated.

getEventPredictionMetadataResponse_ruleExecutionMode :: Lens' GetEventPredictionMetadataResponse (Maybe RuleExecutionMode)

The execution mode of the rule used for evaluating variable values.

getEventPredictionMetadataResponse_rules :: Lens' GetEventPredictionMetadataResponse (Maybe [EvaluatedRule])

List of rules associated with the detector version that were used for evaluating variable values.

getEventPredictionMetadataResponse_httpStatus :: Lens' GetEventPredictionMetadataResponse Int

The response's http status code.