Amazon IoT Events Analysis API

openapi: 3.2.0
info:
  version: 1.0.0
  x-release: v4
  title: AWS IoT Events Alarm Models Analysis API
  description: AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API operations to create, read, update, and delete inputs and detector models, and to list their versions.
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    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: iotevents
  x-aws-signingName: iotevents
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iotevents-2018-07-27.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    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://iotevents.{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 Events multi-region endpoint
- url: https://iotevents.{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 Events multi-region endpoint
- url: http://iotevents.{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 Events endpoint for China (Beijing) and China (Ningxia)
- url: https://iotevents.{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 Events endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Analysis
paths:
  /analysis/detector-models/{analysisId}:
    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: DescribeDetectorModelAnalysis
      description: <p>Retrieves runtime information about a detector model analysis.</p> <note> <p>After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.</p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDetectorModelAnalysisResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '484':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: analysisId
        in: path
        required: true
        description: The ID of the analysis result that you want to retrieve.
        schema:
          type: string
      summary: Amazon IoT Events Describe Detector Model Analysis
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Analysis
  /analysis/detector-models/{analysisId}/results:
    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: GetDetectorModelAnalysisResults
      description: <p>Retrieves one or more analysis results of the detector model.</p> <note> <p>After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.</p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDetectorModelAnalysisResultsResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '484':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: analysisId
        in: path
        required: true
        description: The ID of the analysis result that you want to retrieve.
        schema:
          type: string
      - name: nextToken
        in: query
        required: false
        description: The token that you can use to return the next set of results.
        schema:
          type: string
      - name: maxResults
        in: query
        required: false
        description: The maximum number of results to be returned per request.
        schema:
          type: integer
      summary: Amazon IoT Events Get Detector Model Analysis Results
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Analysis
  /analysis/detector-models/:
    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'
    post:
      operationId: StartDetectorModelAnalysis
      description: Performs an analysis of your detector model. For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html">Troubleshooting a detector model</a> in the <i>AWS IoT Events Developer Guide</i>.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartDetectorModelAnalysisResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '484':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - detectorModelDefinition
              properties:
                detectorModelDefinition:
                  description: Information that defines how a detector operates.
                  type: object
                  properties:
                    states:
                      allOf:
                      - $ref: '#/components/schemas/States'
                      - description: Information about the states of the detector.
                    initialStateName:
                      allOf:
                      - $ref: '#/components/schemas/StateName'
                      - description: The state that is entered at the creation of each detector (instance).
      summary: Amazon IoT Events Start Detector Model Analysis
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Analysis
components:
  schemas:
    VariableValue:
      type: string
      minLength: 1
      maxLength: 1024
    AssetPropertyQuality:
      type: string
    DynamoKeyField:
      type: string
    IotEventsAction:
      type: object
      required:
      - inputName
      properties:
        inputName:
          allOf:
          - $ref: '#/components/schemas/InputName'
          - description: The name of the AWS IoT Events input where the data is sent.
        payload:
          allOf:
          - $ref: '#/components/schemas/Payload'
          - description: You can configure the action payload when you send a message to an AWS IoT Events input.
      description: Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
    Event:
      type: object
      required:
      - eventName
      properties:
        eventName:
          allOf:
          - $ref: '#/components/schemas/EventName'
          - description: The name of the event.
        condition:
          allOf:
          - $ref: '#/components/schemas/Condition'
          - description: Optional. The Boolean expression that, when TRUE, causes the <code>actions</code> to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).
        actions:
          allOf:
          - $ref: '#/components/schemas/Actions'
          - description: The actions to be performed.
      description: Specifies the <code>actions</code> to be performed when the <code>condition</code> evaluates to TRUE.
    SNSTopicPublishAction:
      type: object
      required:
      - targetArn
      properties:
        targetArn:
          allOf:
          - $ref: '#/components/schemas/AmazonResourceName'
          - description: The ARN of the Amazon SNS target where the message is sent.
        payload:
          allOf:
          - $ref: '#/components/schemas/Payload'
          - description: You can configure the action payload when you send a message as an Amazon SNS push notification.
      description: Information required to publish the Amazon SNS message.
    AssetPropertyEntryId:
      type: string
    ContentExpression:
      type: string
      minLength: 1
    UseBase64:
      type: boolean
    OnInputLifecycle:
      type: object
      properties:
        events:
          allOf:
          - $ref: '#/components/schemas/Events'
          - description: Specifies the actions performed when the <code>condition</code> evaluates to TRUE.
        transitionEvents:
          allOf:
          - $ref: '#/components/schemas/TransitionEvents'
          - description: Specifies the actions performed, and the next state entered, when a <code>condition</code> evaluates to TRUE.
      description: Specifies the actions performed when the <code>condition</code> evaluates to TRUE.
    InternalFailureException: {}
    VariableName:
      type: string
      pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
      minLength: 1
      maxLength: 128
    AssetPropertyBooleanValue:
      type: string
    AssetPropertyId:
      type: string
    ResourceNotFoundException: {}
    FirehoseAction:
      type: object
      required:
      - deliveryStreamName
      properties:
        deliveryStreamName:
          allOf:
          - $ref: '#/components/schemas/DeliveryStreamName'
          - description: The name of the Kinesis Data Firehose delivery stream where the data is written.
        separator:
          allOf:
          - $ref: '#/components/schemas/FirehoseSeparator'
          - description: 'A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: ''\n'' (newline), ''\t'' (tab), ''\r\n'' (Windows newline), '','' (comma).'
        payload:
          allOf:
          - $ref: '#/components/schemas/Payload'
          - description: You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.
      description: Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
    ThrottlingException: {}
    GetDetectorModelAnalysisResultsResponse:
      type: object
      properties:
        analysisResults:
          allOf:
          - $ref: '#/components/schemas/AnalysisResults'
          - description: Contains information about one or more analysis results.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The token that you can use to return the next set of results, or <code>null</code> if there are no more results.
    DynamoDBv2Action:
      type: object
      required:
      - tableName
      properties:
        tableName:
          allOf:
          - $ref: '#/components/schemas/DynamoTableName'
          - description: The name of the DynamoDB table.
        payload:
          $ref: '#/components/schemas/Payload'
      description: '<p>Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.</p> <p>You must use expressions for all parameters in <code>DynamoDBv2Action</code>. The expressions accept literals, operators, functions, references, and substitution templates.</p> <p class="title"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>tableName</code> parameter can be <code>''GreenhouseTemperatureTable''</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>tableName</code> parameter can be <code>$variable.ddbtableName</code>.</p> </li> <li> <p>For a substitution template, you must use <code>${}</code>, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>contentExpression</code> parameter in <code>Payload</code> uses a substitution template. </p> <p> <code>''{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}''</code> </p> </li> <li> <p>For a string concatenation, you must use <code>+</code>. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>tableName</code> parameter uses a string concatenation. </p> <p> <code>''GreenhouseTemperatureTable '' + $input.GreenhouseInput.date</code> </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> <p>The value for the <code>type</code> parameter in <code>Payload</code> must be <code>JSON</code>.</p>'
    AnalysisResults:
      type: array
      items:
        $ref: '#/components/schemas/AnalysisResult'
    Events:
      type: array
      items:
        $ref: '#/components/schemas/Event'
    IotSiteWiseAction:
      type: object
      properties:
        entryId:
          allOf:
          - $ref: '#/components/schemas/AssetPropertyEntryId'
          - description: A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
        assetId:
          allOf:
          - $ref: '#/components/schemas/AssetId'
          - description: The ID of the asset that has the specified property.
        propertyId:
          allOf:
          - $ref: '#/components/schemas/AssetPropertyId'
          - description: The ID of the asset property.
        propertyAlias:
          allOf:
          - $ref: '#/components/schemas/AssetPropertyAlias'
          - description: The alias of the asset property.
        propertyValue:
          allOf:
          - $ref: '#/components/schemas/AssetPropertyValue'
          - description: 'The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information. '
      description: <p>Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.</p> <p>You must use expressions for all parameters in <code>IotSiteWiseAction</code>. The expressions accept literals, operators, functions, references, and substitutions templates.</p> <p class="title"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>propertyAlias</code> parameter can be <code>'/company/windfarm/3/turbine/7/temperature'</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>assetId</code> parameter can be <code>$input.TurbineInput.assetId1</code>.</p> </li> <li> <p>For a substitution template, you must use <code>${}</code>, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>propertyAlias</code> parameter uses a substitution template. </p> <p> <code>'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'</code> </p> </li> </ul> <p>You must specify either <code>propertyAlias</code> or both <code>assetId</code> and <code>propertyId</code> to identify the target asset property in AWS IoT SiteWise.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p>
    AssetPropertyTimeInSeconds:
      type: string
    QueueUrl:
      type: string
    Payload:
      type: object
      required:
      - contentExpression
      - type
      properties:
        contentExpression:
          allOf:
          - $ref: '#/components/schemas/ContentExpression'
          - description: The content of the payload. You can use a string expression that includes quoted strings (<code>'&lt;string&gt;'</code>), variables (<code>$variable.&lt;variable-name&gt;</code>), input values (<code>$input.&lt;input-name&gt;.&lt;path-to-datum&gt;</code>), string concatenations, and quoted strings that contain <code>${}</code> as the content. The recommended maximum size of a content expression is 1 KB.
        type:
          allOf:
          - $ref: '#/components/schemas/PayloadType'
          - description: The value of the payload type can be either <code>STRING</code> or <code>JSON</code>.
      description: <p>Information needed to configure the payload.</p> <p>By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use <code>contentExpression</code>.</p>
    DynamoOperation:
      type: string
    TransitionEvent:
      type: object
      required:
      - eventName
      - condition
      - nextState
      properties:
        eventName:
          allOf:
          - $ref: '#/components/schemas/EventName'
          - description: The name of the transition event.
        condition:
          allOf:
          - $ref: '#/components/schemas/Condition'
          - description: Required. A Boolean expression that when TRUE causes the actions to be performed and the <code>nextState</code> to be entered.
        actions:
          allOf:
          - $ref: '#/components/schemas/Actions'
          - description: The actions to be performed.
        nextState:
          allOf:
          - $ref: '#/components/schemas/StateName'
          - description: The next state to enter.
      description: Specifies the actions performed and the next state entered when a <code>condition</code> evaluates to TRUE.
    DeliveryStreamName:
      type: string
    StateName:
      type: string
      minLength: 1
      maxLength: 128
    AssetPropertyVariant:
      type: object
      properties:
        stringValue:
          allOf:
          - $ref: '#/components/schemas/AssetPropertyStringValue'
          - description: The asset property value is a string. You must use an expression, and the evaluated result should be a string.
        integerValue:
          allOf:
          - $ref: '#/components/schemas/AssetPropertyIntegerValue'
          - description: The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
        doubleValue:
          allOf:
          - $ref: '#/components/schemas/AssetPropertyDoubleValue'
          - description: The asset property value is a double. You must use an expression, and the evaluated result should be a double.
        booleanValue:
          allOf:
          - $ref: '#/components/schemas/AssetPropertyBooleanValue'
          - description: The asset property value is a Boolean value that must be <code>'TRUE'</code> or <code>'FALSE'</code>. You must use an expression, and the evaluated result should be a Boolean value.
      description: <p>A structure that contains an asset property value. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html">Variant</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>You must use expressions for all parameters in <code>AssetPropertyVariant</code>. The expressions accept literals, operators, functions, references, and substitution templates.</p> <p class="title"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>integerValue</code> parameter can be <code>'100'</code>.</p> </li> <li> <p>For references, you must specify either variables or parameters. For example, the value for the <code>booleanValue</code> parameter can be <code>$variable.offline</code>.</p> </li> <li> <p>For a substitution template, you must use <code>${}</code>, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. </p> <p>In the following example, the value for the <code>doubleValue</code> parameter uses a substitution template. </p> <p> <code>'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'</code> </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> <p>You must specify one of the following value types, depending on the <code>dataType</code> of the specified asset property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html">AssetProperty</a> in the <i>AWS IoT SiteWise API Reference</i>.</p>
    Action:
      type: object
      properties:
        setVariable:
          allOf:
          - $ref: '#/components/schemas/SetVariableAction'
          - description: Sets a variable to a specified value.
        sns:
          allOf:
          - $ref: '#/components/schemas/SNSTopicPublishAction'
          - description: Sends an Amazon SNS message.
        iotTopicPublish:
          allOf:
          - $ref: '#/components/schemas/IotTopicPublishAction'
          - description: Publishes an MQTT message with the given topic to the AWS IoT message broker.
        setTimer:
          allOf:
          - $ref: '#/components/schemas/SetTimerAction'
          - description: Information needed to set the timer.
        clearTimer:
          allOf:
          - $ref: '#/components/schemas/ClearTimerAction'
          - description: Information needed to clear the timer.
        resetTimer:
          allOf:
          - $ref: '#/components/schemas/ResetTimerAction'
          - description: Information needed to reset the timer.
        lambda:
          allOf:
          - $ref: '#/components/schemas/LambdaAction'
          - description: Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
        iotEvents:
          allOf:
          - $ref: '#/components/schemas/IotEventsAction'
          - description: Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
        sqs:
          allOf:
          - $ref: '#/components/schemas/SqsAction'
          - description: Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
        firehose:
          allOf:
          - $ref: '#/components/schemas/FirehoseAction'
          - description: Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
        dynamoDB:
          allOf:
          - $ref: '#/components/schemas/DynamoDBAction'
          - description: Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html">Actions</a> in <i>AWS IoT Events Developer Guide</i>.
        dynamoDBv2:
          allOf:
          - $ref: '#/components/schemas/DynamoDBv2Action'
          - description: Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html">Actions</a> in <i>AWS IoT Events Developer Guide</i>.
        iotSiteWise:
          allOf:
          - $ref: '#/components/schemas/IotSiteWiseAction'
          - description: Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .
      description: An action to be performed when the <code>condition</code> is TRUE.
    AssetPropertyValue:
      type: object
      properties:
        value:
          allOf:
          - $ref: '#/components/schemas/AssetPropertyVariant'
          - description: The value to send to an asset property.
        timestamp:
          allOf:
          - $ref: '#/components/schemas/AssetPropertyTimestamp'
          - description: The timestamp associated with the asset property value. The default is the current event time.
        quality:
          allOf:
          - $ref: '#/components/schemas/AssetPropertyQuality'
          - description: The quality of the asset property value. The value must be <code>'GOOD'</code>, <code>'BAD'</code>, or <code>'UNCERTAIN'</code>.
      description: <p>A structure that contains value information. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html">AssetPropertyValue</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>You must use expressions for all parameters in <code>AssetPropertyValue</code>. The expressions accept literals, operators, functions, references, and substitution templates.</p> <p class="title"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>quality</code> parameter can be <code>'GOOD'</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>quality</code> parameter can be <code>$input.TemperatureInput.sensorData.quality</code>.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p>
    AnalysisResultLocations:
      type: array
      items:
        $ref: '#/components/schemas/AnalysisResultLocation'
    StartDetectorModelAnalysisResponse:
      type: object
      properties:
        analysisId:
          allOf:
          - $ref: '#/components/schemas/AnalysisId'
          - description: The ID that you can 

# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-iot-events/refs/heads/main/openapi/amazon-iot-events-analysis-api-openapi.yml