openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 145 kB
JSON
{"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 <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html\">Create an alarm model</a> in the <i>AWS IoT Events Developer Guide</i>.","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 <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.","type":"string","minLength":1,"maxLength":2048},"tags":{"description":"<p>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 <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html\">Tagging your AWS IoT Events resources</a> in the <i>AWS IoT Events Developer Guide</i>.</p> <p>You can create up to 50 tags for one alarm model.</p>","type":"array","items":{"$ref":"#/components/schemas/Tag"}},"key":{"description":"An input attribute used as a key to create an alarm. AWS IoT Events routes <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html\">inputs</a> 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."}]}}}}}}}}},"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}}]}},"/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"]}}}}}}},"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}}]}},"/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 <code>BatchPutMessage</code>. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the <code>condition</code> 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"}}}}}}}},"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}}]}},"/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}}]},"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 <code>alarmModelVersion</code> 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}}]},"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 <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.","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."}]}}}}}}}}}},"/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}}]},"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 <code>version</code> parameter is not specified, information about the latest version is returned.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeDetectorModelResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"detectorModelName","in":"path","required":true,"description":"The name of the detector model.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","minLength":1,"maxLength":128}},{"name":"version","in":"query","required":false,"description":"The version of the detector model.","schema":{"type":"string","minLength":1,"maxLength":128}}]},"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"]}}}}}}}},"/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}}]},"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}}]},"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 <code>BatchPutMessage</code>. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the <code>condition</code> expressions used by detectors that monitor this input. "}]}}}}}}}}}},"/analysis/detector-models/{analysisId}":{"get":{"operationId":"DescribeDetectorModelAnalysis","description":"<p>Retrieves runtime information about a detector model analysis.</p> <note> <p>After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.</p> </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeDetectorModelAnalysisResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"analysisId","in":"path","required":true,"description":"The ID of the analysis result that you want to retrieve.","schema":{"type":"string"}}]},"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":[]},"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":"<p>Sets or updates the AWS IoT Events logging options.</p> <p>If you update the value of any <code>loggingOptions</code> 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 <code>roleArn</code> field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.</p>","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."}]}}}}}}}}}},"/analysis/detector-models/{analysisId}/results":{"get":{"operationId":"GetDetectorModelAnalysisResults","description":"<p>Retrieves one or more analysis results of the detector model.</p> <note> <p>After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.</p> </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDetectorModelAnalysisResultsResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}}},"parameters":[{"name":"analysisId","in":"path","required":true,"description":"The ID of the analysis result that you want to retrieve.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The token that you can use to return the next set of results.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"integer"}}]},"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}}]},"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}}]},"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"}}}}}}},"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":"InvalidRequestExcepti