1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package frauddetector
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/frauddetector/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Evaluates an event against a detector version. If a version ID is not provided,
15// the detector’s (ACTIVE) version is used.
16func (c *Client) GetEventPrediction(ctx context.Context, params *GetEventPredictionInput, optFns ...func(*Options)) (*GetEventPredictionOutput, error) {
17	if params == nil {
18		params = &GetEventPredictionInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "GetEventPrediction", params, optFns, addOperationGetEventPredictionMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*GetEventPredictionOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type GetEventPredictionInput struct {
32
33	// The detector ID.
34	//
35	// This member is required.
36	DetectorId *string
37
38	// The entity type (associated with the detector's event type) and specific entity
39	// ID representing who performed the event. If an entity id is not available, use
40	// "UNKNOWN."
41	//
42	// This member is required.
43	Entities []types.Entity
44
45	// The unique ID used to identify the event.
46	//
47	// This member is required.
48	EventId *string
49
50	// Timestamp that defines when the event under evaluation occurred.
51	//
52	// This member is required.
53	EventTimestamp *string
54
55	// The event type associated with the detector specified for the prediction.
56	//
57	// This member is required.
58	EventTypeName *string
59
60	// Names of the event type's variables you defined in Amazon Fraud Detector to
61	// represent data elements and their corresponding values for the event you are
62	// sending for evaluation.
63	//
64	// This member is required.
65	EventVariables map[string]string
66
67	// The detector version ID.
68	DetectorVersionId *string
69
70	// The Amazon SageMaker model endpoint input data blobs.
71	ExternalModelEndpointDataBlobs map[string]types.ModelEndpointDataBlob
72}
73
74type GetEventPredictionOutput struct {
75
76	// The model scores. Amazon Fraud Detector generates model scores between 0 and
77	// 1000, where 0 is low fraud risk and 1000 is high fraud risk. Model scores are
78	// directly related to the false positive rate (FPR). For example, a score of 600
79	// corresponds to an estimated 10% false positive rate whereas a score of 900
80	// corresponds to an estimated 2% false positive rate.
81	ModelScores []types.ModelScores
82
83	// The results.
84	RuleResults []types.RuleResult
85
86	// Metadata pertaining to the operation's result.
87	ResultMetadata middleware.Metadata
88}
89
90func addOperationGetEventPredictionMiddlewares(stack *middleware.Stack, options Options) (err error) {
91	err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetEventPrediction{}, middleware.After)
92	if err != nil {
93		return err
94	}
95	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetEventPrediction{}, middleware.After)
96	if err != nil {
97		return err
98	}
99	if err = addSetLoggerMiddleware(stack, options); err != nil {
100		return err
101	}
102	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
103		return err
104	}
105	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
106		return err
107	}
108	if err = addResolveEndpointMiddleware(stack, options); err != nil {
109		return err
110	}
111	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
112		return err
113	}
114	if err = addRetryMiddlewares(stack, options); err != nil {
115		return err
116	}
117	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
118		return err
119	}
120	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
121		return err
122	}
123	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
124		return err
125	}
126	if err = addClientUserAgent(stack); err != nil {
127		return err
128	}
129	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
130		return err
131	}
132	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
133		return err
134	}
135	if err = addOpGetEventPredictionValidationMiddleware(stack); err != nil {
136		return err
137	}
138	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetEventPrediction(options.Region), middleware.Before); err != nil {
139		return err
140	}
141	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
142		return err
143	}
144	if err = addResponseErrorMiddleware(stack); err != nil {
145		return err
146	}
147	if err = addRequestResponseLogging(stack, options); err != nil {
148		return err
149	}
150	return nil
151}
152
153func newServiceMetadataMiddleware_opGetEventPrediction(region string) *awsmiddleware.RegisterServiceMetadata {
154	return &awsmiddleware.RegisterServiceMetadata{
155		Region:        region,
156		ServiceID:     ServiceID,
157		SigningName:   "frauddetector",
158		OperationName: "GetEventPrediction",
159	}
160}
161