Amazon Fraud Detector Detectors API

openapi: 3.2.0
info:
  title: Amazon Fraud Detector Detectors API
  version: '2019-11-15'
  description: 'Operations tagged Detectors across 2 of this provider''s published API definitions: amazon-fraud-detector-openapi.yml, amazon-fraud-detector-detectors-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://frauddetector.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
tags:
- name: Detectors
  description: Fraud detector configurations
paths:
  /detectors:
    put:
      operationId: putDetector
      summary: Put Detector
      description: Creates or updates a detector.
      tags:
      - Detectors
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutDetectorRequest'
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - awsSigV4: []
    post:
      operationId: getDetectors
      summary: Get Detectors
      description: Gets all detectors or a single detector if a detectorId is specified.
      tags:
      - Detectors
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                detectorId:
                  type: string
                nextToken:
                  type: string
                maxResults:
                  type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  detectors:
                    type: array
                    items:
                      $ref: '#/components/schemas/Detector'
                  nextToken:
                    type: string
              examples:
                default:
                  x-microcks-default: true
                  value:
                    detectors:
                    - detectorId: payment-fraud-detector
                      description: Detects payment fraud
                      eventTypeName: transaction
                      arn: arn:aws:frauddetector:us-east-1:123456789012:detector/payment-fraud-detector
                      lastUpdatedTime: '2025-06-01T10:00:00Z'
                      createdTime: '2025-01-01T08:00:00Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - awsSigV4: []
    servers:
    - url: https://frauddetector.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /detectors/{detectorId}:
    delete:
      operationId: deleteDetector
      summary: Delete Detector
      description: Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.
      tags:
      - Detectors
      parameters:
      - name: detectorId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the detector to delete.
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - awsSigV4: []
    servers:
    - url: https://frauddetector.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#DeleteDetector:
    post:
      operationId: DeleteDetector
      summary: Delete Detector
      description: Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector. When you delete a detector, 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/DeleteDetectorResult'
        '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'
        '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.DeleteDetector
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDetectorRequest'
      tags:
      - Detectors
      security:
      - sigv4: []
    servers:
    - url: https://frauddetector.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#DescribeDetector:
    post:
      operationId: DescribeDetector
      summary: Describe Detector
      description: Gets all versions for a specified detector.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDetectorResult'
        '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.DescribeDetector
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDetectorRequest'
      tags:
      - Detectors
      security:
      - sigv4: []
    servers:
    - url: https://frauddetector.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#GetDetectors:
    post:
      operationId: GetDetectors
      summary: Get Detectors
      description: Gets all detectors or a single detector if a detectorId is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetDetectorsResponse as part of your request. A null pagination token fetches the records from the beginning.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetDetectorsResult'
        '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.GetDetectors
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetDetectorsRequest'
      tags:
      - Detectors
      security:
      - sigv4: []
    servers:
    - url: https://frauddetector.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#PutDetector:
    post:
      operationId: PutDetector
      summary: Put Detector
      description: Creates or updates a detector.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutDetectorResult'
        '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'
        '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.PutDetector
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutDetectorRequest_2'
      tags:
      - Detectors
      security:
      - sigv4: []
    servers:
    - url: https://frauddetector.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    ErrorResponse:
      type: object
      description: Standard error response from the Amazon Fraud Detector API.
      properties:
        message:
          type: string
        code:
          type: string
    Detector:
      type: object
      description: An Amazon Fraud Detector detector that orchestrates ML models and rules for fraud decisions.
      properties:
        detectorId:
          type: string
        description:
          type: string
        eventTypeName:
          type: string
        lastUpdatedTime:
          type: string
          format: date-time
        createdTime:
          type: string
          format: date-time
        arn:
          type: string
      required:
      - detectorId
      - eventTypeName
    Tag:
      type: object
      description: A metadata label applied to a Fraud Detector resource.
      properties:
        key:
          type: string
        value:
          type: string
      required:
      - key
      - value
    PutDetectorRequest:
      type: object
      required:
      - detectorId
      - eventTypeName
      properties:
        detectorId:
          type: string
        description:
          type: string
        eventTypeName:
          type: string
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    GetDetectorsRequest:
      type: object
      properties:
        detectorId:
          type: string
          description: The detector ID.
        nextToken:
          type: string
          description: The next token for the subsequent request.
        maxResults:
          type: integer
          description: The maximum number of objects to return for the request.
    DescribeDetectorRequest:
      type: object
      properties:
        detectorId:
          type: string
          description: The detector ID.
        nextToken:
          type: string
          description: The next token from the previous response.
        maxResults:
          type: integer
          description: The maximum number of results to return for the request.
      required:
      - detectorId
    Tag_2:
      type: object
      properties:
        key:
          type: string
          description: A tag key.
        value:
          type: string
          description: A value assigned to a tag key.
      required:
      - key
      - value
    PutDetectorRequest_2:
      type: object
      properties:
        detectorId:
          type: string
          description: The detector ID.
        description:
          type: string
          description: The description of the detector.
        eventTypeName:
          type: string
          description: The name of the event type.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag_2'
          description: A collection of key and value pairs.
      required:
      - detectorId
      - eventTypeName
    PutDetectorResult:
      type: object
      properties: {}
    ResourceNotFoundException:
      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
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    Detector_2:
      type: object
      properties:
        detectorId:
          type: string
          description: The detector ID.
        description:
          type: string
          description: The detector description.
        eventTypeName:
          type: string
          description: The name of the event type.
        lastUpdatedTime:
          type: string
          description: Timestamp of when the detector was last updated.
        createdTime:
          type: string
          description: Timestamp of when the detector was created.
        arn:
          type: string
          description: The detector ARN.
    DeleteDetectorResult:
      type: object
      properties: {}
    DetectorVersionSummary:
      type: object
      properties:
        detectorVersionId:
          type: string
          description: The detector version ID.
        status:
          type: string
          enum:
          - DRAFT
          - ACTIVE
          - INACTIVE
          description: The detector version status.
        description:
          type: string
          description: The detector version description.
        lastUpdatedTime:
          type: string
          description: Timestamp of when the detector version was last updated.
    DescribeDetectorResult:
      type: object
      properties:
        detectorId:
          type: string
          description: The detector ID.
        detectorVersionSummaries:
          type: array
          items:
            $ref: '#/components/schemas/DetectorVersionSummary'
          description: The status and description for each detector version.
        nextToken:
          type: string
          description: The next token to be used for subsequent requests.
        arn:
          type: string
          description: The detector ARN.
    GetDetectorsResult:
      type: object
      properties:
        detectors:
          type: array
          items:
            $ref: '#/components/schemas/Detector_2'
          description: The detectors.
        nextToken:
          type: string
          description: The next page token.
    DeleteDetectorRequest:
      type: object
      properties:
        detectorId:
          type: string
          description: The ID of the detector to delete.
      required:
      - detectorId
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
  securitySchemes:
    awsSigV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4
    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-refined-from:
- amazon-fraud-detector-openapi.yml
- amazon-fraud-detector-detectors-api-openapi.yml