mypydantic.models.frauddetector

   1# Model Generated: Thu Mar  2 21:56:19 2023
   2
   3from __future__ import annotations
   4
   5from typing import (
   6    Any,
   7    Dict,
   8    IO,
   9    List,
  10    Literal,
  11    Mapping,
  12    Optional,
  13    Sequence,
  14    Type,
  15    Union,
  16)
  17
  18from botocore.response import StreamingBody
  19from pydantic import Field
  20
  21from mypydantic.models.base_model import BaseModel
  22
  23
  24class ATIMetricDataPointModel(BaseModel):
  25    cr: Optional[float] = Field(default=None, alias="cr")
  26    adr: Optional[float] = Field(default=None, alias="adr")
  27    threshold: Optional[float] = Field(default=None, alias="threshold")
  28    atodr: Optional[float] = Field(default=None, alias="atodr")
  29
  30
  31class ATIModelPerformanceModel(BaseModel):
  32    asi: Optional[float] = Field(default=None, alias="asi")
  33
  34
  35class AggregatedLogOddsMetricModel(BaseModel):
  36    variable_names: List[str] = Field(alias="variableNames")
  37    aggregated_variables_importance: float = Field(
  38        alias="aggregatedVariablesImportance"
  39    )
  40
  41
  42class AggregatedVariablesImpactExplanationModel(BaseModel):
  43    event_variable_names: Optional[List[str]] = Field(
  44        default=None, alias="eventVariableNames"
  45    )
  46    relative_impact: Optional[str] = Field(default=None, alias="relativeImpact")
  47    log_odds_impact: Optional[float] = Field(default=None, alias="logOddsImpact")
  48
  49
  50class AllowDenyListModel(BaseModel):
  51    name: str = Field(alias="name")
  52    description: Optional[str] = Field(default=None, alias="description")
  53    variable_type: Optional[str] = Field(default=None, alias="variableType")
  54    created_time: Optional[str] = Field(default=None, alias="createdTime")
  55    updated_time: Optional[str] = Field(default=None, alias="updatedTime")
  56    arn: Optional[str] = Field(default=None, alias="arn")
  57
  58
  59class BatchCreateVariableErrorModel(BaseModel):
  60    name: Optional[str] = Field(default=None, alias="name")
  61    code: Optional[int] = Field(default=None, alias="code")
  62    message: Optional[str] = Field(default=None, alias="message")
  63
  64
  65class TagModel(BaseModel):
  66    key: str = Field(alias="key")
  67    value: str = Field(alias="value")
  68
  69
  70class VariableEntryModel(BaseModel):
  71    name: Optional[str] = Field(default=None, alias="name")
  72    data_type: Optional[str] = Field(default=None, alias="dataType")
  73    data_source: Optional[str] = Field(default=None, alias="dataSource")
  74    default_value: Optional[str] = Field(default=None, alias="defaultValue")
  75    description: Optional[str] = Field(default=None, alias="description")
  76    variable_type: Optional[str] = Field(default=None, alias="variableType")
  77
  78
  79class ResponseMetadataModel(BaseModel):
  80    request_id: str = Field(alias="RequestId")
  81    host_id: str = Field(alias="HostId")
  82    http_status_code: int = Field(alias="HTTPStatusCode")
  83    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
  84    retry_attempts: int = Field(alias="RetryAttempts")
  85
  86
  87class BatchGetVariableErrorModel(BaseModel):
  88    name: Optional[str] = Field(default=None, alias="name")
  89    code: Optional[int] = Field(default=None, alias="code")
  90    message: Optional[str] = Field(default=None, alias="message")
  91
  92
  93class BatchGetVariableRequestModel(BaseModel):
  94    names: Sequence[str] = Field(alias="names")
  95
  96
  97class VariableModel(BaseModel):
  98    name: Optional[str] = Field(default=None, alias="name")
  99    data_type: Optional[Literal["BOOLEAN", "FLOAT", "INTEGER", "STRING"]] = Field(
 100        default=None, alias="dataType"
 101    )
 102    data_source: Optional[
 103        Literal["EVENT", "EXTERNAL_MODEL_SCORE", "MODEL_SCORE"]
 104    ] = Field(default=None, alias="dataSource")
 105    default_value: Optional[str] = Field(default=None, alias="defaultValue")
 106    description: Optional[str] = Field(default=None, alias="description")
 107    variable_type: Optional[str] = Field(default=None, alias="variableType")
 108    last_updated_time: Optional[str] = Field(default=None, alias="lastUpdatedTime")
 109    created_time: Optional[str] = Field(default=None, alias="createdTime")
 110    arn: Optional[str] = Field(default=None, alias="arn")
 111
 112
 113class BatchImportModel(BaseModel):
 114    job_id: Optional[str] = Field(default=None, alias="jobId")
 115    status: Optional[
 116        Literal[
 117            "CANCELED",
 118            "CANCEL_IN_PROGRESS",
 119            "COMPLETE",
 120            "FAILED",
 121            "IN_PROGRESS",
 122            "IN_PROGRESS_INITIALIZING",
 123        ]
 124    ] = Field(default=None, alias="status")
 125    failure_reason: Optional[str] = Field(default=None, alias="failureReason")
 126    start_time: Optional[str] = Field(default=None, alias="startTime")
 127    completion_time: Optional[str] = Field(default=None, alias="completionTime")
 128    input_path: Optional[str] = Field(default=None, alias="inputPath")
 129    output_path: Optional[str] = Field(default=None, alias="outputPath")
 130    event_type_name: Optional[str] = Field(default=None, alias="eventTypeName")
 131    iam_role_arn: Optional[str] = Field(default=None, alias="iamRoleArn")
 132    arn: Optional[str] = Field(default=None, alias="arn")
 133    processed_records_count: Optional[int] = Field(
 134        default=None, alias="processedRecordsCount"
 135    )
 136    failed_records_count: Optional[int] = Field(
 137        default=None, alias="failedRecordsCount"
 138    )
 139    total_records_count: Optional[int] = Field(default=None, alias="totalRecordsCount")
 140
 141
 142class BatchPredictionModel(BaseModel):
 143    job_id: Optional[str] = Field(default=None, alias="jobId")
 144    status: Optional[
 145        Literal[
 146            "CANCELED",
 147            "CANCEL_IN_PROGRESS",
 148            "COMPLETE",
 149            "FAILED",
 150            "IN_PROGRESS",
 151            "IN_PROGRESS_INITIALIZING",
 152        ]
 153    ] = Field(default=None, alias="status")
 154    failure_reason: Optional[str] = Field(default=None, alias="failureReason")
 155    start_time: Optional[str] = Field(default=None, alias="startTime")
 156    completion_time: Optional[str] = Field(default=None, alias="completionTime")
 157    last_heartbeat_time: Optional[str] = Field(default=None, alias="lastHeartbeatTime")
 158    input_path: Optional[str] = Field(default=None, alias="inputPath")
 159    output_path: Optional[str] = Field(default=None, alias="outputPath")
 160    event_type_name: Optional[str] = Field(default=None, alias="eventTypeName")
 161    detector_name: Optional[str] = Field(default=None, alias="detectorName")
 162    detector_version: Optional[str] = Field(default=None, alias="detectorVersion")
 163    iam_role_arn: Optional[str] = Field(default=None, alias="iamRoleArn")
 164    arn: Optional[str] = Field(default=None, alias="arn")
 165    processed_records_count: Optional[int] = Field(
 166        default=None, alias="processedRecordsCount"
 167    )
 168    total_records_count: Optional[int] = Field(default=None, alias="totalRecordsCount")
 169
 170
 171class CancelBatchImportJobRequestModel(BaseModel):
 172    job_id: str = Field(alias="jobId")
 173
 174
 175class CancelBatchPredictionJobRequestModel(BaseModel):
 176    job_id: str = Field(alias="jobId")
 177
 178
 179class ModelVersionModel(BaseModel):
 180    model_id: str = Field(alias="modelId")
 181    model_type: Literal[
 182        "ACCOUNT_TAKEOVER_INSIGHTS",
 183        "ONLINE_FRAUD_INSIGHTS",
 184        "TRANSACTION_FRAUD_INSIGHTS",
 185    ] = Field(alias="modelType")
 186    model_version_number: str = Field(alias="modelVersionNumber")
 187    arn: Optional[str] = Field(default=None, alias="arn")
 188
 189
 190class RuleModel(BaseModel):
 191    detector_id: str = Field(alias="detectorId")
 192    rule_id: str = Field(alias="ruleId")
 193    rule_version: str = Field(alias="ruleVersion")
 194
 195
 196class ExternalEventsDetailModel(BaseModel):
 197    data_location: str = Field(alias="dataLocation")
 198    data_access_role_arn: str = Field(alias="dataAccessRoleArn")
 199
 200
 201class FieldValidationMessageModel(BaseModel):
 202    field_name: Optional[str] = Field(default=None, alias="fieldName")
 203    identifier: Optional[str] = Field(default=None, alias="identifier")
 204    title: Optional[str] = Field(default=None, alias="title")
 205    content: Optional[str] = Field(default=None, alias="content")
 206    type: Optional[str] = Field(default=None, alias="type")
 207
 208
 209class FileValidationMessageModel(BaseModel):
 210    title: Optional[str] = Field(default=None, alias="title")
 211    content: Optional[str] = Field(default=None, alias="content")
 212    type: Optional[str] = Field(default=None, alias="type")
 213
 214
 215class DeleteBatchImportJobRequestModel(BaseModel):
 216    job_id: str = Field(alias="jobId")
 217
 218
 219class DeleteBatchPredictionJobRequestModel(BaseModel):
 220    job_id: str = Field(alias="jobId")
 221
 222
 223class DeleteDetectorRequestModel(BaseModel):
 224    detector_id: str = Field(alias="detectorId")
 225
 226
 227class DeleteDetectorVersionRequestModel(BaseModel):
 228    detector_id: str = Field(alias="detectorId")
 229    detector_version_id: str = Field(alias="detectorVersionId")
 230
 231
 232class DeleteEntityTypeRequestModel(BaseModel):
 233    name: str = Field(alias="name")
 234
 235
 236class DeleteEventRequestModel(BaseModel):
 237    event_id: str = Field(alias="eventId")
 238    event_type_name: str = Field(alias="eventTypeName")
 239    delete_audit_history: Optional[bool] = Field(
 240        default=None, alias="deleteAuditHistory"
 241    )
 242
 243
 244class DeleteEventTypeRequestModel(BaseModel):
 245    name: str = Field(alias="name")
 246
 247
 248class DeleteEventsByEventTypeRequestModel(BaseModel):
 249    event_type_name: str = Field(alias="eventTypeName")
 250
 251
 252class DeleteExternalModelRequestModel(BaseModel):
 253    model_endpoint: str = Field(alias="modelEndpoint")
 254
 255
 256class DeleteLabelRequestModel(BaseModel):
 257    name: str = Field(alias="name")
 258
 259
 260class DeleteListRequestModel(BaseModel):
 261    name: str = Field(alias="name")
 262
 263
 264class DeleteModelRequestModel(BaseModel):
 265    model_id: str = Field(alias="modelId")
 266    model_type: Literal[
 267        "ACCOUNT_TAKEOVER_INSIGHTS",
 268        "ONLINE_FRAUD_INSIGHTS",
 269        "TRANSACTION_FRAUD_INSIGHTS",
 270    ] = Field(alias="modelType")
 271
 272
 273class DeleteModelVersionRequestModel(BaseModel):
 274    model_id: str = Field(alias="modelId")
 275    model_type: Literal[
 276        "ACCOUNT_TAKEOVER_INSIGHTS",
 277        "ONLINE_FRAUD_INSIGHTS",
 278        "TRANSACTION_FRAUD_INSIGHTS",
 279    ] = Field(alias="modelType")
 280    model_version_number: str = Field(alias="modelVersionNumber")
 281
 282
 283class DeleteOutcomeRequestModel(BaseModel):
 284    name: str = Field(alias="name")
 285
 286
 287class DeleteVariableRequestModel(BaseModel):
 288    name: str = Field(alias="name")
 289
 290
 291class DescribeDetectorRequestModel(BaseModel):
 292    detector_id: str = Field(alias="detectorId")
 293    next_token: Optional[str] = Field(default=None, alias="nextToken")
 294    max_results: Optional[int] = Field(default=None, alias="maxResults")
 295
 296
 297class DetectorVersionSummaryModel(BaseModel):
 298    detector_version_id: Optional[str] = Field(default=None, alias="detectorVersionId")
 299    status: Optional[Literal["ACTIVE", "DRAFT", "INACTIVE"]] = Field(
 300        default=None, alias="status"
 301    )
 302    description: Optional[str] = Field(default=None, alias="description")
 303    last_updated_time: Optional[str] = Field(default=None, alias="lastUpdatedTime")
 304
 305
 306class DescribeModelVersionsRequestModel(BaseModel):
 307    model_id: Optional[str] = Field(default=None, alias="modelId")
 308    model_version_number: Optional[str] = Field(
 309        default=None, alias="modelVersionNumber"
 310    )
 311    model_type: Optional[
 312        Literal[
 313            "ACCOUNT_TAKEOVER_INSIGHTS",
 314            "ONLINE_FRAUD_INSIGHTS",
 315            "TRANSACTION_FRAUD_INSIGHTS",
 316        ]
 317    ] = Field(default=None, alias="modelType")
 318    next_token: Optional[str] = Field(default=None, alias="nextToken")
 319    max_results: Optional[int] = Field(default=None, alias="maxResults")
 320
 321
 322class DetectorModel(BaseModel):
 323    detector_id: Optional[str] = Field(default=None, alias="detectorId")
 324    description: Optional[str] = Field(default=None, alias="description")
 325    event_type_name: Optional[str] = Field(default=None, alias="eventTypeName")
 326    last_updated_time: Optional[str] = Field(default=None, alias="lastUpdatedTime")
 327    created_time: Optional[str] = Field(default=None, alias="createdTime")
 328    arn: Optional[str] = Field(default=None, alias="arn")
 329
 330
 331class EntityModel(BaseModel):
 332    entity_type: str = Field(alias="entityType")
 333    entity_id: str = Field(alias="entityId")
 334
 335
 336class EntityTypeModel(BaseModel):
 337    name: Optional[str] = Field(default=None, alias="name")
 338    description: Optional[str] = Field(default=None, alias="description")
 339    last_updated_time: Optional[str] = Field(default=None, alias="lastUpdatedTime")
 340    created_time: Optional[str] = Field(default=None, alias="createdTime")
 341    arn: Optional[str] = Field(default=None, alias="arn")
 342
 343
 344class EvaluatedExternalModelModel(BaseModel):
 345    model_endpoint: Optional[str] = Field(default=None, alias="modelEndpoint")
 346    use_event_variables: Optional[bool] = Field(default=None, alias="useEventVariables")
 347    input_variables: Optional[Dict[str, str]] = Field(
 348        default=None, alias="inputVariables"
 349    )
 350    output_variables: Optional[Dict[str, str]] = Field(
 351        default=None, alias="outputVariables"
 352    )
 353
 354
 355class EvaluatedRuleModel(BaseModel):
 356    rule_id: Optional[str] = Field(default=None, alias="ruleId")
 357    rule_version: Optional[str] = Field(default=None, alias="ruleVersion")
 358    expression: Optional[str] = Field(default=None, alias="expression")
 359    expression_with_values: Optional[str] = Field(
 360        default=None, alias="expressionWithValues"
 361    )
 362    outcomes: Optional[List[str]] = Field(default=None, alias="outcomes")
 363    evaluated: Optional[bool] = Field(default=None, alias="evaluated")
 364    matched: Optional[bool] = Field(default=None, alias="matched")
 365
 366
 367class EventPredictionSummaryModel(BaseModel):
 368    event_id: Optional[str] = Field(default=None, alias="eventId")
 369    event_type_name: Optional[str] = Field(default=None, alias="eventTypeName")
 370    event_timestamp: Optional[str] = Field(default=None, alias="eventTimestamp")
 371    prediction_timestamp: Optional[str] = Field(
 372        default=None, alias="predictionTimestamp"
 373    )
 374    detector_id: Optional[str] = Field(default=None, alias="detectorId")
 375    detector_version_id: Optional[str] = Field(default=None, alias="detectorVersionId")
 376
 377
 378class IngestedEventStatisticsModel(BaseModel):
 379    number_of_events: Optional[int] = Field(default=None, alias="numberOfEvents")
 380    event_data_size_in_bytes: Optional[int] = Field(
 381        default=None, alias="eventDataSizeInBytes"
 382    )
 383    least_recent_event: Optional[str] = Field(default=None, alias="leastRecentEvent")
 384    most_recent_event: Optional[str] = Field(default=None, alias="mostRecentEvent")
 385    last_updated_time: Optional[str] = Field(default=None, alias="lastUpdatedTime")
 386
 387
 388class EventVariableSummaryModel(BaseModel):
 389    name: Optional[str] = Field(default=None, alias="name")
 390    value: Optional[str] = Field(default=None, alias="value")
 391    source: Optional[str] = Field(default=None, alias="source")
 392
 393
 394class ExternalModelSummaryModel(BaseModel):
 395    model_endpoint: Optional[str] = Field(default=None, alias="modelEndpoint")
 396    model_source: Optional[Literal["SAGEMAKER"]] = Field(
 397        default=None, alias="modelSource"
 398    )
 399
 400
 401class ModelInputConfigurationModel(BaseModel):
 402    use_event_variables: bool = Field(alias="useEventVariables")
 403    event_type_name: Optional[str] = Field(default=None, alias="eventTypeName")
 404    format: Optional[Literal["APPLICATION_JSON", "TEXT_CSV"]] = Field(
 405        default=None, alias="format"
 406    )
 407    json_input_template: Optional[str] = Field(default=None, alias="jsonInputTemplate")
 408    csv_input_template: Optional[str] = Field(default=None, alias="csvInputTemplate")
 409
 410
 411class ModelOutputConfigurationModel(BaseModel):
 412    format: Literal["APPLICATION_JSONLINES", "TEXT_CSV"] = Field(alias="format")
 413    json_key_to_variable_map: Optional[Dict[str, str]] = Field(
 414        default=None, alias="jsonKeyToVariableMap"
 415    )
 416    csv_index_to_variable_map: Optional[Dict[str, str]] = Field(
 417        default=None, alias="csvIndexToVariableMap"
 418    )
 419
 420
 421class FilterConditionModel(BaseModel):
 422    value: Optional[str] = Field(default=None, alias="value")
 423
 424
 425class GetBatchImportJobsRequestModel(BaseModel):
 426    job_id: Optional[str] = Field(default=None, alias="jobId")
 427    max_results: Optional[int] = Field(default=None, alias="maxResults")
 428    next_token: Optional[str] = Field(default=None, alias="nextToken")
 429
 430
 431class GetBatchPredictionJobsRequestModel(BaseModel):
 432    job_id: Optional[str] = Field(default=None, alias="jobId")
 433    max_results: Optional[int] = Field(default=None, alias="maxResults")
 434    next_token: Optional[str] = Field(default=None, alias="nextToken")
 435
 436
 437class GetDeleteEventsByEventTypeStatusRequestModel(BaseModel):
 438    event_type_name: str = Field(alias="eventTypeName")
 439
 440
 441class GetDetectorVersionRequestModel(BaseModel):
 442    detector_id: str = Field(alias="detectorId")
 443    detector_version_id: str = Field(alias="detectorVersionId")
 444
 445
 446class GetDetectorsRequestModel(BaseModel):
 447    detector_id: Optional[str] = Field(default=None, alias="detectorId")
 448    next_token: Optional[str] = Field(default=None, alias="nextToken")
 449    max_results: Optional[int] = Field(default=None, alias="maxResults")
 450
 451
 452class GetEntityTypesRequestModel(BaseModel):
 453    name: Optional[str] = Field(default=None, alias="name")
 454    next_token: Optional[str] = Field(default=None, alias="nextToken")
 455    max_results: Optional[int] = Field(default=None, alias="maxResults")
 456
 457
 458class GetEventPredictionMetadataRequestModel(BaseModel):
 459    event_id: str = Field(alias="eventId")
 460    event_type_name: str = Field(alias="eventTypeName")
 461    detector_id: str = Field(alias="detectorId")
 462    detector_version_id: str = Field(alias="detectorVersionId")
 463    prediction_timestamp: str = Field(alias="predictionTimestamp")
 464
 465
 466class ModelEndpointDataBlobModel(BaseModel):
 467    byte_buffer: Optional[
 468        Union[str, bytes, Type[IO[Any]], Type[StreamingBody]]
 469    ] = Field(default=None, alias="byteBuffer")
 470    content_type: Optional[str] = Field(default=None, alias="contentType")
 471
 472
 473class RuleResultModel(BaseModel):
 474    rule_id: Optional[str] = Field(default=None, alias="ruleId")
 475    outcomes: Optional[List[str]] = Field(default=None, alias="outcomes")
 476
 477
 478class GetEventRequestModel(BaseModel):
 479    event_id: str = Field(alias="eventId")
 480    event_type_name: str = Field(alias="eventTypeName")
 481
 482
 483class GetEventTypesRequestModel(BaseModel):
 484    name: Optional[str] = Field(default=None, alias="name")
 485    next_token: Optional[str] = Field(default=None, alias="nextToken")
 486    max_results: Optional[int] = Field(default=None, alias="maxResults")
 487
 488
 489class GetExternalModelsRequestModel(BaseModel):
 490    model_endpoint: Optional[str] = Field(default=None, alias="modelEndpoint")
 491    next_token: Optional[str] = Field(default=None, alias="nextToken")
 492    max_results: Optional[int] = Field(default=None, alias="maxResults")
 493
 494
 495class KMSKeyModel(BaseModel):
 496    kms_encryption_key_arn: Optional[str] = Field(
 497        default=None, alias="kmsEncryptionKeyArn"
 498    )
 499
 500
 501class GetLabelsRequestModel(BaseModel):
 502    name: Optional[str] = Field(default=None, alias="name")
 503    next_token: Optional[str] = Field(default=None, alias="nextToken")
 504    max_results: Optional[int] = Field(default=None, alias="maxResults")
 505
 506
 507class LabelModel(BaseModel):
 508    name: Optional[str] = Field(default=None, alias="name")
 509    description: Optional[str] = Field(default=None, alias="description")
 510    last_updated_time: Optional[str] = Field(default=None, alias="lastUpdatedTime")
 511    created_time: Optional[str] = Field(default=None, alias="createdTime")
 512    arn: Optional[str] = Field(default=None, alias="arn")
 513
 514
 515class GetListElementsRequestModel(BaseModel):
 516    name: str = Field(alias="name")
 517    next_token: Optional[str] = Field(default=None, alias="nextToken")
 518    max_results: Optional[int] = Field(default=None, alias="maxResults")
 519
 520
 521class GetListsMetadataRequestModel(BaseModel):
 522    name: Optional[str] = Field(default=None, alias="name")
 523    next_token: Optional[str] = Field(default=None, alias="nextToken")
 524    max_results: Optional[int] = Field(default=None, alias="maxResults")
 525
 526
 527class GetModelVersionRequestModel(BaseModel):
 528    model_id: str = Field(alias="modelId")
 529    model_type: Literal[
 530        "ACCOUNT_TAKEOVER_INSIGHTS",
 531        "ONLINE_FRAUD_INSIGHTS",
 532        "TRANSACTION_FRAUD_INSIGHTS",
 533    ] = Field(alias="modelType")
 534    model_version_number: str = Field(alias="modelVersionNumber")
 535
 536
 537class GetModelsRequestModel(BaseModel):
 538    model_id: Optional[str] = Field(default=None, alias="modelId")
 539    model_type: Optional[
 540        Literal[
 541            "ACCOUNT_TAKEOVER_INSIGHTS",
 542            "ONLINE_FRAUD_INSIGHTS",
 543            "TRANSACTION_FRAUD_INSIGHTS",
 544        ]
 545    ] = Field(default=None, alias="modelType")
 546    next_token: Optional[str] = Field(default=None, alias="nextToken")
 547    max_results: Optional[int] = Field(default=None, alias="maxResults")
 548
 549
 550class ModelModel(BaseModel):
 551    model_id: Optional[str] = Field(default=None, alias="modelId")
 552    model_type: Optional[
 553        Literal[
 554            "ACCOUNT_TAKEOVER_INSIGHTS",
 555            "ONLINE_FRAUD_INSIGHTS",
 556            "TRANSACTION_FRAUD_INSIGHTS",
 557        ]
 558    ] = Field(default=None, alias="modelType")
 559    description: Optional[str] = Field(default=None, alias="description")
 560    event_type_name: Optional[str] = Field(default=None, alias="eventTypeName")
 561    created_time: Optional[str] = Field(default=None, alias="createdTime")
 562    last_updated_time: Optional[str] = Field(default=None, alias="lastUpdatedTime")
 563    arn: Optional[str] = Field(default=None, alias="arn")
 564
 565
 566class GetOutcomesRequestModel(BaseModel):
 567    name: Optional[str] = Field(default=None, alias="name")
 568    next_token: Optional[str] = Field(default=None, alias="nextToken")
 569    max_results: Optional[int] = Field(default=None, alias="maxResults")
 570
 571
 572class OutcomeModel(BaseModel):
 573    name: Optional[str] = Field(default=None, alias="name")
 574    description: Optional[str] = Field(default=None, alias="description")
 575    last_updated_time: Optional[str] = Field(default=None, alias="lastUpdatedTime")
 576    created_time: Optional[str] = Field(default=None, alias="createdTime")
 577    arn: Optional[str] = Field(default=None, alias="arn")
 578
 579
 580class GetRulesRequestModel(BaseModel):
 581    detector_id: str = Field(alias="detectorId")
 582    rule_id: Optional[str] = Field(default=None, alias="ruleId")
 583    rule_version: Optional[str] = Field(default=None, alias="ruleVersion")
 584    next_token: Optional[str] = Field(default=None, alias="nextToken")
 585    max_results: Optional[int] = Field(default=None, alias="maxResults")
 586
 587
 588class RuleDetailModel(BaseModel):
 589    rule_id: Optional[str] = Field(default=None, alias="ruleId")
 590    description: Optional[str] = Field(default=None, alias="description")
 591    detector_id: Optional[str] = Field(default=None, alias="detectorId")
 592    rule_version: Optional[str] = Field(default=None, alias="ruleVersion")
 593    expression: Optional[str] = Field(default=None, alias="expression")
 594    language: Optional[Literal["DETECTORPL"]] = Field(default=None, alias="language")
 595    outcomes: Optional[List[str]] = Field(default=None, alias="outcomes")
 596    last_updated_time: Optional[str] = Field(default=None, alias="lastUpdatedTime")
 597    created_time: Optional[str] = Field(default=None, alias="createdTime")
 598    arn: Optional[str] = Field(default=None, alias="arn")
 599
 600
 601class GetVariablesRequestModel(BaseModel):
 602    name: Optional[str] = Field(default=None, alias="name")
 603    next_token: Optional[str] = Field(default=None, alias="nextToken")
 604    max_results: Optional[int] = Field(default=None, alias="maxResults")
 605
 606
 607class IngestedEventsTimeWindowModel(BaseModel):
 608    start_time: str = Field(alias="startTime")
 609    end_time: str = Field(alias="endTime")
 610
 611
 612class LabelSchemaModel(BaseModel):
 613    label_mapper: Optional[Mapping[str, Sequence[str]]] = Field(
 614        default=None, alias="labelMapper"
 615    )
 616    unlabeled_events_treatment: Optional[
 617        Literal["AUTO", "FRAUD", "IGNORE", "LEGIT"]
 618    ] = Field(default=None, alias="unlabeledEventsTreatment")
 619
 620
 621class PredictionTimeRangeModel(BaseModel):
 622    start_time: str = Field(alias="startTime")
 623    end_time: str = Field(alias="endTime")
 624
 625
 626class ListTagsForResourceRequestModel(BaseModel):
 627    resource_arn: str = Field(alias="resourceARN")
 628    next_token: Optional[str] = Field(default=None, alias="nextToken")
 629    max_results: Optional[int] = Field(default=None, alias="maxResults")
 630
 631
 632class LogOddsMetricModel(BaseModel):
 633    variable_name: str = Field(alias="variableName")
 634    variable_type: str = Field(alias="variableType")
 635    variable_importance: float = Field(alias="variableImportance")
 636
 637
 638class MetricDataPointModel(BaseModel):
 639    fpr: Optional[float] = Field(default=None, alias="fpr")
 640    precision: Optional[float] = Field(default=None, alias="precision")
 641    tpr: Optional[float] = Field(default=None, alias="tpr")
 642    threshold: Optional[float] = Field(default=None, alias="threshold")
 643
 644
 645class OFIMetricDataPointModel(BaseModel):
 646    fpr: Optional[float] = Field(default=None, alias="fpr")
 647    precision: Optional[float] = Field(default=None, alias="precision")
 648    tpr: Optional[float] = Field(default=None, alias="tpr")
 649    threshold: Optional[float] = Field(default=None, alias="threshold")
 650
 651
 652class UncertaintyRangeModel(BaseModel):
 653    lower_bound_value: float = Field(alias="lowerBoundValue")
 654    upper_bound_value: float = Field(alias="upperBoundValue")
 655
 656
 657class VariableImpactExplanationModel(BaseModel):
 658    event_variable_name: Optional[str] = Field(default=None, alias="eventVariableName")
 659    relative_impact: Optional[str] = Field(default=None, alias="relativeImpact")
 660    log_odds_impact: Optional[float] = Field(default=None, alias="logOddsImpact")
 661
 662
 663class PutKMSEncryptionKeyRequestModel(BaseModel):
 664    kms_encryption_key_arn: str = Field(alias="kmsEncryptionKeyArn")
 665
 666
 667class TFIMetricDataPointModel(BaseModel):
 668    fpr: Optional[float] = Field(default=None, alias="fpr")
 669    precision: Optional[float] = Field(default=None, alias="precision")
 670    tpr: Optional[float] = Field(default=None, alias="tpr")
 671    threshold: Optional[float] = Field(default=None, alias="threshold")
 672
 673
 674class UntagResourceRequestModel(BaseModel):
 675    resource_arn: str = Field(alias="resourceARN")
 676    tag_keys: Sequence[str] = Field(alias="tagKeys")
 677
 678
 679class UpdateDetectorVersionMetadataRequestModel(BaseModel):
 680    detector_id: str = Field(alias="detectorId")
 681    detector_version_id: str = Field(alias="detectorVersionId")
 682    description: str = Field(alias="description")
 683
 684
 685class UpdateDetectorVersionStatusRequestModel(BaseModel):
 686    detector_id: str = Field(alias="detectorId")
 687    detector_version_id: str = Field(alias="detectorVersionId")
 688    status: Literal["ACTIVE", "DRAFT", "INACTIVE"] = Field(alias="status")
 689
 690
 691class UpdateEventLabelRequestModel(BaseModel):
 692    event_id: str = Field(alias="eventId")
 693    event_type_name: str = Field(alias="eventTypeName")
 694    assigned_label: str = Field(alias="assignedLabel")
 695    label_timestamp: str = Field(alias="labelTimestamp")
 696
 697
 698class UpdateListRequestModel(BaseModel):
 699    name: str = Field(alias="name")
 700    elements: Optional[Sequence[str]] = Field(default=None, alias="elements")
 701    description: Optional[str] = Field(default=None, alias="description")
 702    update_mode: Optional[Literal["APPEND", "REMOVE", "REPLACE"]] = Field(
 703        default=None, alias="updateMode"
 704    )
 705    variable_type: Optional[str] = Field(default=None, alias="variableType")
 706
 707
 708class UpdateModelRequestModel(BaseModel):
 709    model_id: str = Field(alias="modelId")
 710    model_type: Literal[
 711        "ACCOUNT_TAKEOVER_INSIGHTS",
 712        "ONLINE_FRAUD_INSIGHTS",
 713        "TRANSACTION_FRAUD_INSIGHTS",
 714    ] = Field(alias="modelType")
 715    description: Optional[str] = Field(default=None, alias="description")
 716
 717
 718class UpdateModelVersionStatusRequestModel(BaseModel):
 719    model_id: str = Field(alias="modelId")
 720    model_type: Literal[
 721        "ACCOUNT_TAKEOVER_INSIGHTS",
 722        "ONLINE_FRAUD_INSIGHTS",
 723        "TRANSACTION_FRAUD_INSIGHTS",
 724    ] = Field(alias="modelType")
 725    model_version_number: str = Field(alias="modelVersionNumber")
 726    status: Literal["ACTIVE", "INACTIVE", "TRAINING_CANCELLED"] = Field(alias="status")
 727
 728
 729class UpdateVariableRequestModel(BaseModel):
 730    name: str = Field(alias="name")
 731    default_value: Optional[str] = Field(default=None, alias="defaultValue")
 732    description: Optional[str] = Field(default=None, alias="description")
 733    variable_type: Optional[str] = Field(default=None, alias="variableType")
 734
 735
 736class ATITrainingMetricsValueModel(BaseModel):
 737    metric_data_points: Optional[List[ATIMetricDataPointModel]] = Field(
 738        default=None, alias="metricDataPoints"
 739    )
 740    model_performance: Optional[ATIModelPerformanceModel] = Field(
 741        default=None, alias="modelPerformance"
 742    )
 743
 744
 745class AggregatedVariablesImportanceMetricsModel(BaseModel):
 746    log_odds_metrics: Optional[List[AggregatedLogOddsMetricModel]] = Field(
 747        default=None, alias="logOddsMetrics"
 748    )
 749
 750
 751class CreateBatchImportJobRequestModel(BaseModel):
 752    job_id: str = Field(alias="jobId")
 753    input_path: str = Field(alias="inputPath")
 754    output_path: str = Field(alias="outputPath")
 755    event_type_name: str = Field(alias="eventTypeName")
 756    iam_role_arn: str = Field(alias="iamRoleArn")
 757    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
 758
 759
 760class CreateBatchPredictionJobRequestModel(BaseModel):
 761    job_id: str = Field(alias="jobId")
 762    input_path: str = Field(alias="inputPath")
 763    output_path: str = Field(alias="outputPath")
 764    event_type_name: str = Field(alias="eventTypeName")
 765    detector_name: str = Field(alias="detectorName")
 766    iam_role_arn: str = Field(alias="iamRoleArn")
 767    detector_version: Optional[str] = Field(default=None, alias="detectorVersion")
 768    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
 769
 770
 771class CreateListRequestModel(BaseModel):
 772    name: str = Field(alias="name")
 773    elements: Optional[Sequence[str]] = Field(default=None, alias="elements")
 774    variable_type: Optional[str] = Field(default=None, alias="variableType")
 775    description: Optional[str] = Field(default=None, alias="description")
 776    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
 777
 778
 779class CreateModelRequestModel(BaseModel):
 780    model_id: str = Field(alias="modelId")
 781    model_type: Literal[
 782        "ACCOUNT_TAKEOVER_INSIGHTS",
 783        "ONLINE_FRAUD_INSIGHTS",
 784        "TRANSACTION_FRAUD_INSIGHTS",
 785    ] = Field(alias="modelType")
 786    event_type_name: str = Field(alias="eventTypeName")
 787    description: Optional[str] = Field(default=None, alias="description")
 788    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
 789
 790
 791class CreateRuleRequestModel(BaseModel):
 792    rule_id: str = Field(alias="ruleId")
 793    detector_id: str = Field(alias="detectorId")
 794    expression: str = Field(alias="expression")
 795    language: Literal["DETECTORPL"] = Field(alias="language")
 796    outcomes: Sequence[str] = Field(alias="outcomes")
 797    description: Optional[str] = Field(default=None, alias="description")
 798    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
 799
 800
 801class CreateVariableRequestModel(BaseModel):
 802    name: str = Field(alias="name")
 803    data_type: Literal["BOOLEAN", "FLOAT", "INTEGER", "STRING"] = Field(
 804        alias="dataType"
 805    )
 806    data_source: Literal["EVENT", "EXTERNAL_MODEL_SCORE", "MODEL_SCORE"] = Field(
 807        alias="dataSource"
 808    )
 809    default_value: str = Field(alias="defaultValue")
 810    description: Optional[str] = Field(default=None, alias="description")
 811    variable_type: Optional[str] = Field(default=None, alias="variableType")
 812    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
 813
 814
 815class PutDetectorRequestModel(BaseModel):
 816    detector_id: str = Field(alias="detectorId")
 817    event_type_name: str = Field(alias="eventTypeName")
 818    description: Optional[str] = Field(default=None, alias="description")
 819    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
 820
 821
 822class PutEntityTypeRequestModel(BaseModel):
 823    name: str = Field(alias="name")
 824    description: Optional[str] = Field(default=None, alias="description")
 825    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
 826
 827
 828class PutEventTypeRequestModel(BaseModel):
 829    name: str = Field(alias="name")
 830    event_variables: Sequence[str] = Field(alias="eventVariables")
 831    entity_types: Sequence[str] = Field(alias="entityTypes")
 832    description: Optional[str] = Field(default=None, alias="description")
 833    labels: Optional[Sequence[str]] = Field(default=None, alias="labels")
 834    event_ingestion: Optional[Literal["DISABLED", "ENABLED"]] = Field(
 835        default=None, alias="eventIngestion"
 836    )
 837    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
 838
 839
 840class PutLabelRequestModel(BaseModel):
 841    name: str = Field(alias="name")
 842    description: Optional[str] = Field(default=None, alias="description")
 843    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
 844
 845
 846class PutOutcomeRequestModel(BaseModel):
 847    name: str = Field(alias="name")
 848    description: Optional[str] = Field(default=None, alias="description")
 849    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
 850
 851
 852class TagResourceRequestModel(BaseModel):
 853    resource_arn: str = Field(alias="resourceARN")
 854    tags: Sequence[TagModel] = Field(alias="tags")
 855
 856
 857class BatchCreateVariableRequestModel(BaseModel):
 858    variable_entries: Sequence[VariableEntryModel] = Field(alias="variableEntries")
 859    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
 860
 861
 862class BatchCreateVariableResultModel(BaseModel):
 863    errors: List[BatchCreateVariableErrorModel] = Field(alias="errors")
 864    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 865
 866
 867class CreateDetectorVersionResultModel(BaseModel):
 868    detector_id: str = Field(alias="detectorId")
 869    detector_version_id: str = Field(alias="detectorVersionId")
 870    status: Literal["ACTIVE", "DRAFT", "INACTIVE"] = Field(alias="status")
 871    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 872
 873
 874class CreateModelVersionResultModel(BaseModel):
 875    model_id: str = Field(alias="modelId")
 876    model_type: Literal[
 877        "ACCOUNT_TAKEOVER_INSIGHTS",
 878        "ONLINE_FRAUD_INSIGHTS",
 879        "TRANSACTION_FRAUD_INSIGHTS",
 880    ] = Field(alias="modelType")
 881    model_version_number: str = Field(alias="modelVersionNumber")
 882    status: str = Field(alias="status")
 883    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 884
 885
 886class DeleteEventsByEventTypeResultModel(BaseModel):
 887    event_type_name: str = Field(alias="eventTypeName")
 888    events_deletion_status: str = Field(alias="eventsDeletionStatus")
 889    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 890
 891
 892class GetDeleteEventsByEventTypeStatusResultModel(BaseModel):
 893    event_type_name: str = Field(alias="eventTypeName")
 894    events_deletion_status: Literal[
 895        "CANCELED",
 896        "CANCEL_IN_PROGRESS",
 897        "COMPLETE",
 898        "FAILED",
 899        "IN_PROGRESS",
 900        "IN_PROGRESS_INITIALIZING",
 901    ] = Field(alias="eventsDeletionStatus")
 902    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 903
 904
 905class GetListElementsResultModel(BaseModel):
 906    elements: List[str] = Field(alias="elements")
 907    next_token: str = Field(alias="nextToken")
 908    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 909
 910
 911class GetListsMetadataResultModel(BaseModel):
 912    lists: List[AllowDenyListModel] = Field(alias="lists")
 913    next_token: str = Field(alias="nextToken")
 914    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 915
 916
 917class ListTagsForResourceResultModel(BaseModel):
 918    tags: List[TagModel] = Field(alias="tags")
 919    next_token: str = Field(alias="nextToken")
 920    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 921
 922
 923class UpdateModelVersionResultModel(BaseModel):
 924    model_id: str = Field(alias="modelId")
 925    model_type: Literal[
 926        "ACCOUNT_TAKEOVER_INSIGHTS",
 927        "ONLINE_FRAUD_INSIGHTS",
 928        "TRANSACTION_FRAUD_INSIGHTS",
 929    ] = Field(alias="modelType")
 930    model_version_number: str = Field(alias="modelVersionNumber")
 931    status: str = Field(alias="status")
 932    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 933
 934
 935class BatchGetVariableResultModel(BaseModel):
 936    variables: List[VariableModel] = Field(alias="variables")
 937    errors: List[BatchGetVariableErrorModel] = Field(alias="errors")
 938    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 939
 940
 941class GetVariablesResultModel(BaseModel):
 942    variables: List[VariableModel] = Field(alias="variables")
 943    next_token: str = Field(alias="nextToken")
 944    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 945
 946
 947class GetBatchImportJobsResultModel(BaseModel):
 948    batch_imports: List[BatchImportModel] = Field(alias="batchImports")
 949    next_token: str = Field(alias="nextToken")
 950    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 951
 952
 953class GetBatchPredictionJobsResultModel(BaseModel):
 954    batch_predictions: List[BatchPredictionModel] = Field(alias="batchPredictions")
 955    next_token: str = Field(alias="nextToken")
 956    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 957
 958
 959class ModelScoresModel(BaseModel):
 960    model_version: Optional[ModelVersionModel] = Field(
 961        default=None, alias="modelVersion"
 962    )
 963    scores: Optional[Dict[str, float]] = Field(default=None, alias="scores")
 964
 965
 966class CreateDetectorVersionRequestModel(BaseModel):
 967    detector_id: str = Field(alias="detectorId")
 968    rules: Sequence[RuleModel] = Field(alias="rules")
 969    description: Optional[str] = Field(default=None, alias="description")
 970    external_model_endpoints: Optional[Sequence[str]] = Field(
 971        default=None, alias="externalModelEndpoints"
 972    )
 973    model_versions: Optional[Sequence[ModelVersionModel]] = Field(
 974        default=None, alias="modelVersions"
 975    )
 976    rule_execution_mode: Optional[Literal["ALL_MATCHED", "FIRST_MATCHED"]] = Field(
 977        default=None, alias="ruleExecutionMode"
 978    )
 979    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
 980
 981
 982class CreateRuleResultModel(BaseModel):
 983    rule: RuleModel = Field(alias="rule")
 984    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 985
 986
 987class DeleteRuleRequestModel(BaseModel):
 988    rule: RuleModel = Field(alias="rule")
 989
 990
 991class GetDetectorVersionResultModel(BaseModel):
 992    detector_id: str = Field(alias="detectorId")
 993    detector_version_id: str = Field(alias="detectorVersionId")
 994    description: str = Field(alias="description")
 995    external_model_endpoints: List[str] = Field(alias="externalModelEndpoints")
 996    model_versions: List[ModelVersionModel] = Field(alias="modelVersions")
 997    rules: List[RuleModel] = Field(alias="rules")
 998    status: Literal["ACTIVE", "DRAFT", "INACTIVE"] = Field(alias="status")
 999    last_updated_time: str = Field(alias="lastUpdatedTime")
1000    created_time: str = Field(alias="createdTime")
1001    rule_execution_mode: Literal["ALL_MATCHED", "FIRST_MATCHED"] = Field(
1002        alias="ruleExecutionMode"
1003    )
1004    arn: str = Field(alias="arn")
1005    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1006
1007
1008class UpdateDetectorVersionRequestModel(BaseModel):
1009    detector_id: str = Field(alias="detectorId")
1010    detector_version_id: str = Field(alias="detectorVersionId")
1011    external_model_endpoints: Sequence[str] = Field(alias="externalModelEndpoints")
1012    rules: Sequence[RuleModel] = Field(alias="rules")
1013    description: Optional[str] = Field(default=None, alias="description")
1014    model_versions: Optional[Sequence[ModelVersionModel]] = Field(
1015        default=None, alias="modelVersions"
1016    )
1017    rule_execution_mode: Optional[Literal["ALL_MATCHED", "FIRST_MATCHED"]] = Field(
1018        default=None, alias="ruleExecutionMode"
1019    )
1020
1021
1022class UpdateRuleMetadataRequestModel(BaseModel):
1023    rule: RuleModel = Field(alias="rule")
1024    description: str = Field(alias="description")
1025
1026
1027class UpdateRuleVersionRequestModel(BaseModel):
1028    rule: RuleModel = Field(alias="rule")
1029    expression: str = Field(alias="expression")
1030    language: Literal["DETECTORPL"] = Field(alias="language")
1031    outcomes: Sequence[str] = Field(alias="outcomes")
1032    description: Optional[str] = Field(default=None, alias="description")
1033    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
1034
1035
1036class UpdateRuleVersionResultModel(BaseModel):
1037    rule: RuleModel = Field(alias="rule")
1038    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1039
1040
1041class DataValidationMetricsModel(BaseModel):
1042    file_level_messages: Optional[List[FileValidationMessageModel]] = Field(
1043        default=None, alias="fileLevelMessages"
1044    )
1045    field_level_messages: Optional[List[FieldValidationMessageModel]] = Field(
1046        default=None, alias="fieldLevelMessages"
1047    )
1048
1049
1050class DescribeDetectorResultModel(BaseModel):
1051    detector_id: str = Field(alias="detectorId")
1052    detector_version_summaries: List[DetectorVersionSummaryModel] = Field(
1053        alias="detectorVersionSummaries"
1054    )
1055    next_token: str = Field(alias="nextToken")
1056    arn: str = Field(alias="arn")
1057    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1058
1059
1060class GetDetectorsResultModel(BaseModel):
1061    detectors: List[DetectorModel] = Field(alias="detectors")
1062    next_token: str = Field(alias="nextToken")
1063    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1064
1065
1066class EventModel(BaseModel):
1067    event_id: Optional[str] = Field(default=None, alias="eventId")
1068    event_type_name: Optional[str] = Field(default=None, alias="eventTypeName")
1069    event_timestamp: Optional[str] = Field(default=None, alias="eventTimestamp")
1070    event_variables: Optional[Dict[str, str]] = Field(
1071        default=None, alias="eventVariables"
1072    )
1073    current_label: Optional[str] = Field(default=None, alias="currentLabel")
1074    label_timestamp: Optional[str] = Field(default=None, alias="labelTimestamp")
1075    entities: Optional[List[EntityModel]] = Field(default=None, alias="entities")
1076
1077
1078class SendEventRequestModel(BaseModel):
1079    event_id: str = Field(alias="eventId")
1080    event_type_name: str = Field(alias="eventTypeName")
1081    event_timestamp: str = Field(alias="eventTimestamp")
1082    event_variables: Mapping[str, str] = Field(alias="eventVariables")
1083    entities: Sequence[EntityModel] = Field(alias="entities")
1084    assigned_label: Optional[str] = Field(default=None, alias="assignedLabel")
1085    label_timestamp: Optional[str] = Field(default=None, alias="labelTimestamp")
1086
1087
1088class GetEntityTypesResultModel(BaseModel):
1089    entity_types: List[EntityTypeModel] = Field(alias="entityTypes")
1090    next_token: str = Field(alias="nextToken")
1091    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1092
1093
1094class ListEventPredictionsResultModel(BaseModel):
1095    event_prediction_summaries: List[EventPredictionSummaryModel] = Field(
1096        alias="eventPredictionSummaries"
1097    )
1098    next_token: str = Field(alias="nextToken")
1099    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1100
1101
1102class EventTypeModel(BaseModel):
1103    name: Optional[str] = Field(default=None, alias="name")
1104    description: Optional[str] = Field(default=None, alias="description")
1105    event_variables: Optional[List[str]] = Field(default=None, alias="eventVariables")
1106    labels: Optional[List[str]] = Field(default=None, alias="labels")
1107    entity_types: Optional[List[str]] = Field(default=None, alias="entityTypes")
1108    event_ingestion: Optional[Literal["DISABLED", "ENABLED"]] = Field(
1109        default=None, alias="eventIngestion"
1110    )
1111    ingested_event_statistics: Optional[IngestedEventStatisticsModel] = Field(
1112        default=None, alias="ingestedEventStatistics"
1113    )
1114    last_updated_time: Optional[str] = Field(default=None, alias="lastUpdatedTime")
1115    created_time: Optional[str] = Field(default=None, alias="createdTime")
1116    arn: Optional[str] = Field(default=None, alias="arn")
1117
1118
1119class ExternalModelOutputsModel(BaseModel):
1120    external_model: Optional[ExternalModelSummaryModel] = Field(
1121        default=None, alias="externalModel"
1122    )
1123    outputs: Optional[Dict[str, str]] = Field(default=None, alias="outputs")
1124
1125
1126class ExternalModelModel(BaseModel):
1127    model_endpoint: Optional[str] = Field(default=None, alias="modelEndpoint")
1128    model_source: Optional[Literal["SAGEMAKER"]] = Field(
1129        default=None, alias="modelSource"
1130    )
1131    invoke_model_endpoint_role_arn: Optional[str] = Field(
1132        default=None, alias="invokeModelEndpointRoleArn"
1133    )
1134    input_configuration: Optional[ModelInputConfigurationModel] = Field(
1135        default=None, alias="inputConfiguration"
1136    )
1137    output_configuration: Optional[ModelOutputConfigurationModel] = Field(
1138        default=None, alias="outputConfiguration"
1139    )
1140    model_endpoint_status: Optional[Literal["ASSOCIATED", "DISSOCIATED"]] = Field(
1141        default=None, alias="modelEndpointStatus"
1142    )
1143    last_updated_time: Optional[str] = Field(default=None, alias="lastUpdatedTime")
1144    created_time: Optional[str] = Field(default=None, alias="createdTime")
1145    arn: Optional[str] = Field(default=None, alias="arn")
1146
1147
1148class PutExternalModelRequestModel(BaseModel):
1149    model_endpoint: str = Field(alias="modelEndpoint")
1150    model_source: Literal["SAGEMAKER"] = Field(alias="modelSource")
1151    invoke_model_endpoint_role_arn: str = Field(alias="invokeModelEndpointRoleArn")
1152    input_configuration: ModelInputConfigurationModel = Field(
1153        alias="inputConfiguration"
1154    )
1155    output_configuration: ModelOutputConfigurationModel = Field(
1156        alias="outputConfiguration"
1157    )
1158    model_endpoint_status: Literal["ASSOCIATED", "DISSOCIATED"] = Field(
1159        alias="modelEndpointStatus"
1160    )
1161    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
1162
1163
1164class GetEventPredictionRequestModel(BaseModel):
1165    detector_id: str = Field(alias="detectorId")
1166    event_id: str = Field(alias="eventId")
1167    event_type_name: str = Field(alias="eventTypeName")
1168    entities: Sequence[EntityModel] = Field(alias="entities")
1169    event_timestamp: str = Field(alias="eventTimestamp")
1170    event_variables: Mapping[str, str] = Field(alias="eventVariables")
1171    detector_version_id: Optional[str] = Field(default=None, alias="detectorVersionId")
1172    external_model_endpoint_data_blobs: Optional[
1173        Mapping[str, ModelEndpointDataBlobModel]
1174    ] = Field(default=None, alias="externalModelEndpointDataBlobs")
1175
1176
1177class GetKMSEncryptionKeyResultModel(BaseModel):
1178    kms_key: KMSKeyModel = Field(alias="kmsKey")
1179    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1180
1181
1182class GetLabelsResultModel(BaseModel):
1183    labels: List[LabelModel] = Field(alias="labels")
1184    next_token: str = Field(alias="nextToken")
1185    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1186
1187
1188class GetModelsResultModel(BaseModel):
1189    next_token: str = Field(alias="nextToken")
1190    models: List[ModelModel] = Field(alias="models")
1191    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1192
1193
1194class GetOutcomesResultModel(BaseModel):
1195    outcomes: List[OutcomeModel] = Field(alias="outcomes")
1196    next_token: str = Field(alias="nextToken")
1197    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1198
1199
1200class GetRulesResultModel(BaseModel):
1201    rule_details: List[RuleDetailModel] = Field(alias="ruleDetails")
1202    next_token: str = Field(alias="nextToken")
1203    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1204
1205
1206class IngestedEventsDetailModel(BaseModel):
1207    ingested_events_time_window: IngestedEventsTimeWindowModel = Field(
1208        alias="ingestedEventsTimeWindow"
1209    )
1210
1211
1212class TrainingDataSchemaModel(BaseModel):
1213    model_variables: Sequence[str] = Field(alias="modelVariables")
1214    label_schema: Optional[LabelSchemaModel] = Field(default=None, alias="labelSchema")
1215
1216
1217class ListEventPredictionsRequestModel(BaseModel):
1218    event_id: Optional[FilterConditionModel] = Field(default=None, alias="eventId")
1219    event_type: Optional[FilterConditionModel] = Field(default=None, alias="eventType")
1220    detector_id: Optional[FilterConditionModel] = Field(
1221        default=None, alias="detectorId"
1222    )
1223    detector_version_id: Optional[FilterConditionModel] = Field(
1224        default=None, alias="detectorVersionId"
1225    )
1226    prediction_time_range: Optional[PredictionTimeRangeModel] = Field(
1227        default=None, alias="predictionTimeRange"
1228    )
1229    next_token: Optional[str] = Field(default=None, alias="nextToken")
1230    max_results: Optional[int] = Field(default=None, alias="maxResults")
1231
1232
1233class VariableImportanceMetricsModel(BaseModel):
1234    log_odds_metrics: Optional[List[LogOddsMetricModel]] = Field(
1235        default=None, alias="logOddsMetrics"
1236    )
1237
1238
1239class TrainingMetricsModel(BaseModel):
1240    auc: Optional[float] = Field(default=None, alias="auc")
1241    metric_data_points: Optional[List[MetricDataPointModel]] = Field(
1242        default=None, alias="metricDataPoints"
1243    )
1244
1245
1246class OFIModelPerformanceModel(BaseModel):
1247    auc: Optional[float] = Field(default=None, alias="auc")
1248    uncertainty_range: Optional[UncertaintyRangeModel] = Field(
1249        default=None, alias="uncertaintyRange"
1250    )
1251
1252
1253class TFIModelPerformanceModel(BaseModel):
1254    auc: Optional[float] = Field(default=None, alias="auc")
1255    uncertainty_range: Optional[UncertaintyRangeModel] = Field(
1256        default=None, alias="uncertaintyRange"
1257    )
1258
1259
1260class PredictionExplanationsModel(BaseModel):
1261    variable_impact_explanations: Optional[
1262        List[VariableImpactExplanationModel]
1263    ] = Field(default=None, alias="variableImpactExplanations")
1264    aggregated_variables_impact_explanations: Optional[
1265        List[AggregatedVariablesImpactExplanationModel]
1266    ] = Field(default=None, alias="aggregatedVariablesImpactExplanations")
1267
1268
1269class GetEventResultModel(BaseModel):
1270    event: EventModel = Field(alias="event")
1271    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1272
1273
1274class GetEventTypesResultModel(BaseModel):
1275    event_types: List[EventTypeModel] = Field(alias="eventTypes")
1276    next_token: str = Field(alias="nextToken")
1277    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1278
1279
1280class GetEventPredictionResultModel(BaseModel):
1281    model_scores: List[ModelScoresModel] = Field(alias="modelScores")
1282    rule_results: List[RuleResultModel] = Field(alias="ruleResults")
1283    external_model_outputs: List[ExternalModelOutputsModel] = Field(
1284        alias="externalModelOutputs"
1285    )
1286    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1287
1288
1289class GetExternalModelsResultModel(BaseModel):
1290    external_models: List[ExternalModelModel] = Field(alias="externalModels")
1291    next_token: str = Field(alias="nextToken")
1292    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1293
1294
1295class UpdateModelVersionRequestModel(BaseModel):
1296    model_id: str = Field(alias="modelId")
1297    model_type: Literal[
1298        "ACCOUNT_TAKEOVER_INSIGHTS",
1299        "ONLINE_FRAUD_INSIGHTS",
1300        "TRANSACTION_FRAUD_INSIGHTS",
1301    ] = Field(alias="modelType")
1302    major_version_number: str = Field(alias="majorVersionNumber")
1303    external_events_detail: Optional[ExternalEventsDetailModel] = Field(
1304        default=None, alias="externalEventsDetail"
1305    )
1306    ingested_events_detail: Optional[IngestedEventsDetailModel] = Field(
1307        default=None, alias="ingestedEventsDetail"
1308    )
1309    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
1310
1311
1312class CreateModelVersionRequestModel(BaseModel):
1313    model_id: str = Field(alias="modelId")
1314    model_type: Literal[
1315        "ACCOUNT_TAKEOVER_INSIGHTS",
1316        "ONLINE_FRAUD_INSIGHTS",
1317        "TRANSACTION_FRAUD_INSIGHTS",
1318    ] = Field(alias="modelType")
1319    training_data_source: Literal["EXTERNAL_EVENTS", "INGESTED_EVENTS"] = Field(
1320        alias="trainingDataSource"
1321    )
1322    training_data_schema: TrainingDataSchemaModel = Field(alias="trainingDataSchema")
1323    external_events_detail: Optional[ExternalEventsDetailModel] = Field(
1324        default=None, alias="externalEventsDetail"
1325    )
1326    ingested_events_detail: Optional[IngestedEventsDetailModel] = Field(
1327        default=None, alias="ingestedEventsDetail"
1328    )
1329    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="tags")
1330
1331
1332class GetModelVersionResultModel(BaseModel):
1333    model_id: str = Field(alias="modelId")
1334    model_type: Literal[
1335        "ACCOUNT_TAKEOVER_INSIGHTS",
1336        "ONLINE_FRAUD_INSIGHTS",
1337        "TRANSACTION_FRAUD_INSIGHTS",
1338    ] = Field(alias="modelType")
1339    model_version_number: str = Field(alias="modelVersionNumber")
1340    training_data_source: Literal["EXTERNAL_EVENTS", "INGESTED_EVENTS"] = Field(
1341        alias="trainingDataSource"
1342    )
1343    training_data_schema: TrainingDataSchemaModel = Field(alias="trainingDataSchema")
1344    external_events_detail: ExternalEventsDetailModel = Field(
1345        alias="externalEventsDetail"
1346    )
1347    ingested_events_detail: IngestedEventsDetailModel = Field(
1348        alias="ingestedEventsDetail"
1349    )
1350    status: str = Field(alias="status")
1351    arn: str = Field(alias="arn")
1352    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1353
1354
1355class TrainingResultModel(BaseModel):
1356    data_validation_metrics: Optional[DataValidationMetricsModel] = Field(
1357        default=None, alias="dataValidationMetrics"
1358    )
1359    training_metrics: Optional[TrainingMetricsModel] = Field(
1360        default=None, alias="trainingMetrics"
1361    )
1362    variable_importance_metrics: Optional[VariableImportanceMetricsModel] = Field(
1363        default=None, alias="variableImportanceMetrics"
1364    )
1365
1366
1367class OFITrainingMetricsValueModel(BaseModel):
1368    metric_data_points: Optional[List[OFIMetricDataPointModel]] = Field(
1369        default=None, alias="metricDataPoints"
1370    )
1371    model_performance: Optional[OFIModelPerformanceModel] = Field(
1372        default=None, alias="modelPerformance"
1373    )
1374
1375
1376class TFITrainingMetricsValueModel(BaseModel):
1377    metric_data_points: Optional[List[TFIMetricDataPointModel]] = Field(
1378        default=None, alias="metricDataPoints"
1379    )
1380    model_performance: Optional[TFIModelPerformanceModel] = Field(
1381        default=None, alias="modelPerformance"
1382    )
1383
1384
1385class ModelVersionEvaluationModel(BaseModel):
1386    output_variable_name: Optional[str] = Field(
1387        default=None, alias="outputVariableName"
1388    )
1389    evaluation_score: Optional[str] = Field(default=None, alias="evaluationScore")
1390    prediction_explanations: Optional[PredictionExplanationsModel] = Field(
1391        default=None, alias="predictionExplanations"
1392    )
1393
1394
1395class TrainingMetricsV2Model(BaseModel):
1396    ofi: Optional[OFITrainingMetricsValueModel] = Field(default=None, alias="ofi")
1397    tfi: Optional[TFITrainingMetricsValueModel] = Field(default=None, alias="tfi")
1398    ati: Optional[ATITrainingMetricsValueModel] = Field(default=None, alias="ati")
1399
1400
1401class EvaluatedModelVersionModel(BaseModel):
1402    model_id: Optional[str] = Field(default=None, alias="modelId")
1403    model_version: Optional[str] = Field(default=None, alias="modelVersion")
1404    model_type: Optional[str] = Field(default=None, alias="modelType")
1405    evaluations: Optional[List[ModelVersionEvaluationModel]] = Field(
1406        default=None, alias="evaluations"
1407    )
1408
1409
1410class TrainingResultV2Model(BaseModel):
1411    data_validation_metrics: Optional[DataValidationMetricsModel] = Field(
1412        default=None, alias="dataValidationMetrics"
1413    )
1414    training_metrics_v2: Optional[TrainingMetricsV2Model] = Field(
1415        default=None, alias="trainingMetricsV2"
1416    )
1417    variable_importance_metrics: Optional[VariableImportanceMetricsModel] = Field(
1418        default=None, alias="variableImportanceMetrics"
1419    )
1420    aggregated_variables_importance_metrics: Optional[
1421        AggregatedVariablesImportanceMetricsModel
1422    ] = Field(default=None, alias="aggregatedVariablesImportanceMetrics")
1423
1424
1425class GetEventPredictionMetadataResultModel(BaseModel):
1426    event_id: str = Field(alias="eventId")
1427    event_type_name: str = Field(alias="eventTypeName")
1428    entity_id: str = Field(alias="entityId")
1429    entity_type: str = Field(alias="entityType")
1430    event_timestamp: str = Field(alias="eventTimestamp")
1431    detector_id: str = Field(alias="detectorId")
1432    detector_version_id: str = Field(alias="detectorVersionId")
1433    detector_version_status: str = Field(alias="detectorVersionStatus")
1434    event_variables: List[EventVariableSummaryModel] = Field(alias="eventVariables")
1435    rules: List[EvaluatedRuleModel] = Field(alias="rules")
1436    rule_execution_mode: Literal["ALL_MATCHED", "FIRST_MATCHED"] = Field(
1437        alias="ruleExecutionMode"
1438    )
1439    outcomes: List[str] = Field(alias="outcomes")
1440    evaluated_model_versions: List[EvaluatedModelVersionModel] = Field(
1441        alias="evaluatedModelVersions"
1442    )
1443    evaluated_external_models: List[EvaluatedExternalModelModel] = Field(
1444        alias="evaluatedExternalModels"
1445    )
1446    prediction_timestamp: str = Field(alias="predictionTimestamp")
1447    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1448
1449
1450class ModelVersionDetailModel(BaseModel):
1451    model_id: Optional[str] = Field(default=None, alias="modelId")
1452    model_type: Optional[
1453        Literal[
1454            "ACCOUNT_TAKEOVER_INSIGHTS",
1455            "ONLINE_FRAUD_INSIGHTS",
1456            "TRANSACTION_FRAUD_INSIGHTS",
1457        ]
1458    ] = Field(default=None, alias="modelType")
1459    model_version_number: Optional[str] = Field(
1460        default=None, alias="modelVersionNumber"
1461    )
1462    status: Optional[str] = Field(default=None, alias="status")
1463    training_data_source: Optional[
1464        Literal["EXTERNAL_EVENTS", "INGESTED_EVENTS"]
1465    ] = Field(default=None, alias="trainingDataSource")
1466    training_data_schema: Optional[TrainingDataSchemaModel] = Field(
1467        default=None, alias="trainingDataSchema"
1468    )
1469    external_events_detail: Optional[ExternalEventsDetailModel] = Field(
1470        default=None, alias="externalEventsDetail"
1471    )
1472    ingested_events_detail: Optional[IngestedEventsDetailModel] = Field(
1473        default=None, alias="ingestedEventsDetail"
1474    )
1475    training_result: Optional[TrainingResultModel] = Field(
1476        default=None, alias="trainingResult"
1477    )
1478    last_updated_time: Optional[str] = Field(default=None, alias="lastUpdatedTime")
1479    created_time: Optional[str] = Field(default=None, alias="createdTime")
1480    arn: Optional[str] = Field(default=None, alias="arn")
1481    training_result_v2: Optional[TrainingResultV2Model] = Field(
1482        default=None, alias="trainingResultV2"
1483    )
1484
1485
1486class DescribeModelVersionsResultModel(BaseModel):
1487    model_version_details: List[ModelVersionDetailModel] = Field(
1488        alias="modelVersionDetails"
1489    )
1490    next_token: str = Field(alias="nextToken")
1491    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")