Amazon IoT Events Detector Models API

openapi: 3.2.0
info:
  version: 1.0.0
  x-release: v4
  title: AWS IoT Events Alarm Models Detector Models 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: Detector Models
paths:
  /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: CreateDetectorModel
      description: Creates a detector model.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDetectorModelResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '482':
          description: ResourceAlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceAlreadyExistsException'
        '483':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '484':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '485':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '486':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - detectorModelName
              - detectorModelDefinition
              - roleArn
              properties:
                detectorModelName:
                  description: The name of the detector model.
                  type: string
                  pattern: ^[a-zA-Z0-9_-]+$
                  minLength: 1
                  maxLength: 128
                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).
                detectorModelDescription:
                  description: A brief description of the detector model.
                  type: string
                  maxLength: 128
                key:
                  description: The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.
                  type: string
                  pattern: ^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w- ]+`)|([\w\-]+)))*$
                  minLength: 1
                  maxLength: 128
                roleArn:
                  description: The ARN of the role that grants permission to AWS IoT Events to perform its operations.
                  type: string
                  minLength: 1
                  maxLength: 2048
                tags:
                  description: Metadata that can be used to manage the detector model.
                  type: array
                  items:
                    $ref: '#/components/schemas/Tag'
                evaluationMethod:
                  description: 'Information about the order in which events are evaluated and how actions are executed. '
                  type: string
                  enum:
                  - BATCH
                  - SERIAL
      summary: Amazon IoT Events Create Detector Model
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Detector Models
    get:
      operationId: ListDetectorModels
      description: Lists the detector models you have created. Only the metadata associated with each detector model is returned.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDetectorModelsResponse'
        '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'
        '483':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - 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
          minimum: 1
          maximum: 250
      summary: Amazon IoT Events List Detector Models
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Detector Models
  /detector-models/{detectorModelName}:
    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'
    delete:
      operationId: DeleteDetectorModel
      description: Deletes a detector model. Any active instances of the detector model are also deleted.
      responses:
        '204':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDetectorModelResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '484':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '485':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: detectorModelName
        in: path
        required: true
        description: The name of the detector model to be deleted.
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_-]+$
          minLength: 1
          maxLength: 128
      summary: Amazon IoT Events Delete Detector Model
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Detector Models
    get:
      operationId: DescribeDetectorModel
      description: Describes a detector model. If the <code>version</code> parameter is not specified, information about the latest version is returned.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDetectorModelResponse'
        '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: detectorModelName
        in: path
        required: true
        description: The name of the detector model.
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_-]+$
          minLength: 1
          maxLength: 128
      - name: version
        in: query
        required: false
        description: The version of the detector model.
        schema:
          type: string
          minLength: 1
          maxLength: 128
      summary: Amazon IoT Events Describe Detector Model
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Detector Models
    post:
      operationId: UpdateDetectorModel
      description: Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDetectorModelResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ResourceInUseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '484':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '485':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: detectorModelName
        in: path
        required: true
        description: The name of the detector model that is updated.
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_-]+$
          minLength: 1
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - detectorModelDefinition
              - roleArn
              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).
                detectorModelDescription:
                  description: A brief description of the detector model.
                  type: string
                  maxLength: 128
                roleArn:
                  description: The ARN of the role that grants permission to AWS IoT Events to perform its operations.
                  type: string
                  minLength: 1
                  maxLength: 2048
                evaluationMethod:
                  description: 'Information about the order in which events are evaluated and how actions are executed. '
                  type: string
                  enum:
                  - BATCH
                  - SERIAL
      summary: Amazon IoT Events Update Detector Model
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Detector Models
  /detector-models/{detectorModelName}/versions:
    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: ListDetectorModelVersions
      description: Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDetectorModelVersionsResponse'
        '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: detectorModelName
        in: path
        required: true
        description: The name of the detector model whose versions are returned.
        schema:
          type: string
          pattern: ^[a-zA-Z0-9_-]+$
          minLength: 1
          maxLength: 128
      - 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
          minimum: 1
          maximum: 250
      summary: Amazon IoT Events List Detector Model Versions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Detector Models
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: {}
    DetectorModel:
      type: object
      properties:
        detectorModelDefinition:
          allOf:
          - $ref: '#/components/schemas/DetectorModelDefinition'
          - description: Information that defines how a detector operates.
        detectorModelConfiguration:
          allOf:
          - $ref: '#/components/schemas/DetectorModelConfiguration'
          - description: Information about how the detector is configured.
      description: Information about the detector model.
    VariableName:
      type: string
      pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
      minLength: 1
      maxLength: 128
    AssetPropertyBooleanValue:
      type: string
    AssetPropertyId:
      type: string
    ResourceNotFoundException: {}
    DetectorModelArn:
      type: string
    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: {}
    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>'
    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
    ResourceAlreadyExistsException: {}
    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'
 

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