openapi: 3.0.0 info: version: '2018-07-27' x-release: v4 title: AWS IoT Events 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' 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 externalDocs: description: Amazon Web Services documentation url: 'https://docs.aws.amazon.com/iotevents/' 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) x-hasEquivalentPaths: true paths: /alarm-models: post: operationId: CreateAlarmModel description: 'Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateAlarmModelResponse' '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: - alarmModelName - roleArn - alarmRule properties: alarmModelName: description: A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model. type: string pattern: '^[a-zA-Z0-9_-]+$' minLength: 1 maxLength: 128 alarmModelDescription: description: A description that tells you what the alarm model detects. type: string maxLength: 128 roleArn: description: 'The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.' type: string minLength: 1 maxLength: 2048 tags: description: '

A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide.

You can create up to 50 tags for one alarm model.

' type: array items: $ref: '#/components/schemas/Tag' key: description: 'An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.' type: string pattern: '^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w- ]+`)|([\w\-]+)))*$' minLength: 1 maxLength: 128 severity: description: A non-negative integer that reflects the severity level of the alarm. type: integer minimum: 0 maximum: 2147483647 alarmRule: description: Defines when your alarm is invoked. type: object properties: simpleRule: allOf: - $ref: '#/components/schemas/SimpleRule' - description: A rule that compares an input property value to a threshold value with a comparison operator. alarmNotification: description: Contains information about one or more notification actions. type: object properties: notificationActions: allOf: - $ref: '#/components/schemas/NotificationActions' - description: Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model. alarmEventActions: description: Contains information about one or more alarm actions. type: object properties: alarmActions: allOf: - $ref: '#/components/schemas/AlarmActions' - description: Specifies one or more supported actions to receive notifications when the alarm state changes. alarmCapabilities: description: Contains the configuration information of alarm state changes. type: object properties: initializationConfiguration: allOf: - $ref: '#/components/schemas/InitializationConfiguration' - description: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model. acknowledgeFlow: allOf: - $ref: '#/components/schemas/AcknowledgeFlow' - description: Specifies whether to get notified for alarm state changes. summary: Amazon IoT Events Create Alarm Model x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: ListAlarmModels description: Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListAlarmModelsResponse' '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 Alarm Models x-microcks-operation: delay: 0 dispatcher: FALLBACK /detector-models: 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 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: 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 /inputs: post: operationId: CreateInput description: Creates an input. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateInputResponse' '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' '484': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - inputName - inputDefinition properties: inputName: description: The name you want to give to the input. type: string pattern: '^[a-zA-Z][a-zA-Z0-9_]*$' minLength: 1 maxLength: 128 inputDescription: description: A brief description of the input. type: string maxLength: 128 inputDefinition: description: The definition of the input. type: object properties: attributes: allOf: - $ref: '#/components/schemas/Attributes' - description: 'The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors that monitor this input. ' tags: description: Metadata that can be used to manage the input. type: array items: $ref: '#/components/schemas/Tag' summary: Amazon IoT Events Create Input x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: ListInputs description: Lists the inputs you have created. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListInputsResponse' '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 Inputs x-microcks-operation: delay: 0 dispatcher: FALLBACK '/alarm-models/{alarmModelName}': delete: operationId: DeleteAlarmModel description: Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone. responses: '204': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteAlarmModelResponse' '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: alarmModelName in: path required: true description: The name of the alarm model. schema: type: string pattern: '^[a-zA-Z0-9_-]+$' minLength: 1 maxLength: 128 summary: Amazon IoT Events Delete Alarm Model x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: DescribeAlarmModel description: 'Retrieves information about an alarm model. If you don''t specify a value for the alarmModelVersion parameter, the latest version is returned.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeAlarmModelResponse' '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: alarmModelName in: path required: true description: The name of the alarm model. schema: type: string pattern: '^[a-zA-Z0-9_-]+$' minLength: 1 maxLength: 128 - name: version in: query required: false description: The version of the alarm model. schema: type: string minLength: 1 maxLength: 128 summary: Amazon IoT Events Describe Alarm Model x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: UpdateAlarmModel description: Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateAlarmModelResponse' '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: alarmModelName in: path required: true description: The name of the alarm model. schema: type: string pattern: '^[a-zA-Z0-9_-]+$' minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - roleArn - alarmRule properties: alarmModelDescription: description: The description of the alarm model. type: string maxLength: 128 roleArn: description: 'The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.' type: string minLength: 1 maxLength: 2048 severity: description: A non-negative integer that reflects the severity level of the alarm. type: integer minimum: 0 maximum: 2147483647 alarmRule: description: Defines when your alarm is invoked. type: object properties: simpleRule: allOf: - $ref: '#/components/schemas/SimpleRule' - description: A rule that compares an input property value to a threshold value with a comparison operator. alarmNotification: description: Contains information about one or more notification actions. type: object properties: notificationActions: allOf: - $ref: '#/components/schemas/NotificationActions' - description: Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model. alarmEventActions: description: Contains information about one or more alarm actions. type: object properties: alarmActions: allOf: - $ref: '#/components/schemas/AlarmActions' - description: Specifies one or more supported actions to receive notifications when the alarm state changes. alarmCapabilities: description: Contains the configuration information of alarm state changes. type: object properties: initializationConfiguration: allOf: - $ref: '#/components/schemas/InitializationConfiguration' - description: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model. acknowledgeFlow: allOf: - $ref: '#/components/schemas/AcknowledgeFlow' - description: Specifies whether to get notified for alarm state changes. summary: Amazon IoT Events Update Alarm Model x-microcks-operation: delay: 0 dispatcher: FALLBACK '/detector-models/{detectorModelName}': 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 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: DescribeDetectorModel description: 'Describes a detector model. If the version 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 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 '/inputs/{inputName}': delete: operationId: DeleteInput description: Deletes an input. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteInputResponse' '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' '485': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' parameters: - name: inputName in: path required: true description: The name of the input to delete. schema: type: string pattern: '^[a-zA-Z][a-zA-Z0-9_]*$' minLength: 1 maxLength: 128 summary: Amazon IoT Events Delete Input x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: DescribeInput description: Describes an input. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeInputResponse' '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: inputName in: path required: true description: The name of the input. schema: type: string pattern: '^[a-zA-Z][a-zA-Z0-9_]*$' minLength: 1 maxLength: 128 summary: Amazon IoT Events Describe Input x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateInput description: Updates an input. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateInputResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '485': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' parameters: - name: inputName in: path required: true description: The name of the input you want to update. schema: type: string pattern: '^[a-zA-Z][a-zA-Z0-9_]*$' minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - inputDefinition properties: inputDescription: description: A brief description of the input. type: string maxLength: 128 inputDefinition: description: The definition of the input. type: object properties: attributes: allOf: - $ref: '#/components/schemas/Attributes' - description: 'The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors that monitor this input. ' summary: Amazon IoT Events Update Input x-microcks-operation: delay: 0 dispatcher: FALLBACK '/analysis/detector-models/{analysisId}': get: operationId: DescribeDetectorModelAnalysis description: '

Retrieves runtime information about a detector model analysis.

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

' 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 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' /logging: get: operationId: DescribeLoggingOptions description: Retrieves the current settings of the AWS IoT Events logging options. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeLoggingOptionsResponse' '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: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' '485': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' parameters: [] summary: Amazon IoT Events Describe Logging Options x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' put: operationId: PutLoggingOptions description: '

Sets or updates the AWS IoT Events logging options.

If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. If you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.

' responses: '200': description: Success '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' '484': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' '485': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - loggingOptions properties: loggingOptions: description: The values of the AWS IoT Events logging options. type: object properties: roleArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The ARN of the role that grants permission to AWS IoT Events to perform logging. level: allOf: - $ref: '#/components/schemas/LoggingLevel' - description: The logging level. enabled: allOf: - $ref: '#/components/schemas/LoggingEnabled' - description: 'If TRUE, logging is enabled for AWS IoT Events.' detectorDebugOptions: allOf: - $ref: '#/components/schemas/DetectorDebugOptions' - description: Information that identifies those detector models and their detectors (instances) for which the logging level is given. summary: Amazon IoT Events Put Logging Options x-microcks-operation: delay: 0 dispatcher: FALLBACK '/analysis/detector-models/{analysisId}/results': get: operationId: GetDetectorModelAnalysisResults description: '

Retrieves one or more analysis results of the detector model.

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

' 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 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' '/alarm-models/{alarmModelName}/versions': get: operationId: ListAlarmModelVersions description: Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListAlarmModelVersionsResponse' '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: alarmModelName in: path required: true description: The name of the alarm model. 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 Alarm Model Versions x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' '/detector-models/{detectorModelName}/versions': 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 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' /input-routings: post: operationId: ListInputRoutings description: ' Lists one or more input routings. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListInputRoutingsResponse' '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' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - inputIdentifier properties: inputIdentifier: description: ' The identifer of the input. ' type: object properties: iotEventsInputIdentifier: allOf: - $ref: '#/components/schemas/IotEventsInputIdentifier' - description: ' The identifier of the input routed to AWS IoT Events. ' iotSiteWiseInputIdentifier: allOf: - $ref: '#/components/schemas/IotSiteWiseInputIdentifier' - description: ' The identifer of the input routed from AWS IoT SiteWise. ' maxResults: description: ' The maximum number of results to be returned per request. ' type: integer minimum: 1 maximum: 250 nextToken: description: ' The token that you can use to return the next set of results. ' type: string summary: Amazon IoT Events List Input Routings x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /tags#resourceArn: get: operationId: ListTagsForResource description: Lists the tags (metadata) you have assigned to the resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' parameters: - name: resourceArn in: query required: true description: The ARN of the resource. schema: type: string minLength: 1 maxLength: 2048 summary: Amazon IoT Events List Tags for Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: TagResource description: Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '485': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' parameters: - name: resourceArn in: query required: true description: The ARN of the resource. schema: type: string minLength: 1 maxLength: 2048 requestBody: required: true content: application/json: schema: type: object required: - tags properties: tags: description: The new or modified tags for the resource. type: array items: $ref: '#/components/schemas/Tag' summary: Amazon IoT Events Tag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK /analysis/detector-models/: post: operationId: StartDetectorModelAnalysis description: 'Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.' 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 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' /tags#resourceArn&tagKeys: delete: operationId: UntagResource description: Removes the given tags (metadata) from the resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UntagResourceResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' parameters: - name: resourceArn in: query required: true description: The ARN of the resource. schema: type: string minLength: 1 maxLength: 2048 - name: tagKeys in: query required: true description: A list of the keys of the tags to be removed from the resource. schema: type: array items: $ref: '#/components/schemas/TagKey' summary: Amazon IoT Events Untag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential 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-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders 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 schemas: CreateAlarmModelResponse: type: object properties: creationTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The time the alarm model was created, in the Unix epoch format.' alarmModelArn: allOf: - $ref: '#/components/schemas/AlarmModelArn' - description: 'The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.' alarmModelVersion: allOf: - $ref: '#/components/schemas/AlarmModelVersion' - description: The version of the alarm model. lastUpdateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The time the alarm model was last updated, in the Unix epoch format.' status: allOf: - $ref: '#/components/schemas/AlarmModelVersionStatus' - description: '

The status of the alarm model. The status can be one of the following values:

' Tag: type: object required: - key - value properties: key: allOf: - $ref: '#/components/schemas/TagKey' - description: The tag's key. value: allOf: - $ref: '#/components/schemas/TagValue' - description: The tag's value. description: Metadata that can be used to manage the resource. SimpleRule: type: object required: - inputProperty - comparisonOperator - threshold properties: inputProperty: allOf: - $ref: '#/components/schemas/InputProperty' - description: The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property. comparisonOperator: allOf: - $ref: '#/components/schemas/ComparisonOperator' - description: The comparison operator. threshold: allOf: - $ref: '#/components/schemas/Threshold' - description: The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute. description: A rule that compares an input property value to a threshold value with a comparison operator. NotificationActions: type: array items: $ref: '#/components/schemas/NotificationAction' minItems: 1 AlarmActions: type: array items: $ref: '#/components/schemas/AlarmAction' InitializationConfiguration: type: object required: - disabledOnInitialization properties: disabledOnInitialization: allOf: - $ref: '#/components/schemas/DisabledOnInitialization' - description: 'The value must be TRUE or FALSE. If FALSE, all alarm instances created based on the alarm model are activated. The default value is TRUE.' description: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model. AcknowledgeFlow: type: object required: - enabled properties: enabled: allOf: - $ref: '#/components/schemas/AcknowledgeFlowEnabled' - description: 'The value must be TRUE or FALSE. If TRUE, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to NORMAL. If FALSE, you won''t receive notifications. The alarm automatically changes to the NORMAL state when the input property value returns to the specified range.' description: Specifies whether to get notified for alarm state changes. InvalidRequestException: {} ResourceInUseException: {} ResourceAlreadyExistsException: {} LimitExceededException: {} ThrottlingException: {} InternalFailureException: {} ServiceUnavailableException: {} CreateDetectorModelResponse: type: object properties: detectorModelConfiguration: allOf: - $ref: '#/components/schemas/DetectorModelConfiguration' - description: Information about how the detector model is configured. States: type: array items: $ref: '#/components/schemas/State' minItems: 1 StateName: type: string minLength: 1 maxLength: 128 CreateInputResponse: type: object properties: inputConfiguration: allOf: - $ref: '#/components/schemas/InputConfiguration' - description: Information about the configuration of the input. Attributes: type: array items: $ref: '#/components/schemas/Attribute' minItems: 1 maxItems: 200 DeleteAlarmModelResponse: type: object properties: {} ResourceNotFoundException: {} DeleteDetectorModelResponse: type: object properties: {} DeleteInputResponse: type: object properties: {} DescribeAlarmModelResponse: type: object properties: creationTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The time the alarm model was created, in the Unix epoch format.' alarmModelArn: allOf: - $ref: '#/components/schemas/AlarmModelArn' - description: 'The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.' alarmModelVersion: allOf: - $ref: '#/components/schemas/AlarmModelVersion' - description: The version of the alarm model. lastUpdateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The time the alarm model was last updated, in the Unix epoch format.' status: allOf: - $ref: '#/components/schemas/AlarmModelVersionStatus' - description: '

The status of the alarm model. The status can be one of the following values:

' statusMessage: allOf: - $ref: '#/components/schemas/StatusMessage' - description: ' Contains information about the status of the alarm model. ' alarmModelName: allOf: - $ref: '#/components/schemas/AlarmModelName' - description: The name of the alarm model. alarmModelDescription: allOf: - $ref: '#/components/schemas/AlarmModelDescription' - description: The description of the alarm model. roleArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: 'The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.' key: allOf: - $ref: '#/components/schemas/AttributeJsonPath' - description: 'An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.' severity: allOf: - $ref: '#/components/schemas/Severity' - description: A non-negative integer that reflects the severity level of the alarm. alarmRule: allOf: - $ref: '#/components/schemas/AlarmRule' - description: Defines when your alarm is invoked. alarmNotification: allOf: - $ref: '#/components/schemas/AlarmNotification' - description: Contains information about one or more notification actions. alarmEventActions: allOf: - $ref: '#/components/schemas/AlarmEventActions' - description: Contains information about one or more alarm actions. alarmCapabilities: allOf: - $ref: '#/components/schemas/AlarmCapabilities' - description: Contains the configuration information of alarm state changes. DescribeDetectorModelResponse: type: object properties: detectorModel: allOf: - $ref: '#/components/schemas/DetectorModel' - description: Information about the detector model. DescribeDetectorModelAnalysisResponse: type: object properties: status: allOf: - $ref: '#/components/schemas/AnalysisStatus' - description: '

The status of the analysis activity. The status can be one of the following values:

' DescribeInputResponse: type: object properties: input: allOf: - $ref: '#/components/schemas/Input' - description: Information about the input. DescribeLoggingOptionsResponse: type: object properties: loggingOptions: allOf: - $ref: '#/components/schemas/LoggingOptions' - description: The current settings of the AWS IoT Events logging options. UnsupportedOperationException: {} 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 null if there are no more results.' ListAlarmModelVersionsResponse: type: object properties: alarmModelVersionSummaries: allOf: - $ref: '#/components/schemas/AlarmModelVersionSummaries' - description: A list that summarizes each alarm model version. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'The token that you can use to return the next set of results, or null if there are no more results.' ListAlarmModelsResponse: type: object properties: alarmModelSummaries: allOf: - $ref: '#/components/schemas/AlarmModelSummaries' - description: A list that summarizes each alarm model. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'The token that you can use to return the next set of results, or null if there are no more results.' ListDetectorModelVersionsResponse: type: object properties: detectorModelVersionSummaries: allOf: - $ref: '#/components/schemas/DetectorModelVersionSummaries' - description: Summary information about the detector model versions. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'The token that you can use to return the next set of results, or null if there are no more results.' ListDetectorModelsResponse: type: object properties: detectorModelSummaries: allOf: - $ref: '#/components/schemas/DetectorModelSummaries' - description: Summary information about the detector models. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'The token that you can use to return the next set of results, or null if there are no more results.' ListInputRoutingsResponse: type: object properties: routedResources: allOf: - $ref: '#/components/schemas/RoutedResources' - description: ' Summary information about the routed resources. ' nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: ' The token that you can use to return the next set of results, or null if there are no more results. ' IotEventsInputIdentifier: type: object required: - inputName properties: inputName: allOf: - $ref: '#/components/schemas/InputName' - description: ' The name of the input routed to AWS IoT Events. ' description: ' The identifier of the input routed to AWS IoT Events. ' IotSiteWiseInputIdentifier: type: object properties: iotSiteWiseAssetModelPropertyIdentifier: allOf: - $ref: '#/components/schemas/IotSiteWiseAssetModelPropertyIdentifier' - description: ' The identifier of the AWS IoT SiteWise asset model property. ' description: ' The identifer of the input routed from AWS IoT SiteWise. ' ListInputsResponse: type: object properties: inputSummaries: allOf: - $ref: '#/components/schemas/InputSummaries' - description: Summary information about the inputs. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'The token that you can use to return the next set of results, or null if there are no more results.' ListTagsForResourceResponse: type: object properties: tags: allOf: - $ref: '#/components/schemas/Tags' - description: The list of tags assigned to the resource. AmazonResourceName: type: string minLength: 1 maxLength: 2048 LoggingLevel: type: string enum: - ERROR - INFO - DEBUG LoggingEnabled: type: boolean DetectorDebugOptions: type: array items: $ref: '#/components/schemas/DetectorDebugOption' minItems: 1 StartDetectorModelAnalysisResponse: type: object properties: analysisId: allOf: - $ref: '#/components/schemas/AnalysisId' - description: The ID that you can use to retrieve the analysis result. TagResourceResponse: type: object properties: {} UntagResourceResponse: type: object properties: {} TagKey: type: string minLength: 1 maxLength: 128 UpdateAlarmModelResponse: type: object properties: creationTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The time the alarm model was created, in the Unix epoch format.' alarmModelArn: allOf: - $ref: '#/components/schemas/AlarmModelArn' - description: 'The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.' alarmModelVersion: allOf: - $ref: '#/components/schemas/AlarmModelVersion' - description: The version of the alarm model. lastUpdateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The time the alarm model was last updated, in the Unix epoch format.' status: allOf: - $ref: '#/components/schemas/AlarmModelVersionStatus' - description: '

The status of the alarm model. The status can be one of the following values:

' UpdateDetectorModelResponse: type: object properties: detectorModelConfiguration: allOf: - $ref: '#/components/schemas/DetectorModelConfiguration' - description: Information about how the detector model is configured. UpdateInputResponse: type: object properties: inputConfiguration: allOf: - $ref: '#/components/schemas/InputConfiguration' - description: Information about the configuration of the input. AcknowledgeFlowEnabled: type: boolean SetVariableAction: type: object required: - variableName - value properties: variableName: allOf: - $ref: '#/components/schemas/VariableName' - description: The name of the variable. value: allOf: - $ref: '#/components/schemas/VariableValue' - description: The new value of the variable. description: Information about the variable and its new value. 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. IotTopicPublishAction: type: object required: - mqttTopic properties: mqttTopic: allOf: - $ref: '#/components/schemas/MQTTTopic' - description: The MQTT topic of the message. You can use a string expression that includes variables ($variable.<variable-name>) and input values ($input.<input-name>.<path-to-datum>) as the topic string. payload: allOf: - $ref: '#/components/schemas/Payload' - description: You can configure the action payload when you publish a message to an AWS IoT Core topic. description: Information required to publish the MQTT message through the AWS IoT message broker. SetTimerAction: type: object required: - timerName properties: timerName: allOf: - $ref: '#/components/schemas/TimerName' - description: The name of the timer. seconds: allOf: - $ref: '#/components/schemas/Seconds' - deprecated: true description: The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds. seconds is deprecated. You can use durationExpression for SetTimerAction. The value of seconds can be used as a string expression for durationExpression. durationExpression: allOf: - $ref: '#/components/schemas/VariableValue' - description: 'The duration of the timer, in seconds. You can use a string expression that includes numbers, variables ($variable.<variable-name>), and input values ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number. ' description: Information needed to set the timer. ClearTimerAction: type: object required: - timerName properties: timerName: allOf: - $ref: '#/components/schemas/TimerName' - description: The name of the timer to clear. description: Information needed to clear the timer. ResetTimerAction: type: object required: - timerName properties: timerName: allOf: - $ref: '#/components/schemas/TimerName' - description: The name of the timer to reset. description: Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when you reset the timer. LambdaAction: type: object required: - functionArn properties: functionArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The ARN of the Lambda function that is executed. payload: allOf: - $ref: '#/components/schemas/Payload' - description: You can configure the action payload when you send a message to a Lambda function. description: 'Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.' 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.' SqsAction: type: object required: - queueUrl properties: queueUrl: allOf: - $ref: '#/components/schemas/QueueUrl' - description: The URL of the SQS queue where the data is written. useBase64: allOf: - $ref: '#/components/schemas/UseBase64' - description: 'Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.' payload: allOf: - $ref: '#/components/schemas/Payload' - description: You can configure the action payload when you send a message to an Amazon SQS queue. description: Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue. 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. DynamoDBAction: type: object required: - hashKeyField - hashKeyValue - tableName properties: hashKeyType: allOf: - $ref: '#/components/schemas/DynamoKeyType' - description: '

The data type for the hash key (also called the partition key). You can specify the following values:

If you don''t specify hashKeyType, the default value is ''STRING''.

' hashKeyField: allOf: - $ref: '#/components/schemas/DynamoKeyField' - description: The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table. hashKeyValue: allOf: - $ref: '#/components/schemas/DynamoKeyValue' - description: The value of the hash key (also called the partition key). rangeKeyType: allOf: - $ref: '#/components/schemas/DynamoKeyType' - description: '

The data type for the range key (also called the sort key), You can specify the following values:

If you don''t specify rangeKeyField, the default value is ''STRING''.

' rangeKeyField: allOf: - $ref: '#/components/schemas/DynamoKeyField' - description: 'The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table. ' rangeKeyValue: allOf: - $ref: '#/components/schemas/DynamoKeyValue' - description: The value of the range key (also called the sort key). operation: allOf: - $ref: '#/components/schemas/DynamoOperation' - description: '

The type of operation to perform. You can specify the following values:

If you don''t specify this parameter, AWS IoT Events triggers the ''INSERT'' operation.

' payloadField: allOf: - $ref: '#/components/schemas/DynamoKeyField' - description: '

The name of the DynamoDB column that receives the action payload.

If you don''t specify this parameter, the name of the DynamoDB column is payload.

' tableName: allOf: - $ref: '#/components/schemas/DynamoTableName' - description: 'The name of the DynamoDB table. The tableName value must match the table name of the target DynamoDB table. ' payload: $ref: '#/components/schemas/Payload' description: '

Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

You must use expressions for all parameters in DynamoDBAction. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

For more information, see Expressions in the AWS IoT Events Developer Guide.

If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is <payload-field>_raw.

' 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: '

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 payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.

You must use expressions for all parameters in DynamoDBv2Action. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

For more information, see Expressions in the AWS IoT Events Developer Guide.

The value for the type parameter in Payload must be JSON.

' 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: '

Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.

You must use expressions for all parameters in IotSiteWiseAction. The expressions accept literals, operators, functions, references, and substitutions templates.

Examples

You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.

For more information, see Expressions in the AWS IoT Events Developer Guide.

' 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 payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.' 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 payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.' 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 condition is TRUE. Actions: type: array items: $ref: '#/components/schemas/Action' AlarmAction: type: object properties: sns: $ref: '#/components/schemas/SNSTopicPublishAction' iotTopicPublish: $ref: '#/components/schemas/IotTopicPublishAction' lambda: $ref: '#/components/schemas/LambdaAction' iotEvents: $ref: '#/components/schemas/IotEventsAction' sqs: $ref: '#/components/schemas/SqsAction' firehose: $ref: '#/components/schemas/FirehoseAction' dynamoDB: $ref: '#/components/schemas/DynamoDBAction' dynamoDBv2: $ref: '#/components/schemas/DynamoDBv2Action' iotSiteWise: $ref: '#/components/schemas/IotSiteWiseAction' description: Specifies one of the following actions to receive notifications when the alarm state changes. AlarmCapabilities: type: object properties: initializationConfiguration: allOf: - $ref: '#/components/schemas/InitializationConfiguration' - description: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model. acknowledgeFlow: allOf: - $ref: '#/components/schemas/AcknowledgeFlow' - description: Specifies whether to get notified for alarm state changes. description: Contains the configuration information of alarm state changes. AlarmEventActions: type: object properties: alarmActions: allOf: - $ref: '#/components/schemas/AlarmActions' - description: Specifies one or more supported actions to receive notifications when the alarm state changes. description: Contains information about one or more alarm actions. AlarmModelArn: type: string AlarmModelDescription: type: string maxLength: 128 AlarmModelName: type: string pattern: '^[a-zA-Z0-9_-]+$' minLength: 1 maxLength: 128 AlarmModelSummary: type: object properties: creationTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The time the alarm model was created, in the Unix epoch format.' alarmModelDescription: allOf: - $ref: '#/components/schemas/AlarmModelDescription' - description: The description of the alarm model. alarmModelName: allOf: - $ref: '#/components/schemas/AlarmModelName' - description: The name of the alarm model. description: Contains a summary of an alarm model. AlarmModelSummaries: type: array items: $ref: '#/components/schemas/AlarmModelSummary' Timestamp: type: string format: date-time AlarmModelVersion: type: string minLength: 1 maxLength: 128 AlarmModelVersionStatus: type: string enum: - ACTIVE - ACTIVATING - INACTIVE - FAILED AlarmModelVersionSummary: type: object properties: alarmModelName: allOf: - $ref: '#/components/schemas/AlarmModelName' - description: The name of the alarm model. alarmModelArn: allOf: - $ref: '#/components/schemas/AlarmModelArn' - description: 'The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.' alarmModelVersion: allOf: - $ref: '#/components/schemas/AlarmModelVersion' - description: The version of the alarm model. roleArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: 'The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.' creationTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The time the alarm model was created, in the Unix epoch format.' lastUpdateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The time the alarm model was last updated, in the Unix epoch format.' status: allOf: - $ref: '#/components/schemas/AlarmModelVersionStatus' - description: '

The status of the alarm model. The status can be one of the following values:

' statusMessage: allOf: - $ref: '#/components/schemas/StatusMessage' - description: ' Contains information about the status of the alarm model version. ' description: Contains a summary of an alarm model version. AlarmModelVersionSummaries: type: array items: $ref: '#/components/schemas/AlarmModelVersionSummary' StatusMessage: type: string AlarmNotification: type: object properties: notificationActions: allOf: - $ref: '#/components/schemas/NotificationActions' - description: Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model. description: Contains information about one or more notification actions. AlarmRule: type: object properties: simpleRule: allOf: - $ref: '#/components/schemas/SimpleRule' - description: A rule that compares an input property value to a threshold value with a comparison operator. description: Defines when your alarm is invoked. AnalysisId: type: string AnalysisMessage: type: string AnalysisType: type: string AnalysisResultLevel: type: string enum: - INFO - WARNING - ERROR AnalysisResultLocations: type: array items: $ref: '#/components/schemas/AnalysisResultLocation' AnalysisResult: type: object properties: type: allOf: - $ref: '#/components/schemas/AnalysisType' - description: '

The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:

For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.

' level: allOf: - $ref: '#/components/schemas/AnalysisResultLevel' - description: '

The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories:

' message: allOf: - $ref: '#/components/schemas/AnalysisMessage' - description: Contains additional information about the analysis result. locations: allOf: - $ref: '#/components/schemas/AnalysisResultLocations' - description: Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references. description: Contains the result of the analysis. AnalysisResultLocationPath: type: string AnalysisResultLocation: type: object properties: path: allOf: - $ref: '#/components/schemas/AnalysisResultLocationPath' - description: 'A JsonPath expression that identifies the error field in your detector model.' description: Contains information that you can use to locate the field in your detector model that the analysis result references. AnalysisResults: type: array items: $ref: '#/components/schemas/AnalysisResult' AnalysisStatus: type: string enum: - RUNNING - COMPLETE - FAILED AssetId: type: string AssetModelId: type: string AssetPropertyAlias: type: string AssetPropertyBooleanValue: type: string AssetPropertyDoubleValue: type: string AssetPropertyEntryId: type: string AssetPropertyId: type: string AssetPropertyIntegerValue: type: string AssetPropertyOffsetInNanos: type: string AssetPropertyQuality: type: string AssetPropertyStringValue: type: string AssetPropertyTimeInSeconds: type: string AssetPropertyTimestamp: type: object required: - timeInSeconds properties: timeInSeconds: allOf: - $ref: '#/components/schemas/AssetPropertyTimeInSeconds' - description: 'The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.' offsetInNanos: allOf: - $ref: '#/components/schemas/AssetPropertyOffsetInNanos' - description: The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999. description: '

A structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference.

You must use expressions for all parameters in AssetPropertyTimestamp. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

For more information, see Expressions in the AWS IoT Events Developer Guide.

' 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 ''TRUE'' or ''FALSE''. You must use an expression, and the evaluated result should be a Boolean value.' description: '

A structure that contains an asset property value. For more information, see Variant in the AWS IoT SiteWise API Reference.

You must use expressions for all parameters in AssetPropertyVariant. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

For more information, see Expressions in the AWS IoT Events Developer Guide.

You must specify one of the following value types, depending on the dataType of the specified asset property. For more information, see AssetProperty in the AWS IoT SiteWise API Reference.

' 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 ''GOOD'', ''BAD'', or ''UNCERTAIN''.' description: '

A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference.

You must use expressions for all parameters in AssetPropertyValue. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

For more information, see Expressions in the AWS IoT Events Developer Guide.

' AttributeJsonPath: type: string pattern: '^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w- ]+`)|([\w\-]+)))*$' minLength: 1 maxLength: 128 Attribute: type: object required: - jsonPath properties: jsonPath: allOf: - $ref: '#/components/schemas/AttributeJsonPath' - description: '

An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (BatchPutMessage). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the condition expressions used by detectors.

Syntax: <field-name>.<field-name>...

' description: 'The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload. Those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors. ' TimerName: type: string minLength: 1 maxLength: 128 ComparisonOperator: type: string enum: - GREATER - GREATER_OR_EQUAL - LESS - LESS_OR_EQUAL - EQUAL - NOT_EQUAL Condition: type: string maxLength: 512 ContentExpression: type: string minLength: 1 Tags: type: array items: $ref: '#/components/schemas/Tag' Severity: type: integer minimum: 0 maximum: 2147483647 CreateAlarmModelRequest: type: object required: - alarmModelName - roleArn - alarmRule title: CreateAlarmModelRequest properties: alarmModelName: allOf: - $ref: '#/components/schemas/AlarmModelName' - description: A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model. alarmModelDescription: allOf: - $ref: '#/components/schemas/AlarmModelDescription' - description: A description that tells you what the alarm model detects. roleArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: 'The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.' tags: allOf: - $ref: '#/components/schemas/Tags' - description: '

A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide.

You can create up to 50 tags for one alarm model.

' key: allOf: - $ref: '#/components/schemas/AttributeJsonPath' - description: 'An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.' severity: allOf: - $ref: '#/components/schemas/Severity' - description: A non-negative integer that reflects the severity level of the alarm. alarmRule: allOf: - $ref: '#/components/schemas/AlarmRule' - description: Defines when your alarm is invoked. alarmNotification: allOf: - $ref: '#/components/schemas/AlarmNotification' - description: Contains information about one or more notification actions. alarmEventActions: allOf: - $ref: '#/components/schemas/AlarmEventActions' - description: Contains information about one or more alarm actions. alarmCapabilities: allOf: - $ref: '#/components/schemas/AlarmCapabilities' - description: Contains the configuration information of alarm state changes. DetectorModelName: type: string pattern: '^[a-zA-Z0-9_-]+$' minLength: 1 maxLength: 128 DetectorModelDefinition: type: object required: - states - initialStateName 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). description: Information that defines how a detector operates. DetectorModelDescription: type: string maxLength: 128 EvaluationMethod: type: string enum: - BATCH - SERIAL CreateDetectorModelRequest: type: object required: - detectorModelName - detectorModelDefinition - roleArn title: CreateDetectorModelRequest properties: detectorModelName: allOf: - $ref: '#/components/schemas/DetectorModelName' - description: The name of the detector model. detectorModelDefinition: allOf: - $ref: '#/components/schemas/DetectorModelDefinition' - description: Information that defines how the detectors operate. detectorModelDescription: allOf: - $ref: '#/components/schemas/DetectorModelDescription' - description: A brief description of the detector model. key: allOf: - $ref: '#/components/schemas/AttributeJsonPath' - 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. roleArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The ARN of the role that grants permission to AWS IoT Events to perform its operations. tags: allOf: - $ref: '#/components/schemas/Tags' - description: Metadata that can be used to manage the detector model. evaluationMethod: allOf: - $ref: '#/components/schemas/EvaluationMethod' - description: 'Information about the order in which events are evaluated and how actions are executed. ' DetectorModelConfiguration: type: object properties: detectorModelName: allOf: - $ref: '#/components/schemas/DetectorModelName' - description: The name of the detector model. detectorModelVersion: allOf: - $ref: '#/components/schemas/DetectorModelVersion' - description: The version of the detector model. detectorModelDescription: allOf: - $ref: '#/components/schemas/DetectorModelDescription' - description: A brief description of the detector model. detectorModelArn: allOf: - $ref: '#/components/schemas/DetectorModelArn' - description: The ARN of the detector model. roleArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The ARN of the role that grants permission to AWS IoT Events to perform its operations. creationTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time the detector model was created. lastUpdateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time the detector model was last updated. status: allOf: - $ref: '#/components/schemas/DetectorModelVersionStatus' - description: The status of the detector model. key: allOf: - $ref: '#/components/schemas/AttributeJsonPath' - description: '

The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.

This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.

' evaluationMethod: allOf: - $ref: '#/components/schemas/EvaluationMethod' - description: 'Information about the order in which events are evaluated and how actions are executed. ' description: Information about how the detector model is configured. InputName: type: string pattern: '^[a-zA-Z][a-zA-Z0-9_]*$' minLength: 1 maxLength: 128 InputDescription: type: string maxLength: 128 InputDefinition: type: object required: - attributes properties: attributes: allOf: - $ref: '#/components/schemas/Attributes' - description: 'The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors that monitor this input. ' description: The definition of the input. CreateInputRequest: type: object required: - inputName - inputDefinition title: CreateInputRequest properties: inputName: allOf: - $ref: '#/components/schemas/InputName' - description: The name you want to give to the input. inputDescription: allOf: - $ref: '#/components/schemas/InputDescription' - description: A brief description of the input. inputDefinition: allOf: - $ref: '#/components/schemas/InputDefinition' - description: The definition of the input. tags: allOf: - $ref: '#/components/schemas/Tags' - description: Metadata that can be used to manage the input. InputConfiguration: type: object required: - inputName - inputArn - creationTime - lastUpdateTime - status properties: inputName: allOf: - $ref: '#/components/schemas/InputName' - description: The name of the input. inputDescription: allOf: - $ref: '#/components/schemas/InputDescription' - description: A brief description of the input. inputArn: allOf: - $ref: '#/components/schemas/InputArn' - description: The ARN of the input. creationTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time the input was created. lastUpdateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The last time the input was updated. status: allOf: - $ref: '#/components/schemas/InputStatus' - description: The status of the input. description: Information about the configuration of an input. DeleteAlarmModelRequest: type: object title: DeleteAlarmModelRequest properties: {} DeleteDetectorModelRequest: type: object title: DeleteDetectorModelRequest properties: {} DeleteInputRequest: type: object title: DeleteInputRequest properties: {} DeliveryStreamName: type: string DescribeAlarmModelRequest: type: object title: DescribeAlarmModelRequest properties: {} DescribeDetectorModelAnalysisRequest: type: object title: DescribeDetectorModelAnalysisRequest properties: {} DetectorModelVersion: type: string minLength: 1 maxLength: 128 DescribeDetectorModelRequest: type: object title: DescribeDetectorModelRequest properties: {} 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. DescribeInputRequest: type: object title: DescribeInputRequest properties: {} Input: type: object properties: inputConfiguration: allOf: - $ref: '#/components/schemas/InputConfiguration' - description: Information about the configuration of an input. inputDefinition: allOf: - $ref: '#/components/schemas/InputDefinition' - description: The definition of the input. description: Information about the input. DescribeLoggingOptionsRequest: type: object title: DescribeLoggingOptionsRequest properties: {} LoggingOptions: type: object required: - roleArn - level - enabled properties: roleArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The ARN of the role that grants permission to AWS IoT Events to perform logging. level: allOf: - $ref: '#/components/schemas/LoggingLevel' - description: The logging level. enabled: allOf: - $ref: '#/components/schemas/LoggingEnabled' - description: 'If TRUE, logging is enabled for AWS IoT Events.' detectorDebugOptions: allOf: - $ref: '#/components/schemas/DetectorDebugOptions' - description: Information that identifies those detector models and their detectors (instances) for which the logging level is given. description: The values of the AWS IoT Events logging options. KeyValue: type: string pattern: '^[a-zA-Z0-9\-_:]+$' minLength: 1 maxLength: 128 DetectorDebugOption: type: object required: - detectorModelName properties: detectorModelName: allOf: - $ref: '#/components/schemas/DetectorModelName' - description: The name of the detector model. keyValue: allOf: - $ref: '#/components/schemas/KeyValue' - description: The value of the input attribute key used to create the detector (the instance of the detector model). description: The detector model and the specific detectors (instances) for which the logging level is given. DetectorModelArn: type: string DetectorModelVersionStatus: type: string enum: - ACTIVE - ACTIVATING - INACTIVE - DEPRECATED - DRAFT - PAUSED - FAILED DetectorModelSummary: type: object properties: detectorModelName: allOf: - $ref: '#/components/schemas/DetectorModelName' - description: The name of the detector model. detectorModelDescription: allOf: - $ref: '#/components/schemas/DetectorModelDescription' - description: A brief description of the detector model. creationTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time the detector model was created. description: Information about the detector model. DetectorModelSummaries: type: array items: $ref: '#/components/schemas/DetectorModelSummary' DetectorModelVersionSummary: type: object properties: detectorModelName: allOf: - $ref: '#/components/schemas/DetectorModelName' - description: The name of the detector model. detectorModelVersion: allOf: - $ref: '#/components/schemas/DetectorModelVersion' - description: The ID of the detector model version. detectorModelArn: allOf: - $ref: '#/components/schemas/DetectorModelArn' - description: The ARN of the detector model version. roleArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The ARN of the role that grants the detector model permission to perform its tasks. creationTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time the detector model version was created. lastUpdateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The last time the detector model version was updated. status: allOf: - $ref: '#/components/schemas/DetectorModelVersionStatus' - description: The status of the detector model version. evaluationMethod: allOf: - $ref: '#/components/schemas/EvaluationMethod' - description: 'Information about the order in which events are evaluated and how actions are executed. ' description: Information about the detector model version. DetectorModelVersionSummaries: type: array items: $ref: '#/components/schemas/DetectorModelVersionSummary' DisabledOnInitialization: type: boolean DynamoKeyType: type: string DynamoKeyField: type: string DynamoKeyValue: type: string DynamoOperation: type: string DynamoTableName: 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 (''<string>''), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} 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 STRING or JSON. description: '

Information needed to configure the payload.

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 contentExpression.

' FromEmail: type: string EmailContent: type: object properties: subject: allOf: - $ref: '#/components/schemas/EmailSubject' - description: The subject of the email. additionalMessage: allOf: - $ref: '#/components/schemas/NotificationAdditionalMessage' - description: The message that you want to send. The message can be up to 200 characters. description: Contains the subject and message of an email. EmailRecipients: type: object properties: to: allOf: - $ref: '#/components/schemas/RecipientDetails' - description: Specifies one or more recipients who receive the email. description: '

Contains the information of one or more recipients who receive the emails.

You must add the users that receive emails to your AWS SSO store.

' EmailConfiguration: type: object required: - from - recipients properties: from: allOf: - $ref: '#/components/schemas/FromEmail' - description: '

The email address that sends emails.

If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the email address that sends emails in Amazon SES.

' content: allOf: - $ref: '#/components/schemas/EmailContent' - description: Contains the subject and message of an email. recipients: allOf: - $ref: '#/components/schemas/EmailRecipients' - description: '

Contains the information of one or more recipients who receive the emails.

You must add the users that receive emails to your AWS SSO store.

' description: Contains the configuration information of email notifications. EmailConfigurations: type: array items: $ref: '#/components/schemas/EmailConfiguration' minItems: 1 EmailSubject: type: string NotificationAdditionalMessage: type: string RecipientDetails: type: array items: $ref: '#/components/schemas/RecipientDetail' minItems: 1 EventName: type: string maxLength: 128 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 actions 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 actions to be performed when the condition evaluates to TRUE. Events: type: array items: $ref: '#/components/schemas/Event' FirehoseSeparator: type: string pattern: '([\n\t])|(\r\n)|(,)' NextToken: type: string MaxAnalysisResults: type: integer GetDetectorModelAnalysisResultsRequest: type: object title: GetDetectorModelAnalysisResultsRequest properties: {} IdentityStoreId: type: string InputArn: type: string InputStatus: type: string enum: - CREATING - UPDATING - ACTIVE - DELETING InputIdentifier: type: object properties: iotEventsInputIdentifier: allOf: - $ref: '#/components/schemas/IotEventsInputIdentifier' - description: ' The identifier of the input routed to AWS IoT Events. ' iotSiteWiseInputIdentifier: allOf: - $ref: '#/components/schemas/IotSiteWiseInputIdentifier' - description: ' The identifer of the input routed from AWS IoT SiteWise. ' description: ' The identifer of the input. ' InputProperty: type: string minLength: 1 maxLength: 512 InputSummary: type: object properties: inputName: allOf: - $ref: '#/components/schemas/InputName' - description: The name of the input. inputDescription: allOf: - $ref: '#/components/schemas/InputDescription' - description: A brief description of the input. inputArn: allOf: - $ref: '#/components/schemas/InputArn' - description: The ARN of the input. creationTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time the input was created. lastUpdateTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The last time the input was updated. status: allOf: - $ref: '#/components/schemas/InputStatus' - description: The status of the input. description: Information about the input. InputSummaries: type: array items: $ref: '#/components/schemas/InputSummary' IotSiteWiseAssetModelPropertyIdentifier: type: object required: - assetModelId - propertyId properties: assetModelId: allOf: - $ref: '#/components/schemas/AssetModelId' - description: ' The ID of the AWS IoT SiteWise asset model. ' propertyId: allOf: - $ref: '#/components/schemas/AssetPropertyId' - description: ' The ID of the AWS IoT SiteWise asset property. ' description: ' The asset model property identifer of the input routed from AWS IoT SiteWise. ' MQTTTopic: type: string minLength: 1 maxLength: 128 MaxResults: type: integer minimum: 1 maximum: 250 ListAlarmModelVersionsRequest: type: object title: ListAlarmModelVersionsRequest properties: {} ListAlarmModelsRequest: type: object title: ListAlarmModelsRequest properties: {} ListDetectorModelVersionsRequest: type: object title: ListDetectorModelVersionsRequest properties: {} ListDetectorModelsRequest: type: object title: ListDetectorModelsRequest properties: {} ListInputRoutingsRequest: type: object required: - inputIdentifier title: ListInputRoutingsRequest properties: inputIdentifier: allOf: - $ref: '#/components/schemas/InputIdentifier' - description: ' The identifer of the routed input. ' maxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: ' The maximum number of results to be returned per request. ' nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: ' The token that you can use to return the next set of results. ' RoutedResources: type: array items: $ref: '#/components/schemas/RoutedResource' ListInputsRequest: type: object title: ListInputsRequest properties: {} ListTagsForResourceRequest: type: object title: ListTagsForResourceRequest properties: {} NotificationTargetActions: type: object properties: lambdaAction: $ref: '#/components/schemas/LambdaAction' description: 'Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events.' SMSConfigurations: type: array items: $ref: '#/components/schemas/SMSConfiguration' minItems: 1 NotificationAction: type: object required: - action properties: action: allOf: - $ref: '#/components/schemas/NotificationTargetActions' - description: 'Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events.' smsConfigurations: allOf: - $ref: '#/components/schemas/SMSConfigurations' - description: Contains the configuration information of SMS notifications. emailConfigurations: allOf: - $ref: '#/components/schemas/EmailConfigurations' - description: Contains the configuration information of email notifications. description: Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model. OnEnterLifecycle: type: object properties: events: allOf: - $ref: '#/components/schemas/Events' - description: Specifies the actions that are performed when the state is entered and the condition is TRUE. description: 'When entering this state, perform these actions if the condition is TRUE.' OnExitLifecycle: type: object properties: events: allOf: - $ref: '#/components/schemas/Events' - description: Specifies the actions that are performed when the state is exited and the condition is TRUE. description: 'When exiting this state, perform these actions if the specified condition is TRUE.' TransitionEvents: type: array items: $ref: '#/components/schemas/TransitionEvent' OnInputLifecycle: type: object properties: events: allOf: - $ref: '#/components/schemas/Events' - description: Specifies the actions performed when the condition evaluates to TRUE. transitionEvents: allOf: - $ref: '#/components/schemas/TransitionEvents' - description: 'Specifies the actions performed, and the next state entered, when a condition evaluates to TRUE.' description: Specifies the actions performed when the condition evaluates to TRUE. PayloadType: type: string enum: - STRING - JSON PutLoggingOptionsRequest: type: object required: - loggingOptions title: PutLoggingOptionsRequest properties: loggingOptions: allOf: - $ref: '#/components/schemas/LoggingOptions' - description: The new values of the AWS IoT Events logging options. QueueUrl: type: string SSOIdentity: type: object required: - identityStoreId properties: identityStoreId: allOf: - $ref: '#/components/schemas/IdentityStoreId' - description: The ID of the AWS SSO identity store. userId: allOf: - $ref: '#/components/schemas/SSOReferenceId' - description: The user ID. description: 'Contains information about your identity source in AWS Single Sign-On. For more information, see the AWS Single Sign-On User Guide.' RecipientDetail: type: object properties: ssoIdentity: allOf: - $ref: '#/components/schemas/SSOIdentity' - description: The AWS Single Sign-On (AWS SSO) authentication information. description: The information that identifies the recipient. ResourceName: type: string RoutedResource: type: object properties: name: allOf: - $ref: '#/components/schemas/ResourceName' - description: ' The name of the routed resource. ' arn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: ' The ARN of the routed resource. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference. ' description: ' Contains information about the routed resource. ' SMSSenderId: type: string SMSConfiguration: type: object required: - recipients properties: senderId: allOf: - $ref: '#/components/schemas/SMSSenderId' - description: The sender ID. additionalMessage: allOf: - $ref: '#/components/schemas/NotificationAdditionalMessage' - description: The message that you want to send. The message can be up to 200 characters. recipients: allOf: - $ref: '#/components/schemas/RecipientDetails' - description: '

Specifies one or more recipients who receive the message.

You must add the users that receive SMS messages to your AWS SSO store.

' description: Contains the configuration information of SMS notifications. SSOReferenceId: type: string Seconds: type: integer minimum: 1 maximum: 31622400 VariableValue: type: string minLength: 1 maxLength: 1024 VariableName: type: string pattern: '^[a-zA-Z][a-zA-Z0-9_]*$' minLength: 1 maxLength: 128 Threshold: type: string minLength: 1 maxLength: 512 UseBase64: type: boolean StartDetectorModelAnalysisRequest: type: object required: - detectorModelDefinition title: StartDetectorModelAnalysisRequest properties: detectorModelDefinition: $ref: '#/components/schemas/DetectorModelDefinition' State: type: object required: - stateName properties: stateName: allOf: - $ref: '#/components/schemas/StateName' - description: The name of the state. onInput: allOf: - $ref: '#/components/schemas/OnInputLifecycle' - description: 'When an input is received and the condition is TRUE, perform the specified actions.' onEnter: allOf: - $ref: '#/components/schemas/OnEnterLifecycle' - description: 'When entering this state, perform these actions if the condition is TRUE.' onExit: allOf: - $ref: '#/components/schemas/OnExitLifecycle' - description: 'When exiting this state, perform these actions if the specified condition is TRUE.' description: Information that defines a state of a detector. TagValue: type: string minLength: 0 maxLength: 256 TagKeys: type: array items: $ref: '#/components/schemas/TagKey' TagResourceRequest: type: object required: - tags title: TagResourceRequest properties: tags: allOf: - $ref: '#/components/schemas/Tags' - description: The new or modified tags for the resource. 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 nextState 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 condition evaluates to TRUE. UntagResourceRequest: type: object title: UntagResourceRequest properties: {} UpdateAlarmModelRequest: type: object required: - roleArn - alarmRule title: UpdateAlarmModelRequest properties: alarmModelDescription: allOf: - $ref: '#/components/schemas/AlarmModelDescription' - description: The description of the alarm model. roleArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: 'The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.' severity: allOf: - $ref: '#/components/schemas/Severity' - description: A non-negative integer that reflects the severity level of the alarm. alarmRule: allOf: - $ref: '#/components/schemas/AlarmRule' - description: Defines when your alarm is invoked. alarmNotification: allOf: - $ref: '#/components/schemas/AlarmNotification' - description: Contains information about one or more notification actions. alarmEventActions: allOf: - $ref: '#/components/schemas/AlarmEventActions' - description: Contains information about one or more alarm actions. alarmCapabilities: allOf: - $ref: '#/components/schemas/AlarmCapabilities' - description: Contains the configuration information of alarm state changes. UpdateDetectorModelRequest: type: object required: - detectorModelDefinition - roleArn title: UpdateDetectorModelRequest properties: detectorModelDefinition: allOf: - $ref: '#/components/schemas/DetectorModelDefinition' - description: Information that defines how a detector operates. detectorModelDescription: allOf: - $ref: '#/components/schemas/DetectorModelDescription' - description: A brief description of the detector model. roleArn: allOf: - $ref: '#/components/schemas/AmazonResourceName' - description: The ARN of the role that grants permission to AWS IoT Events to perform its operations. evaluationMethod: allOf: - $ref: '#/components/schemas/EvaluationMethod' - description: 'Information about the order in which events are evaluated and how actions are executed. ' UpdateInputRequest: type: object required: - inputDefinition title: UpdateInputRequest properties: inputDescription: allOf: - $ref: '#/components/schemas/InputDescription' - description: A brief description of the input. inputDefinition: allOf: - $ref: '#/components/schemas/InputDefinition' - description: The definition of the input. security: - hmac: []