Amazon Fraud Detector Event Types API

openapi: 3.2.0
info:
  title: Amazon Fraud Detector Event Types API
  version: '2019-11-15'
  description: 'Operations tagged Event Types across 2 of this provider''s published API definitions: amazon-fraud-detector-openapi.yml, amazon-fraud-detector-event-types-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: Event Types
  description: Event schema definitions
paths:
  /event-types:
    put:
      operationId: putEventType
      summary: Put Event Type
      description: Creates or updates an event type.
      tags:
      - Event Types
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutEventTypeRequest'
      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: getEventTypes
      summary: Get Event Types
      description: Gets all event types or a specific event type if a name is provided.
      tags:
      - Event Types
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                nextToken:
                  type: string
                maxResults:
                  type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  eventTypes:
                    type: array
                    items:
                      $ref: '#/components/schemas/EventType'
                  nextToken:
                    type: string
              examples:
                default:
                  x-microcks-default: true
                  value:
                    eventTypes:
                    - name: transaction
                      description: Payment transaction event
                      eventVariables:
                      - transaction_amount
                      - ip_address
                      - email
                      labels:
                      - fraud
                      - legit
        '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
  /#DeleteEventType:
    post:
      operationId: DeleteEventType
      summary: Delete Event Type
      description: Deletes an event type. You cannot delete an event type that is used in a detector or a model. When you delete an event type, Amazon Fraud Detector permanently deletes that event type 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/DeleteEventTypeResult'
        '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.DeleteEventType
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteEventTypeRequest'
      tags:
      - Event Types
      security:
      - sigv4: []
    servers:
    - url: https://frauddetector.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#GetEventTypes:
    post:
      operationId: GetEventTypes
      summary: Get Event Types
      description: Gets all event types or a specific event type if name is provided. 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 GetEventTypesResponse 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/GetEventTypesResult'
        '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.GetEventTypes
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetEventTypesRequest'
      tags:
      - Event Types
      security:
      - sigv4: []
    servers:
    - url: https://frauddetector.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#PutEventType:
    post:
      operationId: PutEventType
      summary: Put Event Type
      description: Creates or updates an event type. An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event (such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutEventTypeResult'
        '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.PutEventType
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutEventTypeRequest_2'
      tags:
      - Event Types
      security:
      - sigv4: []
    servers:
    - url: https://frauddetector.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    EventType:
      type: object
      description: A schema defining the structure of events analyzed by a Fraud Detector.
      properties:
        name:
          type: string
        description:
          type: string
        eventVariables:
          type: array
          items:
            type: string
        labels:
          type: array
          items:
            type: string
        entityTypes:
          type: array
          items:
            type: string
        eventIngestion:
          type: string
          enum:
          - ENABLED
          - DISABLED
        lastUpdatedTime:
          type: string
          format: date-time
        createdTime:
          type: string
          format: date-time
        arn:
          type: string
      required:
      - name
      - eventVariables
      - labels
      - entityTypes
    ErrorResponse:
      type: object
      description: Standard error response from the Amazon Fraud Detector API.
      properties:
        message:
          type: string
        code:
          type: string
    PutEventTypeRequest:
      type: object
      required:
      - name
      - eventVariables
      - labels
      - entityTypes
      properties:
        name:
          type: string
        description:
          type: string
        eventVariables:
          type: array
          items:
            type: string
        labels:
          type: array
          items:
            type: string
        entityTypes:
          type: array
          items:
            type: string
        eventIngestion:
          type: string
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    Tag:
      type: object
      description: A metadata label applied to a Fraud Detector resource.
      properties:
        key:
          type: string
        value:
          type: string
      required:
      - key
      - value
    PutEventTypeResult:
      type: object
      properties: {}
    DeleteEventTypeRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the event type to delete.
      required:
      - name
    GetEventTypesRequest:
      type: object
      properties:
        name:
          type: string
          description: The name.
        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.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    EventType_2:
      type: object
      properties:
        name:
          type: string
          description: The event type name.
        description:
          type: string
          description: The event type description.
        eventVariables:
          type: array
          items:
            type: string
          description: The event type event variables.
        labels:
          type: array
          items:
            type: string
          description: The event type labels.
        entityTypes:
          type: array
          items:
            type: string
          description: The event type entity types.
        eventIngestion:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: If Enabled, Amazon Fraud Detector stores event data when you generate a prediction and uses that data to update calculated variables in near real-time. Amazon Fraud Detector uses this data, known as INGESTED_EVENTS, to train your model and improve fraud predictions.
        ingestedEventStatistics:
          $ref: '#/components/schemas/IngestedEventStatistics'
        lastUpdatedTime:
          type: string
          description: Timestamp of when the event type was last updated.
        createdTime:
          type: string
          description: Timestamp of when the event type was created.
        arn:
          type: string
          description: The entity type ARN.
        eventOrchestration:
          $ref: '#/components/schemas/EventOrchestration'
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    EventOrchestration:
      type: object
      properties:
        eventBridgeEnabled:
          type: boolean
          description: Specifies if event orchestration is enabled through Amazon EventBridge.
      required:
      - eventBridgeEnabled
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    GetEventTypesResult:
      type: object
      properties:
        eventTypes:
          type: array
          items:
            $ref: '#/components/schemas/EventType_2'
          description: An array of event types.
        nextToken:
          type: string
          description: The next page token.
    ValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    PutEventTypeRequest_2:
      type: object
      properties:
        name:
          type: string
          description: The name.
        description:
          type: string
          description: The description of the event type.
        eventVariables:
          type: array
          items:
            type: string
          description: The event type variables.
        labels:
          type: array
          items:
            type: string
          description: The event type labels.
        entityTypes:
          type: array
          items:
            type: string
          description: 'The entity type for the event type. Example entity types: customer, merchant, account.'
        eventIngestion:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Specifies if ingestion is enabled or disabled.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag_2'
          description: A collection of key and value pairs.
        eventOrchestration:
          $ref: '#/components/schemas/EventOrchestration'
      required:
      - name
      - eventVariables
      - entityTypes
    IngestedEventStatistics:
      type: object
      properties:
        numberOfEvents:
          type: integer
          description: The number of stored events.
        eventDataSizeInBytes:
          type: integer
          description: The total size of the stored events.
        leastRecentEvent:
          type: string
          description: The oldest stored event.
        mostRecentEvent:
          type: string
          description: The newest stored event.
        lastUpdatedTime:
          type: string
          description: Timestamp of when the stored event was last updated.
    DeleteEventTypeResult:
      type: object
      properties: {}
    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
    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-event-types-api-openapi.yml