@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Amazon Fraud Detector
@version 2019-11-15
@auth AWS SigV4
@endpoints 73
@hint download_for_search
@toc root(73)

@endpoint POST /
@required {variableEntries: [VariableEntry]}
@optional {tags: [Tag]}
@returns(200) {errors: [BatchCreateVariableError]?}

@endpoint POST /
@required {names: [str]}
@returns(200) {variables: [Variable]?, errors: [BatchGetVariableError]?}

@endpoint POST /
@required {jobId: str}

@endpoint POST /
@required {jobId: str}

@endpoint POST /
@required {jobId: str, inputPath: str, outputPath: str, eventTypeName: str, iamRoleArn: str}
@optional {tags: [Tag]}

@endpoint POST /
@required {jobId: str, inputPath: str, outputPath: str, eventTypeName: str, detectorName: str, iamRoleArn: str}
@optional {detectorVersion: str, tags: [Tag]}

@endpoint POST /
@required {detectorId: str, rules: [Rule]}
@optional {description: str, externalModelEndpoints: [str], modelVersions: [ModelVersion], ruleExecutionMode: str, tags: [Tag]}
@returns(200) {detectorId: str?, detectorVersionId: str?, status: str?}

@endpoint POST /
@required {name: str}
@optional {elements: [str], variableType: str, description: str, tags: [Tag]}

@endpoint POST /
@required {modelId: str, modelType: str, eventTypeName: str}
@optional {description: str, tags: [Tag]}

@endpoint POST /
@required {modelId: str, modelType: str, trainingDataSource: str, trainingDataSchema: TrainingDataSchema}
@optional {externalEventsDetail: ExternalEventsDetail, ingestedEventsDetail: IngestedEventsDetail, tags: [Tag]}
@returns(200) {modelId: str?, modelType: str?, modelVersionNumber: str?, status: str?}

@endpoint POST /
@required {ruleId: str, detectorId: str, expression: str, language: str, outcomes: [str]}
@optional {description: str, tags: [Tag]}
@returns(200) {rule: Rule?{detectorId: str, ruleId: str, ruleVersion: str}}

@endpoint POST /
@required {name: str, dataType: str, dataSource: str, defaultValue: str}
@optional {description: str, variableType: str, tags: [Tag]}

@endpoint POST /
@required {jobId: str}

@endpoint POST /
@required {jobId: str}

@endpoint POST /
@required {detectorId: str}

@endpoint POST /
@required {detectorId: str, detectorVersionId: str}

@endpoint POST /
@required {name: str}

@endpoint POST /
@required {eventId: str, eventTypeName: str}
@optional {deleteAuditHistory: bool}

@endpoint POST /
@required {name: str}

@endpoint POST /
@required {eventTypeName: str}
@returns(200) {eventTypeName: str?, eventsDeletionStatus: str?}

@endpoint POST /
@required {modelEndpoint: str}

@endpoint POST /
@required {name: str}

@endpoint POST /
@required {name: str}

@endpoint POST /
@required {modelId: str, modelType: str}

@endpoint POST /
@required {modelId: str, modelType: str, modelVersionNumber: str}

@endpoint POST /
@required {name: str}

@endpoint POST /
@required {rule: Rule}

@endpoint POST /
@required {name: str}

@endpoint POST /
@required {detectorId: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {detectorId: str?, detectorVersionSummaries: [DetectorVersionSummary]?, nextToken: str?, arn: str?}

@endpoint POST /
@optional {modelId: str, modelVersionNumber: str, modelType: str, nextToken: str, maxResults: int}
@returns(200) {modelVersionDetails: [ModelVersionDetail]?, nextToken: str?}

@endpoint POST /
@optional {jobId: str, maxResults: int, nextToken: str}
@returns(200) {batchImports: [BatchImport]?, nextToken: str?}

@endpoint POST /
@optional {jobId: str, maxResults: int, nextToken: str}
@returns(200) {batchPredictions: [BatchPrediction]?, nextToken: str?}

@endpoint POST /
@required {eventTypeName: str}
@returns(200) {eventTypeName: str?, eventsDeletionStatus: str?}

@endpoint POST /
@required {detectorId: str, detectorVersionId: str}
@returns(200) {detectorId: str?, detectorVersionId: str?, description: str?, externalModelEndpoints: [str]?, modelVersions: [ModelVersion]?, rules: [Rule]?, status: str?, lastUpdatedTime: str?, createdTime: str?, ruleExecutionMode: str?, arn: str?}

@endpoint POST /
@optional {detectorId: str, nextToken: str, maxResults: int}
@returns(200) {detectors: [Detector]?, nextToken: str?}

@endpoint POST /
@optional {name: str, nextToken: str, maxResults: int}
@returns(200) {entityTypes: [EntityType]?, nextToken: str?}

@endpoint POST /
@required {eventId: str, eventTypeName: str}
@returns(200) {event: Event?{eventId: str?, eventTypeName: str?, eventTimestamp: str?, eventVariables: map<str,str>?, currentLabel: str?, labelTimestamp: str?, entities: [Entity]?}}

@endpoint POST /
@required {detectorId: str, eventId: str, eventTypeName: str, entities: [Entity], eventTimestamp: str, eventVariables: map<str,str>}
@optional {detectorVersionId: str, externalModelEndpointDataBlobs: map<str,ModelEndpointDataBlob>}
@returns(200) {modelScores: [ModelScores]?, ruleResults: [RuleResult]?, externalModelOutputs: [ExternalModelOutputs]?}

@endpoint POST /
@required {eventId: str, eventTypeName: str, detectorId: str, detectorVersionId: str, predictionTimestamp: str}
@returns(200) {eventId: str?, eventTypeName: str?, entityId: str?, entityType: str?, eventTimestamp: str?, detectorId: str?, detectorVersionId: str?, detectorVersionStatus: str?, eventVariables: [EventVariableSummary]?, rules: [EvaluatedRule]?, ruleExecutionMode: str?, outcomes: [str]?, evaluatedModelVersions: [EvaluatedModelVersion]?, evaluatedExternalModels: [EvaluatedExternalModel]?, predictionTimestamp: str?}

@endpoint POST /
@optional {name: str, nextToken: str, maxResults: int}
@returns(200) {eventTypes: [EventType]?, nextToken: str?}

@endpoint POST /
@optional {modelEndpoint: str, nextToken: str, maxResults: int}
@returns(200) {externalModels: [ExternalModel]?, nextToken: str?}

@endpoint POST /
@returns(200) {kmsKey: KMSKey?{kmsEncryptionKeyArn: str?}}

@endpoint POST /
@optional {name: str, nextToken: str, maxResults: int}
@returns(200) {labels: [Label]?, nextToken: str?}

@endpoint POST /
@required {name: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {elements: [str]?, nextToken: str?}

@endpoint POST /
@optional {name: str, nextToken: str, maxResults: int}
@returns(200) {lists: [AllowDenyList]?, nextToken: str?}

@endpoint POST /
@required {modelId: str, modelType: str, modelVersionNumber: str}
@returns(200) {modelId: str?, modelType: str?, modelVersionNumber: str?, trainingDataSource: str?, trainingDataSchema: TrainingDataSchema?{modelVariables: [str], labelSchema: LabelSchema?{labelMapper: map<str,[str]>?, unlabeledEventsTreatment: str?}}, externalEventsDetail: ExternalEventsDetail?{dataLocation: str, dataAccessRoleArn: str}, ingestedEventsDetail: IngestedEventsDetail?{ingestedEventsTimeWindow: IngestedEventsTimeWindow{startTime: str, endTime: str}}, status: str?, arn: str?}

@endpoint POST /
@optional {modelId: str, modelType: str, nextToken: str, maxResults: int}
@returns(200) {nextToken: str?, models: [Model]?}

@endpoint POST /
@optional {name: str, nextToken: str, maxResults: int}
@returns(200) {outcomes: [Outcome]?, nextToken: str?}

@endpoint POST /
@required {detectorId: str}
@optional {ruleId: str, ruleVersion: str, nextToken: str, maxResults: int}
@returns(200) {ruleDetails: [RuleDetail]?, nextToken: str?}

@endpoint POST /
@optional {name: str, nextToken: str, maxResults: int}
@returns(200) {variables: [Variable]?, nextToken: str?}

@endpoint POST /
@optional {eventId: FilterCondition, eventType: FilterCondition, detectorId: FilterCondition, detectorVersionId: FilterCondition, predictionTimeRange: PredictionTimeRange, nextToken: str, maxResults: int}
@returns(200) {eventPredictionSummaries: [EventPredictionSummary]?, nextToken: str?}

@endpoint POST /
@required {resourceARN: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {tags: [Tag]?, nextToken: str?}

@endpoint POST /
@required {detectorId: str, eventTypeName: str}
@optional {description: str, tags: [Tag]}

@endpoint POST /
@required {name: str}
@optional {description: str, tags: [Tag]}

@endpoint POST /
@required {name: str, eventVariables: [str], entityTypes: [str]}
@optional {description: str, labels: [str], eventIngestion: str, tags: [Tag], eventOrchestration: EventOrchestration}

@endpoint POST /
@required {modelEndpoint: str, modelSource: str, invokeModelEndpointRoleArn: str, inputConfiguration: ModelInputConfiguration, outputConfiguration: ModelOutputConfiguration, modelEndpointStatus: str}
@optional {tags: [Tag]}

@endpoint POST /
@required {kmsEncryptionKeyArn: str}

@endpoint POST /
@required {name: str}
@optional {description: str, tags: [Tag]}

@endpoint POST /
@required {name: str}
@optional {description: str, tags: [Tag]}

@endpoint POST /
@required {eventId: str, eventTypeName: str, eventTimestamp: str, eventVariables: map<str,str>, entities: [Entity]}
@optional {assignedLabel: str, labelTimestamp: str}

@endpoint POST /
@required {resourceARN: str, tags: [Tag]}

@endpoint POST /
@required {resourceARN: str, tagKeys: [str]}

@endpoint POST /
@required {detectorId: str, detectorVersionId: str, externalModelEndpoints: [str], rules: [Rule]}
@optional {description: str, modelVersions: [ModelVersion], ruleExecutionMode: str}

@endpoint POST /
@required {detectorId: str, detectorVersionId: str, description: str}

@endpoint POST /
@required {detectorId: str, detectorVersionId: str, status: str}

@endpoint POST /
@required {eventId: str, eventTypeName: str, assignedLabel: str, labelTimestamp: str}

@endpoint POST /
@required {name: str}
@optional {elements: [str], description: str, updateMode: str, variableType: str}

@endpoint POST /
@required {modelId: str, modelType: str}
@optional {description: str}

@endpoint POST /
@required {modelId: str, modelType: str, majorVersionNumber: str}
@optional {externalEventsDetail: ExternalEventsDetail, ingestedEventsDetail: IngestedEventsDetail, tags: [Tag]}
@returns(200) {modelId: str?, modelType: str?, modelVersionNumber: str?, status: str?}

@endpoint POST /
@required {modelId: str, modelType: str, modelVersionNumber: str, status: str}

@endpoint POST /
@required {rule: Rule, description: str}

@endpoint POST /
@required {rule: Rule, expression: str, language: str, outcomes: [str]}
@optional {description: str, tags: [Tag]}
@returns(200) {rule: Rule?{detectorId: str, ruleId: str, ruleVersion: str}}

@endpoint POST /
@required {name: str}
@optional {defaultValue: str, description: str, variableType: str}

@end