Skip to content

Type definitions#

Index > FraudDetector > Type definitions

Auto-generated documentation for FraudDetector type annotations stubs module mypy-boto3-frauddetector.

BlobTypeDef#

# BlobTypeDef Union usage example

from mypy_boto3_frauddetector.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

ModelOutputConfigurationUnionTypeDef#

# ModelOutputConfigurationUnionTypeDef Union usage example

from mypy_boto3_frauddetector.type_defs import ModelOutputConfigurationUnionTypeDef


def get_value() -> ModelOutputConfigurationUnionTypeDef:
    return ...


# ModelOutputConfigurationUnionTypeDef definition

ModelOutputConfigurationUnionTypeDef = Union[
    ModelOutputConfigurationTypeDef,  # (1)
    ModelOutputConfigurationOutputTypeDef,  # (2)
]
  1. See ModelOutputConfigurationTypeDef
  2. See ModelOutputConfigurationOutputTypeDef

TrainingDataSchemaUnionTypeDef#

# TrainingDataSchemaUnionTypeDef Union usage example

from mypy_boto3_frauddetector.type_defs import TrainingDataSchemaUnionTypeDef


def get_value() -> TrainingDataSchemaUnionTypeDef:
    return ...


# TrainingDataSchemaUnionTypeDef definition

TrainingDataSchemaUnionTypeDef = Union[
    TrainingDataSchemaTypeDef,  # (1)
    TrainingDataSchemaOutputTypeDef,  # (2)
]
  1. See TrainingDataSchemaTypeDef
  2. See TrainingDataSchemaOutputTypeDef

ATIMetricDataPointTypeDef#

# ATIMetricDataPointTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ATIMetricDataPointTypeDef


def get_value() -> ATIMetricDataPointTypeDef:
    return {
        "cr": ...,
    }


# ATIMetricDataPointTypeDef definition

class ATIMetricDataPointTypeDef(TypedDict):
    cr: NotRequired[float],
    adr: NotRequired[float],
    threshold: NotRequired[float],
    atodr: NotRequired[float],

ATIModelPerformanceTypeDef#

# ATIModelPerformanceTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ATIModelPerformanceTypeDef


def get_value() -> ATIModelPerformanceTypeDef:
    return {
        "asi": ...,
    }


# ATIModelPerformanceTypeDef definition

class ATIModelPerformanceTypeDef(TypedDict):
    asi: NotRequired[float],

AggregatedLogOddsMetricTypeDef#

# AggregatedLogOddsMetricTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import AggregatedLogOddsMetricTypeDef


def get_value() -> AggregatedLogOddsMetricTypeDef:
    return {
        "variableNames": ...,
    }


# AggregatedLogOddsMetricTypeDef definition

class AggregatedLogOddsMetricTypeDef(TypedDict):
    variableNames: List[str],
    aggregatedVariablesImportance: float,

AggregatedVariablesImpactExplanationTypeDef#

# AggregatedVariablesImpactExplanationTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import AggregatedVariablesImpactExplanationTypeDef


def get_value() -> AggregatedVariablesImpactExplanationTypeDef:
    return {
        "eventVariableNames": ...,
    }


# AggregatedVariablesImpactExplanationTypeDef definition

class AggregatedVariablesImpactExplanationTypeDef(TypedDict):
    eventVariableNames: NotRequired[List[str]],
    relativeImpact: NotRequired[str],
    logOddsImpact: NotRequired[float],

AllowDenyListTypeDef#

# AllowDenyListTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import AllowDenyListTypeDef


def get_value() -> AllowDenyListTypeDef:
    return {
        "name": ...,
    }


# AllowDenyListTypeDef definition

class AllowDenyListTypeDef(TypedDict):
    name: str,
    description: NotRequired[str],
    variableType: NotRequired[str],
    createdTime: NotRequired[str],
    updatedTime: NotRequired[str],
    arn: NotRequired[str],

BatchCreateVariableErrorTypeDef#

# BatchCreateVariableErrorTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import BatchCreateVariableErrorTypeDef


def get_value() -> BatchCreateVariableErrorTypeDef:
    return {
        "name": ...,
    }


# BatchCreateVariableErrorTypeDef definition

class BatchCreateVariableErrorTypeDef(TypedDict):
    name: NotRequired[str],
    code: NotRequired[int],
    message: NotRequired[str],

TagTypeDef#

# TagTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import TagTypeDef


def get_value() -> TagTypeDef:
    return {
        "key": ...,
    }


# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: str,

VariableEntryTypeDef#

# VariableEntryTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import VariableEntryTypeDef


def get_value() -> VariableEntryTypeDef:
    return {
        "name": ...,
    }


# VariableEntryTypeDef definition

class VariableEntryTypeDef(TypedDict):
    name: NotRequired[str],
    dataType: NotRequired[str],
    dataSource: NotRequired[str],
    defaultValue: NotRequired[str],
    description: NotRequired[str],
    variableType: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

BatchGetVariableErrorTypeDef#

# BatchGetVariableErrorTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import BatchGetVariableErrorTypeDef


def get_value() -> BatchGetVariableErrorTypeDef:
    return {
        "name": ...,
    }


# BatchGetVariableErrorTypeDef definition

class BatchGetVariableErrorTypeDef(TypedDict):
    name: NotRequired[str],
    code: NotRequired[int],
    message: NotRequired[str],

BatchGetVariableRequestTypeDef#

# BatchGetVariableRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import BatchGetVariableRequestTypeDef


def get_value() -> BatchGetVariableRequestTypeDef:
    return {
        "names": ...,
    }


# BatchGetVariableRequestTypeDef definition

class BatchGetVariableRequestTypeDef(TypedDict):
    names: Sequence[str],

VariableTypeDef#

# VariableTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import VariableTypeDef


def get_value() -> VariableTypeDef:
    return {
        "name": ...,
    }


# VariableTypeDef definition

class VariableTypeDef(TypedDict):
    name: NotRequired[str],
    dataType: NotRequired[DataTypeType],  # (1)
    dataSource: NotRequired[DataSourceType],  # (2)
    defaultValue: NotRequired[str],
    description: NotRequired[str],
    variableType: NotRequired[str],
    lastUpdatedTime: NotRequired[str],
    createdTime: NotRequired[str],
    arn: NotRequired[str],
  1. See DataTypeType
  2. See DataSourceType

BatchImportTypeDef#

# BatchImportTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import BatchImportTypeDef


def get_value() -> BatchImportTypeDef:
    return {
        "jobId": ...,
    }


# BatchImportTypeDef definition

class BatchImportTypeDef(TypedDict):
    jobId: NotRequired[str],
    status: NotRequired[AsyncJobStatusType],  # (1)
    failureReason: NotRequired[str],
    startTime: NotRequired[str],
    completionTime: NotRequired[str],
    inputPath: NotRequired[str],
    outputPath: NotRequired[str],
    eventTypeName: NotRequired[str],
    iamRoleArn: NotRequired[str],
    arn: NotRequired[str],
    processedRecordsCount: NotRequired[int],
    failedRecordsCount: NotRequired[int],
    totalRecordsCount: NotRequired[int],
  1. See AsyncJobStatusType

BatchPredictionTypeDef#

# BatchPredictionTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import BatchPredictionTypeDef


def get_value() -> BatchPredictionTypeDef:
    return {
        "jobId": ...,
    }


# BatchPredictionTypeDef definition

class BatchPredictionTypeDef(TypedDict):
    jobId: NotRequired[str],
    status: NotRequired[AsyncJobStatusType],  # (1)
    failureReason: NotRequired[str],
    startTime: NotRequired[str],
    completionTime: NotRequired[str],
    lastHeartbeatTime: NotRequired[str],
    inputPath: NotRequired[str],
    outputPath: NotRequired[str],
    eventTypeName: NotRequired[str],
    detectorName: NotRequired[str],
    detectorVersion: NotRequired[str],
    iamRoleArn: NotRequired[str],
    arn: NotRequired[str],
    processedRecordsCount: NotRequired[int],
    totalRecordsCount: NotRequired[int],
  1. See AsyncJobStatusType

CancelBatchImportJobRequestTypeDef#

# CancelBatchImportJobRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import CancelBatchImportJobRequestTypeDef


def get_value() -> CancelBatchImportJobRequestTypeDef:
    return {
        "jobId": ...,
    }


# CancelBatchImportJobRequestTypeDef definition

class CancelBatchImportJobRequestTypeDef(TypedDict):
    jobId: str,

CancelBatchPredictionJobRequestTypeDef#

# CancelBatchPredictionJobRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import CancelBatchPredictionJobRequestTypeDef


def get_value() -> CancelBatchPredictionJobRequestTypeDef:
    return {
        "jobId": ...,
    }


# CancelBatchPredictionJobRequestTypeDef definition

class CancelBatchPredictionJobRequestTypeDef(TypedDict):
    jobId: str,

ModelVersionTypeDef#

# ModelVersionTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ModelVersionTypeDef


def get_value() -> ModelVersionTypeDef:
    return {
        "modelId": ...,
    }


# ModelVersionTypeDef definition

class ModelVersionTypeDef(TypedDict):
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
    modelVersionNumber: str,
    arn: NotRequired[str],
  1. See ModelTypeEnumType

RuleTypeDef#

# RuleTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import RuleTypeDef


def get_value() -> RuleTypeDef:
    return {
        "detectorId": ...,
    }


# RuleTypeDef definition

class RuleTypeDef(TypedDict):
    detectorId: str,
    ruleId: str,
    ruleVersion: str,

ExternalEventsDetailTypeDef#

# ExternalEventsDetailTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ExternalEventsDetailTypeDef


def get_value() -> ExternalEventsDetailTypeDef:
    return {
        "dataLocation": ...,
    }


# ExternalEventsDetailTypeDef definition

class ExternalEventsDetailTypeDef(TypedDict):
    dataLocation: str,
    dataAccessRoleArn: str,

FieldValidationMessageTypeDef#

# FieldValidationMessageTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import FieldValidationMessageTypeDef


def get_value() -> FieldValidationMessageTypeDef:
    return {
        "fieldName": ...,
    }


# FieldValidationMessageTypeDef definition

class FieldValidationMessageTypeDef(TypedDict):
    fieldName: NotRequired[str],
    identifier: NotRequired[str],
    title: NotRequired[str],
    content: NotRequired[str],
    type: NotRequired[str],

FileValidationMessageTypeDef#

# FileValidationMessageTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import FileValidationMessageTypeDef


def get_value() -> FileValidationMessageTypeDef:
    return {
        "title": ...,
    }


# FileValidationMessageTypeDef definition

class FileValidationMessageTypeDef(TypedDict):
    title: NotRequired[str],
    content: NotRequired[str],
    type: NotRequired[str],

DeleteBatchImportJobRequestTypeDef#

# DeleteBatchImportJobRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteBatchImportJobRequestTypeDef


def get_value() -> DeleteBatchImportJobRequestTypeDef:
    return {
        "jobId": ...,
    }


# DeleteBatchImportJobRequestTypeDef definition

class DeleteBatchImportJobRequestTypeDef(TypedDict):
    jobId: str,

DeleteBatchPredictionJobRequestTypeDef#

# DeleteBatchPredictionJobRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteBatchPredictionJobRequestTypeDef


def get_value() -> DeleteBatchPredictionJobRequestTypeDef:
    return {
        "jobId": ...,
    }


# DeleteBatchPredictionJobRequestTypeDef definition

class DeleteBatchPredictionJobRequestTypeDef(TypedDict):
    jobId: str,

DeleteDetectorRequestTypeDef#

# DeleteDetectorRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteDetectorRequestTypeDef


def get_value() -> DeleteDetectorRequestTypeDef:
    return {
        "detectorId": ...,
    }


# DeleteDetectorRequestTypeDef definition

class DeleteDetectorRequestTypeDef(TypedDict):
    detectorId: str,

DeleteDetectorVersionRequestTypeDef#

# DeleteDetectorVersionRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteDetectorVersionRequestTypeDef


def get_value() -> DeleteDetectorVersionRequestTypeDef:
    return {
        "detectorId": ...,
    }


# DeleteDetectorVersionRequestTypeDef definition

class DeleteDetectorVersionRequestTypeDef(TypedDict):
    detectorId: str,
    detectorVersionId: str,

DeleteEntityTypeRequestTypeDef#

# DeleteEntityTypeRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteEntityTypeRequestTypeDef


def get_value() -> DeleteEntityTypeRequestTypeDef:
    return {
        "name": ...,
    }


# DeleteEntityTypeRequestTypeDef definition

class DeleteEntityTypeRequestTypeDef(TypedDict):
    name: str,

DeleteEventRequestTypeDef#

# DeleteEventRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteEventRequestTypeDef


def get_value() -> DeleteEventRequestTypeDef:
    return {
        "eventId": ...,
    }


# DeleteEventRequestTypeDef definition

class DeleteEventRequestTypeDef(TypedDict):
    eventId: str,
    eventTypeName: str,
    deleteAuditHistory: NotRequired[bool],

DeleteEventTypeRequestTypeDef#

# DeleteEventTypeRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteEventTypeRequestTypeDef


def get_value() -> DeleteEventTypeRequestTypeDef:
    return {
        "name": ...,
    }


# DeleteEventTypeRequestTypeDef definition

class DeleteEventTypeRequestTypeDef(TypedDict):
    name: str,

DeleteEventsByEventTypeRequestTypeDef#

# DeleteEventsByEventTypeRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteEventsByEventTypeRequestTypeDef


def get_value() -> DeleteEventsByEventTypeRequestTypeDef:
    return {
        "eventTypeName": ...,
    }


# DeleteEventsByEventTypeRequestTypeDef definition

class DeleteEventsByEventTypeRequestTypeDef(TypedDict):
    eventTypeName: str,

DeleteExternalModelRequestTypeDef#

# DeleteExternalModelRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteExternalModelRequestTypeDef


def get_value() -> DeleteExternalModelRequestTypeDef:
    return {
        "modelEndpoint": ...,
    }


# DeleteExternalModelRequestTypeDef definition

class DeleteExternalModelRequestTypeDef(TypedDict):
    modelEndpoint: str,

DeleteLabelRequestTypeDef#

# DeleteLabelRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteLabelRequestTypeDef


def get_value() -> DeleteLabelRequestTypeDef:
    return {
        "name": ...,
    }


# DeleteLabelRequestTypeDef definition

class DeleteLabelRequestTypeDef(TypedDict):
    name: str,

DeleteListRequestTypeDef#

# DeleteListRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteListRequestTypeDef


def get_value() -> DeleteListRequestTypeDef:
    return {
        "name": ...,
    }


# DeleteListRequestTypeDef definition

class DeleteListRequestTypeDef(TypedDict):
    name: str,

DeleteModelRequestTypeDef#

# DeleteModelRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteModelRequestTypeDef


def get_value() -> DeleteModelRequestTypeDef:
    return {
        "modelId": ...,
    }


# DeleteModelRequestTypeDef definition

class DeleteModelRequestTypeDef(TypedDict):
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
  1. See ModelTypeEnumType

DeleteModelVersionRequestTypeDef#

# DeleteModelVersionRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteModelVersionRequestTypeDef


def get_value() -> DeleteModelVersionRequestTypeDef:
    return {
        "modelId": ...,
    }


# DeleteModelVersionRequestTypeDef definition

class DeleteModelVersionRequestTypeDef(TypedDict):
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
    modelVersionNumber: str,
  1. See ModelTypeEnumType

DeleteOutcomeRequestTypeDef#

# DeleteOutcomeRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteOutcomeRequestTypeDef


def get_value() -> DeleteOutcomeRequestTypeDef:
    return {
        "name": ...,
    }


# DeleteOutcomeRequestTypeDef definition

class DeleteOutcomeRequestTypeDef(TypedDict):
    name: str,

DeleteVariableRequestTypeDef#

# DeleteVariableRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteVariableRequestTypeDef


def get_value() -> DeleteVariableRequestTypeDef:
    return {
        "name": ...,
    }


# DeleteVariableRequestTypeDef definition

class DeleteVariableRequestTypeDef(TypedDict):
    name: str,

DescribeDetectorRequestTypeDef#

# DescribeDetectorRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DescribeDetectorRequestTypeDef


def get_value() -> DescribeDetectorRequestTypeDef:
    return {
        "detectorId": ...,
    }


# DescribeDetectorRequestTypeDef definition

class DescribeDetectorRequestTypeDef(TypedDict):
    detectorId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

DetectorVersionSummaryTypeDef#

# DetectorVersionSummaryTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DetectorVersionSummaryTypeDef


def get_value() -> DetectorVersionSummaryTypeDef:
    return {
        "detectorVersionId": ...,
    }


# DetectorVersionSummaryTypeDef definition

class DetectorVersionSummaryTypeDef(TypedDict):
    detectorVersionId: NotRequired[str],
    status: NotRequired[DetectorVersionStatusType],  # (1)
    description: NotRequired[str],
    lastUpdatedTime: NotRequired[str],
  1. See DetectorVersionStatusType

DescribeModelVersionsRequestTypeDef#

# DescribeModelVersionsRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DescribeModelVersionsRequestTypeDef


def get_value() -> DescribeModelVersionsRequestTypeDef:
    return {
        "modelId": ...,
    }


# DescribeModelVersionsRequestTypeDef definition

class DescribeModelVersionsRequestTypeDef(TypedDict):
    modelId: NotRequired[str],
    modelVersionNumber: NotRequired[str],
    modelType: NotRequired[ModelTypeEnumType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See ModelTypeEnumType

DetectorTypeDef#

# DetectorTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DetectorTypeDef


def get_value() -> DetectorTypeDef:
    return {
        "detectorId": ...,
    }


# DetectorTypeDef definition

class DetectorTypeDef(TypedDict):
    detectorId: NotRequired[str],
    description: NotRequired[str],
    eventTypeName: NotRequired[str],
    lastUpdatedTime: NotRequired[str],
    createdTime: NotRequired[str],
    arn: NotRequired[str],

EntityTypeDef#

# EntityTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import EntityTypeDef


def get_value() -> EntityTypeDef:
    return {
        "entityType": ...,
    }


# EntityTypeDef definition

class EntityTypeDef(TypedDict):
    entityType: str,
    entityId: str,

EntityTypeTypeDef#

# EntityTypeTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import EntityTypeTypeDef


def get_value() -> EntityTypeTypeDef:
    return {
        "name": ...,
    }


# EntityTypeTypeDef definition

class EntityTypeTypeDef(TypedDict):
    name: NotRequired[str],
    description: NotRequired[str],
    lastUpdatedTime: NotRequired[str],
    createdTime: NotRequired[str],
    arn: NotRequired[str],

EvaluatedExternalModelTypeDef#

# EvaluatedExternalModelTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import EvaluatedExternalModelTypeDef


def get_value() -> EvaluatedExternalModelTypeDef:
    return {
        "modelEndpoint": ...,
    }


# EvaluatedExternalModelTypeDef definition

class EvaluatedExternalModelTypeDef(TypedDict):
    modelEndpoint: NotRequired[str],
    useEventVariables: NotRequired[bool],
    inputVariables: NotRequired[Dict[str, str]],
    outputVariables: NotRequired[Dict[str, str]],

EvaluatedRuleTypeDef#

# EvaluatedRuleTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import EvaluatedRuleTypeDef


def get_value() -> EvaluatedRuleTypeDef:
    return {
        "ruleId": ...,
    }


# EvaluatedRuleTypeDef definition

class EvaluatedRuleTypeDef(TypedDict):
    ruleId: NotRequired[str],
    ruleVersion: NotRequired[str],
    expression: NotRequired[str],
    expressionWithValues: NotRequired[str],
    outcomes: NotRequired[List[str]],
    evaluated: NotRequired[bool],
    matched: NotRequired[bool],

EventOrchestrationTypeDef#

# EventOrchestrationTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import EventOrchestrationTypeDef


def get_value() -> EventOrchestrationTypeDef:
    return {
        "eventBridgeEnabled": ...,
    }


# EventOrchestrationTypeDef definition

class EventOrchestrationTypeDef(TypedDict):
    eventBridgeEnabled: bool,

EventPredictionSummaryTypeDef#

# EventPredictionSummaryTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import EventPredictionSummaryTypeDef


def get_value() -> EventPredictionSummaryTypeDef:
    return {
        "eventId": ...,
    }


# EventPredictionSummaryTypeDef definition

class EventPredictionSummaryTypeDef(TypedDict):
    eventId: NotRequired[str],
    eventTypeName: NotRequired[str],
    eventTimestamp: NotRequired[str],
    predictionTimestamp: NotRequired[str],
    detectorId: NotRequired[str],
    detectorVersionId: NotRequired[str],

IngestedEventStatisticsTypeDef#

# IngestedEventStatisticsTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import IngestedEventStatisticsTypeDef


def get_value() -> IngestedEventStatisticsTypeDef:
    return {
        "numberOfEvents": ...,
    }


# IngestedEventStatisticsTypeDef definition

class IngestedEventStatisticsTypeDef(TypedDict):
    numberOfEvents: NotRequired[int],
    eventDataSizeInBytes: NotRequired[int],
    leastRecentEvent: NotRequired[str],
    mostRecentEvent: NotRequired[str],
    lastUpdatedTime: NotRequired[str],

EventVariableSummaryTypeDef#

# EventVariableSummaryTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import EventVariableSummaryTypeDef


def get_value() -> EventVariableSummaryTypeDef:
    return {
        "name": ...,
    }


# EventVariableSummaryTypeDef definition

class EventVariableSummaryTypeDef(TypedDict):
    name: NotRequired[str],
    value: NotRequired[str],
    source: NotRequired[str],

ExternalModelSummaryTypeDef#

# ExternalModelSummaryTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ExternalModelSummaryTypeDef


def get_value() -> ExternalModelSummaryTypeDef:
    return {
        "modelEndpoint": ...,
    }


# ExternalModelSummaryTypeDef definition

class ExternalModelSummaryTypeDef(TypedDict):
    modelEndpoint: NotRequired[str],
    modelSource: NotRequired[ModelSourceType],  # (1)
  1. See ModelSourceType

ModelInputConfigurationTypeDef#

# ModelInputConfigurationTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ModelInputConfigurationTypeDef


def get_value() -> ModelInputConfigurationTypeDef:
    return {
        "eventTypeName": ...,
    }


# ModelInputConfigurationTypeDef definition

class ModelInputConfigurationTypeDef(TypedDict):
    useEventVariables: bool,
    eventTypeName: NotRequired[str],
    format: NotRequired[ModelInputDataFormatType],  # (1)
    jsonInputTemplate: NotRequired[str],
    csvInputTemplate: NotRequired[str],
  1. See ModelInputDataFormatType

ModelOutputConfigurationOutputTypeDef#

# ModelOutputConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ModelOutputConfigurationOutputTypeDef


def get_value() -> ModelOutputConfigurationOutputTypeDef:
    return {
        "format": ...,
    }


# ModelOutputConfigurationOutputTypeDef definition

class ModelOutputConfigurationOutputTypeDef(TypedDict):
    format: ModelOutputDataFormatType,  # (1)
    jsonKeyToVariableMap: NotRequired[Dict[str, str]],
    csvIndexToVariableMap: NotRequired[Dict[str, str]],
  1. See ModelOutputDataFormatType

FilterConditionTypeDef#

# FilterConditionTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import FilterConditionTypeDef


def get_value() -> FilterConditionTypeDef:
    return {
        "value": ...,
    }


# FilterConditionTypeDef definition

class FilterConditionTypeDef(TypedDict):
    value: NotRequired[str],

GetBatchImportJobsRequestTypeDef#

# GetBatchImportJobsRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetBatchImportJobsRequestTypeDef


def get_value() -> GetBatchImportJobsRequestTypeDef:
    return {
        "jobId": ...,
    }


# GetBatchImportJobsRequestTypeDef definition

class GetBatchImportJobsRequestTypeDef(TypedDict):
    jobId: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

GetBatchPredictionJobsRequestTypeDef#

# GetBatchPredictionJobsRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetBatchPredictionJobsRequestTypeDef


def get_value() -> GetBatchPredictionJobsRequestTypeDef:
    return {
        "jobId": ...,
    }


# GetBatchPredictionJobsRequestTypeDef definition

class GetBatchPredictionJobsRequestTypeDef(TypedDict):
    jobId: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

GetDeleteEventsByEventTypeStatusRequestTypeDef#

# GetDeleteEventsByEventTypeStatusRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetDeleteEventsByEventTypeStatusRequestTypeDef


def get_value() -> GetDeleteEventsByEventTypeStatusRequestTypeDef:
    return {
        "eventTypeName": ...,
    }


# GetDeleteEventsByEventTypeStatusRequestTypeDef definition

class GetDeleteEventsByEventTypeStatusRequestTypeDef(TypedDict):
    eventTypeName: str,

GetDetectorVersionRequestTypeDef#

# GetDetectorVersionRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetDetectorVersionRequestTypeDef


def get_value() -> GetDetectorVersionRequestTypeDef:
    return {
        "detectorId": ...,
    }


# GetDetectorVersionRequestTypeDef definition

class GetDetectorVersionRequestTypeDef(TypedDict):
    detectorId: str,
    detectorVersionId: str,

GetDetectorsRequestTypeDef#

# GetDetectorsRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetDetectorsRequestTypeDef


def get_value() -> GetDetectorsRequestTypeDef:
    return {
        "detectorId": ...,
    }


# GetDetectorsRequestTypeDef definition

class GetDetectorsRequestTypeDef(TypedDict):
    detectorId: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

GetEntityTypesRequestTypeDef#

# GetEntityTypesRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetEntityTypesRequestTypeDef


def get_value() -> GetEntityTypesRequestTypeDef:
    return {
        "name": ...,
    }


# GetEntityTypesRequestTypeDef definition

class GetEntityTypesRequestTypeDef(TypedDict):
    name: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

GetEventPredictionMetadataRequestTypeDef#

# GetEventPredictionMetadataRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetEventPredictionMetadataRequestTypeDef


def get_value() -> GetEventPredictionMetadataRequestTypeDef:
    return {
        "eventId": ...,
    }


# GetEventPredictionMetadataRequestTypeDef definition

class GetEventPredictionMetadataRequestTypeDef(TypedDict):
    eventId: str,
    eventTypeName: str,
    detectorId: str,
    detectorVersionId: str,
    predictionTimestamp: str,

RuleResultTypeDef#

# RuleResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import RuleResultTypeDef


def get_value() -> RuleResultTypeDef:
    return {
        "ruleId": ...,
    }


# RuleResultTypeDef definition

class RuleResultTypeDef(TypedDict):
    ruleId: NotRequired[str],
    outcomes: NotRequired[List[str]],

GetEventRequestTypeDef#

# GetEventRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetEventRequestTypeDef


def get_value() -> GetEventRequestTypeDef:
    return {
        "eventId": ...,
    }


# GetEventRequestTypeDef definition

class GetEventRequestTypeDef(TypedDict):
    eventId: str,
    eventTypeName: str,

GetEventTypesRequestTypeDef#

# GetEventTypesRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetEventTypesRequestTypeDef


def get_value() -> GetEventTypesRequestTypeDef:
    return {
        "name": ...,
    }


# GetEventTypesRequestTypeDef definition

class GetEventTypesRequestTypeDef(TypedDict):
    name: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

GetExternalModelsRequestTypeDef#

# GetExternalModelsRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetExternalModelsRequestTypeDef


def get_value() -> GetExternalModelsRequestTypeDef:
    return {
        "modelEndpoint": ...,
    }


# GetExternalModelsRequestTypeDef definition

class GetExternalModelsRequestTypeDef(TypedDict):
    modelEndpoint: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

KMSKeyTypeDef#

# KMSKeyTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import KMSKeyTypeDef


def get_value() -> KMSKeyTypeDef:
    return {
        "kmsEncryptionKeyArn": ...,
    }


# KMSKeyTypeDef definition

class KMSKeyTypeDef(TypedDict):
    kmsEncryptionKeyArn: NotRequired[str],

GetLabelsRequestTypeDef#

# GetLabelsRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetLabelsRequestTypeDef


def get_value() -> GetLabelsRequestTypeDef:
    return {
        "name": ...,
    }


# GetLabelsRequestTypeDef definition

class GetLabelsRequestTypeDef(TypedDict):
    name: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

LabelTypeDef#

# LabelTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import LabelTypeDef


def get_value() -> LabelTypeDef:
    return {
        "name": ...,
    }


# LabelTypeDef definition

class LabelTypeDef(TypedDict):
    name: NotRequired[str],
    description: NotRequired[str],
    lastUpdatedTime: NotRequired[str],
    createdTime: NotRequired[str],
    arn: NotRequired[str],

GetListElementsRequestTypeDef#

# GetListElementsRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetListElementsRequestTypeDef


def get_value() -> GetListElementsRequestTypeDef:
    return {
        "name": ...,
    }


# GetListElementsRequestTypeDef definition

class GetListElementsRequestTypeDef(TypedDict):
    name: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

GetListsMetadataRequestTypeDef#

# GetListsMetadataRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetListsMetadataRequestTypeDef


def get_value() -> GetListsMetadataRequestTypeDef:
    return {
        "name": ...,
    }


# GetListsMetadataRequestTypeDef definition

class GetListsMetadataRequestTypeDef(TypedDict):
    name: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

GetModelVersionRequestTypeDef#

# GetModelVersionRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetModelVersionRequestTypeDef


def get_value() -> GetModelVersionRequestTypeDef:
    return {
        "modelId": ...,
    }


# GetModelVersionRequestTypeDef definition

class GetModelVersionRequestTypeDef(TypedDict):
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
    modelVersionNumber: str,
  1. See ModelTypeEnumType

GetModelsRequestTypeDef#

# GetModelsRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetModelsRequestTypeDef


def get_value() -> GetModelsRequestTypeDef:
    return {
        "modelId": ...,
    }


# GetModelsRequestTypeDef definition

class GetModelsRequestTypeDef(TypedDict):
    modelId: NotRequired[str],
    modelType: NotRequired[ModelTypeEnumType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See ModelTypeEnumType

ModelTypeDef#

# ModelTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ModelTypeDef


def get_value() -> ModelTypeDef:
    return {
        "modelId": ...,
    }


# ModelTypeDef definition

class ModelTypeDef(TypedDict):
    modelId: NotRequired[str],
    modelType: NotRequired[ModelTypeEnumType],  # (1)
    description: NotRequired[str],
    eventTypeName: NotRequired[str],
    createdTime: NotRequired[str],
    lastUpdatedTime: NotRequired[str],
    arn: NotRequired[str],
  1. See ModelTypeEnumType

GetOutcomesRequestTypeDef#

# GetOutcomesRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetOutcomesRequestTypeDef


def get_value() -> GetOutcomesRequestTypeDef:
    return {
        "name": ...,
    }


# GetOutcomesRequestTypeDef definition

class GetOutcomesRequestTypeDef(TypedDict):
    name: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

OutcomeTypeDef#

# OutcomeTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import OutcomeTypeDef


def get_value() -> OutcomeTypeDef:
    return {
        "name": ...,
    }


# OutcomeTypeDef definition

class OutcomeTypeDef(TypedDict):
    name: NotRequired[str],
    description: NotRequired[str],
    lastUpdatedTime: NotRequired[str],
    createdTime: NotRequired[str],
    arn: NotRequired[str],

GetRulesRequestTypeDef#

# GetRulesRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetRulesRequestTypeDef


def get_value() -> GetRulesRequestTypeDef:
    return {
        "detectorId": ...,
    }


# GetRulesRequestTypeDef definition

class GetRulesRequestTypeDef(TypedDict):
    detectorId: str,
    ruleId: NotRequired[str],
    ruleVersion: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

RuleDetailTypeDef#

# RuleDetailTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import RuleDetailTypeDef


def get_value() -> RuleDetailTypeDef:
    return {
        "ruleId": ...,
    }


# RuleDetailTypeDef definition

class RuleDetailTypeDef(TypedDict):
    ruleId: NotRequired[str],
    description: NotRequired[str],
    detectorId: NotRequired[str],
    ruleVersion: NotRequired[str],
    expression: NotRequired[str],
    language: NotRequired[LanguageType],  # (1)
    outcomes: NotRequired[List[str]],
    lastUpdatedTime: NotRequired[str],
    createdTime: NotRequired[str],
    arn: NotRequired[str],
  1. See LanguageType

GetVariablesRequestTypeDef#

# GetVariablesRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetVariablesRequestTypeDef


def get_value() -> GetVariablesRequestTypeDef:
    return {
        "name": ...,
    }


# GetVariablesRequestTypeDef definition

class GetVariablesRequestTypeDef(TypedDict):
    name: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

IngestedEventsTimeWindowTypeDef#

# IngestedEventsTimeWindowTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import IngestedEventsTimeWindowTypeDef


def get_value() -> IngestedEventsTimeWindowTypeDef:
    return {
        "startTime": ...,
    }


# IngestedEventsTimeWindowTypeDef definition

class IngestedEventsTimeWindowTypeDef(TypedDict):
    startTime: str,
    endTime: str,

LabelSchemaOutputTypeDef#

# LabelSchemaOutputTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import LabelSchemaOutputTypeDef


def get_value() -> LabelSchemaOutputTypeDef:
    return {
        "labelMapper": ...,
    }


# LabelSchemaOutputTypeDef definition

class LabelSchemaOutputTypeDef(TypedDict):
    labelMapper: NotRequired[Dict[str, List[str]]],
    unlabeledEventsTreatment: NotRequired[UnlabeledEventsTreatmentType],  # (1)
  1. See UnlabeledEventsTreatmentType

LabelSchemaTypeDef#

# LabelSchemaTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import LabelSchemaTypeDef


def get_value() -> LabelSchemaTypeDef:
    return {
        "labelMapper": ...,
    }


# LabelSchemaTypeDef definition

class LabelSchemaTypeDef(TypedDict):
    labelMapper: NotRequired[Mapping[str, Sequence[str]]],
    unlabeledEventsTreatment: NotRequired[UnlabeledEventsTreatmentType],  # (1)
  1. See UnlabeledEventsTreatmentType

PredictionTimeRangeTypeDef#

# PredictionTimeRangeTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import PredictionTimeRangeTypeDef


def get_value() -> PredictionTimeRangeTypeDef:
    return {
        "startTime": ...,
    }


# PredictionTimeRangeTypeDef definition

class PredictionTimeRangeTypeDef(TypedDict):
    startTime: str,
    endTime: str,

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "resourceARN": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceARN: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

LogOddsMetricTypeDef#

# LogOddsMetricTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import LogOddsMetricTypeDef


def get_value() -> LogOddsMetricTypeDef:
    return {
        "variableName": ...,
    }


# LogOddsMetricTypeDef definition

class LogOddsMetricTypeDef(TypedDict):
    variableName: str,
    variableType: str,
    variableImportance: float,

MetricDataPointTypeDef#

# MetricDataPointTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import MetricDataPointTypeDef


def get_value() -> MetricDataPointTypeDef:
    return {
        "fpr": ...,
    }


# MetricDataPointTypeDef definition

class MetricDataPointTypeDef(TypedDict):
    fpr: NotRequired[float],
    precision: NotRequired[float],
    tpr: NotRequired[float],
    threshold: NotRequired[float],

ModelOutputConfigurationTypeDef#

# ModelOutputConfigurationTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ModelOutputConfigurationTypeDef


def get_value() -> ModelOutputConfigurationTypeDef:
    return {
        "format": ...,
    }


# ModelOutputConfigurationTypeDef definition

class ModelOutputConfigurationTypeDef(TypedDict):
    format: ModelOutputDataFormatType,  # (1)
    jsonKeyToVariableMap: NotRequired[Mapping[str, str]],
    csvIndexToVariableMap: NotRequired[Mapping[str, str]],
  1. See ModelOutputDataFormatType

OFIMetricDataPointTypeDef#

# OFIMetricDataPointTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import OFIMetricDataPointTypeDef


def get_value() -> OFIMetricDataPointTypeDef:
    return {
        "fpr": ...,
    }


# OFIMetricDataPointTypeDef definition

class OFIMetricDataPointTypeDef(TypedDict):
    fpr: NotRequired[float],
    precision: NotRequired[float],
    tpr: NotRequired[float],
    threshold: NotRequired[float],

UncertaintyRangeTypeDef#

# UncertaintyRangeTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import UncertaintyRangeTypeDef


def get_value() -> UncertaintyRangeTypeDef:
    return {
        "lowerBoundValue": ...,
    }


# UncertaintyRangeTypeDef definition

class UncertaintyRangeTypeDef(TypedDict):
    lowerBoundValue: float,
    upperBoundValue: float,

VariableImpactExplanationTypeDef#

# VariableImpactExplanationTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import VariableImpactExplanationTypeDef


def get_value() -> VariableImpactExplanationTypeDef:
    return {
        "eventVariableName": ...,
    }


# VariableImpactExplanationTypeDef definition

class VariableImpactExplanationTypeDef(TypedDict):
    eventVariableName: NotRequired[str],
    relativeImpact: NotRequired[str],
    logOddsImpact: NotRequired[float],

PutKMSEncryptionKeyRequestTypeDef#

# PutKMSEncryptionKeyRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import PutKMSEncryptionKeyRequestTypeDef


def get_value() -> PutKMSEncryptionKeyRequestTypeDef:
    return {
        "kmsEncryptionKeyArn": ...,
    }


# PutKMSEncryptionKeyRequestTypeDef definition

class PutKMSEncryptionKeyRequestTypeDef(TypedDict):
    kmsEncryptionKeyArn: str,

TFIMetricDataPointTypeDef#

# TFIMetricDataPointTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import TFIMetricDataPointTypeDef


def get_value() -> TFIMetricDataPointTypeDef:
    return {
        "fpr": ...,
    }


# TFIMetricDataPointTypeDef definition

class TFIMetricDataPointTypeDef(TypedDict):
    fpr: NotRequired[float],
    precision: NotRequired[float],
    tpr: NotRequired[float],
    threshold: NotRequired[float],

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "resourceARN": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    resourceARN: str,
    tagKeys: Sequence[str],

UpdateDetectorVersionMetadataRequestTypeDef#

# UpdateDetectorVersionMetadataRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import UpdateDetectorVersionMetadataRequestTypeDef


def get_value() -> UpdateDetectorVersionMetadataRequestTypeDef:
    return {
        "detectorId": ...,
    }


# UpdateDetectorVersionMetadataRequestTypeDef definition

class UpdateDetectorVersionMetadataRequestTypeDef(TypedDict):
    detectorId: str,
    detectorVersionId: str,
    description: str,

UpdateDetectorVersionStatusRequestTypeDef#

# UpdateDetectorVersionStatusRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import UpdateDetectorVersionStatusRequestTypeDef


def get_value() -> UpdateDetectorVersionStatusRequestTypeDef:
    return {
        "detectorId": ...,
    }


# UpdateDetectorVersionStatusRequestTypeDef definition

class UpdateDetectorVersionStatusRequestTypeDef(TypedDict):
    detectorId: str,
    detectorVersionId: str,
    status: DetectorVersionStatusType,  # (1)
  1. See DetectorVersionStatusType

UpdateEventLabelRequestTypeDef#

# UpdateEventLabelRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import UpdateEventLabelRequestTypeDef


def get_value() -> UpdateEventLabelRequestTypeDef:
    return {
        "eventId": ...,
    }


# UpdateEventLabelRequestTypeDef definition

class UpdateEventLabelRequestTypeDef(TypedDict):
    eventId: str,
    eventTypeName: str,
    assignedLabel: str,
    labelTimestamp: str,

UpdateListRequestTypeDef#

# UpdateListRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import UpdateListRequestTypeDef


def get_value() -> UpdateListRequestTypeDef:
    return {
        "name": ...,
    }


# UpdateListRequestTypeDef definition

class UpdateListRequestTypeDef(TypedDict):
    name: str,
    elements: NotRequired[Sequence[str]],
    description: NotRequired[str],
    updateMode: NotRequired[ListUpdateModeType],  # (1)
    variableType: NotRequired[str],
  1. See ListUpdateModeType

UpdateModelRequestTypeDef#

# UpdateModelRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import UpdateModelRequestTypeDef


def get_value() -> UpdateModelRequestTypeDef:
    return {
        "modelId": ...,
    }


# UpdateModelRequestTypeDef definition

class UpdateModelRequestTypeDef(TypedDict):
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
    description: NotRequired[str],
  1. See ModelTypeEnumType

UpdateModelVersionStatusRequestTypeDef#

# UpdateModelVersionStatusRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import UpdateModelVersionStatusRequestTypeDef


def get_value() -> UpdateModelVersionStatusRequestTypeDef:
    return {
        "modelId": ...,
    }


# UpdateModelVersionStatusRequestTypeDef definition

class UpdateModelVersionStatusRequestTypeDef(TypedDict):
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
    modelVersionNumber: str,
    status: ModelVersionStatusType,  # (2)
  1. See ModelTypeEnumType
  2. See ModelVersionStatusType

UpdateVariableRequestTypeDef#

# UpdateVariableRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import UpdateVariableRequestTypeDef


def get_value() -> UpdateVariableRequestTypeDef:
    return {
        "name": ...,
    }


# UpdateVariableRequestTypeDef definition

class UpdateVariableRequestTypeDef(TypedDict):
    name: str,
    defaultValue: NotRequired[str],
    description: NotRequired[str],
    variableType: NotRequired[str],

ATITrainingMetricsValueTypeDef#

# ATITrainingMetricsValueTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ATITrainingMetricsValueTypeDef


def get_value() -> ATITrainingMetricsValueTypeDef:
    return {
        "metricDataPoints": ...,
    }


# ATITrainingMetricsValueTypeDef definition

class ATITrainingMetricsValueTypeDef(TypedDict):
    metricDataPoints: NotRequired[List[ATIMetricDataPointTypeDef]],  # (1)
    modelPerformance: NotRequired[ATIModelPerformanceTypeDef],  # (2)
  1. See List[ATIMetricDataPointTypeDef]
  2. See ATIModelPerformanceTypeDef

AggregatedVariablesImportanceMetricsTypeDef#

# AggregatedVariablesImportanceMetricsTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import AggregatedVariablesImportanceMetricsTypeDef


def get_value() -> AggregatedVariablesImportanceMetricsTypeDef:
    return {
        "logOddsMetrics": ...,
    }


# AggregatedVariablesImportanceMetricsTypeDef definition

class AggregatedVariablesImportanceMetricsTypeDef(TypedDict):
    logOddsMetrics: NotRequired[List[AggregatedLogOddsMetricTypeDef]],  # (1)
  1. See List[AggregatedLogOddsMetricTypeDef]

CreateBatchImportJobRequestTypeDef#

# CreateBatchImportJobRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import CreateBatchImportJobRequestTypeDef


def get_value() -> CreateBatchImportJobRequestTypeDef:
    return {
        "jobId": ...,
    }


# CreateBatchImportJobRequestTypeDef definition

class CreateBatchImportJobRequestTypeDef(TypedDict):
    jobId: str,
    inputPath: str,
    outputPath: str,
    eventTypeName: str,
    iamRoleArn: str,
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See Sequence[TagTypeDef]

CreateBatchPredictionJobRequestTypeDef#

# CreateBatchPredictionJobRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import CreateBatchPredictionJobRequestTypeDef


def get_value() -> CreateBatchPredictionJobRequestTypeDef:
    return {
        "jobId": ...,
    }


# CreateBatchPredictionJobRequestTypeDef definition

class CreateBatchPredictionJobRequestTypeDef(TypedDict):
    jobId: str,
    inputPath: str,
    outputPath: str,
    eventTypeName: str,
    detectorName: str,
    iamRoleArn: str,
    detectorVersion: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See Sequence[TagTypeDef]

CreateListRequestTypeDef#

# CreateListRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import CreateListRequestTypeDef


def get_value() -> CreateListRequestTypeDef:
    return {
        "name": ...,
    }


# CreateListRequestTypeDef definition

class CreateListRequestTypeDef(TypedDict):
    name: str,
    elements: NotRequired[Sequence[str]],
    variableType: NotRequired[str],
    description: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See Sequence[TagTypeDef]

CreateModelRequestTypeDef#

# CreateModelRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import CreateModelRequestTypeDef


def get_value() -> CreateModelRequestTypeDef:
    return {
        "modelId": ...,
    }


# CreateModelRequestTypeDef definition

class CreateModelRequestTypeDef(TypedDict):
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
    eventTypeName: str,
    description: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See ModelTypeEnumType
  2. See Sequence[TagTypeDef]

CreateRuleRequestTypeDef#

# CreateRuleRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import CreateRuleRequestTypeDef


def get_value() -> CreateRuleRequestTypeDef:
    return {
        "ruleId": ...,
    }


# CreateRuleRequestTypeDef definition

class CreateRuleRequestTypeDef(TypedDict):
    ruleId: str,
    detectorId: str,
    expression: str,
    language: LanguageType,  # (1)
    outcomes: Sequence[str],
    description: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See LanguageType
  2. See Sequence[TagTypeDef]

CreateVariableRequestTypeDef#

# CreateVariableRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import CreateVariableRequestTypeDef


def get_value() -> CreateVariableRequestTypeDef:
    return {
        "name": ...,
    }


# CreateVariableRequestTypeDef definition

class CreateVariableRequestTypeDef(TypedDict):
    name: str,
    dataType: DataTypeType,  # (1)
    dataSource: DataSourceType,  # (2)
    defaultValue: str,
    description: NotRequired[str],
    variableType: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See DataTypeType
  2. See DataSourceType
  3. See Sequence[TagTypeDef]

PutDetectorRequestTypeDef#

# PutDetectorRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import PutDetectorRequestTypeDef


def get_value() -> PutDetectorRequestTypeDef:
    return {
        "detectorId": ...,
    }


# PutDetectorRequestTypeDef definition

class PutDetectorRequestTypeDef(TypedDict):
    detectorId: str,
    eventTypeName: str,
    description: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See Sequence[TagTypeDef]

PutEntityTypeRequestTypeDef#

# PutEntityTypeRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import PutEntityTypeRequestTypeDef


def get_value() -> PutEntityTypeRequestTypeDef:
    return {
        "name": ...,
    }


# PutEntityTypeRequestTypeDef definition

class PutEntityTypeRequestTypeDef(TypedDict):
    name: str,
    description: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See Sequence[TagTypeDef]

PutLabelRequestTypeDef#

# PutLabelRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import PutLabelRequestTypeDef


def get_value() -> PutLabelRequestTypeDef:
    return {
        "name": ...,
    }


# PutLabelRequestTypeDef definition

class PutLabelRequestTypeDef(TypedDict):
    name: str,
    description: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See Sequence[TagTypeDef]

PutOutcomeRequestTypeDef#

# PutOutcomeRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import PutOutcomeRequestTypeDef


def get_value() -> PutOutcomeRequestTypeDef:
    return {
        "name": ...,
    }


# PutOutcomeRequestTypeDef definition

class PutOutcomeRequestTypeDef(TypedDict):
    name: str,
    description: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See Sequence[TagTypeDef]

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "resourceARN": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    resourceARN: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See Sequence[TagTypeDef]

BatchCreateVariableRequestTypeDef#

# BatchCreateVariableRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import BatchCreateVariableRequestTypeDef


def get_value() -> BatchCreateVariableRequestTypeDef:
    return {
        "variableEntries": ...,
    }


# BatchCreateVariableRequestTypeDef definition

class BatchCreateVariableRequestTypeDef(TypedDict):
    variableEntries: Sequence[VariableEntryTypeDef],  # (1)
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See Sequence[VariableEntryTypeDef]
  2. See Sequence[TagTypeDef]

BatchCreateVariableResultTypeDef#

# BatchCreateVariableResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import BatchCreateVariableResultTypeDef


def get_value() -> BatchCreateVariableResultTypeDef:
    return {
        "errors": ...,
    }


# BatchCreateVariableResultTypeDef definition

class BatchCreateVariableResultTypeDef(TypedDict):
    errors: List[BatchCreateVariableErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[BatchCreateVariableErrorTypeDef]
  2. See ResponseMetadataTypeDef

CreateDetectorVersionResultTypeDef#

# CreateDetectorVersionResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import CreateDetectorVersionResultTypeDef


def get_value() -> CreateDetectorVersionResultTypeDef:
    return {
        "detectorId": ...,
    }


# CreateDetectorVersionResultTypeDef definition

class CreateDetectorVersionResultTypeDef(TypedDict):
    detectorId: str,
    detectorVersionId: str,
    status: DetectorVersionStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DetectorVersionStatusType
  2. See ResponseMetadataTypeDef

CreateModelVersionResultTypeDef#

# CreateModelVersionResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import CreateModelVersionResultTypeDef


def get_value() -> CreateModelVersionResultTypeDef:
    return {
        "modelId": ...,
    }


# CreateModelVersionResultTypeDef definition

class CreateModelVersionResultTypeDef(TypedDict):
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
    modelVersionNumber: str,
    status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ModelTypeEnumType
  2. See ResponseMetadataTypeDef

DeleteEventsByEventTypeResultTypeDef#

# DeleteEventsByEventTypeResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteEventsByEventTypeResultTypeDef


def get_value() -> DeleteEventsByEventTypeResultTypeDef:
    return {
        "eventTypeName": ...,
    }


# DeleteEventsByEventTypeResultTypeDef definition

class DeleteEventsByEventTypeResultTypeDef(TypedDict):
    eventTypeName: str,
    eventsDeletionStatus: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetDeleteEventsByEventTypeStatusResultTypeDef#

# GetDeleteEventsByEventTypeStatusResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetDeleteEventsByEventTypeStatusResultTypeDef


def get_value() -> GetDeleteEventsByEventTypeStatusResultTypeDef:
    return {
        "eventTypeName": ...,
    }


# GetDeleteEventsByEventTypeStatusResultTypeDef definition

class GetDeleteEventsByEventTypeStatusResultTypeDef(TypedDict):
    eventTypeName: str,
    eventsDeletionStatus: AsyncJobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AsyncJobStatusType
  2. See ResponseMetadataTypeDef

GetListElementsResultTypeDef#

# GetListElementsResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetListElementsResultTypeDef


def get_value() -> GetListElementsResultTypeDef:
    return {
        "elements": ...,
    }


# GetListElementsResultTypeDef definition

class GetListElementsResultTypeDef(TypedDict):
    elements: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    nextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

GetListsMetadataResultTypeDef#

# GetListsMetadataResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetListsMetadataResultTypeDef


def get_value() -> GetListsMetadataResultTypeDef:
    return {
        "lists": ...,
    }


# GetListsMetadataResultTypeDef definition

class GetListsMetadataResultTypeDef(TypedDict):
    lists: List[AllowDenyListTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[AllowDenyListTypeDef]
  2. See ResponseMetadataTypeDef

ListTagsForResourceResultTypeDef#

# ListTagsForResourceResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ListTagsForResourceResultTypeDef


def get_value() -> ListTagsForResourceResultTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceResultTypeDef definition

class ListTagsForResourceResultTypeDef(TypedDict):
    tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[TagTypeDef]
  2. See ResponseMetadataTypeDef

UpdateModelVersionResultTypeDef#

# UpdateModelVersionResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import UpdateModelVersionResultTypeDef


def get_value() -> UpdateModelVersionResultTypeDef:
    return {
        "modelId": ...,
    }


# UpdateModelVersionResultTypeDef definition

class UpdateModelVersionResultTypeDef(TypedDict):
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
    modelVersionNumber: str,
    status: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ModelTypeEnumType
  2. See ResponseMetadataTypeDef

BatchGetVariableResultTypeDef#

# BatchGetVariableResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import BatchGetVariableResultTypeDef


def get_value() -> BatchGetVariableResultTypeDef:
    return {
        "variables": ...,
    }


# BatchGetVariableResultTypeDef definition

class BatchGetVariableResultTypeDef(TypedDict):
    variables: List[VariableTypeDef],  # (1)
    errors: List[BatchGetVariableErrorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See List[VariableTypeDef]
  2. See List[BatchGetVariableErrorTypeDef]
  3. See ResponseMetadataTypeDef

GetVariablesResultTypeDef#

# GetVariablesResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetVariablesResultTypeDef


def get_value() -> GetVariablesResultTypeDef:
    return {
        "variables": ...,
    }


# GetVariablesResultTypeDef definition

class GetVariablesResultTypeDef(TypedDict):
    variables: List[VariableTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[VariableTypeDef]
  2. See ResponseMetadataTypeDef

GetBatchImportJobsResultTypeDef#

# GetBatchImportJobsResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetBatchImportJobsResultTypeDef


def get_value() -> GetBatchImportJobsResultTypeDef:
    return {
        "batchImports": ...,
    }


# GetBatchImportJobsResultTypeDef definition

class GetBatchImportJobsResultTypeDef(TypedDict):
    batchImports: List[BatchImportTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[BatchImportTypeDef]
  2. See ResponseMetadataTypeDef

GetBatchPredictionJobsResultTypeDef#

# GetBatchPredictionJobsResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetBatchPredictionJobsResultTypeDef


def get_value() -> GetBatchPredictionJobsResultTypeDef:
    return {
        "batchPredictions": ...,
    }


# GetBatchPredictionJobsResultTypeDef definition

class GetBatchPredictionJobsResultTypeDef(TypedDict):
    batchPredictions: List[BatchPredictionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[BatchPredictionTypeDef]
  2. See ResponseMetadataTypeDef

ModelEndpointDataBlobTypeDef#

# ModelEndpointDataBlobTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ModelEndpointDataBlobTypeDef


def get_value() -> ModelEndpointDataBlobTypeDef:
    return {
        "byteBuffer": ...,
    }


# ModelEndpointDataBlobTypeDef definition

class ModelEndpointDataBlobTypeDef(TypedDict):
    byteBuffer: NotRequired[BlobTypeDef],
    contentType: NotRequired[str],

ModelScoresTypeDef#

# ModelScoresTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ModelScoresTypeDef


def get_value() -> ModelScoresTypeDef:
    return {
        "modelVersion": ...,
    }


# ModelScoresTypeDef definition

class ModelScoresTypeDef(TypedDict):
    modelVersion: NotRequired[ModelVersionTypeDef],  # (1)
    scores: NotRequired[Dict[str, float]],
  1. See ModelVersionTypeDef

CreateDetectorVersionRequestTypeDef#

# CreateDetectorVersionRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import CreateDetectorVersionRequestTypeDef


def get_value() -> CreateDetectorVersionRequestTypeDef:
    return {
        "detectorId": ...,
    }


# CreateDetectorVersionRequestTypeDef definition

class CreateDetectorVersionRequestTypeDef(TypedDict):
    detectorId: str,
    rules: Sequence[RuleTypeDef],  # (1)
    description: NotRequired[str],
    externalModelEndpoints: NotRequired[Sequence[str]],
    modelVersions: NotRequired[Sequence[ModelVersionTypeDef]],  # (2)
    ruleExecutionMode: NotRequired[RuleExecutionModeType],  # (3)
    tags: NotRequired[Sequence[TagTypeDef]],  # (4)
  1. See Sequence[RuleTypeDef]
  2. See Sequence[ModelVersionTypeDef]
  3. See RuleExecutionModeType
  4. See Sequence[TagTypeDef]

CreateRuleResultTypeDef#

# CreateRuleResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import CreateRuleResultTypeDef


def get_value() -> CreateRuleResultTypeDef:
    return {
        "rule": ...,
    }


# CreateRuleResultTypeDef definition

class CreateRuleResultTypeDef(TypedDict):
    rule: RuleTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RuleTypeDef
  2. See ResponseMetadataTypeDef

DeleteRuleRequestTypeDef#

# DeleteRuleRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DeleteRuleRequestTypeDef


def get_value() -> DeleteRuleRequestTypeDef:
    return {
        "rule": ...,
    }


# DeleteRuleRequestTypeDef definition

class DeleteRuleRequestTypeDef(TypedDict):
    rule: RuleTypeDef,  # (1)
  1. See RuleTypeDef

GetDetectorVersionResultTypeDef#

# GetDetectorVersionResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetDetectorVersionResultTypeDef


def get_value() -> GetDetectorVersionResultTypeDef:
    return {
        "detectorId": ...,
    }


# GetDetectorVersionResultTypeDef definition

class GetDetectorVersionResultTypeDef(TypedDict):
    detectorId: str,
    detectorVersionId: str,
    description: str,
    externalModelEndpoints: List[str],
    modelVersions: List[ModelVersionTypeDef],  # (1)
    rules: List[RuleTypeDef],  # (2)
    status: DetectorVersionStatusType,  # (3)
    lastUpdatedTime: str,
    createdTime: str,
    ruleExecutionMode: RuleExecutionModeType,  # (4)
    arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See List[ModelVersionTypeDef]
  2. See List[RuleTypeDef]
  3. See DetectorVersionStatusType
  4. See RuleExecutionModeType
  5. See ResponseMetadataTypeDef

UpdateDetectorVersionRequestTypeDef#

# UpdateDetectorVersionRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import UpdateDetectorVersionRequestTypeDef


def get_value() -> UpdateDetectorVersionRequestTypeDef:
    return {
        "detectorId": ...,
    }


# UpdateDetectorVersionRequestTypeDef definition

class UpdateDetectorVersionRequestTypeDef(TypedDict):
    detectorId: str,
    detectorVersionId: str,
    externalModelEndpoints: Sequence[str],
    rules: Sequence[RuleTypeDef],  # (1)
    description: NotRequired[str],
    modelVersions: NotRequired[Sequence[ModelVersionTypeDef]],  # (2)
    ruleExecutionMode: NotRequired[RuleExecutionModeType],  # (3)
  1. See Sequence[RuleTypeDef]
  2. See Sequence[ModelVersionTypeDef]
  3. See RuleExecutionModeType

UpdateRuleMetadataRequestTypeDef#

# UpdateRuleMetadataRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import UpdateRuleMetadataRequestTypeDef


def get_value() -> UpdateRuleMetadataRequestTypeDef:
    return {
        "rule": ...,
    }


# UpdateRuleMetadataRequestTypeDef definition

class UpdateRuleMetadataRequestTypeDef(TypedDict):
    rule: RuleTypeDef,  # (1)
    description: str,
  1. See RuleTypeDef

UpdateRuleVersionRequestTypeDef#

# UpdateRuleVersionRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import UpdateRuleVersionRequestTypeDef


def get_value() -> UpdateRuleVersionRequestTypeDef:
    return {
        "rule": ...,
    }


# UpdateRuleVersionRequestTypeDef definition

class UpdateRuleVersionRequestTypeDef(TypedDict):
    rule: RuleTypeDef,  # (1)
    expression: str,
    language: LanguageType,  # (2)
    outcomes: Sequence[str],
    description: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See RuleTypeDef
  2. See LanguageType
  3. See Sequence[TagTypeDef]

UpdateRuleVersionResultTypeDef#

# UpdateRuleVersionResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import UpdateRuleVersionResultTypeDef


def get_value() -> UpdateRuleVersionResultTypeDef:
    return {
        "rule": ...,
    }


# UpdateRuleVersionResultTypeDef definition

class UpdateRuleVersionResultTypeDef(TypedDict):
    rule: RuleTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RuleTypeDef
  2. See ResponseMetadataTypeDef

DataValidationMetricsTypeDef#

# DataValidationMetricsTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DataValidationMetricsTypeDef


def get_value() -> DataValidationMetricsTypeDef:
    return {
        "fileLevelMessages": ...,
    }


# DataValidationMetricsTypeDef definition

class DataValidationMetricsTypeDef(TypedDict):
    fileLevelMessages: NotRequired[List[FileValidationMessageTypeDef]],  # (1)
    fieldLevelMessages: NotRequired[List[FieldValidationMessageTypeDef]],  # (2)
  1. See List[FileValidationMessageTypeDef]
  2. See List[FieldValidationMessageTypeDef]

DescribeDetectorResultTypeDef#

# DescribeDetectorResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DescribeDetectorResultTypeDef


def get_value() -> DescribeDetectorResultTypeDef:
    return {
        "detectorId": ...,
    }


# DescribeDetectorResultTypeDef definition

class DescribeDetectorResultTypeDef(TypedDict):
    detectorId: str,
    detectorVersionSummaries: List[DetectorVersionSummaryTypeDef],  # (1)
    arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[DetectorVersionSummaryTypeDef]
  2. See ResponseMetadataTypeDef

GetDetectorsResultTypeDef#

# GetDetectorsResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetDetectorsResultTypeDef


def get_value() -> GetDetectorsResultTypeDef:
    return {
        "detectors": ...,
    }


# GetDetectorsResultTypeDef definition

class GetDetectorsResultTypeDef(TypedDict):
    detectors: List[DetectorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[DetectorTypeDef]
  2. See ResponseMetadataTypeDef

EventTypeDef#

# EventTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import EventTypeDef


def get_value() -> EventTypeDef:
    return {
        "eventId": ...,
    }


# EventTypeDef definition

class EventTypeDef(TypedDict):
    eventId: NotRequired[str],
    eventTypeName: NotRequired[str],
    eventTimestamp: NotRequired[str],
    eventVariables: NotRequired[Dict[str, str]],
    currentLabel: NotRequired[str],
    labelTimestamp: NotRequired[str],
    entities: NotRequired[List[EntityTypeDef]],  # (1)
  1. See List[EntityTypeDef]

SendEventRequestTypeDef#

# SendEventRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import SendEventRequestTypeDef


def get_value() -> SendEventRequestTypeDef:
    return {
        "eventId": ...,
    }


# SendEventRequestTypeDef definition

class SendEventRequestTypeDef(TypedDict):
    eventId: str,
    eventTypeName: str,
    eventTimestamp: str,
    eventVariables: Mapping[str, str],
    entities: Sequence[EntityTypeDef],  # (1)
    assignedLabel: NotRequired[str],
    labelTimestamp: NotRequired[str],
  1. See Sequence[EntityTypeDef]

GetEntityTypesResultTypeDef#

# GetEntityTypesResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetEntityTypesResultTypeDef


def get_value() -> GetEntityTypesResultTypeDef:
    return {
        "entityTypes": ...,
    }


# GetEntityTypesResultTypeDef definition

class GetEntityTypesResultTypeDef(TypedDict):
    entityTypes: List[EntityTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[EntityTypeTypeDef]
  2. See ResponseMetadataTypeDef

PutEventTypeRequestTypeDef#

# PutEventTypeRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import PutEventTypeRequestTypeDef


def get_value() -> PutEventTypeRequestTypeDef:
    return {
        "name": ...,
    }


# PutEventTypeRequestTypeDef definition

class PutEventTypeRequestTypeDef(TypedDict):
    name: str,
    eventVariables: Sequence[str],
    entityTypes: Sequence[str],
    description: NotRequired[str],
    labels: NotRequired[Sequence[str]],
    eventIngestion: NotRequired[EventIngestionType],  # (1)
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    eventOrchestration: NotRequired[EventOrchestrationTypeDef],  # (3)
  1. See EventIngestionType
  2. See Sequence[TagTypeDef]
  3. See EventOrchestrationTypeDef

ListEventPredictionsResultTypeDef#

# ListEventPredictionsResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ListEventPredictionsResultTypeDef


def get_value() -> ListEventPredictionsResultTypeDef:
    return {
        "eventPredictionSummaries": ...,
    }


# ListEventPredictionsResultTypeDef definition

class ListEventPredictionsResultTypeDef(TypedDict):
    eventPredictionSummaries: List[EventPredictionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[EventPredictionSummaryTypeDef]
  2. See ResponseMetadataTypeDef

EventTypeTypeDef#

# EventTypeTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import EventTypeTypeDef


def get_value() -> EventTypeTypeDef:
    return {
        "name": ...,
    }


# EventTypeTypeDef definition

class EventTypeTypeDef(TypedDict):
    name: NotRequired[str],
    description: NotRequired[str],
    eventVariables: NotRequired[List[str]],
    labels: NotRequired[List[str]],
    entityTypes: NotRequired[List[str]],
    eventIngestion: NotRequired[EventIngestionType],  # (1)
    ingestedEventStatistics: NotRequired[IngestedEventStatisticsTypeDef],  # (2)
    lastUpdatedTime: NotRequired[str],
    createdTime: NotRequired[str],
    arn: NotRequired[str],
    eventOrchestration: NotRequired[EventOrchestrationTypeDef],  # (3)
  1. See EventIngestionType
  2. See IngestedEventStatisticsTypeDef
  3. See EventOrchestrationTypeDef

ExternalModelOutputsTypeDef#

# ExternalModelOutputsTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ExternalModelOutputsTypeDef


def get_value() -> ExternalModelOutputsTypeDef:
    return {
        "externalModel": ...,
    }


# ExternalModelOutputsTypeDef definition

class ExternalModelOutputsTypeDef(TypedDict):
    externalModel: NotRequired[ExternalModelSummaryTypeDef],  # (1)
    outputs: NotRequired[Dict[str, str]],
  1. See ExternalModelSummaryTypeDef

ExternalModelTypeDef#

# ExternalModelTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ExternalModelTypeDef


def get_value() -> ExternalModelTypeDef:
    return {
        "modelEndpoint": ...,
    }


# ExternalModelTypeDef definition

class ExternalModelTypeDef(TypedDict):
    modelEndpoint: NotRequired[str],
    modelSource: NotRequired[ModelSourceType],  # (1)
    invokeModelEndpointRoleArn: NotRequired[str],
    inputConfiguration: NotRequired[ModelInputConfigurationTypeDef],  # (2)
    outputConfiguration: NotRequired[ModelOutputConfigurationOutputTypeDef],  # (3)
    modelEndpointStatus: NotRequired[ModelEndpointStatusType],  # (4)
    lastUpdatedTime: NotRequired[str],
    createdTime: NotRequired[str],
    arn: NotRequired[str],
  1. See ModelSourceType
  2. See ModelInputConfigurationTypeDef
  3. See ModelOutputConfigurationOutputTypeDef
  4. See ModelEndpointStatusType

GetKMSEncryptionKeyResultTypeDef#

# GetKMSEncryptionKeyResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetKMSEncryptionKeyResultTypeDef


def get_value() -> GetKMSEncryptionKeyResultTypeDef:
    return {
        "kmsKey": ...,
    }


# GetKMSEncryptionKeyResultTypeDef definition

class GetKMSEncryptionKeyResultTypeDef(TypedDict):
    kmsKey: KMSKeyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KMSKeyTypeDef
  2. See ResponseMetadataTypeDef

GetLabelsResultTypeDef#

# GetLabelsResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetLabelsResultTypeDef


def get_value() -> GetLabelsResultTypeDef:
    return {
        "labels": ...,
    }


# GetLabelsResultTypeDef definition

class GetLabelsResultTypeDef(TypedDict):
    labels: List[LabelTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[LabelTypeDef]
  2. See ResponseMetadataTypeDef

GetModelsResultTypeDef#

# GetModelsResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetModelsResultTypeDef


def get_value() -> GetModelsResultTypeDef:
    return {
        "nextToken": ...,
    }


# GetModelsResultTypeDef definition

class GetModelsResultTypeDef(TypedDict):
    models: List[ModelTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[ModelTypeDef]
  2. See ResponseMetadataTypeDef

GetOutcomesResultTypeDef#

# GetOutcomesResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetOutcomesResultTypeDef


def get_value() -> GetOutcomesResultTypeDef:
    return {
        "outcomes": ...,
    }


# GetOutcomesResultTypeDef definition

class GetOutcomesResultTypeDef(TypedDict):
    outcomes: List[OutcomeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[OutcomeTypeDef]
  2. See ResponseMetadataTypeDef

GetRulesResultTypeDef#

# GetRulesResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetRulesResultTypeDef


def get_value() -> GetRulesResultTypeDef:
    return {
        "ruleDetails": ...,
    }


# GetRulesResultTypeDef definition

class GetRulesResultTypeDef(TypedDict):
    ruleDetails: List[RuleDetailTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[RuleDetailTypeDef]
  2. See ResponseMetadataTypeDef

IngestedEventsDetailTypeDef#

# IngestedEventsDetailTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import IngestedEventsDetailTypeDef


def get_value() -> IngestedEventsDetailTypeDef:
    return {
        "ingestedEventsTimeWindow": ...,
    }


# IngestedEventsDetailTypeDef definition

class IngestedEventsDetailTypeDef(TypedDict):
    ingestedEventsTimeWindow: IngestedEventsTimeWindowTypeDef,  # (1)
  1. See IngestedEventsTimeWindowTypeDef

TrainingDataSchemaOutputTypeDef#

# TrainingDataSchemaOutputTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import TrainingDataSchemaOutputTypeDef


def get_value() -> TrainingDataSchemaOutputTypeDef:
    return {
        "modelVariables": ...,
    }


# TrainingDataSchemaOutputTypeDef definition

class TrainingDataSchemaOutputTypeDef(TypedDict):
    modelVariables: List[str],
    labelSchema: NotRequired[LabelSchemaOutputTypeDef],  # (1)
  1. See LabelSchemaOutputTypeDef

TrainingDataSchemaTypeDef#

# TrainingDataSchemaTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import TrainingDataSchemaTypeDef


def get_value() -> TrainingDataSchemaTypeDef:
    return {
        "modelVariables": ...,
    }


# TrainingDataSchemaTypeDef definition

class TrainingDataSchemaTypeDef(TypedDict):
    modelVariables: Sequence[str],
    labelSchema: NotRequired[LabelSchemaTypeDef],  # (1)
  1. See LabelSchemaTypeDef

ListEventPredictionsRequestTypeDef#

# ListEventPredictionsRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ListEventPredictionsRequestTypeDef


def get_value() -> ListEventPredictionsRequestTypeDef:
    return {
        "eventId": ...,
    }


# ListEventPredictionsRequestTypeDef definition

class ListEventPredictionsRequestTypeDef(TypedDict):
    eventId: NotRequired[FilterConditionTypeDef],  # (1)
    eventType: NotRequired[FilterConditionTypeDef],  # (1)
    detectorId: NotRequired[FilterConditionTypeDef],  # (1)
    detectorVersionId: NotRequired[FilterConditionTypeDef],  # (1)
    predictionTimeRange: NotRequired[PredictionTimeRangeTypeDef],  # (5)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See FilterConditionTypeDef
  2. See FilterConditionTypeDef
  3. See FilterConditionTypeDef
  4. See FilterConditionTypeDef
  5. See PredictionTimeRangeTypeDef

VariableImportanceMetricsTypeDef#

# VariableImportanceMetricsTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import VariableImportanceMetricsTypeDef


def get_value() -> VariableImportanceMetricsTypeDef:
    return {
        "logOddsMetrics": ...,
    }


# VariableImportanceMetricsTypeDef definition

class VariableImportanceMetricsTypeDef(TypedDict):
    logOddsMetrics: NotRequired[List[LogOddsMetricTypeDef]],  # (1)
  1. See List[LogOddsMetricTypeDef]

TrainingMetricsTypeDef#

# TrainingMetricsTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import TrainingMetricsTypeDef


def get_value() -> TrainingMetricsTypeDef:
    return {
        "auc": ...,
    }


# TrainingMetricsTypeDef definition

class TrainingMetricsTypeDef(TypedDict):
    auc: NotRequired[float],
    metricDataPoints: NotRequired[List[MetricDataPointTypeDef]],  # (1)
  1. See List[MetricDataPointTypeDef]

OFIModelPerformanceTypeDef#

# OFIModelPerformanceTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import OFIModelPerformanceTypeDef


def get_value() -> OFIModelPerformanceTypeDef:
    return {
        "auc": ...,
    }


# OFIModelPerformanceTypeDef definition

class OFIModelPerformanceTypeDef(TypedDict):
    auc: NotRequired[float],
    uncertaintyRange: NotRequired[UncertaintyRangeTypeDef],  # (1)
  1. See UncertaintyRangeTypeDef

TFIModelPerformanceTypeDef#

# TFIModelPerformanceTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import TFIModelPerformanceTypeDef


def get_value() -> TFIModelPerformanceTypeDef:
    return {
        "auc": ...,
    }


# TFIModelPerformanceTypeDef definition

class TFIModelPerformanceTypeDef(TypedDict):
    auc: NotRequired[float],
    uncertaintyRange: NotRequired[UncertaintyRangeTypeDef],  # (1)
  1. See UncertaintyRangeTypeDef

PredictionExplanationsTypeDef#

# PredictionExplanationsTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import PredictionExplanationsTypeDef


def get_value() -> PredictionExplanationsTypeDef:
    return {
        "variableImpactExplanations": ...,
    }


# PredictionExplanationsTypeDef definition

class PredictionExplanationsTypeDef(TypedDict):
    variableImpactExplanations: NotRequired[List[VariableImpactExplanationTypeDef]],  # (1)
    aggregatedVariablesImpactExplanations: NotRequired[List[AggregatedVariablesImpactExplanationTypeDef]],  # (2)
  1. See List[VariableImpactExplanationTypeDef]
  2. See List[AggregatedVariablesImpactExplanationTypeDef]

GetEventPredictionRequestTypeDef#

# GetEventPredictionRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetEventPredictionRequestTypeDef


def get_value() -> GetEventPredictionRequestTypeDef:
    return {
        "detectorId": ...,
    }


# GetEventPredictionRequestTypeDef definition

class GetEventPredictionRequestTypeDef(TypedDict):
    detectorId: str,
    eventId: str,
    eventTypeName: str,
    entities: Sequence[EntityTypeDef],  # (1)
    eventTimestamp: str,
    eventVariables: Mapping[str, str],
    detectorVersionId: NotRequired[str],
    externalModelEndpointDataBlobs: NotRequired[Mapping[str, ModelEndpointDataBlobTypeDef]],  # (2)
  1. See Sequence[EntityTypeDef]
  2. See Mapping[str, ModelEndpointDataBlobTypeDef]

GetEventResultTypeDef#

# GetEventResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetEventResultTypeDef


def get_value() -> GetEventResultTypeDef:
    return {
        "event": ...,
    }


# GetEventResultTypeDef definition

class GetEventResultTypeDef(TypedDict):
    event: EventTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventTypeDef
  2. See ResponseMetadataTypeDef

GetEventTypesResultTypeDef#

# GetEventTypesResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetEventTypesResultTypeDef


def get_value() -> GetEventTypesResultTypeDef:
    return {
        "eventTypes": ...,
    }


# GetEventTypesResultTypeDef definition

class GetEventTypesResultTypeDef(TypedDict):
    eventTypes: List[EventTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[EventTypeTypeDef]
  2. See ResponseMetadataTypeDef

GetEventPredictionResultTypeDef#

# GetEventPredictionResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetEventPredictionResultTypeDef


def get_value() -> GetEventPredictionResultTypeDef:
    return {
        "modelScores": ...,
    }


# GetEventPredictionResultTypeDef definition

class GetEventPredictionResultTypeDef(TypedDict):
    modelScores: List[ModelScoresTypeDef],  # (1)
    ruleResults: List[RuleResultTypeDef],  # (2)
    externalModelOutputs: List[ExternalModelOutputsTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See List[ModelScoresTypeDef]
  2. See List[RuleResultTypeDef]
  3. See List[ExternalModelOutputsTypeDef]
  4. See ResponseMetadataTypeDef

GetExternalModelsResultTypeDef#

# GetExternalModelsResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetExternalModelsResultTypeDef


def get_value() -> GetExternalModelsResultTypeDef:
    return {
        "externalModels": ...,
    }


# GetExternalModelsResultTypeDef definition

class GetExternalModelsResultTypeDef(TypedDict):
    externalModels: List[ExternalModelTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[ExternalModelTypeDef]
  2. See ResponseMetadataTypeDef

UpdateModelVersionRequestTypeDef#

# UpdateModelVersionRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import UpdateModelVersionRequestTypeDef


def get_value() -> UpdateModelVersionRequestTypeDef:
    return {
        "modelId": ...,
    }


# UpdateModelVersionRequestTypeDef definition

class UpdateModelVersionRequestTypeDef(TypedDict):
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
    majorVersionNumber: str,
    externalEventsDetail: NotRequired[ExternalEventsDetailTypeDef],  # (2)
    ingestedEventsDetail: NotRequired[IngestedEventsDetailTypeDef],  # (3)
    tags: NotRequired[Sequence[TagTypeDef]],  # (4)
  1. See ModelTypeEnumType
  2. See ExternalEventsDetailTypeDef
  3. See IngestedEventsDetailTypeDef
  4. See Sequence[TagTypeDef]

GetModelVersionResultTypeDef#

# GetModelVersionResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetModelVersionResultTypeDef


def get_value() -> GetModelVersionResultTypeDef:
    return {
        "modelId": ...,
    }


# GetModelVersionResultTypeDef definition

class GetModelVersionResultTypeDef(TypedDict):
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
    modelVersionNumber: str,
    trainingDataSource: TrainingDataSourceEnumType,  # (2)
    trainingDataSchema: TrainingDataSchemaOutputTypeDef,  # (3)
    externalEventsDetail: ExternalEventsDetailTypeDef,  # (4)
    ingestedEventsDetail: IngestedEventsDetailTypeDef,  # (5)
    status: str,
    arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See ModelTypeEnumType
  2. See TrainingDataSourceEnumType
  3. See TrainingDataSchemaOutputTypeDef
  4. See ExternalEventsDetailTypeDef
  5. See IngestedEventsDetailTypeDef
  6. See ResponseMetadataTypeDef

TrainingResultTypeDef#

# TrainingResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import TrainingResultTypeDef


def get_value() -> TrainingResultTypeDef:
    return {
        "dataValidationMetrics": ...,
    }


# TrainingResultTypeDef definition

class TrainingResultTypeDef(TypedDict):
    dataValidationMetrics: NotRequired[DataValidationMetricsTypeDef],  # (1)
    trainingMetrics: NotRequired[TrainingMetricsTypeDef],  # (2)
    variableImportanceMetrics: NotRequired[VariableImportanceMetricsTypeDef],  # (3)
  1. See DataValidationMetricsTypeDef
  2. See TrainingMetricsTypeDef
  3. See VariableImportanceMetricsTypeDef

PutExternalModelRequestTypeDef#

# PutExternalModelRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import PutExternalModelRequestTypeDef


def get_value() -> PutExternalModelRequestTypeDef:
    return {
        "modelEndpoint": ...,
    }


# PutExternalModelRequestTypeDef definition

class PutExternalModelRequestTypeDef(TypedDict):
    modelEndpoint: str,
    modelSource: ModelSourceType,  # (1)
    invokeModelEndpointRoleArn: str,
    inputConfiguration: ModelInputConfigurationTypeDef,  # (2)
    outputConfiguration: ModelOutputConfigurationUnionTypeDef,  # (3)
    modelEndpointStatus: ModelEndpointStatusType,  # (4)
    tags: NotRequired[Sequence[TagTypeDef]],  # (5)
  1. See ModelSourceType
  2. See ModelInputConfigurationTypeDef
  3. See ModelOutputConfigurationUnionTypeDef
  4. See ModelEndpointStatusType
  5. See Sequence[TagTypeDef]

OFITrainingMetricsValueTypeDef#

# OFITrainingMetricsValueTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import OFITrainingMetricsValueTypeDef


def get_value() -> OFITrainingMetricsValueTypeDef:
    return {
        "metricDataPoints": ...,
    }


# OFITrainingMetricsValueTypeDef definition

class OFITrainingMetricsValueTypeDef(TypedDict):
    metricDataPoints: NotRequired[List[OFIMetricDataPointTypeDef]],  # (1)
    modelPerformance: NotRequired[OFIModelPerformanceTypeDef],  # (2)
  1. See List[OFIMetricDataPointTypeDef]
  2. See OFIModelPerformanceTypeDef

TFITrainingMetricsValueTypeDef#

# TFITrainingMetricsValueTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import TFITrainingMetricsValueTypeDef


def get_value() -> TFITrainingMetricsValueTypeDef:
    return {
        "metricDataPoints": ...,
    }


# TFITrainingMetricsValueTypeDef definition

class TFITrainingMetricsValueTypeDef(TypedDict):
    metricDataPoints: NotRequired[List[TFIMetricDataPointTypeDef]],  # (1)
    modelPerformance: NotRequired[TFIModelPerformanceTypeDef],  # (2)
  1. See List[TFIMetricDataPointTypeDef]
  2. See TFIModelPerformanceTypeDef

ModelVersionEvaluationTypeDef#

# ModelVersionEvaluationTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ModelVersionEvaluationTypeDef


def get_value() -> ModelVersionEvaluationTypeDef:
    return {
        "outputVariableName": ...,
    }


# ModelVersionEvaluationTypeDef definition

class ModelVersionEvaluationTypeDef(TypedDict):
    outputVariableName: NotRequired[str],
    evaluationScore: NotRequired[str],
    predictionExplanations: NotRequired[PredictionExplanationsTypeDef],  # (1)
  1. See PredictionExplanationsTypeDef

CreateModelVersionRequestTypeDef#

# CreateModelVersionRequestTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import CreateModelVersionRequestTypeDef


def get_value() -> CreateModelVersionRequestTypeDef:
    return {
        "modelId": ...,
    }


# CreateModelVersionRequestTypeDef definition

class CreateModelVersionRequestTypeDef(TypedDict):
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
    trainingDataSource: TrainingDataSourceEnumType,  # (2)
    trainingDataSchema: TrainingDataSchemaUnionTypeDef,  # (3)
    externalEventsDetail: NotRequired[ExternalEventsDetailTypeDef],  # (4)
    ingestedEventsDetail: NotRequired[IngestedEventsDetailTypeDef],  # (5)
    tags: NotRequired[Sequence[TagTypeDef]],  # (6)
  1. See ModelTypeEnumType
  2. See TrainingDataSourceEnumType
  3. See TrainingDataSchemaUnionTypeDef
  4. See ExternalEventsDetailTypeDef
  5. See IngestedEventsDetailTypeDef
  6. See Sequence[TagTypeDef]

TrainingMetricsV2TypeDef#

# TrainingMetricsV2TypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import TrainingMetricsV2TypeDef


def get_value() -> TrainingMetricsV2TypeDef:
    return {
        "ofi": ...,
    }


# TrainingMetricsV2TypeDef definition

class TrainingMetricsV2TypeDef(TypedDict):
    ofi: NotRequired[OFITrainingMetricsValueTypeDef],  # (1)
    tfi: NotRequired[TFITrainingMetricsValueTypeDef],  # (2)
    ati: NotRequired[ATITrainingMetricsValueTypeDef],  # (3)
  1. See OFITrainingMetricsValueTypeDef
  2. See TFITrainingMetricsValueTypeDef
  3. See ATITrainingMetricsValueTypeDef

EvaluatedModelVersionTypeDef#

# EvaluatedModelVersionTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import EvaluatedModelVersionTypeDef


def get_value() -> EvaluatedModelVersionTypeDef:
    return {
        "modelId": ...,
    }


# EvaluatedModelVersionTypeDef definition

class EvaluatedModelVersionTypeDef(TypedDict):
    modelId: NotRequired[str],
    modelVersion: NotRequired[str],
    modelType: NotRequired[str],
    evaluations: NotRequired[List[ModelVersionEvaluationTypeDef]],  # (1)
  1. See List[ModelVersionEvaluationTypeDef]

TrainingResultV2TypeDef#

# TrainingResultV2TypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import TrainingResultV2TypeDef


def get_value() -> TrainingResultV2TypeDef:
    return {
        "dataValidationMetrics": ...,
    }


# TrainingResultV2TypeDef definition

class TrainingResultV2TypeDef(TypedDict):
    dataValidationMetrics: NotRequired[DataValidationMetricsTypeDef],  # (1)
    trainingMetricsV2: NotRequired[TrainingMetricsV2TypeDef],  # (2)
    variableImportanceMetrics: NotRequired[VariableImportanceMetricsTypeDef],  # (3)
    aggregatedVariablesImportanceMetrics: NotRequired[AggregatedVariablesImportanceMetricsTypeDef],  # (4)
  1. See DataValidationMetricsTypeDef
  2. See TrainingMetricsV2TypeDef
  3. See VariableImportanceMetricsTypeDef
  4. See AggregatedVariablesImportanceMetricsTypeDef

GetEventPredictionMetadataResultTypeDef#

# GetEventPredictionMetadataResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import GetEventPredictionMetadataResultTypeDef


def get_value() -> GetEventPredictionMetadataResultTypeDef:
    return {
        "eventId": ...,
    }


# GetEventPredictionMetadataResultTypeDef definition

class GetEventPredictionMetadataResultTypeDef(TypedDict):
    eventId: str,
    eventTypeName: str,
    entityId: str,
    entityType: str,
    eventTimestamp: str,
    detectorId: str,
    detectorVersionId: str,
    detectorVersionStatus: str,
    eventVariables: List[EventVariableSummaryTypeDef],  # (1)
    rules: List[EvaluatedRuleTypeDef],  # (2)
    ruleExecutionMode: RuleExecutionModeType,  # (3)
    outcomes: List[str],
    evaluatedModelVersions: List[EvaluatedModelVersionTypeDef],  # (4)
    evaluatedExternalModels: List[EvaluatedExternalModelTypeDef],  # (5)
    predictionTimestamp: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See List[EventVariableSummaryTypeDef]
  2. See List[EvaluatedRuleTypeDef]
  3. See RuleExecutionModeType
  4. See List[EvaluatedModelVersionTypeDef]
  5. See List[EvaluatedExternalModelTypeDef]
  6. See ResponseMetadataTypeDef

ModelVersionDetailTypeDef#

# ModelVersionDetailTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import ModelVersionDetailTypeDef


def get_value() -> ModelVersionDetailTypeDef:
    return {
        "modelId": ...,
    }


# ModelVersionDetailTypeDef definition

class ModelVersionDetailTypeDef(TypedDict):
    modelId: NotRequired[str],
    modelType: NotRequired[ModelTypeEnumType],  # (1)
    modelVersionNumber: NotRequired[str],
    status: NotRequired[str],
    trainingDataSource: NotRequired[TrainingDataSourceEnumType],  # (2)
    trainingDataSchema: NotRequired[TrainingDataSchemaOutputTypeDef],  # (3)
    externalEventsDetail: NotRequired[ExternalEventsDetailTypeDef],  # (4)
    ingestedEventsDetail: NotRequired[IngestedEventsDetailTypeDef],  # (5)
    trainingResult: NotRequired[TrainingResultTypeDef],  # (6)
    lastUpdatedTime: NotRequired[str],
    createdTime: NotRequired[str],
    arn: NotRequired[str],
    trainingResultV2: NotRequired[TrainingResultV2TypeDef],  # (7)
  1. See ModelTypeEnumType
  2. See TrainingDataSourceEnumType
  3. See TrainingDataSchemaOutputTypeDef
  4. See ExternalEventsDetailTypeDef
  5. See IngestedEventsDetailTypeDef
  6. See TrainingResultTypeDef
  7. See TrainingResultV2TypeDef

DescribeModelVersionsResultTypeDef#

# DescribeModelVersionsResultTypeDef TypedDict usage example

from mypy_boto3_frauddetector.type_defs import DescribeModelVersionsResultTypeDef


def get_value() -> DescribeModelVersionsResultTypeDef:
    return {
        "modelVersionDetails": ...,
    }


# DescribeModelVersionsResultTypeDef definition

class DescribeModelVersionsResultTypeDef(TypedDict):
    modelVersionDetails: List[ModelVersionDetailTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[ModelVersionDetailTypeDef]
  2. See ResponseMetadataTypeDef