Skip to content

Type definitions#

Index > FraudDetector > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

ATIMetricDataPointTypeDef#

# ATIMetricDataPointTypeDef definition

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

ATIModelPerformanceTypeDef#

# ATIModelPerformanceTypeDef definition

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

AggregatedLogOddsMetricTypeDef#

# AggregatedLogOddsMetricTypeDef definition

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

AggregatedVariablesImpactExplanationTypeDef#

# AggregatedVariablesImpactExplanationTypeDef definition

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

AllowDenyListTypeDef#

# AllowDenyListTypeDef definition

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

BatchCreateVariableErrorTypeDef#

# BatchCreateVariableErrorTypeDef definition

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

TagTypeDef#

# TagTypeDef definition

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

VariableEntryTypeDef#

# 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 definition

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

BatchGetVariableErrorTypeDef#

# BatchGetVariableErrorTypeDef definition

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

BatchGetVariableRequestRequestTypeDef#

# BatchGetVariableRequestRequestTypeDef definition

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

VariableTypeDef#

# 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 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 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

CancelBatchImportJobRequestRequestTypeDef#

# CancelBatchImportJobRequestRequestTypeDef definition

class CancelBatchImportJobRequestRequestTypeDef(TypedDict):
    jobId: str,

CancelBatchPredictionJobRequestRequestTypeDef#

# CancelBatchPredictionJobRequestRequestTypeDef definition

class CancelBatchPredictionJobRequestRequestTypeDef(TypedDict):
    jobId: str,

ModelVersionTypeDef#

# ModelVersionTypeDef definition

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

RuleTypeDef#

# RuleTypeDef definition

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

ExternalEventsDetailTypeDef#

# ExternalEventsDetailTypeDef definition

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

FieldValidationMessageTypeDef#

# FieldValidationMessageTypeDef definition

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

FileValidationMessageTypeDef#

# FileValidationMessageTypeDef definition

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

DeleteBatchImportJobRequestRequestTypeDef#

# DeleteBatchImportJobRequestRequestTypeDef definition

class DeleteBatchImportJobRequestRequestTypeDef(TypedDict):
    jobId: str,

DeleteBatchPredictionJobRequestRequestTypeDef#

# DeleteBatchPredictionJobRequestRequestTypeDef definition

class DeleteBatchPredictionJobRequestRequestTypeDef(TypedDict):
    jobId: str,

DeleteDetectorRequestRequestTypeDef#

# DeleteDetectorRequestRequestTypeDef definition

class DeleteDetectorRequestRequestTypeDef(TypedDict):
    detectorId: str,

DeleteDetectorVersionRequestRequestTypeDef#

# DeleteDetectorVersionRequestRequestTypeDef definition

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

DeleteEntityTypeRequestRequestTypeDef#

# DeleteEntityTypeRequestRequestTypeDef definition

class DeleteEntityTypeRequestRequestTypeDef(TypedDict):
    name: str,

DeleteEventRequestRequestTypeDef#

# DeleteEventRequestRequestTypeDef definition

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

DeleteEventTypeRequestRequestTypeDef#

# DeleteEventTypeRequestRequestTypeDef definition

class DeleteEventTypeRequestRequestTypeDef(TypedDict):
    name: str,

DeleteEventsByEventTypeRequestRequestTypeDef#

# DeleteEventsByEventTypeRequestRequestTypeDef definition

class DeleteEventsByEventTypeRequestRequestTypeDef(TypedDict):
    eventTypeName: str,

DeleteExternalModelRequestRequestTypeDef#

# DeleteExternalModelRequestRequestTypeDef definition

class DeleteExternalModelRequestRequestTypeDef(TypedDict):
    modelEndpoint: str,

DeleteLabelRequestRequestTypeDef#

# DeleteLabelRequestRequestTypeDef definition

class DeleteLabelRequestRequestTypeDef(TypedDict):
    name: str,

DeleteListRequestRequestTypeDef#

# DeleteListRequestRequestTypeDef definition

class DeleteListRequestRequestTypeDef(TypedDict):
    name: str,

DeleteModelRequestRequestTypeDef#

# DeleteModelRequestRequestTypeDef definition

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

DeleteModelVersionRequestRequestTypeDef#

# DeleteModelVersionRequestRequestTypeDef definition

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

DeleteOutcomeRequestRequestTypeDef#

# DeleteOutcomeRequestRequestTypeDef definition

class DeleteOutcomeRequestRequestTypeDef(TypedDict):
    name: str,

DeleteVariableRequestRequestTypeDef#

# DeleteVariableRequestRequestTypeDef definition

class DeleteVariableRequestRequestTypeDef(TypedDict):
    name: str,

DescribeDetectorRequestRequestTypeDef#

# DescribeDetectorRequestRequestTypeDef definition

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

DetectorVersionSummaryTypeDef#

# DetectorVersionSummaryTypeDef definition

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

DescribeModelVersionsRequestRequestTypeDef#

# DescribeModelVersionsRequestRequestTypeDef definition

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

DetectorTypeDef#

# 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 definition

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

EntityTypeTypeDef#

# EntityTypeTypeDef definition

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

EvaluatedExternalModelTypeDef#

# EvaluatedExternalModelTypeDef definition

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

EvaluatedRuleTypeDef#

# 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