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,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

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#

# EventOrchestrationTypeDef definition

class EventOrchestrationTypeDef(TypedDict):
    eventBridgeEnabled: bool,

EventPredictionSummaryTypeDef#

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

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

EventVariableSummaryTypeDef#

# EventVariableSummaryTypeDef definition

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

ExternalModelSummaryTypeDef#

# ExternalModelSummaryTypeDef definition

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

ModelInputConfigurationTypeDef#

# ModelInputConfigurationTypeDef definition

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

ModelOutputConfigurationTypeDef#

# ModelOutputConfigurationTypeDef definition

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

FilterConditionTypeDef#

# FilterConditionTypeDef definition

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

GetBatchImportJobsRequestRequestTypeDef#

# GetBatchImportJobsRequestRequestTypeDef definition

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

GetBatchPredictionJobsRequestRequestTypeDef#

# GetBatchPredictionJobsRequestRequestTypeDef definition

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

GetDeleteEventsByEventTypeStatusRequestRequestTypeDef#

# GetDeleteEventsByEventTypeStatusRequestRequestTypeDef definition

class GetDeleteEventsByEventTypeStatusRequestRequestTypeDef(TypedDict):
    eventTypeName: str,

GetDetectorVersionRequestRequestTypeDef#

# GetDetectorVersionRequestRequestTypeDef definition

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

GetDetectorsRequestRequestTypeDef#

# GetDetectorsRequestRequestTypeDef definition

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

GetEntityTypesRequestRequestTypeDef#

# GetEntityTypesRequestRequestTypeDef definition

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

GetEventPredictionMetadataRequestRequestTypeDef#

# GetEventPredictionMetadataRequestRequestTypeDef definition

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

RuleResultTypeDef#

# RuleResultTypeDef definition

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

GetEventRequestRequestTypeDef#

# GetEventRequestRequestTypeDef definition

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

GetEventTypesRequestRequestTypeDef#

# GetEventTypesRequestRequestTypeDef definition

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

GetExternalModelsRequestRequestTypeDef#

# GetExternalModelsRequestRequestTypeDef definition

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

KMSKeyTypeDef#

# KMSKeyTypeDef definition

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

GetLabelsRequestRequestTypeDef#

# GetLabelsRequestRequestTypeDef definition

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

LabelTypeDef#

# LabelTypeDef definition

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

GetListElementsRequestRequestTypeDef#

# GetListElementsRequestRequestTypeDef definition

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

GetListsMetadataRequestRequestTypeDef#

# GetListsMetadataRequestRequestTypeDef definition

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

GetModelVersionRequestRequestTypeDef#

# GetModelVersionRequestRequestTypeDef definition

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

GetModelsRequestRequestTypeDef#

# GetModelsRequestRequestTypeDef definition

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

ModelTypeDef#

# 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

GetOutcomesRequestRequestTypeDef#

# GetOutcomesRequestRequestTypeDef definition

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

OutcomeTypeDef#

# OutcomeTypeDef definition

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

GetRulesRequestRequestTypeDef#

# GetRulesRequestRequestTypeDef definition

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

RuleDetailTypeDef#

# 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

GetVariablesRequestRequestTypeDef#

# GetVariablesRequestRequestTypeDef definition

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

IngestedEventsTimeWindowTypeDef#

# IngestedEventsTimeWindowTypeDef definition

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

LabelSchemaTypeDef#

# LabelSchemaTypeDef definition

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

PredictionTimeRangeTypeDef#

# PredictionTimeRangeTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

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

LogOddsMetricTypeDef#

# LogOddsMetricTypeDef definition

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

MetricDataPointTypeDef#

# MetricDataPointTypeDef definition

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

OFIMetricDataPointTypeDef#

# OFIMetricDataPointTypeDef definition

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

UncertaintyRangeTypeDef#

# UncertaintyRangeTypeDef definition

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

VariableImpactExplanationTypeDef#

# VariableImpactExplanationTypeDef definition

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

PutKMSEncryptionKeyRequestRequestTypeDef#

# PutKMSEncryptionKeyRequestRequestTypeDef definition

class PutKMSEncryptionKeyRequestRequestTypeDef(TypedDict):
    kmsEncryptionKeyArn: str,

TFIMetricDataPointTypeDef#

# TFIMetricDataPointTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateDetectorVersionMetadataRequestRequestTypeDef#

# UpdateDetectorVersionMetadataRequestRequestTypeDef definition

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

UpdateDetectorVersionStatusRequestRequestTypeDef#

# UpdateDetectorVersionStatusRequestRequestTypeDef definition

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

UpdateEventLabelRequestRequestTypeDef#

# UpdateEventLabelRequestRequestTypeDef definition

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

UpdateListRequestRequestTypeDef#

# UpdateListRequestRequestTypeDef definition

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

UpdateModelRequestRequestTypeDef#

# UpdateModelRequestRequestTypeDef definition

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

UpdateModelVersionStatusRequestRequestTypeDef#

# UpdateModelVersionStatusRequestRequestTypeDef definition

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

UpdateVariableRequestRequestTypeDef#

# UpdateVariableRequestRequestTypeDef definition

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

ATITrainingMetricsValueTypeDef#

# ATITrainingMetricsValueTypeDef definition

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

AggregatedVariablesImportanceMetricsTypeDef#

# AggregatedVariablesImportanceMetricsTypeDef definition

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

CreateBatchImportJobRequestRequestTypeDef#

# CreateBatchImportJobRequestRequestTypeDef definition

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

CreateBatchPredictionJobRequestRequestTypeDef#

# CreateBatchPredictionJobRequestRequestTypeDef definition

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

CreateListRequestRequestTypeDef#

# CreateListRequestRequestTypeDef definition

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

CreateModelRequestRequestTypeDef#

# CreateModelRequestRequestTypeDef definition

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

CreateRuleRequestRequestTypeDef#

# CreateRuleRequestRequestTypeDef definition

class CreateRuleRequestRequestTypeDef(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 TagTypeDef

CreateVariableRequestRequestTypeDef#

# CreateVariableRequestRequestTypeDef definition

class CreateVariableRequestRequestTypeDef(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 TagTypeDef

PutDetectorRequestRequestTypeDef#

# PutDetectorRequestRequestTypeDef definition

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

PutEntityTypeRequestRequestTypeDef#

# PutEntityTypeRequestRequestTypeDef definition

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

PutLabelRequestRequestTypeDef#

# PutLabelRequestRequestTypeDef definition

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

PutOutcomeRequestRequestTypeDef#

# PutOutcomeRequestRequestTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

BatchCreateVariableRequestRequestTypeDef#

# BatchCreateVariableRequestRequestTypeDef definition

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

BatchCreateVariableResultTypeDef#

# BatchCreateVariableResultTypeDef definition

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

CreateDetectorVersionResultTypeDef#

# CreateDetectorVersionResultTypeDef definition

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

CreateModelVersionResultTypeDef#

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

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

GetDeleteEventsByEventTypeStatusResultTypeDef#

# GetDeleteEventsByEventTypeStatusResultTypeDef definition

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

GetListElementsResultTypeDef#

# GetListElementsResultTypeDef definition

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

GetListsMetadataResultTypeDef#

# GetListsMetadataResultTypeDef definition

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

ListTagsForResourceResultTypeDef#

# ListTagsForResourceResultTypeDef definition

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

UpdateModelVersionResultTypeDef#

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

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

GetVariablesResultTypeDef#

# GetVariablesResultTypeDef definition

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

GetBatchImportJobsResultTypeDef#

# GetBatchImportJobsResultTypeDef definition

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

GetBatchPredictionJobsResultTypeDef#

# GetBatchPredictionJobsResultTypeDef definition

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

ModelEndpointDataBlobTypeDef#

# ModelEndpointDataBlobTypeDef definition

class ModelEndpointDataBlobTypeDef(TypedDict):
    byteBuffer: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    contentType: NotRequired[str],

ModelScoresTypeDef#

# ModelScoresTypeDef definition

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

CreateDetectorVersionRequestRequestTypeDef#

# CreateDetectorVersionRequestRequestTypeDef definition

class CreateDetectorVersionRequestRequestTypeDef(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 RuleTypeDef
  2. See ModelVersionTypeDef
  3. See RuleExecutionModeType
  4. See TagTypeDef

CreateRuleResultTypeDef#

# CreateRuleResultTypeDef definition

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

DeleteRuleRequestRequestTypeDef#

# DeleteRuleRequestRequestTypeDef definition

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

GetDetectorVersionResultTypeDef#

# 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 ModelVersionTypeDef
  2. See RuleTypeDef
  3. See DetectorVersionStatusType
  4. See RuleExecutionModeType
  5. See ResponseMetadataTypeDef

UpdateDetectorVersionRequestRequestTypeDef#

# UpdateDetectorVersionRequestRequestTypeDef definition

class UpdateDetectorVersionRequestRequestTypeDef(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 RuleTypeDef
  2. See ModelVersionTypeDef
  3. See RuleExecutionModeType

UpdateRuleMetadataRequestRequestTypeDef#

# UpdateRuleMetadataRequestRequestTypeDef definition

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

UpdateRuleVersionRequestRequestTypeDef#

# UpdateRuleVersionRequestRequestTypeDef definition

class UpdateRuleVersionRequestRequestTypeDef(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 TagTypeDef

UpdateRuleVersionResultTypeDef#

# UpdateRuleVersionResultTypeDef definition

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

DataValidationMetricsTypeDef#

# DataValidationMetricsTypeDef definition

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

DescribeDetectorResultTypeDef#

# DescribeDetectorResultTypeDef definition

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

GetDetectorsResultTypeDef#

# GetDetectorsResultTypeDef definition

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

EventTypeDef#

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

SendEventRequestRequestTypeDef#

# SendEventRequestRequestTypeDef definition

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

GetEntityTypesResultTypeDef#

# GetEntityTypesResultTypeDef definition

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

PutEventTypeRequestRequestTypeDef#

# PutEventTypeRequestRequestTypeDef definition

class PutEventTypeRequestRequestTypeDef(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 TagTypeDef
  3. See EventOrchestrationTypeDef

ListEventPredictionsResultTypeDef#

# ListEventPredictionsResultTypeDef definition

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

EventTypeTypeDef#

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

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

ExternalModelTypeDef#

# ExternalModelTypeDef definition

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

PutExternalModelRequestRequestTypeDef#

# PutExternalModelRequestRequestTypeDef definition

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

GetKMSEncryptionKeyResultTypeDef#

# GetKMSEncryptionKeyResultTypeDef definition

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

GetLabelsResultTypeDef#

# GetLabelsResultTypeDef definition

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

GetModelsResultTypeDef#

# GetModelsResultTypeDef definition

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

GetOutcomesResultTypeDef#

# GetOutcomesResultTypeDef definition

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

GetRulesResultTypeDef#

# GetRulesResultTypeDef definition

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

IngestedEventsDetailTypeDef#

# IngestedEventsDetailTypeDef definition

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

TrainingDataSchemaTypeDef#

# TrainingDataSchemaTypeDef definition

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

ListEventPredictionsRequestRequestTypeDef#

# ListEventPredictionsRequestRequestTypeDef definition

class ListEventPredictionsRequestRequestTypeDef(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 definition

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

TrainingMetricsTypeDef#

# TrainingMetricsTypeDef definition

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

OFIModelPerformanceTypeDef#

# OFIModelPerformanceTypeDef definition

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

TFIModelPerformanceTypeDef#

# TFIModelPerformanceTypeDef definition

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

PredictionExplanationsTypeDef#

# PredictionExplanationsTypeDef definition

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

GetEventPredictionRequestRequestTypeDef#

# GetEventPredictionRequestRequestTypeDef definition

class GetEventPredictionRequestRequestTypeDef(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 EntityTypeDef
  2. See ModelEndpointDataBlobTypeDef

GetEventResultTypeDef#

# GetEventResultTypeDef definition

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

GetEventTypesResultTypeDef#

# GetEventTypesResultTypeDef definition

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

GetEventPredictionResultTypeDef#

# GetEventPredictionResultTypeDef definition

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

GetExternalModelsResultTypeDef#

# GetExternalModelsResultTypeDef definition

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

UpdateModelVersionRequestRequestTypeDef#

# UpdateModelVersionRequestRequestTypeDef definition

class UpdateModelVersionRequestRequestTypeDef(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 TagTypeDef

CreateModelVersionRequestRequestTypeDef#

# CreateModelVersionRequestRequestTypeDef definition

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

GetModelVersionResultTypeDef#

# GetModelVersionResultTypeDef definition

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

TrainingResultTypeDef#

# 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

OFITrainingMetricsValueTypeDef#

# OFITrainingMetricsValueTypeDef definition

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

TFITrainingMetricsValueTypeDef#

# TFITrainingMetricsValueTypeDef definition

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

ModelVersionEvaluationTypeDef#

# ModelVersionEvaluationTypeDef definition

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

TrainingMetricsV2TypeDef#

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

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

TrainingResultV2TypeDef#

# 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 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 EventVariableSummaryTypeDef
  2. See EvaluatedRuleTypeDef
  3. See RuleExecutionModeType
  4. See EvaluatedModelVersionTypeDef
  5. See EvaluatedExternalModelTypeDef
  6. See ResponseMetadataTypeDef

ModelVersionDetailTypeDef#

# ModelVersionDetailTypeDef definition

class ModelVersionDetailTypeDef(TypedDict):
    modelId: NotRequired[str],
    modelType: NotRequired[ModelTypeEnumType],  # (1)
    modelVersionNumber: NotRequired[str],
    status: NotRequired[str],
    trainingDataSource: NotRequired[TrainingDataSourceEnumType],  # (2)
    trainingDataSchema: NotRequired[TrainingDataSchemaTypeDef],  # (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 TrainingDataSchemaTypeDef
  4. See ExternalEventsDetailTypeDef
  5. See IngestedEventsDetailTypeDef
  6. See TrainingResultTypeDef
  7. See TrainingResultV2TypeDef

DescribeModelVersionsResultTypeDef#

# DescribeModelVersionsResultTypeDef definition

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