find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-fraud-detector:amazon-fraud-detector-detector-version-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon Fraud Detector Detector Version API
  version: '2019-11-15'
  description: Generated from AWS's published Smithy model for Amazon Fraud Detector. 4 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: []
tags:
- name: Detector Version
paths:
  /#CreateDetectorVersion:
    post:
      operationId: CreateDetectorVersion
      summary: Create Detector Version
      description: Creates a detector version. The detector version starts in a DRAFT status.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateDetectorVersionResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.CreateDetectorVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDetectorVersionRequest'
      tags:
      - Detector Version
  /#DeleteDetectorVersion:
    post:
      operationId: DeleteDetectorVersion
      summary: Delete Detector Version
      description: Deletes the detector version. You cannot delete detector versions that are in ACTIVE status. When you delete a detector version, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteDetectorVersionResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          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.DeleteDetectorVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDetectorVersionRequest'
      tags:
      - Detector Version
  /#GetDetectorVersion:
    post:
      operationId: GetDetectorVersion
      summary: Get Detector Version
      description: Gets a particular detector version.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetDetectorVersionResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.GetDetectorVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetDetectorVersionRequest'
      tags:
      - Detector Version
  /#UpdateDetectorVersion:
    post:
      operationId: UpdateDetectorVersion
      summary: Update Detector Version
      description: Updates a detector version. The detector version attributes that you can update include models, external model endpoints, rules, rule execution mode, and description. You can only update a DRAFT detector version.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateDetectorVersionResult'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          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.UpdateDetectorVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateDetectorVersionRequest'
      tags:
      - Detector Version
components:
  schemas:
    GetDetectorVersionRequest:
      type: object
      properties:
        detectorId:
          type: string
          description: The detector ID.
        detectorVersionId:
          type: string
          description: The detector version ID.
      required:
      - detectorId
      - detectorVersionId
    Rule:
      type: object
      properties:
        detectorId:
          type: string
          description: The detector for which the rule is associated.
        ruleId:
          type: string
          description: The rule ID.
        ruleVersion:
          type: string
          description: The rule version.
      required:
      - detectorId
      - ruleId
      - ruleVersion
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    GetDetectorVersionResult:
      type: object
      properties:
        detectorId:
          type: string
          description: The detector ID.
        detectorVersionId:
          type: string
          description: The detector version ID.
        description:
          type: string
          description: The detector version description.
        externalModelEndpoints:
          type: array
          items:
            type: string
          description: The Amazon SageMaker model endpoints included in the detector version.
        modelVersions:
          type: array
          items:
            $ref: '#/components/schemas/ModelVersion'
          description: The model versions included in the detector version.
        rules:
          type: array
          items:
            $ref: '#/components/schemas/Rule'
          description: The rules included in the detector version.
        status:
          type: string
          enum:
          - DRAFT
          - ACTIVE
          - INACTIVE
          description: The status of the detector version.
        lastUpdatedTime:
          type: string
          description: The timestamp when the detector version was last updated.
        createdTime:
          type: string
          description: The timestamp when the detector version was created.
        ruleExecutionMode:
          type: string
          enum:
          - ALL_MATCHED
          - FIRST_MATCHED
          description: The execution mode of the rule in the dectector FIRST_MATCHED indicates that Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule. ALL_MATCHED indicates that Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.
        arn:
          type: string
          description: The detector version ARN.
    CreateDetectorVersionRequest:
      type: object
      properties:
        detectorId:
          type: string
          description: The ID of the detector under which you want to create a new version.
        description:
          type: string
          description: The description of the detector version.
        externalModelEndpoints:
          type: array
          items:
            type: string
          description: The Amazon Sagemaker model endpoints to include in the detector version.
        rules:
          type: array
          items:
            $ref: '#/components/schemas/Rule'
          description: The rules to include in the detector version.
        modelVersions:
          type: array
          items:
            $ref: '#/components/schemas/ModelVersion'
          description: The model versions to include in the detector version.
        ruleExecutionMode:
          type: string
          enum:
          - ALL_MATCHED
          - FIRST_MATCHED
          description: The rule execution mode for the rules included in the detector version. You can define and edit the rule mode at the detector version level, when it is in draft status. If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule. If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. The default behavior is FIRST_MATCHED.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A collection of key and value pairs.
      required:
      - detectorId
      - rules
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DeleteDetectorVersionResult:
      type: object
      properties: {}
    DeleteDetectorVersionRequest:
      type: object
      properties:
        detectorId:
          type: string
          description: The ID of the parent detector for the detector version to delete.
        detectorVersionId:
          type: string
          description: The ID of the detector version to delete.
      required:
      - detectorId
      - detectorVersionId
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CreateDetectorVersionResult:
      type: object
      properties:
        detectorId:
          type: string
          description: The ID for the created version's parent detector.
        detectorVersionId:
          type: string
          description: The ID for the created detector.
        status:
          type: string
          enum:
          - DRAFT
          - ACTIVE
          - INACTIVE
          description: The status of the detector version.
    UpdateDetectorVersionResult:
      type: object
      properties: {}
    UpdateDetectorVersionRequest:
      type: object
      properties:
        detectorId:
          type: string
          description: The parent detector ID for the detector version you want to update.
        detectorVersionId:
          type: string
          description: The detector version ID.
        externalModelEndpoints:
          type: array
          items:
            type: string
          description: The Amazon SageMaker model endpoints to include in the detector version.
        rules:
          type: array
          items:
            $ref: '#/components/schemas/Rule'
          description: The rules to include in the detector version.
        description:
          type: string
          description: The detector version description.
        modelVersions:
          type: array
          items:
            $ref: '#/components/schemas/ModelVersion'
          description: The model versions to include in the detector version.
        ruleExecutionMode:
          type: string
          enum:
          - ALL_MATCHED
          - FIRST_MATCHED
          description: The rule execution mode to add to the detector. If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule. If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status. The default behavior is FIRST_MATCHED.
      required:
      - detectorId
      - detectorVersionId
      - externalModelEndpoints
      - rules
    Tag:
      type: object
      properties:
        key:
          type: string
          description: A tag key.
        value:
          type: string
          description: A value assigned to a tag key.
      required:
      - key
      - value
    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
  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
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)