openapi: 3.2.0
info:
  version: 2015-05-28
  x-release: v4
  title: AWS IoT Violation Events API
  description: 'IoT

    IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud.'
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: iot
  x-aws-signingName: iot
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iot-2015-05-28.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://iot.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS IoT multi-region endpoint
- url: https://iot.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS IoT multi-region endpoint
- url: http://iot.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS IoT endpoint for China (Beijing) and China (Ningxia)
- url: https://iot.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS IoT endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Violation Events
paths:
  /violation-events#startTime&endTime:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    get:
      operationId: ListViolationEvents
      description: 'Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).


        Requires permission to access the ListViolationEvents action.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListViolationEventsResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '482':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
      parameters:
      - name: startTime
        in: query
        required: true
        description: The start time for the alerts to be listed.
        schema:
          type: string
          format: date-time
      - name: endTime
        in: query
        required: true
        description: The end time for the alerts to be listed.
        schema:
          type: string
          format: date-time
      - name: thingName
        in: query
        required: false
        description: A filter to limit results to those alerts caused by the specified thing.
        schema:
          type: string
          minLength: 1
          maxLength: 128
      - name: securityProfileName
        in: query
        required: false
        description: A filter to limit results to those alerts generated by the specified security profile.
        schema:
          type: string
          pattern: '[a-zA-Z0-9:_-]+'
          minLength: 1
          maxLength: 128
      - name: behaviorCriteriaType
        in: query
        required: false
        description: ' The criteria for a behavior. '
        schema:
          type: string
          enum:
          - STATIC
          - STATISTICAL
          - MACHINE_LEARNING
      - name: listSuppressedAlerts
        in: query
        required: false
        description: ' A list of all suppressed alerts. '
        schema:
          type: boolean
      - name: verificationState
        in: query
        required: false
        description: The verification state of the violation (detect alarm).
        schema:
          type: string
          enum:
          - FALSE_POSITIVE
          - BENIGN_POSITIVE
          - TRUE_POSITIVE
          - UNKNOWN
      - name: nextToken
        in: query
        required: false
        description: The token for the next set of results.
        schema:
          type: string
      - name: maxResults
        in: query
        required: false
        description: The maximum number of results to return at one time.
        schema:
          type: integer
          minimum: 1
          maximum: 250
      summary: Amazon IoT Core List Violation Events
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Violation Events
components:
  schemas:
    Cidrs:
      type: array
      items:
        $ref: '#/components/schemas/Cidr'
    ConsecutiveDatapointsToClear:
      type: integer
      minimum: 1
      maximum: 10
    DeviceDefenderThingName:
      type: string
      minLength: 1
      maxLength: 128
    NumberList:
      type: array
      items:
        $ref: '#/components/schemas/Number'
    BehaviorName:
      type: string
      pattern: '[a-zA-Z0-9:_-]+'
      minLength: 1
      maxLength: 128
    DimensionValueOperator:
      type: string
      enum:
      - IN
      - NOT_IN
    Number:
      type: number
      format: double
    EvaluationStatistic:
      type: string
      pattern: (p0|p0\.1|p0\.01|p1|p10|p50|p90|p99|p99\.9|p99\.99|p100)
    InvalidRequestException: {}
    Port:
      type: integer
      minimum: 0
      maximum: 65535
    ViolationEventAdditionalInfo:
      type: object
      properties:
        confidenceLevel:
          allOf:
          - $ref: '#/components/schemas/ConfidenceLevel'
          - description: ' The sensitivity of anomalous behavior evaluation. Can be <code>Low</code>, <code>Medium</code>, or <code>High</code>. '
      description: ' The details of a violation event. '
    BehaviorCriteria:
      type: object
      properties:
        comparisonOperator:
          allOf:
          - $ref: '#/components/schemas/ComparisonOperator'
          - description: '<p>The operator that relates the thing measured (<code>metric</code>) to the criteria (containing a <code>value</code> or <code>statisticalThreshold</code>). Valid operators include:</p> <ul> <li> <p> <code>string-list</code>: <code>in-set</code> and <code>not-in-set</code> </p> </li> <li> <p> <code>number-list</code>: <code>in-set</code> and <code>not-in-set</code> </p> </li> <li> <p> <code>ip-address-list</code>: <code>in-cidr-set</code> and <code>not-in-cidr-set</code> </p> </li> <li> <p> <code>number</code>: <code>less-than</code>, <code>less-than-equals</code>, <code>greater-than</code>, and <code>greater-than-equals</code> </p> </li> </ul>'
        value:
          allOf:
          - $ref: '#/components/schemas/MetricValue'
          - description: The value to be compared with the <code>metric</code>.
        durationSeconds:
          allOf:
          - $ref: '#/components/schemas/DurationSeconds'
          - description: Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, <code>NUM_MESSAGES_SENT</code>). For a <code>statisticalThreshhold</code> metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.
        consecutiveDatapointsToAlarm:
          allOf:
          - $ref: '#/components/schemas/ConsecutiveDatapointsToAlarm'
          - description: If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
        consecutiveDatapointsToClear:
          allOf:
          - $ref: '#/components/schemas/ConsecutiveDatapointsToClear'
          - description: If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
        statisticalThreshold:
          allOf:
          - $ref: '#/components/schemas/StatisticalThreshold'
          - description: A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
        mlDetectionConfig:
          allOf:
          - $ref: '#/components/schemas/MachineLearningDetectionConfig'
          - description: ' The configuration of an ML Detect '
      description: The criteria by which the behavior is determined to be normal.
    UnsignedLong:
      type: integer
      minimum: 0
    MachineLearningDetectionConfig:
      type: object
      required:
      - confidenceLevel
      properties:
        confidenceLevel:
          allOf:
          - $ref: '#/components/schemas/ConfidenceLevel'
          - description: ' The sensitivity of anomalous behavior evaluation. Can be <code>Low</code>, <code>Medium</code>, or <code>High</code>. '
      description: ' The configuration of an ML Detect Security Profile. '
    MetricDimension:
      type: object
      required:
      - dimensionName
      properties:
        dimensionName:
          allOf:
          - $ref: '#/components/schemas/DimensionName'
          - description: A unique identifier for the dimension.
        operator:
          allOf:
          - $ref: '#/components/schemas/DimensionValueOperator'
          - description: 'Defines how the <code>dimensionValues</code> of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the <code>IN</code> operator, a message will be counted only if its topic matches one of the topic filters. With <code>NOT_IN</code> operator, a message will be counted only if it doesn''t match any of the topic filters. The operator is optional: if it''s not provided (is <code>null</code>), it will be interpreted as <code>IN</code>.'
      description: The dimension of a metric.
    VerificationState:
      type: string
      enum:
      - FALSE_POSITIVE
      - BENIGN_POSITIVE
      - TRUE_POSITIVE
      - UNKNOWN
    ViolationEvents:
      type: array
      items:
        $ref: '#/components/schemas/ViolationEvent'
    DurationSeconds:
      type: integer
    ConfidenceLevel:
      type: string
      enum:
      - LOW
      - MEDIUM
      - HIGH
    ComparisonOperator:
      type: string
      enum:
      - less-than
      - less-than-equals
      - greater-than
      - greater-than-equals
      - in-cidr-set
      - not-in-cidr-set
      - in-port-set
      - not-in-port-set
      - in-set
      - not-in-set
    SuppressAlerts:
      type: boolean
    NextToken:
      type: string
    MetricValue:
      type: object
      properties:
        count:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: If the <code>comparisonOperator</code> calls for a numeric value, use this to specify that numeric value to be compared with the <code>metric</code>.
        cidrs:
          allOf:
          - $ref: '#/components/schemas/Cidrs'
          - description: If the <code>comparisonOperator</code> calls for a set of CIDRs, use this to specify that set to be compared with the <code>metric</code>.
        ports:
          allOf:
          - $ref: '#/components/schemas/Ports'
          - description: If the <code>comparisonOperator</code> calls for a set of ports, use this to specify that set to be compared with the <code>metric</code>.
        number:
          allOf:
          - $ref: '#/components/schemas/Number'
          - description: ' The numeral value of a metric. '
        numbers:
          allOf:
          - $ref: '#/components/schemas/NumberList'
          - description: ' The numeral values of a metric. '
        strings:
          allOf:
          - $ref: '#/components/schemas/StringList'
          - description: ' The string values of a metric. '
      description: The value to be compared with the <code>metric</code>.
    ConsecutiveDatapointsToAlarm:
      type: integer
      minimum: 1
      maximum: 10
    DimensionName:
      type: string
      pattern: '[a-zA-Z0-9:_-]+'
      minLength: 1
      maxLength: 128
    VerificationStateDescription:
      type: string
      pattern: '[^\p{Cntrl}]*'
      maxLength: 1000
    ViolationId:
      type: string
      pattern: '[a-zA-Z0-9\-]+'
      minLength: 1
      maxLength: 128
    Timestamp:
      type: string
      format: date-time
    Behavior:
      type: object
      required:
      - name
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/BehaviorName'
          - description: The name you've given to the behavior.
        metric:
          allOf:
          - $ref: '#/components/schemas/BehaviorMetric'
          - description: What is measured by the behavior.
        metricDimension:
          allOf:
          - $ref: '#/components/schemas/MetricDimension'
          - description: The dimension for a metric in your behavior. For example, using a <code>TOPIC_FILTER</code> dimension, you can narrow down the scope of the metric to only MQTT topics where the name matches the pattern specified in the dimension. This can't be used with custom metrics.
        criteria:
          allOf:
          - $ref: '#/components/schemas/BehaviorCriteria'
          - description: The criteria that determine if a device is behaving normally in regard to the <code>metric</code>.
        suppressAlerts:
          allOf:
          - $ref: '#/components/schemas/SuppressAlerts'
          - description: ' Suppresses alerts. '
      description: A Device Defender security profile behavior.
    Ports:
      type: array
      items:
        $ref: '#/components/schemas/Port'
    StringList:
      type: array
      items:
        $ref: '#/components/schemas/stringValue'
    stringValue:
      type: string
    SecurityProfileName:
      type: string
      pattern: '[a-zA-Z0-9:_-]+'
      minLength: 1
      maxLength: 128
    ThrottlingException: {}
    ListViolationEventsResponse:
      type: object
      properties:
        violationEvents:
          allOf:
          - $ref: '#/components/schemas/ViolationEvents'
          - description: The security profile violation alerts issued for this account during the given time period, potentially filtered by security profile, behavior violated, or thing (device) violating.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
    InternalFailureException: {}
    ViolationEventType:
      type: string
      enum:
      - in-alarm
      - alarm-cleared
      - alarm-invalidated
    ViolationEvent:
      type: object
      properties:
        violationId:
          allOf:
          - $ref: '#/components/schemas/ViolationId'
          - description: The ID of the violation event.
        thingName:
          allOf:
          - $ref: '#/components/schemas/DeviceDefenderThingName'
          - description: The name of the thing responsible for the violation event.
        securityProfileName:
          allOf:
          - $ref: '#/components/schemas/SecurityProfileName'
          - description: The name of the security profile whose behavior was violated.
        behavior:
          allOf:
          - $ref: '#/components/schemas/Behavior'
          - description: The behavior that was violated.
        metricValue:
          allOf:
          - $ref: '#/components/schemas/MetricValue'
          - description: The value of the metric (the measurement).
        violationEventAdditionalInfo:
          allOf:
          - $ref: '#/components/schemas/ViolationEventAdditionalInfo'
          - description: ' The details of a violation event. '
        violationEventType:
          allOf:
          - $ref: '#/components/schemas/ViolationEventType'
          - description: The type of violation event.
        verificationState:
          allOf:
          - $ref: '#/components/schemas/VerificationState'
          - description: The verification state of the violation (detect alarm).
        verificationStateDescription:
          allOf:
          - $ref: '#/components/schemas/VerificationStateDescription'
          - description: The description of the verification state of the violation.
        violationEventTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time the violation event occurred.
      description: Information about a Device Defender security profile behavior violation.
    StatisticalThreshold:
      type: object
      properties:
        statistic:
          allOf:
          - $ref: '#/components/schemas/EvaluationStatistic'
          - description: The percentile that resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (<code>durationSeconds</code>) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (<code>comparisonOperator</code>) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.
      description: A statistical ranking (percentile) that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
    BehaviorMetric:
      type: string
    Cidr:
      type: string
      pattern: '[a-fA-F0-9:\.\/]+'
      minLength: 2
      maxLength: 43
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/iot/
x-hasEquivalentPaths: true