Amazon Fraud Detector Predictions API

openapi: 3.1.0
info:
  title: Amazon Fraud Detector Predictions API
  version: '2019-11-15'
  description: Generated from AWS's published Smithy model for Amazon Fraud Detector. 1 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://frauddetector.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#GetEventPrediction:
    post:
      operationId: GetEventPrediction
      summary: Get Event Prediction
      description: Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE)
        version is used.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetEventPredictionResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; ResourceUnavailableException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSHawksNestServiceFacade.GetEventPrediction
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetEventPredictionRequest'
      tags:
      - Predictions
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: frauddetector
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    Entity:
      type: object
      properties:
        entityType:
          type: string
          description: The entity type.
        entityId:
          type: string
          description: The entity ID. If you do not know the entityId, you can pass unknown, which is areserved string literal.
      required:
      - entityType
      - entityId
    ExternalModelOutputs:
      type: object
      properties:
        externalModel:
          $ref: '#/components/schemas/ExternalModelSummary'
        outputs:
          type: object
          additionalProperties:
            type: string
          description: The fraud prediction scores from Amazon SageMaker model.
    ExternalModelSummary:
      type: object
      properties:
        modelEndpoint:
          type: string
          description: The endpoint of the Amazon SageMaker model.
        modelSource:
          type: string
          enum:
          - SAGEMAKER
          description: The source of the model.
    GetEventPredictionRequest:
      type: object
      properties:
        detectorId:
          type: string
          description: The detector ID.
        detectorVersionId:
          type: string
          description: The detector version ID.
        eventId:
          type: string
          description: The unique ID used to identify the event.
        eventTypeName:
          type: string
          description: The event type associated with the detector specified for the prediction.
        entities:
          type: array
          items:
            $ref: '#/components/schemas/Entity'
          description: The entity type (associated with the detector's event type) and specific entity ID representing who
            performed the event. If an entity id is not available, use "UNKNOWN."
        eventTimestamp:
          type: string
          description: Timestamp that defines when the event under evaluation occurred. The timestamp must be specified using
            ISO 8601 standard in UTC.
        eventVariables:
          type: object
          additionalProperties:
            type: string
          description: 'Names of the event type''s variables you defined in Amazon Fraud Detector to represent data elements
            and their corresponding values for the event you are sending for evaluation. You must provide at least one eventVariable
            To ensure most accurate fraud prediction and to simplify your data preparation, Amazon Fraud Detector will replace
            all missing variables or values as follows: For Amazon Fraud Detector trained models: If a null value is provided
            explicitly for a variable or if a variable is missing, model will replace the null value or the missing variable
            (no variable name in the eventVariabl'
        externalModelEndpointDataBlobs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ModelEndpointDataBlob'
          description: The Amazon SageMaker model endpoint input data blobs.
      required:
      - detectorId
      - eventId
      - eventTypeName
      - entities
      - eventTimestamp
      - eventVariables
    GetEventPredictionResult:
      type: object
      properties:
        modelScores:
          type: array
          items:
            $ref: '#/components/schemas/ModelScores'
          description: The model scores. Amazon Fraud Detector generates model scores between 0 and 1000, where 0 is low fraud
            risk and 1000 is high fraud risk. Model scores are directly related to the false positive rate (FPR). For example,
            a score of 600 corresponds to an estimated 10% false positive rate whereas a score of 900 corresponds to an estimated
            2% false positive rate.
        ruleResults:
          type: array
          items:
            $ref: '#/components/schemas/RuleResult'
          description: The results from the rules.
        externalModelOutputs:
          type: array
          items:
            $ref: '#/components/schemas/ExternalModelOutputs'
          description: The model scores for Amazon SageMaker models.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ModelEndpointDataBlob:
      type: object
      properties:
        byteBuffer:
          type: string
          format: byte
          description: The byte buffer of the Amazon SageMaker model endpoint input data blob.
        contentType:
          type: string
          description: The content type of the Amazon SageMaker model endpoint input data blob.
    ModelScores:
      type: object
      properties:
        modelVersion:
          $ref: '#/components/schemas/ModelVersion'
        scores:
          type: object
          additionalProperties:
            type: number
          description: The model's fraud prediction scores.
    ModelVersion:
      type: object
      properties:
        modelId:
          type: string
          description: The model ID.
        modelType:
          type: string
          enum:
          - ONLINE_FRAUD_INSIGHTS
          - TRANSACTION_FRAUD_INSIGHTS
          - ACCOUNT_TAKEOVER_INSIGHTS
          description: The model type.
        modelVersionNumber:
          type: string
          description: The model version number.
        arn:
          type: string
          description: The model version ARN.
      required:
      - modelId
      - modelType
      - modelVersionNumber
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    RuleResult:
      type: object
      properties:
        ruleId:
          type: string
          description: The rule ID that was matched, based on the rule execution mode.
        outcomes:
          type: array
          items:
            type: string
          description: The outcomes of the matched rule, based on the rule execution mode.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/frauddetector/service/2019-11-15/frauddetector-2019-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)