@aws-sdk/client-frauddetector 3.47.2 → 3.51.0

package/dist-types/commands/GetEventPredictionMetadataCommand.d.ts

@@ -0,0 +1,37 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { FraudDetectorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FraudDetectorClient";
+import { GetEventPredictionMetadataRequest, GetEventPredictionMetadataResult } from "../models/models_0";
+export interface GetEventPredictionMetadataCommandInput extends GetEventPredictionMetadataRequest {
+}
+export interface GetEventPredictionMetadataCommandOutput extends GetEventPredictionMetadataResult, __MetadataBearer {
+}
+/**
+ * <p>
+ * 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.
+ * </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { FraudDetectorClient, GetEventPredictionMetadataCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
+ * // const { FraudDetectorClient, GetEventPredictionMetadataCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
+ * const client = new FraudDetectorClient(config);
+ * const command = new GetEventPredictionMetadataCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link GetEventPredictionMetadataCommandInput} for command's `input` shape.
+ * @see {@link GetEventPredictionMetadataCommandOutput} for command's `response` shape.
+ * @see {@link FraudDetectorClientResolvedConfig | config} for FraudDetectorClient's `config` shape.
+ *
+ */
+export declare class GetEventPredictionMetadataCommand extends $Command<GetEventPredictionMetadataCommandInput, GetEventPredictionMetadataCommandOutput, FraudDetectorClientResolvedConfig> {
+    readonly input: GetEventPredictionMetadataCommandInput;
+    constructor(input: GetEventPredictionMetadataCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FraudDetectorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEventPredictionMetadataCommandInput, GetEventPredictionMetadataCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/ListEventPredictionsCommand.d.ts

@@ -0,0 +1,48 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { FraudDetectorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FraudDetectorClient";
+import { ListEventPredictionsRequest, ListEventPredictionsResult } from "../models/models_0";
+export interface ListEventPredictionsCommandInput extends ListEventPredictionsRequest {
+}
+export interface ListEventPredictionsCommandOutput extends ListEventPredictionsResult, __MetadataBearer {
+}
+/**
+ * <p>Gets a list of past predictions. The list can be filtered by detector ID, detector version ID, event ID, event type, or by specifying a time period.
+ *     If filter is not specified, the most recent prediction is returned.</p>
+ *
+ *          <p>For example, the following filter lists all past predictions for <code>xyz</code> event type -
+ *     <code>{
+ *         "eventType":{
+ *         "value": "xyz" }”
+ *         }  </code>
+ *          </p>
+ *
+ *          <p>This is a paginated API. If you provide a null <code>maxResults</code>, this action will retrieve a maximum of 10 records per page.
+ *   If you provide a <code>maxResults</code>, the value must be between 50 and 100. To get the next page results, provide
+ *   the <code>nextToken</code> from the response as part of your request. A null <code>nextToken</code> fetches the records from the beginning.
+ * </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { FraudDetectorClient, ListEventPredictionsCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
+ * // const { FraudDetectorClient, ListEventPredictionsCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
+ * const client = new FraudDetectorClient(config);
+ * const command = new ListEventPredictionsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link ListEventPredictionsCommandInput} for command's `input` shape.
+ * @see {@link ListEventPredictionsCommandOutput} for command's `response` shape.
+ * @see {@link FraudDetectorClientResolvedConfig | config} for FraudDetectorClient's `config` shape.
+ *
+ */
+export declare class ListEventPredictionsCommand extends $Command<ListEventPredictionsCommandInput, ListEventPredictionsCommandOutput, FraudDetectorClientResolvedConfig> {
+    readonly input: ListEventPredictionsCommandInput;
+    constructor(input: ListEventPredictionsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FraudDetectorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListEventPredictionsCommandInput, ListEventPredictionsCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/index.d.ts

@@ -34,6 +34,7 @@ export * from "./GetDetectorsCommand";
 export * from "./GetEntityTypesCommand";
 export * from "./GetEventCommand";
 export * from "./GetEventPredictionCommand";
+export * from "./GetEventPredictionMetadataCommand";
 export * from "./GetEventTypesCommand";
 export * from "./GetExternalModelsCommand";
 export * from "./GetKMSEncryptionKeyCommand";
@@ -43,6 +44,7 @@ export * from "./GetModelsCommand";
 export * from "./GetOutcomesCommand";
 export * from "./GetRulesCommand";
 export * from "./GetVariablesCommand";
+export * from "./ListEventPredictionsCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./PutDetectorCommand";
 export * from "./PutEntityTypeCommand";

package/dist-types/models/models_0.d.ts

@@ -2234,6 +2234,394 @@ export interface ResourceUnavailableException extends __SmithyException, $Metada
     $fault: "client";
     message?: string;
 }
+export interface GetEventPredictionMetadataRequest {
+    /**
+     * <p>
+     * The event ID.
+     * </p>
+     */
+    eventId: string | undefined;
+    /**
+     * <p>
+     * The event type associated with the detector specified for the prediction.
+     * </p>
+     */
+    eventTypeName: string | undefined;
+    /**
+     * <p>
+     * The detector ID.
+     * </p>
+     */
+    detectorId: string | undefined;
+    /**
+     * <p>
+     * The detector version ID.
+     * </p>
+     */
+    detectorVersionId: string | undefined;
+    /**
+     * <p>
+     * The timestamp that defines when the prediction was generated.
+     * </p>
+     */
+    predictionTimestamp: string | undefined;
+}
+export declare namespace GetEventPredictionMetadataRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: GetEventPredictionMetadataRequest) => any;
+}
+/**
+ * <p>
+ * The details of the external (Amazon Sagemaker) model evaluated for generating predictions.
+ * </p>
+ */
+export interface EvaluatedExternalModel {
+    /**
+     * <p>
+     * The endpoint of the external (Amazon Sagemaker) model.
+     * </p>
+     */
+    modelEndpoint?: string;
+    /**
+     * <p>
+     * Indicates whether event variables were used to generate predictions.
+     * </p>
+     */
+    useEventVariables?: boolean;
+    /**
+     * <p>
+     * Input variables use for generating predictions.
+     * </p>
+     */
+    inputVariables?: {
+        [key: string]: string;
+    };
+    /**
+     * <p>
+     * Output variables.
+     * </p>
+     */
+    outputVariables?: {
+        [key: string]: string;
+    };
+}
+export declare namespace EvaluatedExternalModel {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: EvaluatedExternalModel) => any;
+}
+/**
+ * <p>
+ * The details of the event variable's impact on the prediction score.
+ * </p>
+ */
+export interface VariableImpactExplanation {
+    /**
+     * <p>
+     * The event variable name.
+     * </p>
+     */
+    eventVariableName?: string;
+    /**
+     * <p>
+     *     The event variable's relative impact in terms of magnitude on the prediction scores.
+     *     The relative impact values consist of a numerical rating (0-5, 5 being the highest) and direction (increased/decreased) impact of the fraud risk.
+     * </p>
+     */
+    relativeImpact?: string;
+    /**
+     * <p>
+     *     The raw, uninterpreted value represented as log-odds of the fraud. These values are usually between -10 to +10, but range from - infinity to + infinity.</p>
+     *          <ul>
+     *             <li>
+     *                <p>A positive value indicates that the variable drove the risk score up.</p>
+     *             </li>
+     *             <li>
+     *                <p>A negative value indicates that the variable drove the risk score down.</p>
+     *             </li>
+     *          </ul>
+     */
+    logOddsImpact?: number;
+}
+export declare namespace VariableImpactExplanation {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: VariableImpactExplanation) => any;
+}
+/**
+ * <p>
+ * The prediction explanations that provide insight into how each event variable impacted the model version's fraud prediction score.
+ * </p>
+ */
+export interface PredictionExplanations {
+    /**
+     * <p>
+     * The details of the event variable's impact on the prediction score.
+     * </p>
+     */
+    variableImpactExplanations?: VariableImpactExplanation[];
+}
+export declare namespace PredictionExplanations {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: PredictionExplanations) => any;
+}
+/**
+ * <p>
+ * The model version evalutions.
+ * </p>
+ */
+export interface ModelVersionEvaluation {
+    /**
+     * <p>
+     * The output variable name.
+     * </p>
+     */
+    outputVariableName?: string;
+    /**
+     * <p>
+     * The evaluation score generated for the model version.
+     * </p>
+     */
+    evaluationScore?: string;
+    /**
+     * <p>
+     * The prediction explanations generated for the model version.
+     * </p>
+     */
+    predictionExplanations?: PredictionExplanations;
+}
+export declare namespace ModelVersionEvaluation {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: ModelVersionEvaluation) => any;
+}
+/**
+ * <p>
+ * The model version evaluated for generating prediction.
+ * </p>
+ */
+export interface EvaluatedModelVersion {
+    /**
+     * <p>
+     * The model ID.
+     * </p>
+     */
+    modelId?: string;
+    /**
+     * <p>
+     * The model version.
+     * </p>
+     */
+    modelVersion?: string;
+    /**
+     * <p>The model type. </p>
+     *          <p>Valid values: <code>ONLINE_FRAUD_INSIGHTS</code> | <code>TRANSACTION_FRAUD_INSIGHTS</code>
+     *          </p>
+     */
+    modelType?: string;
+    /**
+     * <p>
+     * Evaluations generated for the model version.
+     * </p>
+     */
+    evaluations?: ModelVersionEvaluation[];
+}
+export declare namespace EvaluatedModelVersion {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: EvaluatedModelVersion) => any;
+}
+/**
+ * <p>
+ * Information about the summary of an event variable that was evaluated for generating prediction.
+ * </p>
+ */
+export interface EventVariableSummary {
+    /**
+     * <p>
+     * The event variable name.
+     * </p>
+     */
+    name?: string;
+    /**
+     * <p>
+     * The value of the event variable.
+     * </p>
+     */
+    value?: string;
+    /**
+     * <p>
+     * The event variable source.
+     * </p>
+     */
+    source?: string;
+}
+export declare namespace EventVariableSummary {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: EventVariableSummary) => any;
+}
+/**
+ * <p>
+ * The details of the rule used for evaluating variable values.
+ * </p>
+ */
+export interface EvaluatedRule {
+    /**
+     * <p>
+     * The rule ID.
+     * </p>
+     */
+    ruleId?: string;
+    /**
+     * <p>
+     * The rule version.
+     * </p>
+     */
+    ruleVersion?: string;
+    /**
+     * <p>
+     * The rule expression.
+     * </p>
+     */
+    expression?: string;
+    /**
+     * <p>
+     * The rule expression value.
+     * </p>
+     */
+    expressionWithValues?: string;
+    /**
+     * <p>
+     * The rule outcome.
+     * </p>
+     */
+    outcomes?: string[];
+    /**
+     * <p>
+     * Indicates whether the rule was evaluated.
+     * </p>
+     */
+    evaluated?: boolean;
+    /**
+     * <p>
+     * Indicates whether the rule matched.
+     * </p>
+     */
+    matched?: boolean;
+}
+export declare namespace EvaluatedRule {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: EvaluatedRule) => any;
+}
+export interface GetEventPredictionMetadataResult {
+    /**
+     * <p>
+     * The event ID.
+     * </p>
+     */
+    eventId?: string;
+    /**
+     * <p>
+     * The event type associated with the detector specified for this prediction.
+     * </p>
+     */
+    eventTypeName?: string;
+    /**
+     * <p>
+     * The entity ID.
+     * </p>
+     */
+    entityId?: string;
+    /**
+     * <p>
+     * The entity type.
+     * </p>
+     */
+    entityType?: string;
+    /**
+     * <p>
+     * The timestamp for when the prediction was generated for the associated event ID.
+     * </p>
+     */
+    eventTimestamp?: string;
+    /**
+     * <p>
+     * The detector ID.
+     * </p>
+     */
+    detectorId?: string;
+    /**
+     * <p>
+     * The detector version ID.
+     * </p>
+     */
+    detectorVersionId?: string;
+    /**
+     * <p>
+     * The status of the detector version.
+     * </p>
+     */
+    detectorVersionStatus?: string;
+    /**
+     * <p>
+     * A list of event variables that influenced the prediction scores.
+     * </p>
+     */
+    eventVariables?: EventVariableSummary[];
+    /**
+     * <p>
+     * List of rules associated with the detector version that were used for evaluating variable values.
+     * </p>
+     */
+    rules?: EvaluatedRule[];
+    /**
+     * <p>
+     * The execution mode of the rule used for evaluating variable values.
+     * </p>
+     */
+    ruleExecutionMode?: RuleExecutionMode | string;
+    /**
+     * <p>
+     * The outcomes of the matched rule, based on the rule execution mode.
+     * </p>
+     */
+    outcomes?: string[];
+    /**
+     * <p>
+     * Model versions that were evaluated for generating predictions.
+     * </p>
+     */
+    evaluatedModelVersions?: EvaluatedModelVersion[];
+    /**
+     * <p>
+     * External (Amazon SageMaker) models that were evaluated for generating predictions.
+     * </p>
+     */
+    evaluatedExternalModels?: EvaluatedExternalModel[];
+    /**
+     * <p>The timestamp that defines when the prediction was generated.
+     * </p>
+     */
+    predictionTimestamp?: string;
+}
+export declare namespace GetEventPredictionMetadataResult {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: GetEventPredictionMetadataResult) => any;
+}
 export interface GetEventTypesRequest {
     /**
      * <p>The name.</p>
@@ -3001,6 +3389,169 @@ export declare namespace GetVariablesResult {
      */
     const filterSensitiveLog: (obj: GetVariablesResult) => any;
 }
+/**
+ * <p>
+ * A conditional statement for filtering a list of past predictions.
+ * </p>
+ */
+export interface FilterCondition {
+    /**
+     * <p>
+     * A statement containing a resource property and a value to specify filter condition.
+     * </p>
+     */
+    value?: string;
+}
+export declare namespace FilterCondition {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: FilterCondition) => any;
+}
+/**
+ * <p>
+ * The time period for when the predictions were generated.
+ * </p>
+ */
+export interface PredictionTimeRange {
+    /**
+     * <p>
+     * The start time of the time period for when the predictions were generated.
+     * </p>
+     */
+    startTime: string | undefined;
+    /**
+     * <p>
+     * The end time of the time period for when the predictions were generated.
+     * </p>
+     */
+    endTime: string | undefined;
+}
+export declare namespace PredictionTimeRange {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: PredictionTimeRange) => any;
+}
+export interface ListEventPredictionsRequest {
+    /**
+     * <p>
+     * The event ID.
+     * </p>
+     */
+    eventId?: FilterCondition;
+    /**
+     * <p>
+     * The event type associated with the detector.
+     * </p>
+     */
+    eventType?: FilterCondition;
+    /**
+     * <p>
+     * The detector ID.
+     * </p>
+     */
+    detectorId?: FilterCondition;
+    /**
+     * <p>
+     * The detector version ID.
+     * </p>
+     */
+    detectorVersionId?: FilterCondition;
+    /**
+     * <p>
+     * The time period for when the predictions were generated.
+     * </p>
+     */
+    predictionTimeRange?: PredictionTimeRange;
+    /**
+     * <p>
+     * Identifies the next page of results to return. Use the token to make the call again to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
+     * </p>
+     */
+    nextToken?: string;
+    /**
+     * <p>
+     * The maximum number of predictions to return for the request.
+     * </p>
+     */
+    maxResults?: number;
+}
+export declare namespace ListEventPredictionsRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: ListEventPredictionsRequest) => any;
+}
+/**
+ * <p>
+ * Information about the summary of an event prediction.
+ * </p>
+ */
+export interface EventPredictionSummary {
+    /**
+     * <p>
+     * The event ID.
+     * </p>
+     */
+    eventId?: string;
+    /**
+     * <p>
+     * The event type.
+     * </p>
+     */
+    eventTypeName?: string;
+    /**
+     * <p>
+     * The timestamp of the event.
+     * </p>
+     */
+    eventTimestamp?: string;
+    /**
+     * <p>
+     * The timestamp when the prediction was generated.
+     * </p>
+     */
+    predictionTimestamp?: string;
+    /**
+     * <p>
+     * The detector ID.
+     * </p>
+     */
+    detectorId?: string;
+    /**
+     * <p>
+     * The detector version ID.
+     * </p>
+     */
+    detectorVersionId?: string;
+}
+export declare namespace EventPredictionSummary {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: EventPredictionSummary) => any;
+}
+export interface ListEventPredictionsResult {
+    /**
+     * <p>
+     * The summary of the past predictions.
+     * </p>
+     */
+    eventPredictionSummaries?: EventPredictionSummary[];
+    /**
+     * <p>
+     * Identifies the next page of results to return. Use the token to make the call again to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
+     * </p>
+     */
+    nextToken?: string;
+}
+export declare namespace ListEventPredictionsResult {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: ListEventPredictionsResult) => any;
+}
 export interface ListTagsForResourceRequest {
     /**
      * <p>The ARN that specifies the resource whose tags you want to list.</p>

package/dist-types/pagination/ListEventPredictionsPaginator.d.ts

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListEventPredictionsCommandInput, ListEventPredictionsCommandOutput } from "../commands/ListEventPredictionsCommand";
+import { FraudDetectorPaginationConfiguration } from "./Interfaces";
+export declare function paginateListEventPredictions(config: FraudDetectorPaginationConfiguration, input: ListEventPredictionsCommandInput, ...additionalArguments: any): Paginator<ListEventPredictionsCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -11,4 +11,5 @@ export * from "./GetOutcomesPaginator";
 export * from "./Interfaces";
 export * from "./GetRulesPaginator";
 export * from "./GetVariablesPaginator";
+export * from "./ListEventPredictionsPaginator";
 export * from "./ListTagsForResourcePaginator";