Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge them.
Deletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the detector will be removed from the list of detectors. The deleted detector will no longer appear if referenced in the ListDetectors API call.
" - }, - "BatchDisableAlarm":{ - "name":"BatchDisableAlarm", - "http":{ - "method":"POST", - "requestUri":"/alarms/disable", - "responseCode":202 - }, - "input":{"shape":"BatchDisableAlarmRequest"}, - "output":{"shape":"BatchDisableAlarmResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"Disables one or more alarms. The alarms change to the DISABLED state after you disable them.
Enables one or more alarms. The alarms change to the NORMAL state after you enable them.
Sends a set of messages to the IoT Events system. Each message payload is transformed into the input you specify (\"inputName\") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.
Resets one or more alarms. The alarms return to the NORMAL state after you reset them.
Changes one or more alarms to the snooze mode. The alarms change to the SNOOZE_DISABLED state after you set them to the snooze mode.
Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
" - }, - "DescribeAlarm":{ - "name":"DescribeAlarm", - "http":{ - "method":"GET", - "requestUri":"/alarms/{alarmModelName}/keyValues/" - }, - "input":{"shape":"DescribeAlarmRequest"}, - "output":{"shape":"DescribeAlarmResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"Retrieves information about an alarm.
" - }, - "DescribeDetector":{ - "name":"DescribeDetector", - "http":{ - "method":"GET", - "requestUri":"/detectors/{detectorModelName}/keyValues/" - }, - "input":{"shape":"DescribeDetectorRequest"}, - "output":{"shape":"DescribeDetectorResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"Returns information about the specified detector (instance).
" - }, - "ListAlarms":{ - "name":"ListAlarms", - "http":{ - "method":"GET", - "requestUri":"/alarms/{alarmModelName}" - }, - "input":{"shape":"ListAlarmsRequest"}, - "output":{"shape":"ListAlarmsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"Lists one or more alarms. The operation returns only the metadata associated with each alarm.
" - }, - "ListDetectors":{ - "name":"ListDetectors", - "http":{ - "method":"GET", - "requestUri":"/detectors/{detectorModelName}" - }, - "input":{"shape":"ListDetectorsRequest"}, - "output":{"shape":"ListDetectorsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"Lists detectors (the instances of a detector model).
" - } - }, - "shapes":{ - "AcknowledgeActionConfiguration":{ - "type":"structure", - "members":{ - "note":{ - "shape":"Note", - "documentation":"The note that you can leave when you acknowledge the alarm.
" - } - }, - "documentation":"Contains the configuration information of an acknowledge action.
" - }, - "AcknowledgeAlarmActionRequest":{ - "type":"structure", - "required":[ - "requestId", - "alarmModelName" - ], - "members":{ - "requestId":{ - "shape":"RequestId", - "documentation":"The request ID. Each ID must be unique within each batch.
" - }, - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
" - }, - "keyValue":{ - "shape":"KeyValue", - "documentation":"The value of the key used as a filter to select only the alarms associated with the key.
" - }, - "note":{ - "shape":"Note", - "documentation":"The note that you can leave when you acknowledge the alarm.
" - } - }, - "documentation":"Information needed to acknowledge the alarm.
" - }, - "AcknowledgeAlarmActionRequests":{ - "type":"list", - "member":{"shape":"AcknowledgeAlarmActionRequest"}, - "min":1 - }, - "Alarm":{ - "type":"structure", - "members":{ - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
" - }, - "alarmModelVersion":{ - "shape":"AlarmModelVersion", - "documentation":"The version of the alarm model.
" - }, - "keyValue":{ - "shape":"KeyValue", - "documentation":"The value of the key used as a filter to select only the alarms associated with the key.
" - }, - "alarmState":{ - "shape":"AlarmState", - "documentation":"Contains information about the current state of the alarm.
" - }, - "severity":{ - "shape":"Severity", - "documentation":"A non-negative integer that reflects the severity level of the alarm.
" - }, - "creationTime":{ - "shape":"Timestamp", - "documentation":"The time the alarm was created, in the Unix epoch format.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The time the alarm was last updated, in the Unix epoch format.
" - } - }, - "documentation":"Contains information about an alarm.
" - }, - "AlarmModelName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9_-]+$" - }, - "AlarmModelVersion":{ - "type":"string", - "max":128, - "min":1 - }, - "AlarmState":{ - "type":"structure", - "members":{ - "stateName":{ - "shape":"AlarmStateName", - "documentation":"The name of the alarm state. The state name can be one of the following values:
DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.
NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.
ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.
ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.
SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.
LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.
Information needed to evaluate data.
" - }, - "customerAction":{ - "shape":"CustomerAction", - "documentation":"Contains information about the action that you can take to respond to the alarm.
" - }, - "systemEvent":{ - "shape":"SystemEvent", - "documentation":"Contains information about alarm state changes.
" - } - }, - "documentation":"Contains information about the current state of the alarm.
" - }, - "AlarmStateName":{ - "type":"string", - "enum":[ - "DISABLED", - "NORMAL", - "ACTIVE", - "ACKNOWLEDGED", - "SNOOZE_DISABLED", - "LATCHED" - ] - }, - "AlarmSummaries":{ - "type":"list", - "member":{"shape":"AlarmSummary"} - }, - "AlarmSummary":{ - "type":"structure", - "members":{ - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
" - }, - "alarmModelVersion":{ - "shape":"AlarmModelVersion", - "documentation":"The version of the alarm model.
" - }, - "keyValue":{ - "shape":"KeyValue", - "documentation":"The value of the key used as a filter to select only the alarms associated with the key.
" - }, - "stateName":{ - "shape":"AlarmStateName", - "documentation":"The name of the alarm state. The state name can be one of the following values:
DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.
NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.
ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.
ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.
SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.
LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.
The time the alarm was created, in the Unix epoch format.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The time the alarm was last updated, in the Unix epoch format.
" - } - }, - "documentation":"Contains a summary of an alarm.
" - }, - "BatchAcknowledgeAlarmRequest":{ - "type":"structure", - "required":["acknowledgeActionRequests"], - "members":{ - "acknowledgeActionRequests":{ - "shape":"AcknowledgeAlarmActionRequests", - "documentation":"The list of acknowledge action requests. You can specify up to 10 requests per operation.
" - } - } - }, - "BatchAcknowledgeAlarmResponse":{ - "type":"structure", - "members":{ - "errorEntries":{ - "shape":"BatchAlarmActionErrorEntries", - "documentation":"A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.
The request ID. Each ID must be unique within each batch.
" - }, - "errorCode":{ - "shape":"ErrorCode", - "documentation":"The error code.
" - }, - "errorMessage":{ - "shape":"ErrorMessage", - "documentation":"A message that describes the error.
" - } - }, - "documentation":"Contains error messages associated with one of the following requests:
" - }, - "BatchDeleteDetectorErrorEntries":{ - "type":"list", - "member":{"shape":"BatchDeleteDetectorErrorEntry"} - }, - "BatchDeleteDetectorErrorEntry":{ - "type":"structure", - "members":{ - "messageId":{ - "shape":"MessageId", - "documentation":"The ID of the message that caused the error. (See the value of the \"messageId\" in the detectors object of the DeleteDetectorRequest.)
The error code.
" - }, - "errorMessage":{ - "shape":"ErrorMessage", - "documentation":"A message that describes the error.
" - } - }, - "documentation":"Contains error messages associated with the deletion request.
" - }, - "BatchDeleteDetectorRequest":{ - "type":"structure", - "required":["detectors"], - "members":{ - "detectors":{ - "shape":"DeleteDetectorRequests", - "documentation":"The list of one or more detectors to be deleted.
" - } - } - }, - "BatchDeleteDetectorResponse":{ - "type":"structure", - "members":{ - "batchDeleteDetectorErrorEntries":{ - "shape":"BatchDeleteDetectorErrorEntries", - "documentation":"A list of errors associated with the request, or an empty array ([]) if there are no errors. Each error entry contains a messageId that helps you identify the entry that failed.
The list of disable action requests. You can specify up to 10 requests per operation.
" - } - } - }, - "BatchDisableAlarmResponse":{ - "type":"structure", - "members":{ - "errorEntries":{ - "shape":"BatchAlarmActionErrorEntries", - "documentation":"A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.
The list of enable action requests. You can specify up to 10 requests per operation.
" - } - } - }, - "BatchEnableAlarmResponse":{ - "type":"structure", - "members":{ - "errorEntries":{ - "shape":"BatchAlarmActionErrorEntries", - "documentation":"A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.
The ID of the message that caused the error. (See the value corresponding to the \"messageId\" key in the \"message\" object.)
The error code.
" - }, - "errorMessage":{ - "shape":"ErrorMessage", - "documentation":"A message that describes the error.
" - } - }, - "documentation":"Contains information about the errors encountered.
" - }, - "BatchPutMessageRequest":{ - "type":"structure", - "required":["messages"], - "members":{ - "messages":{ - "shape":"Messages", - "documentation":"The list of messages to send. Each message has the following format: '{ \"messageId\": \"string\", \"inputName\": \"string\", \"payload\": \"string\"}'
A list of any errors encountered when sending the messages.
" - } - } - }, - "BatchResetAlarmRequest":{ - "type":"structure", - "required":["resetActionRequests"], - "members":{ - "resetActionRequests":{ - "shape":"ResetAlarmActionRequests", - "documentation":"The list of reset action requests. You can specify up to 10 requests per operation.
" - } - } - }, - "BatchResetAlarmResponse":{ - "type":"structure", - "members":{ - "errorEntries":{ - "shape":"BatchAlarmActionErrorEntries", - "documentation":"A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.
The list of snooze action requests. You can specify up to 10 requests per operation.
" - } - } - }, - "BatchSnoozeAlarmResponse":{ - "type":"structure", - "members":{ - "errorEntries":{ - "shape":"BatchAlarmActionErrorEntries", - "documentation":"A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.
The \"messageId\" of the update request that caused the error. (The value of the \"messageId\" in the update request \"Detector\" object.)
The error code.
" - }, - "errorMessage":{ - "shape":"ErrorMessage", - "documentation":"A message that describes the error.
" - } - }, - "documentation":"Information about the error that occurred when attempting to update a detector.
" - }, - "BatchUpdateDetectorRequest":{ - "type":"structure", - "required":["detectors"], - "members":{ - "detectors":{ - "shape":"UpdateDetectorRequests", - "documentation":"The list of detectors (instances) to update, along with the values to update.
" - } - } - }, - "BatchUpdateDetectorResponse":{ - "type":"structure", - "members":{ - "batchUpdateDetectorErrorEntries":{ - "shape":"BatchUpdateDetectorErrorEntries", - "documentation":"A list of those detector updates that resulted in errors. (If an error is listed here, the specific update did not occur.)
" - } - } - }, - "ComparisonOperator":{ - "type":"string", - "enum":[ - "GREATER", - "GREATER_OR_EQUAL", - "LESS", - "LESS_OR_EQUAL", - "EQUAL", - "NOT_EQUAL" - ] - }, - "CustomerAction":{ - "type":"structure", - "members":{ - "actionName":{ - "shape":"CustomerActionName", - "documentation":"The name of the action. The action name can be one of the following values:
SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED.
ENABLE - When you enable the alarm, the alarm state changes to NORMAL.
DISABLE - When you disable the alarm, the alarm state changes to DISABLED.
ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to ACKNOWLEDGED.
RESET - When you reset the alarm, the alarm state changes to NORMAL.
For more information, see the AlarmState API.
" - }, - "snoozeActionConfiguration":{ - "shape":"SnoozeActionConfiguration", - "documentation":"Contains the configuration information of a snooze action.
" - }, - "enableActionConfiguration":{ - "shape":"EnableActionConfiguration", - "documentation":"Contains the configuration information of an enable action.
" - }, - "disableActionConfiguration":{ - "shape":"DisableActionConfiguration", - "documentation":"Contains the configuration information of a disable action.
" - }, - "acknowledgeActionConfiguration":{ - "shape":"AcknowledgeActionConfiguration", - "documentation":"Contains the configuration information of an acknowledge action.
" - }, - "resetActionConfiguration":{ - "shape":"ResetActionConfiguration", - "documentation":"Contains the configuration information of a reset action.
" - } - }, - "documentation":"Contains information about the action that you can take to respond to the alarm.
" - }, - "CustomerActionName":{ - "type":"string", - "enum":[ - "SNOOZE", - "ENABLE", - "DISABLE", - "ACKNOWLEDGE", - "RESET" - ] - }, - "DeleteDetectorRequest":{ - "type":"structure", - "required":[ - "messageId", - "detectorModelName" - ], - "members":{ - "messageId":{ - "shape":"MessageId", - "documentation":"The ID to assign to the DeleteDetectorRequest. Each \"messageId\" must be unique within each batch sent.
The name of the detector model that was used to create the detector instance.
" - }, - "keyValue":{ - "shape":"KeyValue", - "documentation":"The value of the key used to identify the detector.
" - } - }, - "documentation":"Information used to delete the detector model.
" - }, - "DeleteDetectorRequests":{ - "type":"list", - "member":{"shape":"DeleteDetectorRequest"}, - "min":1 - }, - "DescribeAlarmRequest":{ - "type":"structure", - "required":["alarmModelName"], - "members":{ - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
", - "location":"uri", - "locationName":"alarmModelName" - }, - "keyValue":{ - "shape":"KeyValue", - "documentation":"The value of the key used as a filter to select only the alarms associated with the key.
", - "location":"querystring", - "locationName":"keyValue" - } - } - }, - "DescribeAlarmResponse":{ - "type":"structure", - "members":{ - "alarm":{ - "shape":"Alarm", - "documentation":"Contains information about an alarm.
" - } - } - }, - "DescribeDetectorRequest":{ - "type":"structure", - "required":["detectorModelName"], - "members":{ - "detectorModelName":{ - "shape":"DetectorModelName", - "documentation":"The name of the detector model whose detectors (instances) you want information about.
", - "location":"uri", - "locationName":"detectorModelName" - }, - "keyValue":{ - "shape":"KeyValue", - "documentation":"A filter used to limit results to detectors (instances) created because of the given key ID.
", - "location":"querystring", - "locationName":"keyValue" - } - } - }, - "DescribeDetectorResponse":{ - "type":"structure", - "members":{ - "detector":{ - "shape":"Detector", - "documentation":"Information about the detector (instance).
" - } - } - }, - "Detector":{ - "type":"structure", - "members":{ - "detectorModelName":{ - "shape":"DetectorModelName", - "documentation":"The name of the detector model that created this detector (instance).
" - }, - "keyValue":{ - "shape":"KeyValue", - "documentation":"The value of the key (identifying the device or system) that caused the creation of this detector (instance).
" - }, - "detectorModelVersion":{ - "shape":"DetectorModelVersion", - "documentation":"The version of the detector model that created this detector (instance).
" - }, - "state":{ - "shape":"DetectorState", - "documentation":"The current state of the detector (instance).
" - }, - "creationTime":{ - "shape":"Timestamp", - "documentation":"The time the detector (instance) was created.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The time the detector (instance) was last updated.
" - } - }, - "documentation":"Information about the detector (instance).
" - }, - "DetectorModelName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9_-]+$" - }, - "DetectorModelVersion":{ - "type":"string", - "max":128, - "min":1 - }, - "DetectorState":{ - "type":"structure", - "required":[ - "stateName", - "variables", - "timers" - ], - "members":{ - "stateName":{ - "shape":"StateName", - "documentation":"The name of the state.
" - }, - "variables":{ - "shape":"Variables", - "documentation":"The current values of the detector's variables.
" - }, - "timers":{ - "shape":"Timers", - "documentation":"The current state of the detector's timers.
" - } - }, - "documentation":"Information about the current state of the detector instance.
" - }, - "DetectorStateDefinition":{ - "type":"structure", - "required":[ - "stateName", - "variables", - "timers" - ], - "members":{ - "stateName":{ - "shape":"StateName", - "documentation":"The name of the new state of the detector (instance).
" - }, - "variables":{ - "shape":"VariableDefinitions", - "documentation":"The new values of the detector's variables. Any variable whose value isn't specified is cleared.
" - }, - "timers":{ - "shape":"TimerDefinitions", - "documentation":"The new values of the detector's timers. Any timer whose value isn't specified is cleared, and its timeout event won't occur.
" - } - }, - "documentation":"The new state, variable values, and timer settings of the detector (instance).
" - }, - "DetectorStateSummary":{ - "type":"structure", - "members":{ - "stateName":{ - "shape":"StateName", - "documentation":"The name of the state.
" - } - }, - "documentation":"Information about the detector state.
" - }, - "DetectorSummaries":{ - "type":"list", - "member":{"shape":"DetectorSummary"} - }, - "DetectorSummary":{ - "type":"structure", - "members":{ - "detectorModelName":{ - "shape":"DetectorModelName", - "documentation":"The name of the detector model that created this detector (instance).
" - }, - "keyValue":{ - "shape":"KeyValue", - "documentation":"The value of the key (identifying the device or system) that caused the creation of this detector (instance).
" - }, - "detectorModelVersion":{ - "shape":"DetectorModelVersion", - "documentation":"The version of the detector model that created this detector (instance).
" - }, - "state":{ - "shape":"DetectorStateSummary", - "documentation":"The current state of the detector (instance).
" - }, - "creationTime":{ - "shape":"Timestamp", - "documentation":"The time the detector (instance) was created.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The time the detector (instance) was last updated.
" - } - }, - "documentation":"Information about the detector (instance).
" - }, - "DisableActionConfiguration":{ - "type":"structure", - "members":{ - "note":{ - "shape":"Note", - "documentation":"The note that you can leave when you disable the alarm.
" - } - }, - "documentation":"Contains the configuration information of a disable action.
" - }, - "DisableAlarmActionRequest":{ - "type":"structure", - "required":[ - "requestId", - "alarmModelName" - ], - "members":{ - "requestId":{ - "shape":"RequestId", - "documentation":"The request ID. Each ID must be unique within each batch.
" - }, - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
" - }, - "keyValue":{ - "shape":"KeyValue", - "documentation":"The value of the key used as a filter to select only the alarms associated with the key.
" - }, - "note":{ - "shape":"Note", - "documentation":"The note that you can leave when you disable the alarm.
" - } - }, - "documentation":"Information used to disable the alarm.
" - }, - "DisableAlarmActionRequests":{ - "type":"list", - "member":{"shape":"DisableAlarmActionRequest"}, - "min":1 - }, - "EnableActionConfiguration":{ - "type":"structure", - "members":{ - "note":{ - "shape":"Note", - "documentation":"The note that you can leave when you enable the alarm.
" - } - }, - "documentation":"Contains the configuration information of an enable action.
" - }, - "EnableAlarmActionRequest":{ - "type":"structure", - "required":[ - "requestId", - "alarmModelName" - ], - "members":{ - "requestId":{ - "shape":"RequestId", - "documentation":"The request ID. Each ID must be unique within each batch.
" - }, - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
" - }, - "keyValue":{ - "shape":"KeyValue", - "documentation":"The value of the key used as a filter to select only the alarms associated with the key.
" - }, - "note":{ - "shape":"Note", - "documentation":"The note that you can leave when you enable the alarm.
" - } - }, - "documentation":"Information needed to enable the alarm.
" - }, - "EnableAlarmActionRequests":{ - "type":"list", - "member":{"shape":"EnableAlarmActionRequest"}, - "min":1 - }, - "EphemeralInputName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" - }, - "EpochMilliTimestamp":{ - "type":"long", - "max":9223372036854775807, - "min":1 - }, - "ErrorCode":{ - "type":"string", - "enum":[ - "ResourceNotFoundException", - "InvalidRequestException", - "InternalFailureException", - "ServiceUnavailableException", - "ThrottlingException" - ] - }, - "ErrorMessage":{"type":"string"}, - "EventType":{ - "type":"string", - "enum":["STATE_CHANGE"] - }, - "InputPropertyValue":{"type":"string"}, - "InternalFailureException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"The message for the exception.
" - } - }, - "documentation":"An internal failure occurred.
", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true - }, - "InvalidRequestException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"The message for the exception.
" - } - }, - "documentation":"The request was invalid.
", - "error":{"httpStatusCode":400}, - "exception":true - }, - "KeyValue":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9\\-_:]+$" - }, - "ListAlarmsRequest":{ - "type":"structure", - "required":["alarmModelName"], - "members":{ - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
", - "location":"uri", - "locationName":"alarmModelName" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token that you can use to return the next set of results.
", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to be returned per request.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListAlarmsResponse":{ - "type":"structure", - "members":{ - "alarmSummaries":{ - "shape":"AlarmSummaries", - "documentation":"A list that summarizes each alarm.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token that you can use to return the next set of results, or null if there are no more results.
The name of the detector model whose detectors (instances) are listed.
", - "location":"uri", - "locationName":"detectorModelName" - }, - "stateName":{ - "shape":"StateName", - "documentation":"A filter that limits results to those detectors (instances) in the given state.
", - "location":"querystring", - "locationName":"stateName" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token that you can use to return the next set of results.
", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to be returned per request.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListDetectorsResponse":{ - "type":"structure", - "members":{ - "detectorSummaries":{ - "shape":"DetectorSummaries", - "documentation":"A list of summary information about the detectors (instances).
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token that you can use to return the next set of results, or null if there are no more results.
The ID to assign to the message. Within each batch sent, each \"messageId\" must be unique.
The name of the input into which the message payload is transformed.
" - }, - "payload":{ - "shape":"Payload", - "documentation":"The payload of the message. This can be a JSON string or a Base-64-encoded string representing binary data (in which case you must decode it).
" - }, - "timestamp":{ - "shape":"TimestampValue", - "documentation":"The timestamp associated with the message.
" - } - }, - "documentation":"Information about a message.
" - }, - "MessageId":{ - "type":"string", - "max":64, - "min":1, - "pattern":"^[a-zA-Z0-9_-]+$" - }, - "Messages":{ - "type":"list", - "member":{"shape":"Message"}, - "min":1 - }, - "NextToken":{"type":"string"}, - "Note":{ - "type":"string", - "max":256 - }, - "Payload":{"type":"blob"}, - "RequestId":{ - "type":"string", - "max":64, - "min":1, - "pattern":"^[a-zA-Z0-9_-]+$" - }, - "ResetActionConfiguration":{ - "type":"structure", - "members":{ - "note":{ - "shape":"Note", - "documentation":"The note that you can leave when you reset the alarm.
" - } - }, - "documentation":"Contains the configuration information of a reset action.
" - }, - "ResetAlarmActionRequest":{ - "type":"structure", - "required":[ - "requestId", - "alarmModelName" - ], - "members":{ - "requestId":{ - "shape":"RequestId", - "documentation":"The request ID. Each ID must be unique within each batch.
" - }, - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
" - }, - "keyValue":{ - "shape":"KeyValue", - "documentation":"The value of the key used as a filter to select only the alarms associated with the key.
" - }, - "note":{ - "shape":"Note", - "documentation":"The note that you can leave when you reset the alarm.
" - } - }, - "documentation":"Information needed to reset the alarm.
" - }, - "ResetAlarmActionRequests":{ - "type":"list", - "member":{"shape":"ResetAlarmActionRequest"}, - "min":1 - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"The message for the exception.
" - } - }, - "documentation":"The resource was not found.
", - "error":{"httpStatusCode":404}, - "exception":true - }, - "RuleEvaluation":{ - "type":"structure", - "members":{ - "simpleRuleEvaluation":{ - "shape":"SimpleRuleEvaluation", - "documentation":"Information needed to compare two values with a comparison operator.
" - } - }, - "documentation":"Information needed to evaluate data.
" - }, - "Seconds":{"type":"integer"}, - "ServiceUnavailableException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"The message for the exception.
" - } - }, - "documentation":"The service is currently unavailable.
", - "error":{"httpStatusCode":503}, - "exception":true, - "fault":true - }, - "Severity":{ - "type":"integer", - "box":true, - "max":2147483647, - "min":0 - }, - "SimpleRuleEvaluation":{ - "type":"structure", - "members":{ - "inputPropertyValue":{ - "shape":"InputPropertyValue", - "documentation":"The value of the input property, on the left side of the comparison operator.
" - }, - "operator":{ - "shape":"ComparisonOperator", - "documentation":"The comparison operator.
" - }, - "thresholdValue":{ - "shape":"ThresholdValue", - "documentation":"The threshold value, on the right side of the comparison operator.
" - } - }, - "documentation":"Information needed to compare two values with a comparison operator.
" - }, - "SnoozeActionConfiguration":{ - "type":"structure", - "members":{ - "snoozeDuration":{ - "shape":"SnoozeDuration", - "documentation":"The snooze time in seconds. The alarm automatically changes to the NORMAL state after this duration.
The note that you can leave when you snooze the alarm.
" - } - }, - "documentation":"Contains the configuration information of a snooze action.
" - }, - "SnoozeAlarmActionRequest":{ - "type":"structure", - "required":[ - "requestId", - "alarmModelName", - "snoozeDuration" - ], - "members":{ - "requestId":{ - "shape":"RequestId", - "documentation":"The request ID. Each ID must be unique within each batch.
" - }, - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
" - }, - "keyValue":{ - "shape":"KeyValue", - "documentation":"The value of the key used as a filter to select only the alarms associated with the key.
" - }, - "note":{ - "shape":"Note", - "documentation":"The note that you can leave when you snooze the alarm.
" - }, - "snoozeDuration":{ - "shape":"SnoozeDuration", - "documentation":"The snooze time in seconds. The alarm automatically changes to the NORMAL state after this duration.
Information needed to snooze the alarm.
" - }, - "SnoozeAlarmActionRequests":{ - "type":"list", - "member":{"shape":"SnoozeAlarmActionRequest"}, - "min":1 - }, - "SnoozeDuration":{"type":"integer"}, - "StateChangeConfiguration":{ - "type":"structure", - "members":{ - "triggerType":{ - "shape":"TriggerType", - "documentation":"The trigger type. If the value is SNOOZE_TIMEOUT, the snooze duration ends and the alarm automatically changes to the NORMAL state.
Contains the configuration information of alarm state changes.
" - }, - "StateName":{ - "type":"string", - "max":128, - "min":1 - }, - "SystemEvent":{ - "type":"structure", - "members":{ - "eventType":{ - "shape":"EventType", - "documentation":"The event type. If the value is STATE_CHANGE, the event contains information about alarm state changes.
Contains the configuration information of alarm state changes.
" - } - }, - "documentation":"Contains information about alarm state changes.
" - }, - "ThresholdValue":{"type":"string"}, - "ThrottlingException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"The message for the exception.
" - } - }, - "documentation":"The request could not be completed due to throttling.
", - "error":{"httpStatusCode":429}, - "exception":true - }, - "Timer":{ - "type":"structure", - "required":[ - "name", - "timestamp" - ], - "members":{ - "name":{ - "shape":"TimerName", - "documentation":"The name of the timer.
" - }, - "timestamp":{ - "shape":"Timestamp", - "documentation":"The expiration time for the timer.
" - } - }, - "documentation":"The current state of a timer.
" - }, - "TimerDefinition":{ - "type":"structure", - "required":[ - "name", - "seconds" - ], - "members":{ - "name":{ - "shape":"TimerName", - "documentation":"The name of the timer.
" - }, - "seconds":{ - "shape":"Seconds", - "documentation":"The new setting of the timer (the number of seconds before the timer elapses).
" - } - }, - "documentation":"The new setting of a timer.
" - }, - "TimerDefinitions":{ - "type":"list", - "member":{"shape":"TimerDefinition"} - }, - "TimerName":{ - "type":"string", - "max":128, - "min":1 - }, - "Timers":{ - "type":"list", - "member":{"shape":"Timer"} - }, - "Timestamp":{"type":"timestamp"}, - "TimestampValue":{ - "type":"structure", - "members":{ - "timeInMillis":{ - "shape":"EpochMilliTimestamp", - "documentation":"The value of the timestamp, in the Unix epoch format.
" - } - }, - "documentation":"Contains information about a timestamp.
" - }, - "TriggerType":{ - "type":"string", - "enum":["SNOOZE_TIMEOUT"] - }, - "UpdateDetectorRequest":{ - "type":"structure", - "required":[ - "messageId", - "detectorModelName", - "state" - ], - "members":{ - "messageId":{ - "shape":"MessageId", - "documentation":"The ID to assign to the detector update \"message\". Each \"messageId\" must be unique within each batch sent.
The name of the detector model that created the detectors (instances).
" - }, - "keyValue":{ - "shape":"KeyValue", - "documentation":"The value of the input key attribute (identifying the device or system) that caused the creation of this detector (instance).
" - }, - "state":{ - "shape":"DetectorStateDefinition", - "documentation":"The new state, variable values, and timer settings of the detector (instance).
" - } - }, - "documentation":"Information used to update the detector (instance).
" - }, - "UpdateDetectorRequests":{ - "type":"list", - "member":{"shape":"UpdateDetectorRequest"}, - "min":1 - }, - "Variable":{ - "type":"structure", - "required":[ - "name", - "value" - ], - "members":{ - "name":{ - "shape":"VariableName", - "documentation":"The name of the variable.
" - }, - "value":{ - "shape":"VariableValue", - "documentation":"The current value of the variable.
" - } - }, - "documentation":"The current state of the variable.
" - }, - "VariableDefinition":{ - "type":"structure", - "required":[ - "name", - "value" - ], - "members":{ - "name":{ - "shape":"VariableName", - "documentation":"The name of the variable.
" - }, - "value":{ - "shape":"VariableValue", - "documentation":"The new value of the variable.
" - } - }, - "documentation":"The new value of the variable.
" - }, - "VariableDefinitions":{ - "type":"list", - "member":{"shape":"VariableDefinition"} - }, - "VariableName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$" - }, - "VariableValue":{ - "type":"string", - "max":1024, - "min":1 - }, - "Variables":{ - "type":"list", - "member":{"shape":"Variable"} - }, - "errorMessage":{"type":"string"} - }, - "documentation":"IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use IoT Events Data API commands to send inputs to detectors, list detectors, and view or update a detector's status.
For more information, see What is IoT Events? in the IoT Events Developer Guide.
" -} diff --git a/awscli/botocore/data/iotevents/2018-07-27/completions-1.json b/awscli/botocore/data/iotevents/2018-07-27/completions-1.json deleted file mode 100644 index cfe0a838f92b..000000000000 --- a/awscli/botocore/data/iotevents/2018-07-27/completions-1.json +++ /dev/null @@ -1,146 +0,0 @@ -{ - "version": "1.0", - "resources": { - "AlarmModel": { - "operation": "ListAlarmModels", - "resourceIdentifier": { - "alarmModelName": "alarmModelSummaries[].alarmModelName" - } - }, - "DetectorModel": { - "operation": "ListDetectorModels", - "resourceIdentifier": { - "detectorModelName": "detectorModelSummaries[].detectorModelName" - } - }, - "Input": { - "operation": "ListInputs", - "resourceIdentifier": { - "inputName": "inputSummaries[].inputName" - } - } - }, - "operations": { - "DeleteAlarmModel": { - "alarmModelName": { - "completions": [ - { - "parameters": {}, - "resourceName": "AlarmModel", - "resourceIdentifier": "alarmModelName" - } - ] - } - }, - "DeleteDetectorModel": { - "detectorModelName": { - "completions": [ - { - "parameters": {}, - "resourceName": "DetectorModel", - "resourceIdentifier": "detectorModelName" - } - ] - } - }, - "DeleteInput": { - "inputName": { - "completions": [ - { - "parameters": {}, - "resourceName": "Input", - "resourceIdentifier": "inputName" - } - ] - } - }, - "DescribeAlarmModel": { - "alarmModelName": { - "completions": [ - { - "parameters": {}, - "resourceName": "AlarmModel", - "resourceIdentifier": "alarmModelName" - } - ] - } - }, - "DescribeDetectorModel": { - "detectorModelName": { - "completions": [ - { - "parameters": {}, - "resourceName": "DetectorModel", - "resourceIdentifier": "detectorModelName" - } - ] - } - }, - "DescribeInput": { - "inputName": { - "completions": [ - { - "parameters": {}, - "resourceName": "Input", - "resourceIdentifier": "inputName" - } - ] - } - }, - "ListAlarmModelVersions": { - "alarmModelName": { - "completions": [ - { - "parameters": {}, - "resourceName": "AlarmModel", - "resourceIdentifier": "alarmModelName" - } - ] - } - }, - "ListDetectorModelVersions": { - "detectorModelName": { - "completions": [ - { - "parameters": {}, - "resourceName": "DetectorModel", - "resourceIdentifier": "detectorModelName" - } - ] - } - }, - "UpdateAlarmModel": { - "alarmModelName": { - "completions": [ - { - "parameters": {}, - "resourceName": "AlarmModel", - "resourceIdentifier": "alarmModelName" - } - ] - } - }, - "UpdateDetectorModel": { - "detectorModelName": { - "completions": [ - { - "parameters": {}, - "resourceName": "DetectorModel", - "resourceIdentifier": "detectorModelName" - } - ] - } - }, - "UpdateInput": { - "inputName": { - "completions": [ - { - "parameters": {}, - "resourceName": "Input", - "resourceIdentifier": "inputName" - } - ] - } - } - } -} diff --git a/awscli/botocore/data/iotevents/2018-07-27/endpoint-rule-set-1.json b/awscli/botocore/data/iotevents/2018-07-27/endpoint-rule-set-1.json deleted file mode 100644 index 4a73454e44c8..000000000000 --- a/awscli/botocore/data/iotevents/2018-07-27/endpoint-rule-set-1.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://iotevents-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://iotevents-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://iotevents.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://iotevents.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] -} \ No newline at end of file diff --git a/awscli/botocore/data/iotevents/2018-07-27/paginators-1.json b/awscli/botocore/data/iotevents/2018-07-27/paginators-1.json deleted file mode 100644 index ea142457a6a7..000000000000 --- a/awscli/botocore/data/iotevents/2018-07-27/paginators-1.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "pagination": {} -} diff --git a/awscli/botocore/data/iotevents/2018-07-27/service-2.json b/awscli/botocore/data/iotevents/2018-07-27/service-2.json deleted file mode 100644 index a012b35c6448..000000000000 --- a/awscli/botocore/data/iotevents/2018-07-27/service-2.json +++ /dev/null @@ -1,2938 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2018-07-27", - "endpointPrefix":"iotevents", - "protocol":"rest-json", - "protocols":["rest-json"], - "serviceFullName":"AWS IoT Events", - "serviceId":"IoT Events", - "signatureVersion":"v4", - "signingName":"iotevents", - "uid":"iotevents-2018-07-27", - "auth":["aws.auth#sigv4"] - }, - "operations":{ - "CreateAlarmModel":{ - "name":"CreateAlarmModel", - "http":{ - "method":"POST", - "requestUri":"/alarm-models" - }, - "input":{"shape":"CreateAlarmModelRequest"}, - "output":{"shape":"CreateAlarmModelResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceInUseException"}, - {"shape":"ResourceAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"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.
" - }, - "CreateDetectorModel":{ - "name":"CreateDetectorModel", - "http":{ - "method":"POST", - "requestUri":"/detector-models" - }, - "input":{"shape":"CreateDetectorModelRequest"}, - "output":{"shape":"CreateDetectorModelResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceInUseException"}, - {"shape":"ResourceAlreadyExistsException"}, - {"shape":"LimitExceededException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"Creates a detector model.
" - }, - "CreateInput":{ - "name":"CreateInput", - "http":{ - "method":"POST", - "requestUri":"/inputs", - "responseCode":201 - }, - "input":{"shape":"CreateInputRequest"}, - "output":{"shape":"CreateInputResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ResourceAlreadyExistsException"} - ], - "documentation":"Creates an input.
" - }, - "DeleteAlarmModel":{ - "name":"DeleteAlarmModel", - "http":{ - "method":"DELETE", - "requestUri":"/alarm-models/{alarmModelName}", - "responseCode":204 - }, - "input":{"shape":"DeleteAlarmModelRequest"}, - "output":{"shape":"DeleteAlarmModelResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceInUseException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.
" - }, - "DeleteDetectorModel":{ - "name":"DeleteDetectorModel", - "http":{ - "method":"DELETE", - "requestUri":"/detector-models/{detectorModelName}", - "responseCode":204 - }, - "input":{"shape":"DeleteDetectorModelRequest"}, - "output":{"shape":"DeleteDetectorModelResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceInUseException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"Deletes a detector model. Any active instances of the detector model are also deleted.
" - }, - "DeleteInput":{ - "name":"DeleteInput", - "http":{ - "method":"DELETE", - "requestUri":"/inputs/{inputName}" - }, - "input":{"shape":"DeleteInputRequest"}, - "output":{"shape":"DeleteInputResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ResourceInUseException"} - ], - "documentation":"Deletes an input.
" - }, - "DescribeAlarmModel":{ - "name":"DescribeAlarmModel", - "http":{ - "method":"GET", - "requestUri":"/alarm-models/{alarmModelName}" - }, - "input":{"shape":"DescribeAlarmModelRequest"}, - "output":{"shape":"DescribeAlarmModelResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion parameter, the latest version is returned.
Describes a detector model. If the version parameter is not specified, information about the latest version is returned.
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.
Describes an input.
" - }, - "DescribeLoggingOptions":{ - "name":"DescribeLoggingOptions", - "http":{ - "method":"GET", - "requestUri":"/logging" - }, - "input":{"shape":"DescribeLoggingOptionsRequest"}, - "output":{"shape":"DescribeLoggingOptionsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"UnsupportedOperationException"} - ], - "documentation":"Retrieves the current settings of the AWS IoT Events logging options.
" - }, - "GetDetectorModelAnalysisResults":{ - "name":"GetDetectorModelAnalysisResults", - "http":{ - "method":"GET", - "requestUri":"/analysis/detector-models/{analysisId}/results" - }, - "input":{"shape":"GetDetectorModelAnalysisResultsRequest"}, - "output":{"shape":"GetDetectorModelAnalysisResultsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"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.
Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
" - }, - "ListAlarmModels":{ - "name":"ListAlarmModels", - "http":{ - "method":"GET", - "requestUri":"/alarm-models" - }, - "input":{"shape":"ListAlarmModelsRequest"}, - "output":{"shape":"ListAlarmModelsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
" - }, - "ListDetectorModelVersions":{ - "name":"ListDetectorModelVersions", - "http":{ - "method":"GET", - "requestUri":"/detector-models/{detectorModelName}/versions" - }, - "input":{"shape":"ListDetectorModelVersionsRequest"}, - "output":{"shape":"ListDetectorModelVersionsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
" - }, - "ListDetectorModels":{ - "name":"ListDetectorModels", - "http":{ - "method":"GET", - "requestUri":"/detector-models" - }, - "input":{"shape":"ListDetectorModelsRequest"}, - "output":{"shape":"ListDetectorModelsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"Lists the detector models you have created. Only the metadata associated with each detector model is returned.
" - }, - "ListInputRoutings":{ - "name":"ListInputRoutings", - "http":{ - "method":"POST", - "requestUri":"/input-routings" - }, - "input":{"shape":"ListInputRoutingsRequest"}, - "output":{"shape":"ListInputRoutingsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ResourceNotFoundException"} - ], - "documentation":"Lists one or more input routings.
" - }, - "ListInputs":{ - "name":"ListInputs", - "http":{ - "method":"GET", - "requestUri":"/inputs" - }, - "input":{"shape":"ListInputsRequest"}, - "output":{"shape":"ListInputsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"Lists the inputs you have created.
" - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"GET", - "requestUri":"/tags" - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ResourceInUseException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"} - ], - "documentation":"Lists the tags (metadata) you have assigned to the resource.
" - }, - "PutLoggingOptions":{ - "name":"PutLoggingOptions", - "http":{ - "method":"PUT", - "requestUri":"/logging" - }, - "input":{"shape":"PutLoggingOptionsRequest"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"UnsupportedOperationException"}, - {"shape":"ResourceInUseException"} - ], - "documentation":"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.
Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.
" - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/tags" - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ResourceInUseException"}, - {"shape":"ThrottlingException"}, - {"shape":"LimitExceededException"}, - {"shape":"InternalFailureException"} - ], - "documentation":"Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/tags" - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ResourceInUseException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"} - ], - "documentation":"Removes the given tags (metadata) from the resource.
" - }, - "UpdateAlarmModel":{ - "name":"UpdateAlarmModel", - "http":{ - "method":"POST", - "requestUri":"/alarm-models/{alarmModelName}" - }, - "input":{"shape":"UpdateAlarmModelRequest"}, - "output":{"shape":"UpdateAlarmModelResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceInUseException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.
" - }, - "UpdateDetectorModel":{ - "name":"UpdateDetectorModel", - "http":{ - "method":"POST", - "requestUri":"/detector-models/{detectorModelName}" - }, - "input":{"shape":"UpdateDetectorModelRequest"}, - "output":{"shape":"UpdateDetectorModelResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ResourceInUseException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ThrottlingException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"} - ], - "documentation":"Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
" - }, - "UpdateInput":{ - "name":"UpdateInput", - "http":{ - "method":"PUT", - "requestUri":"/inputs/{inputName}" - }, - "input":{"shape":"UpdateInputRequest"}, - "output":{"shape":"UpdateInputResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalFailureException"}, - {"shape":"ServiceUnavailableException"}, - {"shape":"ResourceInUseException"} - ], - "documentation":"Updates an input.
" - } - }, - "shapes":{ - "AcknowledgeFlow":{ - "type":"structure", - "required":["enabled"], - "members":{ - "enabled":{ - "shape":"AcknowledgeFlowEnabled", - "documentation":"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.
Specifies whether to get notified for alarm state changes.
" - }, - "AcknowledgeFlowEnabled":{ - "type":"boolean", - "box":true - }, - "Action":{ - "type":"structure", - "members":{ - "setVariable":{ - "shape":"SetVariableAction", - "documentation":"Sets a variable to a specified value.
" - }, - "sns":{ - "shape":"SNSTopicPublishAction", - "documentation":"Sends an Amazon SNS message.
" - }, - "iotTopicPublish":{ - "shape":"IotTopicPublishAction", - "documentation":"Publishes an MQTT message with the given topic to the AWS IoT message broker.
" - }, - "setTimer":{ - "shape":"SetTimerAction", - "documentation":"Information needed to set the timer.
" - }, - "clearTimer":{ - "shape":"ClearTimerAction", - "documentation":"Information needed to clear the timer.
" - }, - "resetTimer":{ - "shape":"ResetTimerAction", - "documentation":"Information needed to reset the timer.
" - }, - "lambda":{ - "shape":"LambdaAction", - "documentation":"Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
" - }, - "iotEvents":{ - "shape":"IotEventsAction", - "documentation":"Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
" - }, - "sqs":{ - "shape":"SqsAction", - "documentation":"Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
" - }, - "firehose":{ - "shape":"FirehoseAction", - "documentation":"Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
" - }, - "dynamoDB":{ - "shape":"DynamoDBAction", - "documentation":"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":{ - "shape":"DynamoDBv2Action", - "documentation":"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":{ - "shape":"IotSiteWiseAction", - "documentation":"Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .
" - } - }, - "documentation":"An action to be performed when the condition is TRUE.
Specifies one of the following actions to receive notifications when the alarm state changes.
" - }, - "AlarmActions":{ - "type":"list", - "member":{"shape":"AlarmAction"} - }, - "AlarmCapabilities":{ - "type":"structure", - "members":{ - "initializationConfiguration":{ - "shape":"InitializationConfiguration", - "documentation":"Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
" - }, - "acknowledgeFlow":{ - "shape":"AcknowledgeFlow", - "documentation":"Specifies whether to get notified for alarm state changes.
" - } - }, - "documentation":"Contains the configuration information of alarm state changes.
" - }, - "AlarmEventActions":{ - "type":"structure", - "members":{ - "alarmActions":{ - "shape":"AlarmActions", - "documentation":"Specifies one or more supported actions to receive notifications when the alarm state changes.
" - } - }, - "documentation":"Contains information about one or more alarm actions.
" - }, - "AlarmModelArn":{"type":"string"}, - "AlarmModelDescription":{ - "type":"string", - "max":1024 - }, - "AlarmModelName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9_-]+$" - }, - "AlarmModelSummaries":{ - "type":"list", - "member":{"shape":"AlarmModelSummary"} - }, - "AlarmModelSummary":{ - "type":"structure", - "members":{ - "creationTime":{ - "shape":"Timestamp", - "documentation":"The time the alarm model was created, in the Unix epoch format.
" - }, - "alarmModelDescription":{ - "shape":"AlarmModelDescription", - "documentation":"The description of the alarm model.
" - }, - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
" - } - }, - "documentation":"Contains a summary of an alarm model.
" - }, - "AlarmModelVersion":{ - "type":"string", - "max":128, - "min":1 - }, - "AlarmModelVersionStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "ACTIVATING", - "INACTIVE", - "FAILED" - ] - }, - "AlarmModelVersionSummaries":{ - "type":"list", - "member":{"shape":"AlarmModelVersionSummary"} - }, - "AlarmModelVersionSummary":{ - "type":"structure", - "members":{ - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
" - }, - "alarmModelArn":{ - "shape":"AlarmModelArn", - "documentation":"The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
" - }, - "alarmModelVersion":{ - "shape":"AlarmModelVersion", - "documentation":"The version of the alarm model.
" - }, - "roleArn":{ - "shape":"AmazonResourceName", - "documentation":"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":{ - "shape":"Timestamp", - "documentation":"The time the alarm model was created, in the Unix epoch format.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The time the alarm model was last updated, in the Unix epoch format.
" - }, - "status":{ - "shape":"AlarmModelVersionStatus", - "documentation":"The status of the alarm model. The status can be one of the following values:
ACTIVE - The alarm model is active and it's ready to evaluate data.
ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.
INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.
FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.
Contains information about the status of the alarm model version.
" - } - }, - "documentation":"Contains a summary of an alarm model version.
" - }, - "AlarmNotification":{ - "type":"structure", - "members":{ - "notificationActions":{ - "shape":"NotificationActions", - "documentation":"Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.
" - } - }, - "documentation":"Contains information about one or more notification actions.
" - }, - "AlarmRule":{ - "type":"structure", - "members":{ - "simpleRule":{ - "shape":"SimpleRule", - "documentation":"A rule that compares an input property value to a threshold value with a comparison operator.
" - } - }, - "documentation":"Defines when your alarm is invoked.
" - }, - "AmazonResourceName":{ - "type":"string", - "max":2048, - "min":1 - }, - "AnalysisId":{"type":"string"}, - "AnalysisMessage":{"type":"string"}, - "AnalysisResult":{ - "type":"structure", - "members":{ - "type":{ - "shape":"AnalysisType", - "documentation":"The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:
supported-actions - You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region.
service-limits - Resources or API operations can't exceed service quotas (also known as limits). Update your detector model or request a quota increase.
structure - The detector model must follow a structure that AWS IoT Events supports.
expression-syntax - Your expression must follow the required syntax.
data-type - Data types referenced in the detector model must be compatible.
referenced-data - You must define the data referenced in your detector model before you can use the data.
referenced-resource - Resources that the detector model uses must be available.
For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.
" - }, - "level":{ - "shape":"AnalysisResultLevel", - "documentation":"The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories:
INFO - An information result tells you about a significant field in your detector model. This type of result usually doesn't require immediate action.
WARNING - A warning result draws special attention to fields that might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work as expected.
ERROR - An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.
Contains additional information about the analysis result.
" - }, - "locations":{ - "shape":"AnalysisResultLocations", - "documentation":"Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.
" - } - }, - "documentation":"Contains the result of the analysis.
" - }, - "AnalysisResultLevel":{ - "type":"string", - "enum":[ - "INFO", - "WARNING", - "ERROR" - ] - }, - "AnalysisResultLocation":{ - "type":"structure", - "members":{ - "path":{ - "shape":"AnalysisResultLocationPath", - "documentation":"A JsonPath expression that identifies the error field in your detector model.
" - } - }, - "documentation":"Contains information that you can use to locate the field in your detector model that the analysis result references.
" - }, - "AnalysisResultLocationPath":{"type":"string"}, - "AnalysisResultLocations":{ - "type":"list", - "member":{"shape":"AnalysisResultLocation"} - }, - "AnalysisResults":{ - "type":"list", - "member":{"shape":"AnalysisResult"} - }, - "AnalysisStatus":{ - "type":"string", - "enum":[ - "RUNNING", - "COMPLETE", - "FAILED" - ] - }, - "AnalysisType":{"type":"string"}, - "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":"structure", - "required":["timeInSeconds"], - "members":{ - "timeInSeconds":{ - "shape":"AssetPropertyTimeInSeconds", - "documentation":"The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
" - }, - "offsetInNanos":{ - "shape":"AssetPropertyOffsetInNanos", - "documentation":"The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999.
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 literal values, the expressions must contain single quotes. For example, the value for the timeInSeconds parameter can be '1586400675'.
For references, you must specify either variables or input values. For example, the value for the offsetInNanos parameter can be $variable.time.
For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the timeInSeconds parameter uses a substitution template.
'${$input.TemperatureInput.sensorData.timestamp / 1000}'
For more information, see Expressions in the AWS IoT Events Developer Guide.
" - }, - "AssetPropertyValue":{ - "type":"structure", - "members":{ - "value":{ - "shape":"AssetPropertyVariant", - "documentation":"The value to send to an asset property.
" - }, - "timestamp":{ - "shape":"AssetPropertyTimestamp", - "documentation":"The timestamp associated with the asset property value. The default is the current event time.
" - }, - "quality":{ - "shape":"AssetPropertyQuality", - "documentation":"The quality of the asset property value. The value must be 'GOOD', 'BAD', or 'UNCERTAIN'.
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 literal values, the expressions must contain single quotes. For example, the value for the quality parameter can be 'GOOD'.
For references, you must specify either variables or input values. For example, the value for the quality parameter can be $input.TemperatureInput.sensorData.quality.
For more information, see Expressions in the AWS IoT Events Developer Guide.
" - }, - "AssetPropertyVariant":{ - "type":"structure", - "members":{ - "stringValue":{ - "shape":"AssetPropertyStringValue", - "documentation":"The asset property value is a string. You must use an expression, and the evaluated result should be a string.
" - }, - "integerValue":{ - "shape":"AssetPropertyIntegerValue", - "documentation":"The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
" - }, - "doubleValue":{ - "shape":"AssetPropertyDoubleValue", - "documentation":"The asset property value is a double. You must use an expression, and the evaluated result should be a double.
" - }, - "booleanValue":{ - "shape":"AssetPropertyBooleanValue", - "documentation":"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.
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 literal values, the expressions must contain single quotes. For example, the value for the integerValue parameter can be '100'.
For references, you must specify either variables or parameters. For example, the value for the booleanValue parameter can be $variable.offline.
For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the doubleValue parameter uses a substitution template.
'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'
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.
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>...
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.
The name of the timer to clear.
" - } - }, - "documentation":"Information needed to clear the timer.
" - }, - "ComparisonOperator":{ - "type":"string", - "enum":[ - "GREATER", - "GREATER_OR_EQUAL", - "LESS", - "LESS_OR_EQUAL", - "EQUAL", - "NOT_EQUAL" - ] - }, - "Condition":{ - "type":"string", - "max":512 - }, - "ContentExpression":{ - "type":"string", - "min":1 - }, - "CreateAlarmModelRequest":{ - "type":"structure", - "required":[ - "alarmModelName", - "roleArn", - "alarmRule" - ], - "members":{ - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model.
" - }, - "alarmModelDescription":{ - "shape":"AlarmModelDescription", - "documentation":"A description that tells you what the alarm model detects.
" - }, - "roleArn":{ - "shape":"AmazonResourceName", - "documentation":"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":{ - "shape":"Tags", - "documentation":"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":{ - "shape":"AttributeJsonPath", - "documentation":"An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.
" - }, - "severity":{ - "shape":"Severity", - "documentation":"A non-negative integer that reflects the severity level of the alarm.
" - }, - "alarmRule":{ - "shape":"AlarmRule", - "documentation":"Defines when your alarm is invoked.
" - }, - "alarmNotification":{ - "shape":"AlarmNotification", - "documentation":"Contains information about one or more notification actions.
" - }, - "alarmEventActions":{ - "shape":"AlarmEventActions", - "documentation":"Contains information about one or more alarm actions.
" - }, - "alarmCapabilities":{ - "shape":"AlarmCapabilities", - "documentation":"Contains the configuration information of alarm state changes.
" - } - } - }, - "CreateAlarmModelResponse":{ - "type":"structure", - "members":{ - "creationTime":{ - "shape":"Timestamp", - "documentation":"The time the alarm model was created, in the Unix epoch format.
" - }, - "alarmModelArn":{ - "shape":"AlarmModelArn", - "documentation":"The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
" - }, - "alarmModelVersion":{ - "shape":"AlarmModelVersion", - "documentation":"The version of the alarm model.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The time the alarm model was last updated, in the Unix epoch format.
" - }, - "status":{ - "shape":"AlarmModelVersionStatus", - "documentation":"The status of the alarm model. The status can be one of the following values:
ACTIVE - The alarm model is active and it's ready to evaluate data.
ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.
INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.
FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.
The name of the detector model.
" - }, - "detectorModelDefinition":{ - "shape":"DetectorModelDefinition", - "documentation":"Information that defines how the detectors operate.
" - }, - "detectorModelDescription":{ - "shape":"DetectorModelDescription", - "documentation":"A brief description of the detector model.
" - }, - "key":{ - "shape":"AttributeJsonPath", - "documentation":"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":{ - "shape":"AmazonResourceName", - "documentation":"The ARN of the role that grants permission to AWS IoT Events to perform its operations.
" - }, - "tags":{ - "shape":"Tags", - "documentation":"Metadata that can be used to manage the detector model.
" - }, - "evaluationMethod":{ - "shape":"EvaluationMethod", - "documentation":"Information about the order in which events are evaluated and how actions are executed.
" - } - } - }, - "CreateDetectorModelResponse":{ - "type":"structure", - "members":{ - "detectorModelConfiguration":{ - "shape":"DetectorModelConfiguration", - "documentation":"Information about how the detector model is configured.
" - } - } - }, - "CreateInputRequest":{ - "type":"structure", - "required":[ - "inputName", - "inputDefinition" - ], - "members":{ - "inputName":{ - "shape":"InputName", - "documentation":"The name you want to give to the input.
" - }, - "inputDescription":{ - "shape":"InputDescription", - "documentation":"A brief description of the input.
" - }, - "inputDefinition":{ - "shape":"InputDefinition", - "documentation":"The definition of the input.
" - }, - "tags":{ - "shape":"Tags", - "documentation":"Metadata that can be used to manage the input.
" - } - } - }, - "CreateInputResponse":{ - "type":"structure", - "members":{ - "inputConfiguration":{ - "shape":"InputConfiguration", - "documentation":"Information about the configuration of the input.
" - } - } - }, - "DeleteAlarmModelRequest":{ - "type":"structure", - "required":["alarmModelName"], - "members":{ - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
", - "location":"uri", - "locationName":"alarmModelName" - } - } - }, - "DeleteAlarmModelResponse":{ - "type":"structure", - "members":{} - }, - "DeleteDetectorModelRequest":{ - "type":"structure", - "required":["detectorModelName"], - "members":{ - "detectorModelName":{ - "shape":"DetectorModelName", - "documentation":"The name of the detector model to be deleted.
", - "location":"uri", - "locationName":"detectorModelName" - } - } - }, - "DeleteDetectorModelResponse":{ - "type":"structure", - "members":{} - }, - "DeleteInputRequest":{ - "type":"structure", - "required":["inputName"], - "members":{ - "inputName":{ - "shape":"InputName", - "documentation":"The name of the input to delete.
", - "location":"uri", - "locationName":"inputName" - } - } - }, - "DeleteInputResponse":{ - "type":"structure", - "members":{} - }, - "DeliveryStreamName":{"type":"string"}, - "DescribeAlarmModelRequest":{ - "type":"structure", - "required":["alarmModelName"], - "members":{ - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
", - "location":"uri", - "locationName":"alarmModelName" - }, - "alarmModelVersion":{ - "shape":"AlarmModelVersion", - "documentation":"The version of the alarm model.
", - "location":"querystring", - "locationName":"version" - } - } - }, - "DescribeAlarmModelResponse":{ - "type":"structure", - "members":{ - "creationTime":{ - "shape":"Timestamp", - "documentation":"The time the alarm model was created, in the Unix epoch format.
" - }, - "alarmModelArn":{ - "shape":"AlarmModelArn", - "documentation":"The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
" - }, - "alarmModelVersion":{ - "shape":"AlarmModelVersion", - "documentation":"The version of the alarm model.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The time the alarm model was last updated, in the Unix epoch format.
" - }, - "status":{ - "shape":"AlarmModelVersionStatus", - "documentation":"The status of the alarm model. The status can be one of the following values:
ACTIVE - The alarm model is active and it's ready to evaluate data.
ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.
INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.
FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.
Contains information about the status of the alarm model.
" - }, - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
" - }, - "alarmModelDescription":{ - "shape":"AlarmModelDescription", - "documentation":"The description of the alarm model.
" - }, - "roleArn":{ - "shape":"AmazonResourceName", - "documentation":"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":{ - "shape":"AttributeJsonPath", - "documentation":"An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.
" - }, - "severity":{ - "shape":"Severity", - "documentation":"A non-negative integer that reflects the severity level of the alarm.
" - }, - "alarmRule":{ - "shape":"AlarmRule", - "documentation":"Defines when your alarm is invoked.
" - }, - "alarmNotification":{ - "shape":"AlarmNotification", - "documentation":"Contains information about one or more notification actions.
" - }, - "alarmEventActions":{ - "shape":"AlarmEventActions", - "documentation":"Contains information about one or more alarm actions.
" - }, - "alarmCapabilities":{ - "shape":"AlarmCapabilities", - "documentation":"Contains the configuration information of alarm state changes.
" - } - } - }, - "DescribeDetectorModelAnalysisRequest":{ - "type":"structure", - "required":["analysisId"], - "members":{ - "analysisId":{ - "shape":"AnalysisId", - "documentation":"The ID of the analysis result that you want to retrieve.
", - "location":"uri", - "locationName":"analysisId" - } - } - }, - "DescribeDetectorModelAnalysisResponse":{ - "type":"structure", - "members":{ - "status":{ - "shape":"AnalysisStatus", - "documentation":"The status of the analysis activity. The status can be one of the following values:
RUNNING - AWS IoT Events is analyzing your detector model. This process can take several minutes to complete.
COMPLETE - AWS IoT Events finished analyzing your detector model.
FAILED - AWS IoT Events couldn't analyze your detector model. Try again later.
The name of the detector model.
", - "location":"uri", - "locationName":"detectorModelName" - }, - "detectorModelVersion":{ - "shape":"DetectorModelVersion", - "documentation":"The version of the detector model.
", - "location":"querystring", - "locationName":"version" - } - } - }, - "DescribeDetectorModelResponse":{ - "type":"structure", - "members":{ - "detectorModel":{ - "shape":"DetectorModel", - "documentation":"Information about the detector model.
" - } - } - }, - "DescribeInputRequest":{ - "type":"structure", - "required":["inputName"], - "members":{ - "inputName":{ - "shape":"InputName", - "documentation":"The name of the input.
", - "location":"uri", - "locationName":"inputName" - } - } - }, - "DescribeInputResponse":{ - "type":"structure", - "members":{ - "input":{ - "shape":"Input", - "documentation":"Information about the input.
" - } - } - }, - "DescribeLoggingOptionsRequest":{ - "type":"structure", - "members":{} - }, - "DescribeLoggingOptionsResponse":{ - "type":"structure", - "members":{ - "loggingOptions":{ - "shape":"LoggingOptions", - "documentation":"The current settings of the AWS IoT Events logging options.
" - } - } - }, - "DetectorDebugOption":{ - "type":"structure", - "required":["detectorModelName"], - "members":{ - "detectorModelName":{ - "shape":"DetectorModelName", - "documentation":"The name of the detector model.
" - }, - "keyValue":{ - "shape":"KeyValue", - "documentation":"The value of the input attribute key used to create the detector (the instance of the detector model).
" - } - }, - "documentation":"The detector model and the specific detectors (instances) for which the logging level is given.
" - }, - "DetectorDebugOptions":{ - "type":"list", - "member":{"shape":"DetectorDebugOption"}, - "min":1 - }, - "DetectorModel":{ - "type":"structure", - "members":{ - "detectorModelDefinition":{ - "shape":"DetectorModelDefinition", - "documentation":"Information that defines how a detector operates.
" - }, - "detectorModelConfiguration":{ - "shape":"DetectorModelConfiguration", - "documentation":"Information about how the detector is configured.
" - } - }, - "documentation":"Information about the detector model.
" - }, - "DetectorModelArn":{"type":"string"}, - "DetectorModelConfiguration":{ - "type":"structure", - "members":{ - "detectorModelName":{ - "shape":"DetectorModelName", - "documentation":"The name of the detector model.
" - }, - "detectorModelVersion":{ - "shape":"DetectorModelVersion", - "documentation":"The version of the detector model.
" - }, - "detectorModelDescription":{ - "shape":"DetectorModelDescription", - "documentation":"A brief description of the detector model.
" - }, - "detectorModelArn":{ - "shape":"DetectorModelArn", - "documentation":"The ARN of the detector model.
" - }, - "roleArn":{ - "shape":"AmazonResourceName", - "documentation":"The ARN of the role that grants permission to AWS IoT Events to perform its operations.
" - }, - "creationTime":{ - "shape":"Timestamp", - "documentation":"The time the detector model was created.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The time the detector model was last updated.
" - }, - "status":{ - "shape":"DetectorModelVersionStatus", - "documentation":"The status of the detector model.
" - }, - "key":{ - "shape":"AttributeJsonPath", - "documentation":"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":{ - "shape":"EvaluationMethod", - "documentation":"Information about the order in which events are evaluated and how actions are executed.
" - } - }, - "documentation":"Information about how the detector model is configured.
" - }, - "DetectorModelDefinition":{ - "type":"structure", - "required":[ - "states", - "initialStateName" - ], - "members":{ - "states":{ - "shape":"States", - "documentation":"Information about the states of the detector.
" - }, - "initialStateName":{ - "shape":"StateName", - "documentation":"The state that is entered at the creation of each detector (instance).
" - } - }, - "documentation":"Information that defines how a detector operates.
" - }, - "DetectorModelDescription":{ - "type":"string", - "max":1024 - }, - "DetectorModelName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9_-]+$" - }, - "DetectorModelSummaries":{ - "type":"list", - "member":{"shape":"DetectorModelSummary"} - }, - "DetectorModelSummary":{ - "type":"structure", - "members":{ - "detectorModelName":{ - "shape":"DetectorModelName", - "documentation":"The name of the detector model.
" - }, - "detectorModelDescription":{ - "shape":"DetectorModelDescription", - "documentation":"A brief description of the detector model.
" - }, - "creationTime":{ - "shape":"Timestamp", - "documentation":"The time the detector model was created.
" - } - }, - "documentation":"Information about the detector model.
" - }, - "DetectorModelVersion":{ - "type":"string", - "max":128, - "min":1 - }, - "DetectorModelVersionStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "ACTIVATING", - "INACTIVE", - "DEPRECATED", - "DRAFT", - "PAUSED", - "FAILED" - ] - }, - "DetectorModelVersionSummaries":{ - "type":"list", - "member":{"shape":"DetectorModelVersionSummary"} - }, - "DetectorModelVersionSummary":{ - "type":"structure", - "members":{ - "detectorModelName":{ - "shape":"DetectorModelName", - "documentation":"The name of the detector model.
" - }, - "detectorModelVersion":{ - "shape":"DetectorModelVersion", - "documentation":"The ID of the detector model version.
" - }, - "detectorModelArn":{ - "shape":"DetectorModelArn", - "documentation":"The ARN of the detector model version.
" - }, - "roleArn":{ - "shape":"AmazonResourceName", - "documentation":"The ARN of the role that grants the detector model permission to perform its tasks.
" - }, - "creationTime":{ - "shape":"Timestamp", - "documentation":"The time the detector model version was created.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The last time the detector model version was updated.
" - }, - "status":{ - "shape":"DetectorModelVersionStatus", - "documentation":"The status of the detector model version.
" - }, - "evaluationMethod":{ - "shape":"EvaluationMethod", - "documentation":"Information about the order in which events are evaluated and how actions are executed.
" - } - }, - "documentation":"Information about the detector model version.
" - }, - "DisabledOnInitialization":{ - "type":"boolean", - "box":true - }, - "DynamoDBAction":{ - "type":"structure", - "required":[ - "hashKeyField", - "hashKeyValue", - "tableName" - ], - "members":{ - "hashKeyType":{ - "shape":"DynamoKeyType", - "documentation":"The data type for the hash key (also called the partition key). You can specify the following values:
'STRING' - The hash key is a string.
'NUMBER' - The hash key is a number.
If you don't specify hashKeyType, the default value is 'STRING'.
The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table.
The value of the hash key (also called the partition key).
" - }, - "rangeKeyType":{ - "shape":"DynamoKeyType", - "documentation":"The data type for the range key (also called the sort key), You can specify the following values:
'STRING' - The range key is a string.
'NUMBER' - The range key is number.
If you don't specify rangeKeyField, the default value is 'STRING'.
The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table.
The value of the range key (also called the sort key).
" - }, - "operation":{ - "shape":"DynamoOperation", - "documentation":"The type of operation to perform. You can specify the following values:
'INSERT' - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
'UPDATE' - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
'DELETE' - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
If you don't specify this parameter, AWS IoT Events triggers the 'INSERT' operation.
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.
The name of the DynamoDB table. The tableName value must match the table name of the target DynamoDB table.
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 literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING'.
For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name.
For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the hashKeyValue parameter uses a substitution template.
'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'
For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the tableName parameter uses a string concatenation.
'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date
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.
The name of the DynamoDB table.
" - }, - "payload":{"shape":"Payload"} - }, - "documentation":"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 literal values, the expressions must contain single quotes. For example, the value for the tableName parameter can be 'GreenhouseTemperatureTable'.
For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName.
For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the contentExpression parameter in Payload uses a substitution template.
'{\\\"sensorID\\\": \\\"${$input.GreenhouseInput.sensor_id}\\\", \\\"temperature\\\": \\\"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\\\"}'
For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the tableName parameter uses a string concatenation.
'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date
For more information, see Expressions in the AWS IoT Events Developer Guide.
The value for the type parameter in Payload must be JSON.
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.
Contains the subject and message of an email.
" - }, - "recipients":{ - "shape":"EmailRecipients", - "documentation":"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.
Contains the configuration information of email notifications.
" - }, - "EmailConfigurations":{ - "type":"list", - "member":{"shape":"EmailConfiguration"}, - "min":1 - }, - "EmailContent":{ - "type":"structure", - "members":{ - "subject":{ - "shape":"EmailSubject", - "documentation":"The subject of the email.
" - }, - "additionalMessage":{ - "shape":"NotificationAdditionalMessage", - "documentation":"The message that you want to send. The message can be up to 200 characters.
" - } - }, - "documentation":"Contains the subject and message of an email.
" - }, - "EmailRecipients":{ - "type":"structure", - "members":{ - "to":{ - "shape":"RecipientDetails", - "documentation":"Specifies one or more recipients who receive the email.
" - } - }, - "documentation":"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.
The name of the event.
" - }, - "condition":{ - "shape":"Condition", - "documentation":"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).
The actions to be performed.
" - } - }, - "documentation":"Specifies the actions to be performed when the condition evaluates to TRUE.
The name of the Kinesis Data Firehose delivery stream where the data is written.
" - }, - "separator":{ - "shape":"FirehoseSeparator", - "documentation":"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":{ - "shape":"Payload", - "documentation":"You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.
" - } - }, - "documentation":"Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
" - }, - "FirehoseSeparator":{ - "type":"string", - "pattern":"([\\n\\t])|(\\r\\n)|(,)" - }, - "FromEmail":{"type":"string"}, - "GetDetectorModelAnalysisResultsRequest":{ - "type":"structure", - "required":["analysisId"], - "members":{ - "analysisId":{ - "shape":"AnalysisId", - "documentation":"The ID of the analysis result that you want to retrieve.
", - "location":"uri", - "locationName":"analysisId" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token that you can use to return the next set of results.
", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxAnalysisResults", - "documentation":"The maximum number of results to be returned per request.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "GetDetectorModelAnalysisResultsResponse":{ - "type":"structure", - "members":{ - "analysisResults":{ - "shape":"AnalysisResults", - "documentation":"Contains information about one or more analysis results.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token that you can use to return the next set of results, or null if there are no more results.
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.
Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
" - }, - "Input":{ - "type":"structure", - "members":{ - "inputConfiguration":{ - "shape":"InputConfiguration", - "documentation":"Information about the configuration of an input.
" - }, - "inputDefinition":{ - "shape":"InputDefinition", - "documentation":"The definition of the input.
" - } - }, - "documentation":"Information about the input.
" - }, - "InputArn":{"type":"string"}, - "InputConfiguration":{ - "type":"structure", - "required":[ - "inputName", - "inputArn", - "creationTime", - "lastUpdateTime", - "status" - ], - "members":{ - "inputName":{ - "shape":"InputName", - "documentation":"The name of the input.
" - }, - "inputDescription":{ - "shape":"InputDescription", - "documentation":"A brief description of the input.
" - }, - "inputArn":{ - "shape":"InputArn", - "documentation":"The ARN of the input.
" - }, - "creationTime":{ - "shape":"Timestamp", - "documentation":"The time the input was created.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The last time the input was updated.
" - }, - "status":{ - "shape":"InputStatus", - "documentation":"The status of the input.
" - } - }, - "documentation":"Information about the configuration of an input.
" - }, - "InputDefinition":{ - "type":"structure", - "required":["attributes"], - "members":{ - "attributes":{ - "shape":"Attributes", - "documentation":"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.
The definition of the input.
" - }, - "InputDescription":{ - "type":"string", - "max":1024 - }, - "InputIdentifier":{ - "type":"structure", - "members":{ - "iotEventsInputIdentifier":{ - "shape":"IotEventsInputIdentifier", - "documentation":"The identifier of the input routed to AWS IoT Events.
" - }, - "iotSiteWiseInputIdentifier":{ - "shape":"IotSiteWiseInputIdentifier", - "documentation":"The identifer of the input routed from AWS IoT SiteWise.
" - } - }, - "documentation":"The identifer of the input.
" - }, - "InputName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$" - }, - "InputProperty":{ - "type":"string", - "max":512, - "min":1 - }, - "InputStatus":{ - "type":"string", - "enum":[ - "CREATING", - "UPDATING", - "ACTIVE", - "DELETING" - ] - }, - "InputSummaries":{ - "type":"list", - "member":{"shape":"InputSummary"} - }, - "InputSummary":{ - "type":"structure", - "members":{ - "inputName":{ - "shape":"InputName", - "documentation":"The name of the input.
" - }, - "inputDescription":{ - "shape":"InputDescription", - "documentation":"A brief description of the input.
" - }, - "inputArn":{ - "shape":"InputArn", - "documentation":"The ARN of the input.
" - }, - "creationTime":{ - "shape":"Timestamp", - "documentation":"The time the input was created.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The last time the input was updated.
" - }, - "status":{ - "shape":"InputStatus", - "documentation":"The status of the input.
" - } - }, - "documentation":"Information about the input.
" - }, - "InternalFailureException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"The message for the exception.
" - } - }, - "documentation":"An internal failure occurred.
", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true - }, - "InvalidRequestException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"The message for the exception.
" - } - }, - "documentation":"The request was invalid.
", - "error":{"httpStatusCode":400}, - "exception":true - }, - "IotEventsAction":{ - "type":"structure", - "required":["inputName"], - "members":{ - "inputName":{ - "shape":"InputName", - "documentation":"The name of the AWS IoT Events input where the data is sent.
" - }, - "payload":{ - "shape":"Payload", - "documentation":"You can configure the action payload when you send a message to an AWS IoT Events input.
" - } - }, - "documentation":"Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
" - }, - "IotEventsInputIdentifier":{ - "type":"structure", - "required":["inputName"], - "members":{ - "inputName":{ - "shape":"InputName", - "documentation":"The name of the input routed to AWS IoT Events.
" - } - }, - "documentation":"The identifier of the input routed to AWS IoT Events.
" - }, - "IotSiteWiseAction":{ - "type":"structure", - "members":{ - "entryId":{ - "shape":"AssetPropertyEntryId", - "documentation":"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":{ - "shape":"AssetId", - "documentation":"The ID of the asset that has the specified property.
" - }, - "propertyId":{ - "shape":"AssetPropertyId", - "documentation":"The ID of the asset property.
" - }, - "propertyAlias":{ - "shape":"AssetPropertyAlias", - "documentation":"The alias of the asset property.
" - }, - "propertyValue":{ - "shape":"AssetPropertyValue", - "documentation":"The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
" - } - }, - "documentation":"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
For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature'.
For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1.
For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the propertyAlias parameter uses a substitution template.
'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'
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.
" - }, - "IotSiteWiseAssetModelPropertyIdentifier":{ - "type":"structure", - "required":[ - "assetModelId", - "propertyId" - ], - "members":{ - "assetModelId":{ - "shape":"AssetModelId", - "documentation":"The ID of the AWS IoT SiteWise asset model.
" - }, - "propertyId":{ - "shape":"AssetPropertyId", - "documentation":"The ID of the AWS IoT SiteWise asset property.
" - } - }, - "documentation":"The asset model property identifer of the input routed from AWS IoT SiteWise.
" - }, - "IotSiteWiseInputIdentifier":{ - "type":"structure", - "members":{ - "iotSiteWiseAssetModelPropertyIdentifier":{ - "shape":"IotSiteWiseAssetModelPropertyIdentifier", - "documentation":"The identifier of the AWS IoT SiteWise asset model property.
" - } - }, - "documentation":"The identifer of the input routed from AWS IoT SiteWise.
" - }, - "IotTopicPublishAction":{ - "type":"structure", - "required":["mqttTopic"], - "members":{ - "mqttTopic":{ - "shape":"MQTTTopic", - "documentation":"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.
You can configure the action payload when you publish a message to an AWS IoT Core topic.
" - } - }, - "documentation":"Information required to publish the MQTT message through the AWS IoT message broker.
" - }, - "KeyValue":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9\\-_:]+$" - }, - "LambdaAction":{ - "type":"structure", - "required":["functionArn"], - "members":{ - "functionArn":{ - "shape":"AmazonResourceName", - "documentation":"The ARN of the Lambda function that is executed.
" - }, - "payload":{ - "shape":"Payload", - "documentation":"You can configure the action payload when you send a message to a Lambda function.
" - } - }, - "documentation":"Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
" - }, - "LimitExceededException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"The message for the exception.
" - } - }, - "documentation":"A limit was exceeded.
", - "error":{"httpStatusCode":410}, - "exception":true - }, - "ListAlarmModelVersionsRequest":{ - "type":"structure", - "required":["alarmModelName"], - "members":{ - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
", - "location":"uri", - "locationName":"alarmModelName" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token that you can use to return the next set of results.
", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to be returned per request.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListAlarmModelVersionsResponse":{ - "type":"structure", - "members":{ - "alarmModelVersionSummaries":{ - "shape":"AlarmModelVersionSummaries", - "documentation":"A list that summarizes each alarm model version.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token that you can use to return the next set of results, or null if there are no more results.
The token that you can use to return the next set of results.
", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to be returned per request.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListAlarmModelsResponse":{ - "type":"structure", - "members":{ - "alarmModelSummaries":{ - "shape":"AlarmModelSummaries", - "documentation":"A list that summarizes each alarm model.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token that you can use to return the next set of results, or null if there are no more results.
The name of the detector model whose versions are returned.
", - "location":"uri", - "locationName":"detectorModelName" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token that you can use to return the next set of results.
", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to be returned per request.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListDetectorModelVersionsResponse":{ - "type":"structure", - "members":{ - "detectorModelVersionSummaries":{ - "shape":"DetectorModelVersionSummaries", - "documentation":"Summary information about the detector model versions.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token that you can use to return the next set of results, or null if there are no more results.
The token that you can use to return the next set of results.
", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to be returned per request.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListDetectorModelsResponse":{ - "type":"structure", - "members":{ - "detectorModelSummaries":{ - "shape":"DetectorModelSummaries", - "documentation":"Summary information about the detector models.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token that you can use to return the next set of results, or null if there are no more results.
The identifer of the routed input.
" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to be returned per request.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token that you can use to return the next set of results.
" - } - } - }, - "ListInputRoutingsResponse":{ - "type":"structure", - "members":{ - "routedResources":{ - "shape":"RoutedResources", - "documentation":"Summary information about the routed resources.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":" The token that you can use to return the next set of results, or null if there are no more results.
The token that you can use to return the next set of results.
", - "location":"querystring", - "locationName":"nextToken" - }, - "maxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to be returned per request.
", - "location":"querystring", - "locationName":"maxResults" - } - } - }, - "ListInputsResponse":{ - "type":"structure", - "members":{ - "inputSummaries":{ - "shape":"InputSummaries", - "documentation":"Summary information about the inputs.
" - }, - "nextToken":{ - "shape":"NextToken", - "documentation":"The token that you can use to return the next set of results, or null if there are no more results.
The ARN of the resource.
", - "location":"querystring", - "locationName":"resourceArn" - } - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "members":{ - "tags":{ - "shape":"Tags", - "documentation":"The list of tags assigned to the resource.
" - } - } - }, - "LoggingEnabled":{"type":"boolean"}, - "LoggingLevel":{ - "type":"string", - "enum":[ - "ERROR", - "INFO", - "DEBUG" - ] - }, - "LoggingOptions":{ - "type":"structure", - "required":[ - "roleArn", - "level", - "enabled" - ], - "members":{ - "roleArn":{ - "shape":"AmazonResourceName", - "documentation":"The ARN of the role that grants permission to AWS IoT Events to perform logging.
" - }, - "level":{ - "shape":"LoggingLevel", - "documentation":"The logging level.
" - }, - "enabled":{ - "shape":"LoggingEnabled", - "documentation":"If TRUE, logging is enabled for AWS IoT Events.
" - }, - "detectorDebugOptions":{ - "shape":"DetectorDebugOptions", - "documentation":"Information that identifies those detector models and their detectors (instances) for which the logging level is given.
" - } - }, - "documentation":"The values of the AWS IoT Events logging options.
" - }, - "MQTTTopic":{ - "type":"string", - "max":128, - "min":1 - }, - "MaxAnalysisResults":{"type":"integer"}, - "MaxResults":{ - "type":"integer", - "max":250, - "min":1 - }, - "NextToken":{"type":"string"}, - "NotificationAction":{ - "type":"structure", - "required":["action"], - "members":{ - "action":{ - "shape":"NotificationTargetActions", - "documentation":"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":{ - "shape":"SMSConfigurations", - "documentation":"Contains the configuration information of SMS notifications.
" - }, - "emailConfigurations":{ - "shape":"EmailConfigurations", - "documentation":"Contains the configuration information of email notifications.
" - } - }, - "documentation":"Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.
" - }, - "NotificationActions":{ - "type":"list", - "member":{"shape":"NotificationAction"}, - "min":1 - }, - "NotificationAdditionalMessage":{"type":"string"}, - "NotificationTargetActions":{ - "type":"structure", - "members":{ - "lambdaAction":{"shape":"LambdaAction"} - }, - "documentation":"Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events.
" - }, - "OnEnterLifecycle":{ - "type":"structure", - "members":{ - "events":{ - "shape":"Events", - "documentation":"Specifies the actions that are performed when the state is entered and the condition is TRUE.
When entering this state, perform these actions if the condition is TRUE.
Specifies the actions that are performed when the state is exited and the condition is TRUE.
When exiting this state, perform these actions if the specified condition is TRUE.
Specifies the actions performed when the condition evaluates to TRUE.
Specifies the actions performed, and the next state entered, when a condition evaluates to TRUE.
Specifies the actions performed when the condition evaluates to TRUE.
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.
The value of the payload type can be either STRING or JSON.
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.
The new values of the AWS IoT Events logging options.
" - } - } - }, - "QueueUrl":{"type":"string"}, - "RecipientDetail":{ - "type":"structure", - "members":{ - "ssoIdentity":{ - "shape":"SSOIdentity", - "documentation":"The AWS Single Sign-On (AWS SSO) authentication information.
" - } - }, - "documentation":"The information that identifies the recipient.
" - }, - "RecipientDetails":{ - "type":"list", - "member":{"shape":"RecipientDetail"}, - "min":1 - }, - "ResetTimerAction":{ - "type":"structure", - "required":["timerName"], - "members":{ - "timerName":{ - "shape":"TimerName", - "documentation":"The name of the timer to reset.
" - } - }, - "documentation":"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.
" - }, - "ResourceAlreadyExistsException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"The message for the exception.
" - }, - "resourceId":{ - "shape":"resourceId", - "documentation":"The ID of the resource.
" - }, - "resourceArn":{ - "shape":"resourceArn", - "documentation":"The ARN of the resource.
" - } - }, - "documentation":"The resource already exists.
", - "error":{"httpStatusCode":409}, - "exception":true - }, - "ResourceInUseException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"The message for the exception.
" - } - }, - "documentation":"The resource is in use.
", - "error":{"httpStatusCode":409}, - "exception":true - }, - "ResourceName":{"type":"string"}, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"The message for the exception.
" - } - }, - "documentation":"The resource was not found.
", - "error":{"httpStatusCode":404}, - "exception":true - }, - "RoutedResource":{ - "type":"structure", - "members":{ - "name":{ - "shape":"ResourceName", - "documentation":"The name of the routed resource.
" - }, - "arn":{ - "shape":"AmazonResourceName", - "documentation":"The ARN of the routed resource. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
" - } - }, - "documentation":"Contains information about the routed resource.
" - }, - "RoutedResources":{ - "type":"list", - "member":{"shape":"RoutedResource"} - }, - "SMSConfiguration":{ - "type":"structure", - "required":["recipients"], - "members":{ - "senderId":{ - "shape":"SMSSenderId", - "documentation":"The sender ID.
" - }, - "additionalMessage":{ - "shape":"NotificationAdditionalMessage", - "documentation":"The message that you want to send. The message can be up to 200 characters.
" - }, - "recipients":{ - "shape":"RecipientDetails", - "documentation":"Specifies one or more recipients who receive the message.
You must add the users that receive SMS messages to your AWS SSO store.
Contains the configuration information of SMS notifications.
" - }, - "SMSConfigurations":{ - "type":"list", - "member":{"shape":"SMSConfiguration"}, - "min":1 - }, - "SMSSenderId":{"type":"string"}, - "SNSTopicPublishAction":{ - "type":"structure", - "required":["targetArn"], - "members":{ - "targetArn":{ - "shape":"AmazonResourceName", - "documentation":"The ARN of the Amazon SNS target where the message is sent.
" - }, - "payload":{ - "shape":"Payload", - "documentation":"You can configure the action payload when you send a message as an Amazon SNS push notification.
" - } - }, - "documentation":"Information required to publish the Amazon SNS message.
" - }, - "SSOIdentity":{ - "type":"structure", - "required":["identityStoreId"], - "members":{ - "identityStoreId":{ - "shape":"IdentityStoreId", - "documentation":"The ID of the AWS SSO identity store.
" - }, - "userId":{ - "shape":"SSOReferenceId", - "documentation":"The user ID.
" - } - }, - "documentation":"Contains information about your identity source in AWS Single Sign-On. For more information, see the AWS Single Sign-On User Guide.
" - }, - "SSOReferenceId":{"type":"string"}, - "Seconds":{ - "type":"integer", - "max":31622400, - "min":1 - }, - "ServiceUnavailableException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"The message for the exception.
" - } - }, - "documentation":"The service is currently unavailable.
", - "error":{"httpStatusCode":503}, - "exception":true, - "fault":true - }, - "SetTimerAction":{ - "type":"structure", - "required":["timerName"], - "members":{ - "timerName":{ - "shape":"TimerName", - "documentation":"The name of the timer.
" - }, - "seconds":{ - "shape":"Seconds", - "documentation":"The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.
", - "deprecated":true, - "deprecatedMessage":"seconds is deprecated. You can use durationExpression for SetTimerAction. The value of seconds can be used as a string expression for durationExpression." - }, - "durationExpression":{ - "shape":"VariableValue", - "documentation":"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.
Information needed to set the timer.
" - }, - "SetVariableAction":{ - "type":"structure", - "required":[ - "variableName", - "value" - ], - "members":{ - "variableName":{ - "shape":"VariableName", - "documentation":"The name of the variable.
" - }, - "value":{ - "shape":"VariableValue", - "documentation":"The new value of the variable.
" - } - }, - "documentation":"Information about the variable and its new value.
" - }, - "Severity":{ - "type":"integer", - "box":true, - "max":2147483647, - "min":0 - }, - "SimpleRule":{ - "type":"structure", - "required":[ - "inputProperty", - "comparisonOperator", - "threshold" - ], - "members":{ - "inputProperty":{ - "shape":"InputProperty", - "documentation":"The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property.
" - }, - "comparisonOperator":{ - "shape":"ComparisonOperator", - "documentation":"The comparison operator.
" - }, - "threshold":{ - "shape":"Threshold", - "documentation":"The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute.
" - } - }, - "documentation":"A rule that compares an input property value to a threshold value with a comparison operator.
" - }, - "SqsAction":{ - "type":"structure", - "required":["queueUrl"], - "members":{ - "queueUrl":{ - "shape":"QueueUrl", - "documentation":"The URL of the SQS queue where the data is written.
" - }, - "useBase64":{ - "shape":"UseBase64", - "documentation":"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":{ - "shape":"Payload", - "documentation":"You can configure the action payload when you send a message to an Amazon SQS queue.
" - } - }, - "documentation":"Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
" - }, - "StartDetectorModelAnalysisRequest":{ - "type":"structure", - "required":["detectorModelDefinition"], - "members":{ - "detectorModelDefinition":{"shape":"DetectorModelDefinition"} - } - }, - "StartDetectorModelAnalysisResponse":{ - "type":"structure", - "members":{ - "analysisId":{ - "shape":"AnalysisId", - "documentation":"The ID that you can use to retrieve the analysis result.
" - } - } - }, - "State":{ - "type":"structure", - "required":["stateName"], - "members":{ - "stateName":{ - "shape":"StateName", - "documentation":"The name of the state.
" - }, - "onInput":{ - "shape":"OnInputLifecycle", - "documentation":"When an input is received and the condition is TRUE, perform the specified actions.
When entering this state, perform these actions if the condition is TRUE.
When exiting this state, perform these actions if the specified condition is TRUE.
Information that defines a state of a detector.
" - }, - "StateName":{ - "type":"string", - "max":128, - "min":1 - }, - "States":{ - "type":"list", - "member":{"shape":"State"}, - "min":1 - }, - "StatusMessage":{"type":"string"}, - "Tag":{ - "type":"structure", - "required":[ - "key", - "value" - ], - "members":{ - "key":{ - "shape":"TagKey", - "documentation":"The tag's key.
" - }, - "value":{ - "shape":"TagValue", - "documentation":"The tag's value.
" - } - }, - "documentation":"Metadata that can be used to manage the resource.
" - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1 - }, - "TagKeys":{ - "type":"list", - "member":{"shape":"TagKey"} - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tags" - ], - "members":{ - "resourceArn":{ - "shape":"AmazonResourceName", - "documentation":"The ARN of the resource.
", - "location":"querystring", - "locationName":"resourceArn" - }, - "tags":{ - "shape":"Tags", - "documentation":"The new or modified tags for the resource.
" - } - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{} - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0 - }, - "Tags":{ - "type":"list", - "member":{"shape":"Tag"} - }, - "Threshold":{ - "type":"string", - "max":512, - "min":1 - }, - "ThrottlingException":{ - "type":"structure", - "members":{ - "message":{ - "shape":"errorMessage", - "documentation":"The message for the exception.
" - } - }, - "documentation":"The request could not be completed due to throttling.
", - "error":{"httpStatusCode":429}, - "exception":true - }, - "TimerName":{ - "type":"string", - "max":128, - "min":1 - }, - "Timestamp":{"type":"timestamp"}, - "TransitionEvent":{ - "type":"structure", - "required":[ - "eventName", - "condition", - "nextState" - ], - "members":{ - "eventName":{ - "shape":"EventName", - "documentation":"The name of the transition event.
" - }, - "condition":{ - "shape":"Condition", - "documentation":"Required. A Boolean expression that when TRUE causes the actions to be performed and the nextState to be entered.
The actions to be performed.
" - }, - "nextState":{ - "shape":"StateName", - "documentation":"The next state to enter.
" - } - }, - "documentation":"Specifies the actions performed and the next state entered when a condition evaluates to TRUE.
The message for the exception.
" - } - }, - "documentation":"The requested operation is not supported.
", - "error":{"httpStatusCode":501}, - "exception":true, - "fault":true - }, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tagKeys" - ], - "members":{ - "resourceArn":{ - "shape":"AmazonResourceName", - "documentation":"The ARN of the resource.
", - "location":"querystring", - "locationName":"resourceArn" - }, - "tagKeys":{ - "shape":"TagKeys", - "documentation":"A list of the keys of the tags to be removed from the resource.
", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{} - }, - "UpdateAlarmModelRequest":{ - "type":"structure", - "required":[ - "alarmModelName", - "roleArn", - "alarmRule" - ], - "members":{ - "alarmModelName":{ - "shape":"AlarmModelName", - "documentation":"The name of the alarm model.
", - "location":"uri", - "locationName":"alarmModelName" - }, - "alarmModelDescription":{ - "shape":"AlarmModelDescription", - "documentation":"The description of the alarm model.
" - }, - "roleArn":{ - "shape":"AmazonResourceName", - "documentation":"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":{ - "shape":"Severity", - "documentation":"A non-negative integer that reflects the severity level of the alarm.
" - }, - "alarmRule":{ - "shape":"AlarmRule", - "documentation":"Defines when your alarm is invoked.
" - }, - "alarmNotification":{ - "shape":"AlarmNotification", - "documentation":"Contains information about one or more notification actions.
" - }, - "alarmEventActions":{ - "shape":"AlarmEventActions", - "documentation":"Contains information about one or more alarm actions.
" - }, - "alarmCapabilities":{ - "shape":"AlarmCapabilities", - "documentation":"Contains the configuration information of alarm state changes.
" - } - } - }, - "UpdateAlarmModelResponse":{ - "type":"structure", - "members":{ - "creationTime":{ - "shape":"Timestamp", - "documentation":"The time the alarm model was created, in the Unix epoch format.
" - }, - "alarmModelArn":{ - "shape":"AlarmModelArn", - "documentation":"The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
" - }, - "alarmModelVersion":{ - "shape":"AlarmModelVersion", - "documentation":"The version of the alarm model.
" - }, - "lastUpdateTime":{ - "shape":"Timestamp", - "documentation":"The time the alarm model was last updated, in the Unix epoch format.
" - }, - "status":{ - "shape":"AlarmModelVersionStatus", - "documentation":"The status of the alarm model. The status can be one of the following values:
ACTIVE - The alarm model is active and it's ready to evaluate data.
ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.
INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.
FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.
The name of the detector model that is updated.
", - "location":"uri", - "locationName":"detectorModelName" - }, - "detectorModelDefinition":{ - "shape":"DetectorModelDefinition", - "documentation":"Information that defines how a detector operates.
" - }, - "detectorModelDescription":{ - "shape":"DetectorModelDescription", - "documentation":"A brief description of the detector model.
" - }, - "roleArn":{ - "shape":"AmazonResourceName", - "documentation":"The ARN of the role that grants permission to AWS IoT Events to perform its operations.
" - }, - "evaluationMethod":{ - "shape":"EvaluationMethod", - "documentation":"Information about the order in which events are evaluated and how actions are executed.
" - } - } - }, - "UpdateDetectorModelResponse":{ - "type":"structure", - "members":{ - "detectorModelConfiguration":{ - "shape":"DetectorModelConfiguration", - "documentation":"Information about how the detector model is configured.
" - } - } - }, - "UpdateInputRequest":{ - "type":"structure", - "required":[ - "inputName", - "inputDefinition" - ], - "members":{ - "inputName":{ - "shape":"InputName", - "documentation":"The name of the input you want to update.
", - "location":"uri", - "locationName":"inputName" - }, - "inputDescription":{ - "shape":"InputDescription", - "documentation":"A brief description of the input.
" - }, - "inputDefinition":{ - "shape":"InputDefinition", - "documentation":"The definition of the input.
" - } - } - }, - "UpdateInputResponse":{ - "type":"structure", - "members":{ - "inputConfiguration":{ - "shape":"InputConfiguration", - "documentation":"Information about the configuration of the input.
" - } - } - }, - "UseBase64":{"type":"boolean"}, - "VariableName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$" - }, - "VariableValue":{ - "type":"string", - "max":1024, - "min":1 - }, - "errorMessage":{"type":"string"}, - "resourceArn":{"type":"string"}, - "resourceId":{"type":"string"} - }, - "documentation":"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.
" -} diff --git a/awscli/botocore/data/panorama/2019-07-24/completions-1.json b/awscli/botocore/data/panorama/2019-07-24/completions-1.json deleted file mode 100644 index 274c895a4eda..000000000000 --- a/awscli/botocore/data/panorama/2019-07-24/completions-1.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "version": "1.0", - "resources": { - "ApplicationInstance": { - "operation": "ListApplicationInstances", - "resourceIdentifier": { - "ApplicationInstanceId": "ApplicationInstances[].ApplicationInstanceId" - } - }, - "Device": { - "operation": "ListDevices", - "resourceIdentifier": { - "DeviceId": "Devices[].DeviceId" - } - }, - "Package": { - "operation": "ListPackages", - "resourceIdentifier": { - "PackageId": "Packages[].PackageId", - "PackageName": "Packages[].PackageName" - } - }, - "DeviceJob": { - "operation": "ListDevicesJobs", - "resourceIdentifier": { - "JobId": "DeviceJobs[].JobId" - } - }, - "Node": { - "operation": "ListNodes", - "resourceIdentifier": { - "NodeId": "Nodes[].NodeId" - } - }, - "NodeFromTemplateJob": { - "operation": "ListNodeFromTemplateJobs", - "resourceIdentifier": { - "JobId": "NodeFromTemplateJobs[].JobId" - } - }, - "PackageImportJob": { - "operation": "ListPackageImportJobs", - "resourceIdentifier": { - "JobId": "PackageImportJobs[].JobId" - } - } - }, - "operations": { - "CreateApplicationInstance": { - "ApplicationInstanceIdToReplace": { - "completions": [ - { - "parameters": {}, - "resourceName": "ApplicationInstance", - "resourceIdentifier": "ApplicationInstanceId" - } - ] - } - }, - "CreateJobForDevices": { - "DeviceIds": { - "completions": [ - { - "parameters": {}, - "resourceName": "Device", - "resourceIdentifier": "DeviceId" - } - ] - } - }, - "CreateNodeFromTemplateJob": { - "OutputPackageName": { - "completions": [ - { - "parameters": {}, - "resourceName": "Package", - "resourceIdentifier": "PackageName" - } - ] - } - }, - "DeleteDevice": { - "DeviceId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Device", - "resourceIdentifier": "DeviceId" - } - ] - } - }, - "DeletePackage": { - "PackageId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Package", - "resourceIdentifier": "PackageId" - } - ] - } - }, - "DeregisterPackageVersion": { - "PackageId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Package", - "resourceIdentifier": "PackageId" - } - ] - } - }, - "DescribeApplicationInstance": { - "ApplicationInstanceId": { - "completions": [ - { - "parameters": {}, - "resourceName": "ApplicationInstance", - "resourceIdentifier": "ApplicationInstanceId" - } - ] - } - }, - "DescribeApplicationInstanceDetails": { - "ApplicationInstanceId": { - "completions": [ - { - "parameters": {}, - "resourceName": "ApplicationInstance", - "resourceIdentifier": "ApplicationInstanceId" - } - ] - } - }, - "DescribeDevice": { - "DeviceId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Device", - "resourceIdentifier": "DeviceId" - } - ] - } - }, - "DescribeDeviceJob": { - "JobId": { - "completions": [ - { - "parameters": {}, - "resourceName": "DeviceJob", - "resourceIdentifier": "JobId" - } - ] - } - }, - "DescribeNode": { - "NodeId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Node", - "resourceIdentifier": "NodeId" - } - ] - } - }, - "DescribeNodeFromTemplateJob": { - "JobId": { - "completions": [ - { - "parameters": {}, - "resourceName": "NodeFromTemplateJob", - "resourceIdentifier": "JobId" - } - ] - } - }, - "DescribePackage": { - "PackageId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Package", - "resourceIdentifier": "PackageId" - } - ] - } - }, - "DescribePackageImportJob": { - "JobId": { - "completions": [ - { - "parameters": {}, - "resourceName": "PackageImportJob", - "resourceIdentifier": "JobId" - } - ] - } - }, - "DescribePackageVersion": { - "PackageId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Package", - "resourceIdentifier": "PackageId" - } - ] - } - }, - "ListApplicationInstanceDependencies": { - "ApplicationInstanceId": { - "completions": [ - { - "parameters": {}, - "resourceName": "ApplicationInstance", - "resourceIdentifier": "ApplicationInstanceId" - } - ] - } - }, - "ListApplicationInstanceNodeInstances": { - "ApplicationInstanceId": { - "completions": [ - { - "parameters": {}, - "resourceName": "ApplicationInstance", - "resourceIdentifier": "ApplicationInstanceId" - } - ] - } - }, - "ListApplicationInstances": { - "DeviceId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Device", - "resourceIdentifier": "DeviceId" - } - ] - } - }, - "ListDevicesJobs": { - "DeviceId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Device", - "resourceIdentifier": "DeviceId" - } - ] - } - }, - "ListNodes": { - "PackageName": { - "completions": [ - { - "parameters": {}, - "resourceName": "Package", - "resourceIdentifier": "PackageName" - } - ] - } - }, - "RegisterPackageVersion": { - "PackageId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Package", - "resourceIdentifier": "PackageId" - } - ] - } - }, - "RemoveApplicationInstance": { - "ApplicationInstanceId": { - "completions": [ - { - "parameters": {}, - "resourceName": "ApplicationInstance", - "resourceIdentifier": "ApplicationInstanceId" - } - ] - } - }, - "SignalApplicationInstanceNodeInstances": { - "ApplicationInstanceId": { - "completions": [ - { - "parameters": {}, - "resourceName": "ApplicationInstance", - "resourceIdentifier": "ApplicationInstanceId" - } - ] - } - }, - "UpdateDeviceMetadata": { - "DeviceId": { - "completions": [ - { - "parameters": {}, - "resourceName": "Device", - "resourceIdentifier": "DeviceId" - } - ] - } - } - } -} diff --git a/awscli/botocore/data/panorama/2019-07-24/endpoint-rule-set-1.json b/awscli/botocore/data/panorama/2019-07-24/endpoint-rule-set-1.json deleted file mode 100644 index fbcae1223279..000000000000 --- a/awscli/botocore/data/panorama/2019-07-24/endpoint-rule-set-1.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://panorama-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://panorama-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://panorama.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://panorama.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] -} \ No newline at end of file diff --git a/awscli/botocore/data/panorama/2019-07-24/paginators-1.json b/awscli/botocore/data/panorama/2019-07-24/paginators-1.json deleted file mode 100644 index ea142457a6a7..000000000000 --- a/awscli/botocore/data/panorama/2019-07-24/paginators-1.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "pagination": {} -} diff --git a/awscli/botocore/data/panorama/2019-07-24/service-2.json b/awscli/botocore/data/panorama/2019-07-24/service-2.json deleted file mode 100644 index 53ddcbda6fab..000000000000 --- a/awscli/botocore/data/panorama/2019-07-24/service-2.json +++ /dev/null @@ -1,3883 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2019-07-24", - "endpointPrefix":"panorama", - "jsonVersion":"1.1", - "protocol":"rest-json", - "serviceAbbreviation":"Panorama", - "serviceFullName":"AWS Panorama", - "serviceId":"Panorama", - "signatureVersion":"v4", - "signingName":"panorama", - "uid":"panorama-2019-07-24" - }, - "operations":{ - "CreateApplicationInstance":{ - "name":"CreateApplicationInstance", - "http":{ - "method":"POST", - "requestUri":"/application-instances", - "responseCode":200 - }, - "input":{"shape":"CreateApplicationInstanceRequest"}, - "output":{"shape":"CreateApplicationInstanceResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Creates an application instance and deploys it to a device.
" - }, - "CreateJobForDevices":{ - "name":"CreateJobForDevices", - "http":{ - "method":"POST", - "requestUri":"/jobs", - "responseCode":200 - }, - "input":{"shape":"CreateJobForDevicesRequest"}, - "output":{"shape":"CreateJobForDevicesResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Creates a job to run on a device. A job can update a device's software or reboot it.
" - }, - "CreateNodeFromTemplateJob":{ - "name":"CreateNodeFromTemplateJob", - "http":{ - "method":"POST", - "requestUri":"/packages/template-job", - "responseCode":200 - }, - "input":{"shape":"CreateNodeFromTemplateJobRequest"}, - "output":{"shape":"CreateNodeFromTemplateJobResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Creates a camera stream node.
" - }, - "CreatePackage":{ - "name":"CreatePackage", - "http":{ - "method":"POST", - "requestUri":"/packages", - "responseCode":200 - }, - "input":{"shape":"CreatePackageRequest"}, - "output":{"shape":"CreatePackageResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Creates a package and storage location in an Amazon S3 access point.
" - }, - "CreatePackageImportJob":{ - "name":"CreatePackageImportJob", - "http":{ - "method":"POST", - "requestUri":"/packages/import-jobs", - "responseCode":200 - }, - "input":{"shape":"CreatePackageImportJobRequest"}, - "output":{"shape":"CreatePackageImportJobResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Imports a node package.
" - }, - "DeleteDevice":{ - "name":"DeleteDevice", - "http":{ - "method":"DELETE", - "requestUri":"/devices/{DeviceId}", - "responseCode":200 - }, - "input":{"shape":"DeleteDeviceRequest"}, - "output":{"shape":"DeleteDeviceResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Deletes a device.
" - }, - "DeletePackage":{ - "name":"DeletePackage", - "http":{ - "method":"DELETE", - "requestUri":"/packages/{PackageId}", - "responseCode":200 - }, - "input":{"shape":"DeletePackageRequest"}, - "output":{"shape":"DeletePackageResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Deletes a package.
To delete a package, you need permission to call s3:DeleteObject in addition to permissions for the AWS Panorama API.
Deregisters a package version.
" - }, - "DescribeApplicationInstance":{ - "name":"DescribeApplicationInstance", - "http":{ - "method":"GET", - "requestUri":"/application-instances/{ApplicationInstanceId}", - "responseCode":200 - }, - "input":{"shape":"DescribeApplicationInstanceRequest"}, - "output":{"shape":"DescribeApplicationInstanceResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns information about an application instance on a device.
" - }, - "DescribeApplicationInstanceDetails":{ - "name":"DescribeApplicationInstanceDetails", - "http":{ - "method":"GET", - "requestUri":"/application-instances/{ApplicationInstanceId}/details", - "responseCode":200 - }, - "input":{"shape":"DescribeApplicationInstanceDetailsRequest"}, - "output":{"shape":"DescribeApplicationInstanceDetailsResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns information about an application instance's configuration manifest.
" - }, - "DescribeDevice":{ - "name":"DescribeDevice", - "http":{ - "method":"GET", - "requestUri":"/devices/{DeviceId}", - "responseCode":200 - }, - "input":{"shape":"DescribeDeviceRequest"}, - "output":{"shape":"DescribeDeviceResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns information about a device.
" - }, - "DescribeDeviceJob":{ - "name":"DescribeDeviceJob", - "http":{ - "method":"GET", - "requestUri":"/jobs/{JobId}", - "responseCode":200 - }, - "input":{"shape":"DescribeDeviceJobRequest"}, - "output":{"shape":"DescribeDeviceJobResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns information about a device job.
" - }, - "DescribeNode":{ - "name":"DescribeNode", - "http":{ - "method":"GET", - "requestUri":"/nodes/{NodeId}", - "responseCode":200 - }, - "input":{"shape":"DescribeNodeRequest"}, - "output":{"shape":"DescribeNodeResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns information about a node.
" - }, - "DescribeNodeFromTemplateJob":{ - "name":"DescribeNodeFromTemplateJob", - "http":{ - "method":"GET", - "requestUri":"/packages/template-job/{JobId}", - "responseCode":200 - }, - "input":{"shape":"DescribeNodeFromTemplateJobRequest"}, - "output":{"shape":"DescribeNodeFromTemplateJobResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns information about a job to create a camera stream node.
" - }, - "DescribePackage":{ - "name":"DescribePackage", - "http":{ - "method":"GET", - "requestUri":"/packages/metadata/{PackageId}", - "responseCode":200 - }, - "input":{"shape":"DescribePackageRequest"}, - "output":{"shape":"DescribePackageResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns information about a package.
" - }, - "DescribePackageImportJob":{ - "name":"DescribePackageImportJob", - "http":{ - "method":"GET", - "requestUri":"/packages/import-jobs/{JobId}", - "responseCode":200 - }, - "input":{"shape":"DescribePackageImportJobRequest"}, - "output":{"shape":"DescribePackageImportJobResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns information about a package import job.
" - }, - "DescribePackageVersion":{ - "name":"DescribePackageVersion", - "http":{ - "method":"GET", - "requestUri":"/packages/metadata/{PackageId}/versions/{PackageVersion}", - "responseCode":200 - }, - "input":{"shape":"DescribePackageVersionRequest"}, - "output":{"shape":"DescribePackageVersionResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns information about a package version.
" - }, - "ListApplicationInstanceDependencies":{ - "name":"ListApplicationInstanceDependencies", - "http":{ - "method":"GET", - "requestUri":"/application-instances/{ApplicationInstanceId}/package-dependencies", - "responseCode":200 - }, - "input":{"shape":"ListApplicationInstanceDependenciesRequest"}, - "output":{"shape":"ListApplicationInstanceDependenciesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns a list of application instance dependencies.
" - }, - "ListApplicationInstanceNodeInstances":{ - "name":"ListApplicationInstanceNodeInstances", - "http":{ - "method":"GET", - "requestUri":"/application-instances/{ApplicationInstanceId}/node-instances", - "responseCode":200 - }, - "input":{"shape":"ListApplicationInstanceNodeInstancesRequest"}, - "output":{"shape":"ListApplicationInstanceNodeInstancesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns a list of application node instances.
" - }, - "ListApplicationInstances":{ - "name":"ListApplicationInstances", - "http":{ - "method":"GET", - "requestUri":"/application-instances", - "responseCode":200 - }, - "input":{"shape":"ListApplicationInstancesRequest"}, - "output":{"shape":"ListApplicationInstancesResponse"}, - "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns a list of application instances.
" - }, - "ListDevices":{ - "name":"ListDevices", - "http":{ - "method":"GET", - "requestUri":"/devices", - "responseCode":200 - }, - "input":{"shape":"ListDevicesRequest"}, - "output":{"shape":"ListDevicesResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns a list of devices.
" - }, - "ListDevicesJobs":{ - "name":"ListDevicesJobs", - "http":{ - "method":"GET", - "requestUri":"/jobs", - "responseCode":200 - }, - "input":{"shape":"ListDevicesJobsRequest"}, - "output":{"shape":"ListDevicesJobsResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns a list of jobs.
" - }, - "ListNodeFromTemplateJobs":{ - "name":"ListNodeFromTemplateJobs", - "http":{ - "method":"GET", - "requestUri":"/packages/template-job", - "responseCode":200 - }, - "input":{"shape":"ListNodeFromTemplateJobsRequest"}, - "output":{"shape":"ListNodeFromTemplateJobsResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns a list of camera stream node jobs.
" - }, - "ListNodes":{ - "name":"ListNodes", - "http":{ - "method":"GET", - "requestUri":"/nodes", - "responseCode":200 - }, - "input":{"shape":"ListNodesRequest"}, - "output":{"shape":"ListNodesResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns a list of nodes.
" - }, - "ListPackageImportJobs":{ - "name":"ListPackageImportJobs", - "http":{ - "method":"GET", - "requestUri":"/packages/import-jobs", - "responseCode":200 - }, - "input":{"shape":"ListPackageImportJobsRequest"}, - "output":{"shape":"ListPackageImportJobsResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns a list of package import jobs.
" - }, - "ListPackages":{ - "name":"ListPackages", - "http":{ - "method":"GET", - "requestUri":"/packages", - "responseCode":200 - }, - "input":{"shape":"ListPackagesRequest"}, - "output":{"shape":"ListPackagesResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns a list of packages.
" - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"GET", - "requestUri":"/tags/{ResourceArn}", - "responseCode":200 - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Returns a list of tags for a resource.
" - }, - "ProvisionDevice":{ - "name":"ProvisionDevice", - "http":{ - "method":"POST", - "requestUri":"/devices", - "responseCode":200 - }, - "input":{"shape":"ProvisionDeviceRequest"}, - "output":{"shape":"ProvisionDeviceResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Name the configuration archive certificates-omni_device-name.zip and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.
Registers a package version.
" - }, - "RemoveApplicationInstance":{ - "name":"RemoveApplicationInstance", - "http":{ - "method":"DELETE", - "requestUri":"/application-instances/{ApplicationInstanceId}", - "responseCode":200 - }, - "input":{"shape":"RemoveApplicationInstanceRequest"}, - "output":{"shape":"RemoveApplicationInstanceResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Removes an application instance.
" - }, - "SignalApplicationInstanceNodeInstances":{ - "name":"SignalApplicationInstanceNodeInstances", - "http":{ - "method":"PUT", - "requestUri":"/application-instances/{ApplicationInstanceId}/node-signals", - "responseCode":200 - }, - "input":{"shape":"SignalApplicationInstanceNodeInstancesRequest"}, - "output":{"shape":"SignalApplicationInstanceNodeInstancesResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Signal camera nodes to stop or resume.
" - }, - "TagResource":{ - "name":"TagResource", - "http":{ - "method":"POST", - "requestUri":"/tags/{ResourceArn}", - "responseCode":200 - }, - "input":{"shape":"TagResourceRequest"}, - "output":{"shape":"TagResourceResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Tags a resource.
" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/tags/{ResourceArn}", - "responseCode":200 - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Removes tags from a resource.
" - }, - "UpdateDeviceMetadata":{ - "name":"UpdateDeviceMetadata", - "http":{ - "method":"PUT", - "requestUri":"/devices/{DeviceId}", - "responseCode":200 - }, - "input":{"shape":"UpdateDeviceMetadataRequest"}, - "output":{"shape":"UpdateDeviceMetadataResponse"}, - "errors":[ - {"shape":"ConflictException"}, - {"shape":"ValidationException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Updates a device's metadata.
" - } - }, - "shapes":{ - "AccessDeniedException":{ - "type":"structure", - "required":["Message"], - "members":{ - "Message":{"shape":"String"} - }, - "documentation":"The requestor does not have permission to access the target action or resource.
", - "error":{ - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "AlternateSoftwareMetadata":{ - "type":"structure", - "members":{ - "Version":{ - "shape":"Version", - "documentation":"The appliance software version.
" - } - }, - "documentation":"Details about a beta appliance software update.
" - }, - "AlternateSoftwares":{ - "type":"list", - "member":{"shape":"AlternateSoftwareMetadata"} - }, - "ApplicationInstance":{ - "type":"structure", - "members":{ - "ApplicationInstanceId":{ - "shape":"ApplicationInstanceId", - "documentation":"The application instance's ID.
" - }, - "Arn":{ - "shape":"ApplicationInstanceArn", - "documentation":"The application instance's ARN.
" - }, - "CreatedTime":{ - "shape":"TimeStamp", - "documentation":"When the application instance was created.
" - }, - "DefaultRuntimeContextDevice":{ - "shape":"DefaultRuntimeContextDevice", - "documentation":"The device's ID.
" - }, - "DefaultRuntimeContextDeviceName":{ - "shape":"DeviceName", - "documentation":"The device's name.
" - }, - "Description":{ - "shape":"Description", - "documentation":"The application instance's description.
" - }, - "HealthStatus":{ - "shape":"ApplicationInstanceHealthStatus", - "documentation":"The application instance's health status.
" - }, - "Name":{ - "shape":"ApplicationInstanceName", - "documentation":"The application instance's name.
" - }, - "RuntimeContextStates":{ - "shape":"ReportedRuntimeContextStates", - "documentation":"The application's state.
" - }, - "Status":{ - "shape":"ApplicationInstanceStatus", - "documentation":"The application instance's status.
" - }, - "StatusDescription":{ - "shape":"ApplicationInstanceStatusDescription", - "documentation":"The application instance's status description.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"The application instance's tags.
" - } - }, - "documentation":"An application instance on a device.
" - }, - "ApplicationInstanceArn":{ - "type":"string", - "max":255, - "min":1 - }, - "ApplicationInstanceHealthStatus":{ - "type":"string", - "enum":[ - "RUNNING", - "ERROR", - "NOT_AVAILABLE" - ] - }, - "ApplicationInstanceId":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^[a-zA-Z0-9\\-\\_]+$" - }, - "ApplicationInstanceName":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^[a-zA-Z0-9\\-\\_]+$" - }, - "ApplicationInstanceStatus":{ - "type":"string", - "enum":[ - "DEPLOYMENT_PENDING", - "DEPLOYMENT_REQUESTED", - "DEPLOYMENT_IN_PROGRESS", - "DEPLOYMENT_ERROR", - "DEPLOYMENT_SUCCEEDED", - "REMOVAL_PENDING", - "REMOVAL_REQUESTED", - "REMOVAL_IN_PROGRESS", - "REMOVAL_FAILED", - "REMOVAL_SUCCEEDED", - "DEPLOYMENT_FAILED" - ] - }, - "ApplicationInstanceStatusDescription":{ - "type":"string", - "max":255, - "min":1 - }, - "ApplicationInstances":{ - "type":"list", - "member":{"shape":"ApplicationInstance"} - }, - "Boolean":{"type":"boolean"}, - "Bucket":{"type":"string"}, - "BucketName":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^.+$" - }, - "Certificates":{"type":"blob"}, - "ClientToken":{ - "type":"string", - "max":64, - "min":1, - "pattern":"^[a-zA-Z0-9\\-\\_]+$" - }, - "ConflictException":{ - "type":"structure", - "required":[ - "Message", - "ResourceId", - "ResourceType" - ], - "members":{ - "ErrorArguments":{ - "shape":"ConflictExceptionErrorArgumentList", - "documentation":"A list of attributes that led to the exception and their values.
" - }, - "ErrorId":{ - "shape":"String", - "documentation":"A unique ID for the error.
" - }, - "Message":{"shape":"String"}, - "ResourceId":{ - "shape":"String", - "documentation":"The resource's ID.
" - }, - "ResourceType":{ - "shape":"String", - "documentation":"The resource's type.
" - } - }, - "documentation":"The target resource is in use.
", - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "ConflictExceptionErrorArgument":{ - "type":"structure", - "required":[ - "Name", - "Value" - ], - "members":{ - "Name":{ - "shape":"String", - "documentation":"The error argument's name.
" - }, - "Value":{ - "shape":"String", - "documentation":"The error argument's value.
" - } - }, - "documentation":"A conflict exception error argument.
" - }, - "ConflictExceptionErrorArgumentList":{ - "type":"list", - "member":{"shape":"ConflictExceptionErrorArgument"} - }, - "ConnectionType":{ - "type":"string", - "enum":[ - "STATIC_IP", - "DHCP" - ] - }, - "CreateApplicationInstanceRequest":{ - "type":"structure", - "required":[ - "DefaultRuntimeContextDevice", - "ManifestPayload" - ], - "members":{ - "ApplicationInstanceIdToReplace":{ - "shape":"ApplicationInstanceId", - "documentation":"The ID of an application instance to replace with the new instance.
" - }, - "DefaultRuntimeContextDevice":{ - "shape":"DefaultRuntimeContextDevice", - "documentation":"A device's ID.
" - }, - "Description":{ - "shape":"Description", - "documentation":"A description for the application instance.
" - }, - "ManifestOverridesPayload":{ - "shape":"ManifestOverridesPayload", - "documentation":"Setting overrides for the application manifest.
" - }, - "ManifestPayload":{ - "shape":"ManifestPayload", - "documentation":"The application's manifest document.
" - }, - "Name":{ - "shape":"ApplicationInstanceName", - "documentation":"A name for the application instance.
" - }, - "RuntimeRoleArn":{ - "shape":"RuntimeRoleArn", - "documentation":"The ARN of a runtime role for the application instance.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"Tags for the application instance.
" - } - } - }, - "CreateApplicationInstanceResponse":{ - "type":"structure", - "required":["ApplicationInstanceId"], - "members":{ - "ApplicationInstanceId":{ - "shape":"ApplicationInstanceId", - "documentation":"The application instance's ID.
" - } - } - }, - "CreateJobForDevicesRequest":{ - "type":"structure", - "required":[ - "DeviceIds", - "JobType" - ], - "members":{ - "DeviceIds":{ - "shape":"DeviceIdList", - "documentation":"ID of target device.
" - }, - "DeviceJobConfig":{ - "shape":"DeviceJobConfig", - "documentation":"Configuration settings for a software update job.
" - }, - "JobType":{ - "shape":"JobType", - "documentation":"The type of job to run.
" - } - } - }, - "CreateJobForDevicesResponse":{ - "type":"structure", - "required":["Jobs"], - "members":{ - "Jobs":{ - "shape":"JobList", - "documentation":"A list of jobs.
" - } - } - }, - "CreateNodeFromTemplateJobRequest":{ - "type":"structure", - "required":[ - "NodeName", - "OutputPackageName", - "OutputPackageVersion", - "TemplateParameters", - "TemplateType" - ], - "members":{ - "JobTags":{ - "shape":"JobTagsList", - "documentation":"Tags for the job.
" - }, - "NodeDescription":{ - "shape":"Description", - "documentation":"A description for the node.
" - }, - "NodeName":{ - "shape":"NodeName", - "documentation":"A name for the node.
" - }, - "OutputPackageName":{ - "shape":"NodePackageName", - "documentation":"An output package name for the node.
" - }, - "OutputPackageVersion":{ - "shape":"NodePackageVersion", - "documentation":"An output package version for the node.
" - }, - "TemplateParameters":{ - "shape":"TemplateParametersMap", - "documentation":"Template parameters for the node.
" - }, - "TemplateType":{ - "shape":"TemplateType", - "documentation":"The type of node.
" - } - } - }, - "CreateNodeFromTemplateJobResponse":{ - "type":"structure", - "required":["JobId"], - "members":{ - "JobId":{ - "shape":"JobId", - "documentation":"The job's ID.
" - } - } - }, - "CreatePackageImportJobRequest":{ - "type":"structure", - "required":[ - "ClientToken", - "InputConfig", - "JobType", - "OutputConfig" - ], - "members":{ - "ClientToken":{ - "shape":"ClientToken", - "documentation":"A client token for the package import job.
" - }, - "InputConfig":{ - "shape":"PackageImportJobInputConfig", - "documentation":"An input config for the package import job.
" - }, - "JobTags":{ - "shape":"JobTagsList", - "documentation":"Tags for the package import job.
" - }, - "JobType":{ - "shape":"PackageImportJobType", - "documentation":"A job type for the package import job.
" - }, - "OutputConfig":{ - "shape":"PackageImportJobOutputConfig", - "documentation":"An output config for the package import job.
" - } - } - }, - "CreatePackageImportJobResponse":{ - "type":"structure", - "required":["JobId"], - "members":{ - "JobId":{ - "shape":"JobId", - "documentation":"The job's ID.
" - } - } - }, - "CreatePackageRequest":{ - "type":"structure", - "required":["PackageName"], - "members":{ - "PackageName":{ - "shape":"NodePackageName", - "documentation":"A name for the package.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"Tags for the package.
" - } - } - }, - "CreatePackageResponse":{ - "type":"structure", - "required":["StorageLocation"], - "members":{ - "Arn":{ - "shape":"NodePackageArn", - "documentation":"The package's ARN.
" - }, - "PackageId":{ - "shape":"NodePackageId", - "documentation":"The package's ID.
" - }, - "StorageLocation":{ - "shape":"StorageLocation", - "documentation":"The package's storage location.
" - } - } - }, - "CreatedTime":{"type":"timestamp"}, - "CurrentSoftware":{ - "type":"string", - "max":255, - "min":1 - }, - "DefaultGateway":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^.+$" - }, - "DefaultRuntimeContextDevice":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^[a-zA-Z0-9\\-\\_]+$" - }, - "DeleteDeviceRequest":{ - "type":"structure", - "required":["DeviceId"], - "members":{ - "DeviceId":{ - "shape":"DeviceId", - "documentation":"The device's ID.
", - "location":"uri", - "locationName":"DeviceId" - } - } - }, - "DeleteDeviceResponse":{ - "type":"structure", - "members":{ - "DeviceId":{ - "shape":"DeviceId", - "documentation":"The device's ID.
" - } - } - }, - "DeletePackageRequest":{ - "type":"structure", - "required":["PackageId"], - "members":{ - "ForceDelete":{ - "shape":"Boolean", - "documentation":"Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.
", - "location":"querystring", - "locationName":"ForceDelete" - }, - "PackageId":{ - "shape":"NodePackageId", - "documentation":"The package's ID.
", - "location":"uri", - "locationName":"PackageId" - } - } - }, - "DeletePackageResponse":{ - "type":"structure", - "members":{ - } - }, - "DeregisterPackageVersionRequest":{ - "type":"structure", - "required":[ - "PackageId", - "PackageVersion", - "PatchVersion" - ], - "members":{ - "OwnerAccount":{ - "shape":"PackageOwnerAccount", - "documentation":"An owner account.
", - "location":"querystring", - "locationName":"OwnerAccount" - }, - "PackageId":{ - "shape":"NodePackageId", - "documentation":"A package ID.
", - "location":"uri", - "locationName":"PackageId" - }, - "PackageVersion":{ - "shape":"NodePackageVersion", - "documentation":"A package version.
", - "location":"uri", - "locationName":"PackageVersion" - }, - "PatchVersion":{ - "shape":"NodePackagePatchVersion", - "documentation":"A patch version.
", - "location":"uri", - "locationName":"PatchVersion" - }, - "UpdatedLatestPatchVersion":{ - "shape":"NodePackagePatchVersion", - "documentation":"If the version was marked latest, the new version to maker as latest.
", - "location":"querystring", - "locationName":"UpdatedLatestPatchVersion" - } - } - }, - "DeregisterPackageVersionResponse":{ - "type":"structure", - "members":{ - } - }, - "DescribeApplicationInstanceDetailsRequest":{ - "type":"structure", - "required":["ApplicationInstanceId"], - "members":{ - "ApplicationInstanceId":{ - "shape":"ApplicationInstanceId", - "documentation":"The application instance's ID.
", - "location":"uri", - "locationName":"ApplicationInstanceId" - } - } - }, - "DescribeApplicationInstanceDetailsResponse":{ - "type":"structure", - "members":{ - "ApplicationInstanceId":{ - "shape":"ApplicationInstanceId", - "documentation":"The application instance's ID.
" - }, - "ApplicationInstanceIdToReplace":{ - "shape":"ApplicationInstanceId", - "documentation":"The ID of the application instance that this instance replaced.
" - }, - "CreatedTime":{ - "shape":"TimeStamp", - "documentation":"When the application instance was created.
" - }, - "DefaultRuntimeContextDevice":{ - "shape":"DefaultRuntimeContextDevice", - "documentation":"The application instance's default runtime context device.
" - }, - "Description":{ - "shape":"Description", - "documentation":"The application instance's description.
" - }, - "ManifestOverridesPayload":{ - "shape":"ManifestOverridesPayload", - "documentation":"Parameter overrides for the configuration manifest.
" - }, - "ManifestPayload":{ - "shape":"ManifestPayload", - "documentation":"The application instance's configuration manifest.
" - }, - "Name":{ - "shape":"ApplicationInstanceName", - "documentation":"The application instance's name.
" - } - } - }, - "DescribeApplicationInstanceRequest":{ - "type":"structure", - "required":["ApplicationInstanceId"], - "members":{ - "ApplicationInstanceId":{ - "shape":"ApplicationInstanceId", - "documentation":"The application instance's ID.
", - "location":"uri", - "locationName":"ApplicationInstanceId" - } - } - }, - "DescribeApplicationInstanceResponse":{ - "type":"structure", - "members":{ - "ApplicationInstanceId":{ - "shape":"ApplicationInstanceId", - "documentation":"The application instance's ID.
" - }, - "ApplicationInstanceIdToReplace":{ - "shape":"ApplicationInstanceId", - "documentation":"The ID of the application instance that this instance replaced.
" - }, - "Arn":{ - "shape":"ApplicationInstanceArn", - "documentation":"The application instance's ARN.
" - }, - "CreatedTime":{ - "shape":"TimeStamp", - "documentation":"When the application instance was created.
" - }, - "DefaultRuntimeContextDevice":{ - "shape":"DefaultRuntimeContextDevice", - "documentation":"The device's ID.
" - }, - "DefaultRuntimeContextDeviceName":{ - "shape":"DeviceName", - "documentation":"The device's bane.
" - }, - "Description":{ - "shape":"Description", - "documentation":"The application instance's description.
" - }, - "HealthStatus":{ - "shape":"ApplicationInstanceHealthStatus", - "documentation":"The application instance's health status.
" - }, - "LastUpdatedTime":{ - "shape":"TimeStamp", - "documentation":"The application instance was updated.
" - }, - "Name":{ - "shape":"ApplicationInstanceName", - "documentation":"The application instance's name.
" - }, - "RuntimeContextStates":{ - "shape":"ReportedRuntimeContextStates", - "documentation":"The application instance's state.
" - }, - "RuntimeRoleArn":{ - "shape":"RuntimeRoleArn", - "documentation":"The application instance's runtime role ARN.
" - }, - "Status":{ - "shape":"ApplicationInstanceStatus", - "documentation":"The application instance's status.
" - }, - "StatusDescription":{ - "shape":"ApplicationInstanceStatusDescription", - "documentation":"The application instance's status description.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"The application instance's tags.
" - } - } - }, - "DescribeDeviceJobRequest":{ - "type":"structure", - "required":["JobId"], - "members":{ - "JobId":{ - "shape":"JobId", - "documentation":"The job's ID.
", - "location":"uri", - "locationName":"JobId" - } - } - }, - "DescribeDeviceJobResponse":{ - "type":"structure", - "members":{ - "CreatedTime":{ - "shape":"UpdateCreatedTime", - "documentation":"When the job was created.
" - }, - "DeviceArn":{ - "shape":"DeviceArn", - "documentation":"The device's ARN.
" - }, - "DeviceId":{ - "shape":"DeviceId", - "documentation":"The device's ID.
" - }, - "DeviceName":{ - "shape":"DeviceName", - "documentation":"The device's name.
" - }, - "DeviceType":{ - "shape":"DeviceType", - "documentation":"The device's type.
" - }, - "ImageVersion":{ - "shape":"ImageVersion", - "documentation":"For an OTA job, the target version of the device software.
" - }, - "JobId":{ - "shape":"JobId", - "documentation":"The job's ID.
" - }, - "JobType":{ - "shape":"JobType", - "documentation":"The job's type.
" - }, - "Status":{ - "shape":"UpdateProgress", - "documentation":"The job's status.
" - } - } - }, - "DescribeDeviceRequest":{ - "type":"structure", - "required":["DeviceId"], - "members":{ - "DeviceId":{ - "shape":"DeviceId", - "documentation":"The device's ID.
", - "location":"uri", - "locationName":"DeviceId" - } - } - }, - "DescribeDeviceResponse":{ - "type":"structure", - "members":{ - "AlternateSoftwares":{ - "shape":"AlternateSoftwares", - "documentation":"Beta software releases available for the device.
" - }, - "Arn":{ - "shape":"DeviceArn", - "documentation":"The device's ARN.
" - }, - "Brand":{ - "shape":"DeviceBrand", - "documentation":"The device's maker.
" - }, - "CreatedTime":{ - "shape":"CreatedTime", - "documentation":"When the device was created.
" - }, - "CurrentNetworkingStatus":{ - "shape":"NetworkStatus", - "documentation":"The device's networking status.
" - }, - "CurrentSoftware":{ - "shape":"CurrentSoftware", - "documentation":"The device's current software version.
" - }, - "Description":{ - "shape":"Description", - "documentation":"The device's description.
" - }, - "DeviceAggregatedStatus":{ - "shape":"DeviceAggregatedStatus", - "documentation":"A device's aggregated status. Including the device's connection status, provisioning status, and lease status.
" - }, - "DeviceConnectionStatus":{ - "shape":"DeviceConnectionStatus", - "documentation":"The device's connection status.
" - }, - "DeviceId":{ - "shape":"DeviceId", - "documentation":"The device's ID.
" - }, - "LatestAlternateSoftware":{ - "shape":"LatestAlternateSoftware", - "documentation":"The most recent beta software release.
" - }, - "LatestDeviceJob":{ - "shape":"LatestDeviceJob", - "documentation":"A device's latest job. Includes the target image version, and the job status.
" - }, - "LatestSoftware":{ - "shape":"LatestSoftware", - "documentation":"The latest software version available for the device.
" - }, - "LeaseExpirationTime":{ - "shape":"LeaseExpirationTime", - "documentation":"The device's lease expiration time.
" - }, - "Name":{ - "shape":"DeviceName", - "documentation":"The device's name.
" - }, - "NetworkingConfiguration":{ - "shape":"NetworkPayload", - "documentation":"The device's networking configuration.
" - }, - "ProvisioningStatus":{ - "shape":"DeviceStatus", - "documentation":"The device's provisioning status.
" - }, - "SerialNumber":{ - "shape":"DeviceSerialNumber", - "documentation":"The device's serial number.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"The device's tags.
" - }, - "Type":{ - "shape":"DeviceType", - "documentation":"The device's type.
" - } - } - }, - "DescribeNodeFromTemplateJobRequest":{ - "type":"structure", - "required":["JobId"], - "members":{ - "JobId":{ - "shape":"JobId", - "documentation":"The job's ID.
", - "location":"uri", - "locationName":"JobId" - } - } - }, - "DescribeNodeFromTemplateJobResponse":{ - "type":"structure", - "required":[ - "CreatedTime", - "JobId", - "LastUpdatedTime", - "NodeName", - "OutputPackageName", - "OutputPackageVersion", - "Status", - "StatusMessage", - "TemplateParameters", - "TemplateType" - ], - "members":{ - "CreatedTime":{ - "shape":"CreatedTime", - "documentation":"When the job was created.
" - }, - "JobId":{ - "shape":"JobId", - "documentation":"The job's ID.
" - }, - "JobTags":{ - "shape":"JobTagsList", - "documentation":"The job's tags.
" - }, - "LastUpdatedTime":{ - "shape":"LastUpdatedTime", - "documentation":"When the job was updated.
" - }, - "NodeDescription":{ - "shape":"Description", - "documentation":"The node's description.
" - }, - "NodeName":{ - "shape":"NodeName", - "documentation":"The node's name.
" - }, - "OutputPackageName":{ - "shape":"NodePackageName", - "documentation":"The job's output package name.
" - }, - "OutputPackageVersion":{ - "shape":"NodePackageVersion", - "documentation":"The job's output package version.
" - }, - "Status":{ - "shape":"NodeFromTemplateJobStatus", - "documentation":"The job's status.
" - }, - "StatusMessage":{ - "shape":"NodeFromTemplateJobStatusMessage", - "documentation":"The job's status message.
" - }, - "TemplateParameters":{ - "shape":"TemplateParametersMap", - "documentation":"The job's template parameters.
" - }, - "TemplateType":{ - "shape":"TemplateType", - "documentation":"The job's template type.
" - } - } - }, - "DescribeNodeRequest":{ - "type":"structure", - "required":["NodeId"], - "members":{ - "NodeId":{ - "shape":"NodeId", - "documentation":"The node's ID.
", - "location":"uri", - "locationName":"NodeId" - }, - "OwnerAccount":{ - "shape":"PackageOwnerAccount", - "documentation":"The account ID of the node's owner.
", - "location":"querystring", - "locationName":"OwnerAccount" - } - } - }, - "DescribeNodeResponse":{ - "type":"structure", - "required":[ - "Category", - "CreatedTime", - "Description", - "LastUpdatedTime", - "Name", - "NodeId", - "NodeInterface", - "OwnerAccount", - "PackageId", - "PackageName", - "PackageVersion", - "PatchVersion" - ], - "members":{ - "AssetName":{ - "shape":"NodeAssetName", - "documentation":"The node's asset name.
" - }, - "Category":{ - "shape":"NodeCategory", - "documentation":"The node's category.
" - }, - "CreatedTime":{ - "shape":"TimeStamp", - "documentation":"When the node was created.
" - }, - "Description":{ - "shape":"Description", - "documentation":"The node's description.
" - }, - "LastUpdatedTime":{ - "shape":"TimeStamp", - "documentation":"When the node was updated.
" - }, - "Name":{ - "shape":"NodeName", - "documentation":"The node's name.
" - }, - "NodeId":{ - "shape":"NodeId", - "documentation":"The node's ID.
" - }, - "NodeInterface":{ - "shape":"NodeInterface", - "documentation":"The node's interface.
" - }, - "OwnerAccount":{ - "shape":"PackageOwnerAccount", - "documentation":"The account ID of the node's owner.
" - }, - "PackageArn":{ - "shape":"NodePackageArn", - "documentation":"The node's ARN.
" - }, - "PackageId":{ - "shape":"NodePackageId", - "documentation":"The node's package ID.
" - }, - "PackageName":{ - "shape":"NodePackageName", - "documentation":"The node's package name.
" - }, - "PackageVersion":{ - "shape":"NodePackageVersion", - "documentation":"The node's package version.
" - }, - "PatchVersion":{ - "shape":"NodePackagePatchVersion", - "documentation":"The node's patch version.
" - } - } - }, - "DescribePackageImportJobRequest":{ - "type":"structure", - "required":["JobId"], - "members":{ - "JobId":{ - "shape":"JobId", - "documentation":"The job's ID.
", - "location":"uri", - "locationName":"JobId" - } - } - }, - "DescribePackageImportJobResponse":{ - "type":"structure", - "required":[ - "CreatedTime", - "InputConfig", - "JobId", - "JobType", - "LastUpdatedTime", - "Output", - "OutputConfig", - "Status", - "StatusMessage" - ], - "members":{ - "ClientToken":{ - "shape":"ClientToken", - "documentation":"The job's client token.
" - }, - "CreatedTime":{ - "shape":"CreatedTime", - "documentation":"When the job was created.
" - }, - "InputConfig":{ - "shape":"PackageImportJobInputConfig", - "documentation":"The job's input config.
" - }, - "JobId":{ - "shape":"JobId", - "documentation":"The job's ID.
" - }, - "JobTags":{ - "shape":"JobTagsList", - "documentation":"The job's tags.
" - }, - "JobType":{ - "shape":"PackageImportJobType", - "documentation":"The job's type.
" - }, - "LastUpdatedTime":{ - "shape":"LastUpdatedTime", - "documentation":"When the job was updated.
" - }, - "Output":{ - "shape":"PackageImportJobOutput", - "documentation":"The job's output.
" - }, - "OutputConfig":{ - "shape":"PackageImportJobOutputConfig", - "documentation":"The job's output config.
" - }, - "Status":{ - "shape":"PackageImportJobStatus", - "documentation":"The job's status.
" - }, - "StatusMessage":{ - "shape":"PackageImportJobStatusMessage", - "documentation":"The job's status message.
" - } - } - }, - "DescribePackageRequest":{ - "type":"structure", - "required":["PackageId"], - "members":{ - "PackageId":{ - "shape":"NodePackageId", - "documentation":"The package's ID.
", - "location":"uri", - "locationName":"PackageId" - } - } - }, - "DescribePackageResponse":{ - "type":"structure", - "required":[ - "Arn", - "CreatedTime", - "PackageId", - "PackageName", - "StorageLocation", - "Tags" - ], - "members":{ - "Arn":{ - "shape":"NodePackageArn", - "documentation":"The package's ARN.
" - }, - "CreatedTime":{ - "shape":"TimeStamp", - "documentation":"When the package was created.
" - }, - "PackageId":{ - "shape":"NodePackageId", - "documentation":"The package's ID.
" - }, - "PackageName":{ - "shape":"NodePackageName", - "documentation":"The package's name.
" - }, - "ReadAccessPrincipalArns":{ - "shape":"PrincipalArnsList", - "documentation":"ARNs of accounts that have read access to the package.
" - }, - "StorageLocation":{ - "shape":"StorageLocation", - "documentation":"The package's storage location.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"The package's tags.
" - }, - "WriteAccessPrincipalArns":{ - "shape":"PrincipalArnsList", - "documentation":"ARNs of accounts that have write access to the package.
" - } - } - }, - "DescribePackageVersionRequest":{ - "type":"structure", - "required":[ - "PackageId", - "PackageVersion" - ], - "members":{ - "OwnerAccount":{ - "shape":"PackageOwnerAccount", - "documentation":"The version's owner account.
", - "location":"querystring", - "locationName":"OwnerAccount" - }, - "PackageId":{ - "shape":"NodePackageId", - "documentation":"The version's ID.
", - "location":"uri", - "locationName":"PackageId" - }, - "PackageVersion":{ - "shape":"NodePackageVersion", - "documentation":"The version's version.
", - "location":"uri", - "locationName":"PackageVersion" - }, - "PatchVersion":{ - "shape":"NodePackagePatchVersion", - "documentation":"The version's patch version.
", - "location":"querystring", - "locationName":"PatchVersion" - } - } - }, - "DescribePackageVersionResponse":{ - "type":"structure", - "required":[ - "IsLatestPatch", - "PackageId", - "PackageName", - "PackageVersion", - "PatchVersion", - "Status" - ], - "members":{ - "IsLatestPatch":{ - "shape":"Boolean", - "documentation":"Whether the version is the latest available.
" - }, - "OwnerAccount":{ - "shape":"PackageOwnerAccount", - "documentation":"The account ID of the version's owner.
" - }, - "PackageArn":{ - "shape":"NodePackageArn", - "documentation":"The ARN of the package.
" - }, - "PackageId":{ - "shape":"NodePackageId", - "documentation":"The version's ID.
" - }, - "PackageName":{ - "shape":"NodePackageName", - "documentation":"The version's name.
" - }, - "PackageVersion":{ - "shape":"NodePackageVersion", - "documentation":"The version's version.
" - }, - "PatchVersion":{ - "shape":"NodePackagePatchVersion", - "documentation":"The version's patch version.
" - }, - "RegisteredTime":{ - "shape":"TimeStamp", - "documentation":"The version's registered time.
" - }, - "Status":{ - "shape":"PackageVersionStatus", - "documentation":"The version's status.
" - }, - "StatusDescription":{ - "shape":"PackageVersionStatusDescription", - "documentation":"The version's status description.
" - } - } - }, - "Description":{ - "type":"string", - "max":255, - "min":0, - "pattern":"^.*$" - }, - "DesiredState":{ - "type":"string", - "enum":[ - "RUNNING", - "STOPPED", - "REMOVED" - ] - }, - "Device":{ - "type":"structure", - "members":{ - "Brand":{ - "shape":"DeviceBrand", - "documentation":"The device's maker.
" - }, - "CreatedTime":{ - "shape":"CreatedTime", - "documentation":"When the device was created.
" - }, - "CurrentSoftware":{ - "shape":"CurrentSoftware", - "documentation":"A device's current software.
" - }, - "Description":{ - "shape":"Description", - "documentation":"A description for the device.
" - }, - "DeviceAggregatedStatus":{ - "shape":"DeviceAggregatedStatus", - "documentation":"A device's aggregated status. Including the device's connection status, provisioning status, and lease status.
" - }, - "DeviceId":{ - "shape":"DeviceId", - "documentation":"The device's ID.
" - }, - "LastUpdatedTime":{ - "shape":"LastUpdatedTime", - "documentation":"When the device was updated.
" - }, - "LatestDeviceJob":{ - "shape":"LatestDeviceJob", - "documentation":"A device's latest job. Includes the target image version, and the update job status.
" - }, - "LeaseExpirationTime":{ - "shape":"LeaseExpirationTime", - "documentation":"The device's lease expiration time.
" - }, - "Name":{ - "shape":"DeviceName", - "documentation":"The device's name.
" - }, - "ProvisioningStatus":{ - "shape":"DeviceStatus", - "documentation":"The device's provisioning status.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"The device's tags.
" - }, - "Type":{ - "shape":"DeviceType", - "documentation":"The device's type.
" - } - }, - "documentation":"A device.
" - }, - "DeviceAggregatedStatus":{ - "type":"string", - "enum":[ - "ERROR", - "AWAITING_PROVISIONING", - "PENDING", - "FAILED", - "DELETING", - "ONLINE", - "OFFLINE", - "LEASE_EXPIRED", - "UPDATE_NEEDED", - "REBOOTING" - ] - }, - "DeviceArn":{ - "type":"string", - "max":255, - "min":1 - }, - "DeviceBrand":{ - "type":"string", - "enum":[ - "AWS_PANORAMA", - "LENOVO" - ] - }, - "DeviceConnectionStatus":{ - "type":"string", - "enum":[ - "ONLINE", - "OFFLINE", - "AWAITING_CREDENTIALS", - "NOT_AVAILABLE", - "ERROR" - ] - }, - "DeviceId":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^[a-zA-Z0-9\\-\\_]+$" - }, - "DeviceIdList":{ - "type":"list", - "member":{"shape":"DeviceId"}, - "max":1, - "min":1 - }, - "DeviceJob":{ - "type":"structure", - "members":{ - "CreatedTime":{ - "shape":"CreatedTime", - "documentation":"When the job was created.
" - }, - "DeviceId":{ - "shape":"DeviceId", - "documentation":"The ID of the target device.
" - }, - "DeviceName":{ - "shape":"DeviceName", - "documentation":"The name of the target device
" - }, - "JobId":{ - "shape":"JobId", - "documentation":"The job's ID.
" - }, - "JobType":{ - "shape":"JobType", - "documentation":"The job's type.
" - } - }, - "documentation":"A job that runs on a device.
" - }, - "DeviceJobConfig":{ - "type":"structure", - "members":{ - "OTAJobConfig":{ - "shape":"OTAJobConfig", - "documentation":"A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.
" - } - }, - "documentation":"A job's configuration.
" - }, - "DeviceJobList":{ - "type":"list", - "member":{"shape":"DeviceJob"} - }, - "DeviceList":{ - "type":"list", - "member":{"shape":"Device"} - }, - "DeviceName":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^[a-zA-Z0-9\\-\\_]+$" - }, - "DeviceReportedStatus":{ - "type":"string", - "enum":[ - "STOPPING", - "STOPPED", - "STOP_ERROR", - "REMOVAL_FAILED", - "REMOVAL_IN_PROGRESS", - "STARTING", - "RUNNING", - "INSTALL_ERROR", - "LAUNCHED", - "LAUNCH_ERROR", - "INSTALL_IN_PROGRESS" - ] - }, - "DeviceSerialNumber":{ - "type":"string", - "pattern":"^[0-9]{1,20}$" - }, - "DeviceStatus":{ - "type":"string", - "enum":[ - "AWAITING_PROVISIONING", - "PENDING", - "SUCCEEDED", - "FAILED", - "ERROR", - "DELETING" - ] - }, - "DeviceType":{ - "type":"string", - "enum":[ - "PANORAMA_APPLIANCE_DEVELOPER_KIT", - "PANORAMA_APPLIANCE" - ] - }, - "Dns":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^.+$" - }, - "DnsList":{ - "type":"list", - "member":{"shape":"Dns"} - }, - "EthernetPayload":{ - "type":"structure", - "required":["ConnectionType"], - "members":{ - "ConnectionType":{ - "shape":"ConnectionType", - "documentation":"How the device gets an IP address.
" - }, - "StaticIpConnectionInfo":{ - "shape":"StaticIpConnectionInfo", - "documentation":"Network configuration for a static IP connection.
" - } - }, - "documentation":"A device's network configuration.
" - }, - "EthernetStatus":{ - "type":"structure", - "members":{ - "ConnectionStatus":{ - "shape":"NetworkConnectionStatus", - "documentation":"The device's connection status.
" - }, - "HwAddress":{ - "shape":"HwAddress", - "documentation":"The device's physical address.
" - }, - "IpAddress":{ - "shape":"IpAddress", - "documentation":"The device's IP address.
" - } - }, - "documentation":"A device's Ethernet status.
" - }, - "HwAddress":{ - "type":"string", - "max":255, - "min":1 - }, - "ImageVersion":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^.+$" - }, - "InputPortList":{ - "type":"list", - "member":{"shape":"NodeInputPort"} - }, - "InternalServerException":{ - "type":"structure", - "required":["Message"], - "members":{ - "Message":{"shape":"String"}, - "RetryAfterSeconds":{ - "shape":"RetryAfterSeconds", - "documentation":"The number of seconds a client should wait before retrying the call.
", - "location":"header", - "locationName":"Retry-After" - } - }, - "documentation":"An internal error occurred.
", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true - }, - "IotThingName":{ - "type":"string", - "max":255, - "min":1 - }, - "IpAddress":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d))(:(6553[0-5]|655[0-2]\\d|65[0-4]\\d{2}|6[0-4]\\d{3}|[1-5]\\d{4}|[1-9]\\d{0,3}))?$" - }, - "IpAddressOrServerName":{ - "type":"string", - "max":255, - "min":1, - "pattern":"(^([a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,}$)|(^((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d))(:(6553[0-5]|655[0-2]\\d|65[0-4]\\d{2}|6[0-4]\\d{3}|[1-5]\\d{4}|[1-9]\\d{0,3}))?$)" - }, - "Job":{ - "type":"structure", - "members":{ - "DeviceId":{ - "shape":"DeviceId", - "documentation":"The target device's ID.
" - }, - "JobId":{ - "shape":"JobId", - "documentation":"The job's ID.
" - } - }, - "documentation":"A job for a device.
" - }, - "JobId":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^[a-zA-Z0-9\\-\\_]+$" - }, - "JobList":{ - "type":"list", - "member":{"shape":"Job"} - }, - "JobResourceTags":{ - "type":"structure", - "required":[ - "ResourceType", - "Tags" - ], - "members":{ - "ResourceType":{ - "shape":"JobResourceType", - "documentation":"The job's type.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"The job's tags.
" - } - }, - "documentation":"Tags for a job.
" - }, - "JobResourceType":{ - "type":"string", - "enum":["PACKAGE"] - }, - "JobTagsList":{ - "type":"list", - "member":{"shape":"JobResourceTags"} - }, - "JobType":{ - "type":"string", - "enum":[ - "OTA", - "REBOOT" - ] - }, - "LastUpdatedTime":{"type":"timestamp"}, - "LatestAlternateSoftware":{ - "type":"string", - "max":255, - "min":1 - }, - "LatestDeviceJob":{ - "type":"structure", - "members":{ - "ImageVersion":{ - "shape":"ImageVersion", - "documentation":"The target version of the device software.
" - }, - "JobType":{ - "shape":"JobType", - "documentation":"The job's type.
" - }, - "Status":{ - "shape":"UpdateProgress", - "documentation":"Status of the latest device job.
" - } - }, - "documentation":"Returns information about the latest device job.
" - }, - "LatestSoftware":{ - "type":"string", - "max":255, - "min":1 - }, - "LeaseExpirationTime":{"type":"timestamp"}, - "ListApplicationInstanceDependenciesRequest":{ - "type":"structure", - "required":["ApplicationInstanceId"], - "members":{ - "ApplicationInstanceId":{ - "shape":"ApplicationInstanceId", - "documentation":"The application instance's ID.
", - "location":"uri", - "locationName":"ApplicationInstanceId" - }, - "MaxResults":{ - "shape":"MaxSize25", - "documentation":"The maximum number of application instance dependencies to return in one page of results.
", - "location":"querystring", - "locationName":"maxResults" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListApplicationInstanceDependenciesResponse":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"A pagination token that's included if more results are available.
" - }, - "PackageObjects":{ - "shape":"PackageObjects", - "documentation":"A list of package objects.
" - } - } - }, - "ListApplicationInstanceNodeInstancesRequest":{ - "type":"structure", - "required":["ApplicationInstanceId"], - "members":{ - "ApplicationInstanceId":{ - "shape":"ApplicationInstanceId", - "documentation":"The node instances' application instance ID.
", - "location":"uri", - "locationName":"ApplicationInstanceId" - }, - "MaxResults":{ - "shape":"MaxSize25", - "documentation":"The maximum number of node instances to return in one page of results.
", - "location":"querystring", - "locationName":"maxResults" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListApplicationInstanceNodeInstancesResponse":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"A pagination token that's included if more results are available.
" - }, - "NodeInstances":{ - "shape":"NodeInstances", - "documentation":"A list of node instances.
" - } - } - }, - "ListApplicationInstancesRequest":{ - "type":"structure", - "members":{ - "DeviceId":{ - "shape":"DeviceId", - "documentation":"The application instances' device ID.
", - "location":"querystring", - "locationName":"deviceId" - }, - "MaxResults":{ - "shape":"MaxSize25", - "documentation":"The maximum number of application instances to return in one page of results.
", - "location":"querystring", - "locationName":"maxResults" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", - "location":"querystring", - "locationName":"nextToken" - }, - "StatusFilter":{ - "shape":"StatusFilter", - "documentation":"Only include instances with a specific status.
", - "location":"querystring", - "locationName":"statusFilter" - } - } - }, - "ListApplicationInstancesResponse":{ - "type":"structure", - "members":{ - "ApplicationInstances":{ - "shape":"ApplicationInstances", - "documentation":"A list of application instances.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"A pagination token that's included if more results are available.
" - } - } - }, - "ListDevicesJobsRequest":{ - "type":"structure", - "members":{ - "DeviceId":{ - "shape":"DeviceId", - "documentation":"Filter results by the job's target device ID.
", - "location":"querystring", - "locationName":"DeviceId" - }, - "MaxResults":{ - "shape":"MaxSize25", - "documentation":"The maximum number of device jobs to return in one page of results.
", - "location":"querystring", - "locationName":"MaxResults" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", - "location":"querystring", - "locationName":"NextToken" - } - } - }, - "ListDevicesJobsResponse":{ - "type":"structure", - "members":{ - "DeviceJobs":{ - "shape":"DeviceJobList", - "documentation":"A list of jobs.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"A pagination token that's included if more results are available.
" - } - } - }, - "ListDevicesRequest":{ - "type":"structure", - "members":{ - "DeviceAggregatedStatusFilter":{ - "shape":"DeviceAggregatedStatus", - "documentation":"Filter based on a device's status.
", - "location":"querystring", - "locationName":"DeviceAggregatedStatusFilter" - }, - "MaxResults":{ - "shape":"MaxSize25", - "documentation":"The maximum number of devices to return in one page of results.
", - "location":"querystring", - "locationName":"MaxResults" - }, - "NameFilter":{ - "shape":"NameFilter", - "documentation":"Filter based on device's name. Prefixes supported.
", - "location":"querystring", - "locationName":"NameFilter" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", - "location":"querystring", - "locationName":"NextToken" - }, - "SortBy":{ - "shape":"ListDevicesSortBy", - "documentation":"The target column to be sorted on. Default column sort is CREATED_TIME.
", - "location":"querystring", - "locationName":"SortBy" - }, - "SortOrder":{ - "shape":"SortOrder", - "documentation":"The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.
", - "location":"querystring", - "locationName":"SortOrder" - } - } - }, - "ListDevicesResponse":{ - "type":"structure", - "required":["Devices"], - "members":{ - "Devices":{ - "shape":"DeviceList", - "documentation":"A list of devices.
" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"A pagination token that's included if more results are available.
" - } - } - }, - "ListDevicesSortBy":{ - "type":"string", - "enum":[ - "DEVICE_ID", - "CREATED_TIME", - "NAME", - "DEVICE_AGGREGATED_STATUS" - ] - }, - "ListNodeFromTemplateJobsRequest":{ - "type":"structure", - "members":{ - "MaxResults":{ - "shape":"MaxSize25", - "documentation":"The maximum number of node from template jobs to return in one page of results.
", - "location":"querystring", - "locationName":"MaxResults" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", - "location":"querystring", - "locationName":"NextToken" - } - } - }, - "ListNodeFromTemplateJobsResponse":{ - "type":"structure", - "required":["NodeFromTemplateJobs"], - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"A pagination token that's included if more results are available.
" - }, - "NodeFromTemplateJobs":{ - "shape":"NodeFromTemplateJobList", - "documentation":"A list of jobs.
" - } - } - }, - "ListNodesRequest":{ - "type":"structure", - "members":{ - "Category":{ - "shape":"NodeCategory", - "documentation":"Search for nodes by category.
", - "location":"querystring", - "locationName":"category" - }, - "MaxResults":{ - "shape":"MaxSize25", - "documentation":"The maximum number of nodes to return in one page of results.
", - "location":"querystring", - "locationName":"maxResults" - }, - "NextToken":{ - "shape":"Token", - "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", - "location":"querystring", - "locationName":"nextToken" - }, - "OwnerAccount":{ - "shape":"PackageOwnerAccount", - "documentation":"Search for nodes by the account ID of the nodes' owner.
", - "location":"querystring", - "locationName":"ownerAccount" - }, - "PackageName":{ - "shape":"NodePackageName", - "documentation":"Search for nodes by name.
", - "location":"querystring", - "locationName":"packageName" - }, - "PackageVersion":{ - "shape":"NodePackageVersion", - "documentation":"Search for nodes by version.
", - "location":"querystring", - "locationName":"packageVersion" - }, - "PatchVersion":{ - "shape":"NodePackagePatchVersion", - "documentation":"Search for nodes by patch version.
", - "location":"querystring", - "locationName":"patchVersion" - } - } - }, - "ListNodesResponse":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"Token", - "documentation":"A pagination token that's included if more results are available.
" - }, - "Nodes":{ - "shape":"NodesList", - "documentation":"A list of nodes.
" - } - } - }, - "ListPackageImportJobsRequest":{ - "type":"structure", - "members":{ - "MaxResults":{ - "shape":"MaxSize25", - "documentation":"The maximum number of package import jobs to return in one page of results.
", - "location":"querystring", - "locationName":"MaxResults" - }, - "NextToken":{ - "shape":"NextToken", - "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", - "location":"querystring", - "locationName":"NextToken" - } - } - }, - "ListPackageImportJobsResponse":{ - "type":"structure", - "required":["PackageImportJobs"], - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"A pagination token that's included if more results are available.
" - }, - "PackageImportJobs":{ - "shape":"PackageImportJobList", - "documentation":"A list of package import jobs.
" - } - } - }, - "ListPackagesRequest":{ - "type":"structure", - "members":{ - "MaxResults":{ - "shape":"MaxSize25", - "documentation":"The maximum number of packages to return in one page of results.
", - "location":"querystring", - "locationName":"maxResults" - }, - "NextToken":{ - "shape":"Token", - "documentation":"Specify the pagination token from a previous request to retrieve the next page of results.
", - "location":"querystring", - "locationName":"nextToken" - } - } - }, - "ListPackagesResponse":{ - "type":"structure", - "members":{ - "NextToken":{ - "shape":"NextToken", - "documentation":"A pagination token that's included if more results are available.
" - }, - "Packages":{ - "shape":"PackageList", - "documentation":"A list of packages.
" - } - } - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"The resource's ARN.
", - "location":"uri", - "locationName":"ResourceArn" - } - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "members":{ - "Tags":{ - "shape":"TagMap", - "documentation":"A list of tags.
" - } - } - }, - "ManifestOverridesPayload":{ - "type":"structure", - "members":{ - "PayloadData":{ - "shape":"ManifestOverridesPayloadData", - "documentation":"The overrides document.
" - } - }, - "documentation":"Parameter overrides for an application instance. This is a JSON document that has a single key (PayloadData) where the value is an escaped string representation of the overrides document.
The application manifest.
" - } - }, - "documentation":"A application verion's manifest file. This is a JSON document that has a single key (PayloadData) where the value is an escaped string representation of the application manifest (graph.json). This file is located in the graphs folder in your application source.
Settings for Ethernet port 0.
" - }, - "Ethernet1":{ - "shape":"EthernetPayload", - "documentation":"Settings for Ethernet port 1.
" - }, - "Ntp":{ - "shape":"NtpPayload", - "documentation":"Network time protocol (NTP) server settings.
" - } - }, - "documentation":"The network configuration for a device.
" - }, - "NetworkStatus":{ - "type":"structure", - "members":{ - "Ethernet0Status":{ - "shape":"EthernetStatus", - "documentation":"The status of Ethernet port 0.
" - }, - "Ethernet1Status":{ - "shape":"EthernetStatus", - "documentation":"The status of Ethernet port 1.
" - }, - "LastUpdatedTime":{ - "shape":"LastUpdatedTime", - "documentation":"When the network status changed.
" - }, - "NtpStatus":{ - "shape":"NtpStatus", - "documentation":"Details about a network time protocol (NTP) server connection.
" - } - }, - "documentation":"The network status of a device.
" - }, - "NextToken":{ - "type":"string", - "max":4096, - "min":1, - "pattern":"^.+$" - }, - "Node":{ - "type":"structure", - "required":[ - "Category", - "CreatedTime", - "Name", - "NodeId", - "PackageId", - "PackageName", - "PackageVersion", - "PatchVersion" - ], - "members":{ - "Category":{ - "shape":"NodeCategory", - "documentation":"The node's category.
" - }, - "CreatedTime":{ - "shape":"TimeStamp", - "documentation":"When the node was created.
" - }, - "Description":{ - "shape":"Description", - "documentation":"The node's description.
" - }, - "Name":{ - "shape":"NodeName", - "documentation":"The node's name.
" - }, - "NodeId":{ - "shape":"NodeId", - "documentation":"The node's ID.
" - }, - "OwnerAccount":{ - "shape":"PackageOwnerAccount", - "documentation":"The account ID of the node's owner.
" - }, - "PackageArn":{ - "shape":"NodePackageArn", - "documentation":"The node's ARN.
" - }, - "PackageId":{ - "shape":"NodePackageId", - "documentation":"The node's package ID.
" - }, - "PackageName":{ - "shape":"NodePackageName", - "documentation":"The node's package name.
" - }, - "PackageVersion":{ - "shape":"NodePackageVersion", - "documentation":"The node's package version.
" - }, - "PatchVersion":{ - "shape":"NodePackagePatchVersion", - "documentation":"The node's patch version.
" - } - }, - "documentation":"An application node that represents a camera stream, a model, code, or output.
" - }, - "NodeAssetName":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^[a-zA-Z0-9\\-\\_]+$" - }, - "NodeCategory":{ - "type":"string", - "enum":[ - "BUSINESS_LOGIC", - "ML_MODEL", - "MEDIA_SOURCE", - "MEDIA_SINK" - ] - }, - "NodeFromTemplateJob":{ - "type":"structure", - "members":{ - "CreatedTime":{ - "shape":"CreatedTime", - "documentation":"When the job was created.
" - }, - "JobId":{ - "shape":"JobId", - "documentation":"The job's ID.
" - }, - "NodeName":{ - "shape":"NodeName", - "documentation":"The node's name.
" - }, - "Status":{ - "shape":"NodeFromTemplateJobStatus", - "documentation":"The job's status.
" - }, - "StatusMessage":{ - "shape":"NodeFromTemplateJobStatusMessage", - "documentation":"The job's status message.
" - }, - "TemplateType":{ - "shape":"TemplateType", - "documentation":"The job's template type.
" - } - }, - "documentation":"A job to create a camera stream node.
" - }, - "NodeFromTemplateJobList":{ - "type":"list", - "member":{"shape":"NodeFromTemplateJob"} - }, - "NodeFromTemplateJobStatus":{ - "type":"string", - "enum":[ - "PENDING", - "SUCCEEDED", - "FAILED" - ] - }, - "NodeFromTemplateJobStatusMessage":{"type":"string"}, - "NodeId":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^[a-zA-Z0-9\\-\\_\\.]+$" - }, - "NodeInputPort":{ - "type":"structure", - "members":{ - "DefaultValue":{ - "shape":"PortDefaultValue", - "documentation":"The input port's default value.
" - }, - "Description":{ - "shape":"Description", - "documentation":"The input port's description.
" - }, - "MaxConnections":{ - "shape":"MaxConnections", - "documentation":"The input port's max connections.
" - }, - "Name":{ - "shape":"PortName", - "documentation":"The input port's name.
" - }, - "Type":{ - "shape":"PortType", - "documentation":"The input port's type.
" - } - }, - "documentation":"A node input port.
" - }, - "NodeInstance":{ - "type":"structure", - "required":[ - "CurrentStatus", - "NodeInstanceId" - ], - "members":{ - "CurrentStatus":{ - "shape":"NodeInstanceStatus", - "documentation":"The instance's current status.
" - }, - "NodeId":{ - "shape":"NodeId", - "documentation":"The node's ID.
" - }, - "NodeInstanceId":{ - "shape":"NodeInstanceId", - "documentation":"The instance's ID.
" - }, - "NodeName":{ - "shape":"NodeName", - "documentation":"The instance's name.
" - }, - "PackageName":{ - "shape":"NodePackageName", - "documentation":"The instance's package name.
" - }, - "PackagePatchVersion":{ - "shape":"NodePackagePatchVersion", - "documentation":"The instance's package patch version.
" - }, - "PackageVersion":{ - "shape":"NodePackageVersion", - "documentation":"The instance's package version.
" - } - }, - "documentation":"A node instance.
" - }, - "NodeInstanceId":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9\\-\\_]+$" - }, - "NodeInstanceStatus":{ - "type":"string", - "enum":[ - "RUNNING", - "ERROR", - "NOT_AVAILABLE", - "PAUSED" - ] - }, - "NodeInstances":{ - "type":"list", - "member":{"shape":"NodeInstance"} - }, - "NodeInterface":{ - "type":"structure", - "required":[ - "Inputs", - "Outputs" - ], - "members":{ - "Inputs":{ - "shape":"InputPortList", - "documentation":"The node interface's inputs.
" - }, - "Outputs":{ - "shape":"OutputPortList", - "documentation":"The node interface's outputs.
" - } - }, - "documentation":"A node interface.
" - }, - "NodeName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9\\-\\_]+$" - }, - "NodeOutputPort":{ - "type":"structure", - "members":{ - "Description":{ - "shape":"Description", - "documentation":"The output port's description.
" - }, - "Name":{ - "shape":"PortName", - "documentation":"The output port's name.
" - }, - "Type":{ - "shape":"PortType", - "documentation":"The output port's type.
" - } - }, - "documentation":"A node output port.
" - }, - "NodePackageArn":{ - "type":"string", - "max":255, - "min":1 - }, - "NodePackageId":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^[a-zA-Z0-9\\-\\_\\/]+$" - }, - "NodePackageName":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^[a-zA-Z0-9\\-\\_]+$" - }, - "NodePackagePatchVersion":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^[a-z0-9]+$" - }, - "NodePackageVersion":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^([0-9]+)\\.([0-9]+)$" - }, - "NodeSignal":{ - "type":"structure", - "required":[ - "NodeInstanceId", - "Signal" - ], - "members":{ - "NodeInstanceId":{ - "shape":"NodeInstanceId", - "documentation":"The camera node's name, from the application manifest.
" - }, - "Signal":{ - "shape":"NodeSignalValue", - "documentation":"The signal value.
" - } - }, - "documentation":"A signal to a camera node to start or stop processing video.
" - }, - "NodeSignalList":{ - "type":"list", - "member":{"shape":"NodeSignal"}, - "min":1 - }, - "NodeSignalValue":{ - "type":"string", - "enum":[ - "PAUSE", - "RESUME" - ] - }, - "NodesList":{ - "type":"list", - "member":{"shape":"Node"} - }, - "NtpPayload":{ - "type":"structure", - "required":["NtpServers"], - "members":{ - "NtpServers":{ - "shape":"NtpServerList", - "documentation":"NTP servers to use, in order of preference.
" - } - }, - "documentation":"Network time protocol (NTP) server settings. Use this option to connect to local NTP servers instead of pool.ntp.org.
The connection's status.
" - }, - "IpAddress":{ - "shape":"IpAddress", - "documentation":"The IP address of the server.
" - }, - "NtpServerName":{ - "shape":"NtpServerName", - "documentation":"The domain name of the server.
" - } - }, - "documentation":"Details about an NTP server connection.
" - }, - "OTAJobConfig":{ - "type":"structure", - "required":["ImageVersion"], - "members":{ - "AllowMajorVersionUpdate":{ - "shape":"Boolean", - "documentation":"Whether to apply the update if it is a major version change.
" - }, - "ImageVersion":{ - "shape":"ImageVersion", - "documentation":"The target version of the device software.
" - } - }, - "documentation":"An over-the-air update (OTA) job configuration.
" - }, - "Object":{"type":"string"}, - "ObjectKey":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^.+$" - }, - "OutPutS3Location":{ - "type":"structure", - "required":[ - "BucketName", - "ObjectKey" - ], - "members":{ - "BucketName":{ - "shape":"BucketName", - "documentation":"The object's bucket.
" - }, - "ObjectKey":{ - "shape":"ObjectKey", - "documentation":"The object's key.
" - } - }, - "documentation":"The location of an output object in Amazon S3.
" - }, - "OutputPortList":{ - "type":"list", - "member":{"shape":"NodeOutputPort"} - }, - "PackageImportJob":{ - "type":"structure", - "members":{ - "CreatedTime":{ - "shape":"CreatedTime", - "documentation":"When the job was created.
" - }, - "JobId":{ - "shape":"JobId", - "documentation":"The job's ID.
" - }, - "JobType":{ - "shape":"PackageImportJobType", - "documentation":"The job's type.
" - }, - "LastUpdatedTime":{ - "shape":"LastUpdatedTime", - "documentation":"When the job was updated.
" - }, - "Status":{ - "shape":"PackageImportJobStatus", - "documentation":"The job's status.
" - }, - "StatusMessage":{ - "shape":"PackageImportJobStatusMessage", - "documentation":"The job's status message.
" - } - }, - "documentation":"A job to import a package version.
" - }, - "PackageImportJobInputConfig":{ - "type":"structure", - "members":{ - "PackageVersionInputConfig":{ - "shape":"PackageVersionInputConfig", - "documentation":"The package version's input configuration.
" - } - }, - "documentation":"A configuration for a package import job.
" - }, - "PackageImportJobList":{ - "type":"list", - "member":{"shape":"PackageImportJob"} - }, - "PackageImportJobOutput":{ - "type":"structure", - "required":[ - "OutputS3Location", - "PackageId", - "PackageVersion", - "PatchVersion" - ], - "members":{ - "OutputS3Location":{ - "shape":"OutPutS3Location", - "documentation":"The package's output location.
" - }, - "PackageId":{ - "shape":"NodePackageId", - "documentation":"The package's ID.
" - }, - "PackageVersion":{ - "shape":"NodePackageVersion", - "documentation":"The package's version.
" - }, - "PatchVersion":{ - "shape":"NodePackagePatchVersion", - "documentation":"The package's patch version.
" - } - }, - "documentation":"Results of a package import job.
" - }, - "PackageImportJobOutputConfig":{ - "type":"structure", - "members":{ - "PackageVersionOutputConfig":{ - "shape":"PackageVersionOutputConfig", - "documentation":"The package version's output configuration.
" - } - }, - "documentation":"An output configuration for a package import job.
" - }, - "PackageImportJobStatus":{ - "type":"string", - "enum":[ - "PENDING", - "SUCCEEDED", - "FAILED" - ] - }, - "PackageImportJobStatusMessage":{"type":"string"}, - "PackageImportJobType":{ - "type":"string", - "enum":[ - "NODE_PACKAGE_VERSION", - "MARKETPLACE_NODE_PACKAGE_VERSION" - ] - }, - "PackageList":{ - "type":"list", - "member":{"shape":"PackageListItem"} - }, - "PackageListItem":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"NodePackageArn", - "documentation":"The package's ARN.
" - }, - "CreatedTime":{ - "shape":"TimeStamp", - "documentation":"When the package was created.
" - }, - "PackageId":{ - "shape":"NodePackageId", - "documentation":"The package's ID.
" - }, - "PackageName":{ - "shape":"NodePackageName", - "documentation":"The package's name.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"The package's tags.
" - } - }, - "documentation":"A package summary.
" - }, - "PackageObject":{ - "type":"structure", - "required":[ - "Name", - "PackageVersion", - "PatchVersion" - ], - "members":{ - "Name":{ - "shape":"NodePackageName", - "documentation":"The object's name.
" - }, - "PackageVersion":{ - "shape":"NodePackageVersion", - "documentation":"The object's package version.
" - }, - "PatchVersion":{ - "shape":"NodePackagePatchVersion", - "documentation":"The object's patch version.
" - } - }, - "documentation":"A package object.
" - }, - "PackageObjects":{ - "type":"list", - "member":{"shape":"PackageObject"} - }, - "PackageOwnerAccount":{ - "type":"string", - "max":12, - "min":1, - "pattern":"^[0-9a-z\\_]+$" - }, - "PackageVersionInputConfig":{ - "type":"structure", - "required":["S3Location"], - "members":{ - "S3Location":{ - "shape":"S3Location", - "documentation":"A location in Amazon S3.
" - } - }, - "documentation":"A package version input configuration.
" - }, - "PackageVersionOutputConfig":{ - "type":"structure", - "required":[ - "PackageName", - "PackageVersion" - ], - "members":{ - "MarkLatest":{ - "shape":"MarkLatestPatch", - "documentation":"Indicates that the version is recommended for all users.
" - }, - "PackageName":{ - "shape":"NodePackageName", - "documentation":"The output's package name.
" - }, - "PackageVersion":{ - "shape":"NodePackageVersion", - "documentation":"The output's package version.
" - } - }, - "documentation":"A package version output configuration.
" - }, - "PackageVersionStatus":{ - "type":"string", - "enum":[ - "REGISTER_PENDING", - "REGISTER_COMPLETED", - "FAILED", - "DELETING" - ] - }, - "PackageVersionStatusDescription":{ - "type":"string", - "max":255, - "min":1 - }, - "PortDefaultValue":{ - "type":"string", - "max":255, - "min":1 - }, - "PortName":{ - "type":"string", - "max":50, - "min":1, - "pattern":"^[a-zA-Z0-9\\_]+$" - }, - "PortType":{ - "type":"string", - "enum":[ - "BOOLEAN", - "STRING", - "INT32", - "FLOAT32", - "MEDIA" - ] - }, - "PrincipalArn":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:[a-zA-Z0-9+=,.@\\-_/]+$" - }, - "PrincipalArnsList":{ - "type":"list", - "member":{"shape":"PrincipalArn"} - }, - "ProvisionDeviceRequest":{ - "type":"structure", - "required":["Name"], - "members":{ - "Description":{ - "shape":"Description", - "documentation":"A description for the device.
" - }, - "Name":{ - "shape":"DeviceName", - "documentation":"A name for the device.
" - }, - "NetworkingConfiguration":{ - "shape":"NetworkPayload", - "documentation":"A networking configuration for the device.
" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"Tags for the device.
" - } - } - }, - "ProvisionDeviceResponse":{ - "type":"structure", - "required":[ - "Arn", - "Status" - ], - "members":{ - "Arn":{ - "shape":"DeviceArn", - "documentation":"The device's ARN.
" - }, - "Certificates":{ - "shape":"Certificates", - "documentation":"The device's configuration bundle.
" - }, - "DeviceId":{ - "shape":"DeviceId", - "documentation":"The device's ID.
" - }, - "IotThingName":{ - "shape":"IotThingName", - "documentation":"The device's IoT thing name.
" - }, - "Status":{ - "shape":"DeviceStatus", - "documentation":"The device's status.
" - } - } - }, - "Region":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^.+$" - }, - "RegisterPackageVersionRequest":{ - "type":"structure", - "required":[ - "PackageId", - "PackageVersion", - "PatchVersion" - ], - "members":{ - "MarkLatest":{ - "shape":"MarkLatestPatch", - "documentation":"Whether to mark the new version as the latest version.
" - }, - "OwnerAccount":{ - "shape":"PackageOwnerAccount", - "documentation":"An owner account.
" - }, - "PackageId":{ - "shape":"NodePackageId", - "documentation":"A package ID.
", - "location":"uri", - "locationName":"PackageId" - }, - "PackageVersion":{ - "shape":"NodePackageVersion", - "documentation":"A package version.
", - "location":"uri", - "locationName":"PackageVersion" - }, - "PatchVersion":{ - "shape":"NodePackagePatchVersion", - "documentation":"A patch version.
", - "location":"uri", - "locationName":"PatchVersion" - } - } - }, - "RegisterPackageVersionResponse":{ - "type":"structure", - "members":{ - } - }, - "RemoveApplicationInstanceRequest":{ - "type":"structure", - "required":["ApplicationInstanceId"], - "members":{ - "ApplicationInstanceId":{ - "shape":"ApplicationInstanceId", - "documentation":"An application instance ID.
", - "location":"uri", - "locationName":"ApplicationInstanceId" - } - } - }, - "RemoveApplicationInstanceResponse":{ - "type":"structure", - "members":{ - } - }, - "ReportedRuntimeContextState":{ - "type":"structure", - "required":[ - "DesiredState", - "DeviceReportedStatus", - "DeviceReportedTime", - "RuntimeContextName" - ], - "members":{ - "DesiredState":{ - "shape":"DesiredState", - "documentation":"The application's desired state.
" - }, - "DeviceReportedStatus":{ - "shape":"DeviceReportedStatus", - "documentation":"The application's reported status.
" - }, - "DeviceReportedTime":{ - "shape":"TimeStamp", - "documentation":"When the device reported the application's state.
" - }, - "RuntimeContextName":{ - "shape":"RuntimeContextName", - "documentation":"The device's name.
" - } - }, - "documentation":"An application instance's state.
" - }, - "ReportedRuntimeContextStates":{ - "type":"list", - "member":{"shape":"ReportedRuntimeContextState"} - }, - "ResourceArn":{ - "type":"string", - "max":2048, - "min":1, - "pattern":"^.+$" - }, - "ResourceNotFoundException":{ - "type":"structure", - "required":[ - "Message", - "ResourceId", - "ResourceType" - ], - "members":{ - "Message":{"shape":"String"}, - "ResourceId":{ - "shape":"String", - "documentation":"The resource's ID.
" - }, - "ResourceType":{ - "shape":"String", - "documentation":"The resource's type.
" - } - }, - "documentation":"The target resource was not found.
", - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "RetryAfterSeconds":{"type":"integer"}, - "RuntimeContextName":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^.+$" - }, - "RuntimeRoleArn":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:role/.+$" - }, - "S3Location":{ - "type":"structure", - "required":[ - "BucketName", - "ObjectKey" - ], - "members":{ - "BucketName":{ - "shape":"BucketName", - "documentation":"A bucket name.
" - }, - "ObjectKey":{ - "shape":"ObjectKey", - "documentation":"An object key.
" - }, - "Region":{ - "shape":"Region", - "documentation":"The bucket's Region.
" - } - }, - "documentation":"A location in Amazon S3.
" - }, - "ServiceQuotaExceededException":{ - "type":"structure", - "required":[ - "Message", - "QuotaCode", - "ServiceCode" - ], - "members":{ - "Message":{"shape":"String"}, - "QuotaCode":{ - "shape":"String", - "documentation":"The name of the limit.
" - }, - "ResourceId":{ - "shape":"String", - "documentation":"The target resource's ID.
" - }, - "ResourceType":{ - "shape":"String", - "documentation":"The target resource's type.
" - }, - "ServiceCode":{ - "shape":"String", - "documentation":"The name of the service.
" - } - }, - "documentation":"The request would cause a limit to be exceeded.
", - "error":{ - "httpStatusCode":402, - "senderFault":true - }, - "exception":true - }, - "SignalApplicationInstanceNodeInstancesRequest":{ - "type":"structure", - "required":[ - "ApplicationInstanceId", - "NodeSignals" - ], - "members":{ - "ApplicationInstanceId":{ - "shape":"ApplicationInstanceId", - "documentation":"An application instance ID.
", - "location":"uri", - "locationName":"ApplicationInstanceId" - }, - "NodeSignals":{ - "shape":"NodeSignalList", - "documentation":"A list of signals.
" - } - } - }, - "SignalApplicationInstanceNodeInstancesResponse":{ - "type":"structure", - "required":["ApplicationInstanceId"], - "members":{ - "ApplicationInstanceId":{ - "shape":"ApplicationInstanceId", - "documentation":"An application instance ID.
" - } - } - }, - "SortOrder":{ - "type":"string", - "enum":[ - "ASCENDING", - "DESCENDING" - ] - }, - "StaticIpConnectionInfo":{ - "type":"structure", - "required":[ - "DefaultGateway", - "Dns", - "IpAddress", - "Mask" - ], - "members":{ - "DefaultGateway":{ - "shape":"DefaultGateway", - "documentation":"The connection's default gateway.
" - }, - "Dns":{ - "shape":"DnsList", - "documentation":"The connection's DNS address.
" - }, - "IpAddress":{ - "shape":"IpAddress", - "documentation":"The connection's IP address.
" - }, - "Mask":{ - "shape":"Mask", - "documentation":"The connection's DNS mask.
" - } - }, - "documentation":"A static IP configuration.
" - }, - "StatusFilter":{ - "type":"string", - "enum":[ - "DEPLOYMENT_SUCCEEDED", - "DEPLOYMENT_ERROR", - "REMOVAL_SUCCEEDED", - "REMOVAL_FAILED", - "PROCESSING_DEPLOYMENT", - "PROCESSING_REMOVAL", - "DEPLOYMENT_FAILED" - ] - }, - "StorageLocation":{ - "type":"structure", - "required":[ - "BinaryPrefixLocation", - "Bucket", - "GeneratedPrefixLocation", - "ManifestPrefixLocation", - "RepoPrefixLocation" - ], - "members":{ - "BinaryPrefixLocation":{ - "shape":"Object", - "documentation":"The location's binary prefix.
" - }, - "Bucket":{ - "shape":"Bucket", - "documentation":"The location's bucket.
" - }, - "GeneratedPrefixLocation":{ - "shape":"Object", - "documentation":"The location's generated prefix.
" - }, - "ManifestPrefixLocation":{ - "shape":"Object", - "documentation":"The location's manifest prefix.
" - }, - "RepoPrefixLocation":{ - "shape":"Object", - "documentation":"The location's repo prefix.
" - } - }, - "documentation":"A storage location.
" - }, - "String":{"type":"string"}, - "TagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^.+$" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"}, - "max":50, - "min":1 - }, - "TagMap":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"}, - "max":50, - "min":0 - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "Tags" - ], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"The resource's ARN.
", - "location":"uri", - "locationName":"ResourceArn" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"Tags for the resource.
" - } - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{ - } - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":"^.*$" - }, - "TemplateKey":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^.+$" - }, - "TemplateParametersMap":{ - "type":"map", - "key":{"shape":"TemplateKey"}, - "value":{"shape":"TemplateValue"} - }, - "TemplateType":{ - "type":"string", - "enum":["RTSP_CAMERA_STREAM"] - }, - "TemplateValue":{ - "type":"string", - "max":255, - "min":1, - "pattern":"^.+$", - "sensitive":true - }, - "TimeStamp":{"type":"timestamp"}, - "Token":{ - "type":"string", - "max":4096, - "min":1, - "pattern":"^.+$" - }, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "TagKeys" - ], - "members":{ - "ResourceArn":{ - "shape":"ResourceArn", - "documentation":"The resource's ARN.
", - "location":"uri", - "locationName":"ResourceArn" - }, - "TagKeys":{ - "shape":"TagKeyList", - "documentation":"Tag keys to remove.
", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateCreatedTime":{"type":"timestamp"}, - "UpdateDeviceMetadataRequest":{ - "type":"structure", - "required":["DeviceId"], - "members":{ - "Description":{ - "shape":"Description", - "documentation":"A description for the device.
" - }, - "DeviceId":{ - "shape":"DeviceId", - "documentation":"The device's ID.
", - "location":"uri", - "locationName":"DeviceId" - } - } - }, - "UpdateDeviceMetadataResponse":{ - "type":"structure", - "members":{ - "DeviceId":{ - "shape":"DeviceId", - "documentation":"The device's ID.
" - } - } - }, - "UpdateProgress":{ - "type":"string", - "enum":[ - "PENDING", - "IN_PROGRESS", - "VERIFYING", - "REBOOTING", - "DOWNLOADING", - "COMPLETED", - "FAILED" - ] - }, - "ValidationException":{ - "type":"structure", - "required":["Message"], - "members":{ - "ErrorArguments":{ - "shape":"ValidationExceptionErrorArgumentList", - "documentation":"A list of attributes that led to the exception and their values.
" - }, - "ErrorId":{ - "shape":"String", - "documentation":"A unique ID for the error.
" - }, - "Fields":{ - "shape":"ValidationExceptionFieldList", - "documentation":"A list of request parameters that failed validation.
" - }, - "Message":{"shape":"String"}, - "Reason":{ - "shape":"ValidationExceptionReason", - "documentation":"The reason that validation failed.
" - } - }, - "documentation":"The request contains an invalid parameter value.
", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ValidationExceptionErrorArgument":{ - "type":"structure", - "required":[ - "Name", - "Value" - ], - "members":{ - "Name":{ - "shape":"String", - "documentation":"The argument's name.
" - }, - "Value":{ - "shape":"String", - "documentation":"The argument's value.
" - } - }, - "documentation":"A validation exception error argument.
" - }, - "ValidationExceptionErrorArgumentList":{ - "type":"list", - "member":{"shape":"ValidationExceptionErrorArgument"} - }, - "ValidationExceptionField":{ - "type":"structure", - "required":[ - "Message", - "Name" - ], - "members":{ - "Message":{ - "shape":"String", - "documentation":"The field's message.
" - }, - "Name":{ - "shape":"String", - "documentation":"The field's name.
" - } - }, - "documentation":"A validation exception field.
" - }, - "ValidationExceptionFieldList":{ - "type":"list", - "member":{"shape":"ValidationExceptionField"} - }, - "ValidationExceptionReason":{ - "type":"string", - "enum":[ - "UNKNOWN_OPERATION", - "CANNOT_PARSE", - "FIELD_VALIDATION_FAILED", - "OTHER" - ] - }, - "Version":{ - "type":"string", - "max":255, - "min":1 - } - }, - "documentation":"Overview
This is the AWS Panorama API Reference. For an introduction to the service, see What is AWS Panorama? in the AWS Panorama Developer Guide.
" -} diff --git a/awscli/botocore/data/simspaceweaver/2022-10-28/completions-1.json b/awscli/botocore/data/simspaceweaver/2022-10-28/completions-1.json deleted file mode 100644 index 88a556644812..000000000000 --- a/awscli/botocore/data/simspaceweaver/2022-10-28/completions-1.json +++ /dev/null @@ -1,168 +0,0 @@ -{ - "version": "1.0", - "resources": { - "Simulation": { - "operation": "ListSimulations", - "resourceIdentifier": { - "Arn": "Simulations[].Arn", - "Name": "Simulations[].Name" - } - } - }, - "operations": { - "CreateSnapshot": { - "Simulation": { - "completions": [ - { - "parameters": {}, - "resourceName": "Simulation", - "resourceIdentifier": "Name" - } - ] - } - }, - "DeleteApp": { - "Simulation": { - "completions": [ - { - "parameters": {}, - "resourceName": "Simulation", - "resourceIdentifier": "Name" - } - ] - } - }, - "DeleteSimulation": { - "Simulation": { - "completions": [ - { - "parameters": {}, - "resourceName": "Simulation", - "resourceIdentifier": "Name" - } - ] - } - }, - "DescribeApp": { - "Simulation": { - "completions": [ - { - "parameters": {}, - "resourceName": "Simulation", - "resourceIdentifier": "Name" - } - ] - } - }, - "DescribeSimulation": { - "Simulation": { - "completions": [ - { - "parameters": {}, - "resourceName": "Simulation", - "resourceIdentifier": "Name" - } - ] - } - }, - "ListApps": { - "Simulation": { - "completions": [ - { - "parameters": {}, - "resourceName": "Simulation", - "resourceIdentifier": "Name" - } - ] - } - }, - "ListTagsForResource": { - "ResourceArn": { - "completions": [ - { - "parameters": {}, - "resourceName": "Simulation", - "resourceIdentifier": "Arn" - } - ] - } - }, - "StartApp": { - "Simulation": { - "completions": [ - { - "parameters": {}, - "resourceName": "Simulation", - "resourceIdentifier": "Name" - } - ] - } - }, - "StartClock": { - "Simulation": { - "completions": [ - { - "parameters": {}, - "resourceName": "Simulation", - "resourceIdentifier": "Name" - } - ] - } - }, - "StopApp": { - "Simulation": { - "completions": [ - { - "parameters": {}, - "resourceName": "Simulation", - "resourceIdentifier": "Name" - } - ] - } - }, - "StopClock": { - "Simulation": { - "completions": [ - { - "parameters": {}, - "resourceName": "Simulation", - "resourceIdentifier": "Name" - } - ] - } - }, - "StopSimulation": { - "Simulation": { - "completions": [ - { - "parameters": {}, - "resourceName": "Simulation", - "resourceIdentifier": "Name" - } - ] - } - }, - "TagResource": { - "ResourceArn": { - "completions": [ - { - "parameters": {}, - "resourceName": "Simulation", - "resourceIdentifier": "Arn" - } - ] - } - }, - "UntagResource": { - "ResourceArn": { - "completions": [ - { - "parameters": {}, - "resourceName": "Simulation", - "resourceIdentifier": "Arn" - } - ] - } - } - } -} diff --git a/awscli/botocore/data/simspaceweaver/2022-10-28/endpoint-rule-set-1.json b/awscli/botocore/data/simspaceweaver/2022-10-28/endpoint-rule-set-1.json deleted file mode 100644 index 329d32b97adb..000000000000 --- a/awscli/botocore/data/simspaceweaver/2022-10-28/endpoint-rule-set-1.json +++ /dev/null @@ -1,350 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://simspaceweaver-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://simspaceweaver-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://simspaceweaver.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://simspaceweaver.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "type": "tree" - } - ] -} \ No newline at end of file diff --git a/awscli/botocore/data/simspaceweaver/2022-10-28/paginators-1.json b/awscli/botocore/data/simspaceweaver/2022-10-28/paginators-1.json deleted file mode 100644 index ea142457a6a7..000000000000 --- a/awscli/botocore/data/simspaceweaver/2022-10-28/paginators-1.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "pagination": {} -} diff --git a/awscli/botocore/data/simspaceweaver/2022-10-28/service-2.json b/awscli/botocore/data/simspaceweaver/2022-10-28/service-2.json deleted file mode 100644 index 4bbdbf44cce7..000000000000 --- a/awscli/botocore/data/simspaceweaver/2022-10-28/service-2.json +++ /dev/null @@ -1,1313 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2022-10-28", - "endpointPrefix":"simspaceweaver", - "jsonVersion":"1.1", - "protocol":"rest-json", - "serviceFullName":"AWS SimSpace Weaver", - "serviceId":"SimSpaceWeaver", - "signatureVersion":"v4", - "signingName":"simspaceweaver", - "uid":"simspaceweaver-2022-10-28" - }, - "operations":{ - "CreateSnapshot":{ - "name":"CreateSnapshot", - "http":{ - "method":"POST", - "requestUri":"/createsnapshot", - "responseCode":200 - }, - "input":{"shape":"CreateSnapshotInput"}, - "output":{"shape":"CreateSnapshotOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"} - ], - "documentation":"Creates a snapshot of the specified simulation. A snapshot is a file that contains simulation state data at a specific time. The state data saved in a snapshot includes entity data from the State Fabric, the simulation configuration specified in the schema, and the clock tick number. You can use the snapshot to initialize a new simulation. For more information about snapshots, see Snapshots in the SimSpace Weaver User Guide.
You specify a Destination when you create a snapshot. The Destination is the name of an Amazon S3 bucket and an optional ObjectKeyPrefix. The ObjectKeyPrefix is usually the name of a folder in the bucket. SimSpace Weaver creates a snapshot folder inside the Destination and places the snapshot file there.
The snapshot file is an Amazon S3 object. It has an object key with the form: object-key-prefix/snapshot/simulation-name-YYMMdd-HHmm-ss.zip, where:
YY is the 2-digit year
MM is the 2-digit month
dd is the 2-digit day of the month
HH is the 2-digit hour (24-hour clock)
mm is the 2-digit minutes
ss is the 2-digit seconds
Deletes the instance of the given custom app.
", - "idempotent":true - }, - "DeleteSimulation":{ - "name":"DeleteSimulation", - "http":{ - "method":"DELETE", - "requestUri":"/deletesimulation", - "responseCode":200 - }, - "input":{"shape":"DeleteSimulationInput"}, - "output":{"shape":"DeleteSimulationOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"} - ], - "documentation":"Deletes all SimSpace Weaver resources assigned to the given simulation.
Your simulation uses resources in other Amazon Web Services. This API operation doesn't delete resources in other Amazon Web Services.
Returns the state of the given custom app.
" - }, - "DescribeSimulation":{ - "name":"DescribeSimulation", - "http":{ - "method":"GET", - "requestUri":"/describesimulation", - "responseCode":200 - }, - "input":{"shape":"DescribeSimulationInput"}, - "output":{"shape":"DescribeSimulationOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"} - ], - "documentation":"Returns the current state of the given simulation.
" - }, - "ListApps":{ - "name":"ListApps", - "http":{ - "method":"GET", - "requestUri":"/listapps", - "responseCode":200 - }, - "input":{"shape":"ListAppsInput"}, - "output":{"shape":"ListAppsOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"} - ], - "documentation":"Lists all custom apps or service apps for the given simulation and domain.
" - }, - "ListSimulations":{ - "name":"ListSimulations", - "http":{ - "method":"GET", - "requestUri":"/listsimulations", - "responseCode":200 - }, - "input":{"shape":"ListSimulationsInput"}, - "output":{"shape":"ListSimulationsOutput"}, - "errors":[ - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"} - ], - "documentation":"Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.
" - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"GET", - "requestUri":"/tags/{ResourceArn}", - "responseCode":200 - }, - "input":{"shape":"ListTagsForResourceInput"}, - "output":{"shape":"ListTagsForResourceOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"} - ], - "documentation":"Lists all tags on a SimSpace Weaver resource.
" - }, - "StartApp":{ - "name":"StartApp", - "http":{ - "method":"POST", - "requestUri":"/startapp", - "responseCode":200 - }, - "input":{"shape":"StartAppInput"}, - "output":{"shape":"StartAppOutput"}, - "errors":[ - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"} - ], - "documentation":"Starts a custom app with the configuration specified in the simulation schema.
" - }, - "StartClock":{ - "name":"StartClock", - "http":{ - "method":"POST", - "requestUri":"/startclock", - "responseCode":200 - }, - "input":{"shape":"StartClockInput"}, - "output":{"shape":"StartClockOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"} - ], - "documentation":"Starts the simulation clock.
" - }, - "StartSimulation":{ - "name":"StartSimulation", - "http":{ - "method":"POST", - "requestUri":"/startsimulation", - "responseCode":200 - }, - "input":{"shape":"StartSimulationInput"}, - "output":{"shape":"StartSimulationOutput"}, - "errors":[ - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ConflictException"} - ], - "documentation":"Starts a simulation with the given name. You must choose to start your simulation from a schema or from a snapshot. For more information about the schema, see the schema reference in the SimSpace Weaver User Guide. For more information about snapshots, see Snapshots in the SimSpace Weaver User Guide.
" - }, - "StopApp":{ - "name":"StopApp", - "http":{ - "method":"POST", - "requestUri":"/stopapp", - "responseCode":200 - }, - "input":{"shape":"StopAppInput"}, - "output":{"shape":"StopAppOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"} - ], - "documentation":"Stops the given custom app and shuts down all of its allocated compute resources.
" - }, - "StopClock":{ - "name":"StopClock", - "http":{ - "method":"POST", - "requestUri":"/stopclock", - "responseCode":200 - }, - "input":{"shape":"StopClockInput"}, - "output":{"shape":"StopClockOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"} - ], - "documentation":"Stops the simulation clock.
" - }, - "StopSimulation":{ - "name":"StopSimulation", - "http":{ - "method":"POST", - "requestUri":"/stopsimulation", - "responseCode":200 - }, - "input":{"shape":"StopSimulationInput"}, - "output":{"shape":"StopSimulationOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"ConflictException"} - ], - "documentation":"Stops the given simulation.
You can't restart a simulation after you stop it. If you want to restart a simulation, then you must stop it, delete it, and start a new instance of it.
Adds tags to a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/tags/{ResourceArn}", - "responseCode":200 - }, - "input":{"shape":"UntagResourceInput"}, - "output":{"shape":"UntagResourceOutput"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"} - ], - "documentation":"Removes tags from a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
" - } - }, - "shapes":{ - "AccessDeniedException":{ - "type":"structure", - "members":{ - "Message":{"shape":"NonEmptyString"} - }, - "documentation":"", - "error":{ - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "AppPortMappings":{ - "type":"list", - "member":{"shape":"SimulationAppPortMapping"} - }, - "BucketName":{ - "type":"string", - "max":63, - "min":3 - }, - "ClientToken":{ - "type":"string", - "max":128, - "min":32, - "pattern":"^[a-zA-Z0-9-]+$", - "sensitive":true - }, - "ClockStatus":{ - "type":"string", - "enum":[ - "UNKNOWN", - "STARTING", - "STARTED", - "STOPPING", - "STOPPED" - ] - }, - "ClockTargetStatus":{ - "type":"string", - "enum":[ - "UNKNOWN", - "STARTED", - "STOPPED" - ] - }, - "CloudWatchLogsLogGroup":{ - "type":"structure", - "members":{ - "LogGroupArn":{ - "shape":"LogGroupArn", - "documentation":"The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group for the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For more information about log groups, see Working with log groups and log streams in the Amazon CloudWatch Logs User Guide.
" - } - }, - "documentation":"The Amazon CloudWatch Logs log group for the simulation. For more information about log groups, see Working with log groups and log streams in the Amazon CloudWatch Logs User Guide.
" - }, - "ConflictException":{ - "type":"structure", - "members":{ - "Message":{"shape":"NonEmptyString"} - }, - "documentation":"", - "error":{ - "httpStatusCode":409, - "senderFault":true - }, - "exception":true - }, - "CreateSnapshotInput":{ - "type":"structure", - "required":[ - "Destination", - "Simulation" - ], - "members":{ - "Destination":{ - "shape":"S3Destination", - "documentation":"The Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates the snapshot file.
The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.
" - }, - "Simulation":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the simulation.
" - } - } - }, - "CreateSnapshotOutput":{ - "type":"structure", - "members":{ - } - }, - "DeleteAppInput":{ - "type":"structure", - "required":[ - "App", - "Domain", - "Simulation" - ], - "members":{ - "App":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the app.
", - "location":"querystring", - "locationName":"app" - }, - "Domain":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the domain of the app.
", - "location":"querystring", - "locationName":"domain" - }, - "Simulation":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the simulation of the app.
", - "location":"querystring", - "locationName":"simulation" - } - } - }, - "DeleteAppOutput":{ - "type":"structure", - "members":{ - } - }, - "DeleteSimulationInput":{ - "type":"structure", - "required":["Simulation"], - "members":{ - "Simulation":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the simulation.
", - "location":"querystring", - "locationName":"simulation" - } - } - }, - "DeleteSimulationOutput":{ - "type":"structure", - "members":{ - } - }, - "DescribeAppInput":{ - "type":"structure", - "required":[ - "App", - "Domain", - "Simulation" - ], - "members":{ - "App":{ - "shape":"SimSpaceWeaverLongResourceName", - "documentation":"The name of the app.
", - "location":"querystring", - "locationName":"app" - }, - "Domain":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the domain of the app.
", - "location":"querystring", - "locationName":"domain" - }, - "Simulation":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the simulation of the app.
", - "location":"querystring", - "locationName":"simulation" - } - } - }, - "DescribeAppOutput":{ - "type":"structure", - "members":{ - "Description":{ - "shape":"Description", - "documentation":"The description of the app.
" - }, - "Domain":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the domain of the app.
" - }, - "EndpointInfo":{ - "shape":"SimulationAppEndpointInfo", - "documentation":"Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.
" - }, - "LaunchOverrides":{"shape":"LaunchOverrides"}, - "Name":{ - "shape":"SimSpaceWeaverLongResourceName", - "documentation":"The name of the app.
" - }, - "Simulation":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the simulation of the app.
" - }, - "Status":{ - "shape":"SimulationAppStatus", - "documentation":"The current lifecycle state of the custom app.
" - }, - "TargetStatus":{ - "shape":"SimulationAppTargetStatus", - "documentation":"The desired lifecycle state of the custom app.
" - } - } - }, - "DescribeSimulationInput":{ - "type":"structure", - "required":["Simulation"], - "members":{ - "Simulation":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the simulation.
", - "location":"querystring", - "locationName":"simulation" - } - } - }, - "DescribeSimulationOutput":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"SimSpaceWeaverArn", - "documentation":"The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).
" - }, - "Description":{ - "shape":"Description", - "documentation":"The description of the simulation.
" - }, - "ExecutionId":{ - "shape":"UUID", - "documentation":"A universally unique identifier (UUID) for this simulation.
" - }, - "LiveSimulationState":{ - "shape":"LiveSimulationState", - "documentation":"A collection of additional state information, such as domain and clock configuration.
" - }, - "LoggingConfiguration":{ - "shape":"LoggingConfiguration", - "documentation":"Settings that control how SimSpace Weaver handles your simulation log data.
" - }, - "MaximumDuration":{ - "shape":"TimeToLiveString", - "documentation":"The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches this limit. The maximum value is 14D, or its equivalent in the other units. The default value is 14D. A value equivalent to 0 makes the simulation immediately transition to Stopping as soon as it reaches Started.
The name of the simulation.
" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see IAM roles in the Identity and Access Management User Guide.
" - }, - "SchemaError":{ - "shape":"OptionalString", - "documentation":"An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.
", - "deprecated":true, - "deprecatedMessage":"SchemaError is no longer used, check StartError instead." - }, - "SchemaS3Location":{ - "shape":"S3Location", - "documentation":"The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .
" - }, - "SnapshotS3Location":{"shape":"S3Location"}, - "StartError":{ - "shape":"OptionalString", - "documentation":"An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the STARTING state.
The current lifecycle state of the simulation.
" - }, - "TargetStatus":{ - "shape":"SimulationTargetStatus", - "documentation":"The desired lifecycle state of the simulation.
" - } - } - }, - "Description":{ - "type":"string", - "max":500, - "min":0 - }, - "Domain":{ - "type":"structure", - "members":{ - "Lifecycle":{ - "shape":"LifecycleManagementStrategy", - "documentation":"The type of lifecycle management for apps in the domain. Indicates whether apps in this domain are managed (SimSpace Weaver starts and stops the apps) or unmanaged (you must start and stop the apps).
Lifecycle types
PerWorker – Managed: SimSpace Weaver starts one app on each worker.
BySpatialSubdivision – Managed: SimSpace Weaver starts one app for each spatial partition.
ByRequest – Unmanaged: You use the StartApp API to start the apps and use the StopApp API to stop the apps.
The name of the domain.
" - } - }, - "documentation":"A collection of app instances that run the same executable app code and have the same launch options and commands.
For more information about domains, see Key concepts: Domains in the SimSpace Weaver User Guide.
" - }, - "DomainList":{ - "type":"list", - "member":{"shape":"Domain"} - }, - "InternalServerException":{ - "type":"structure", - "members":{ - "Message":{"shape":"NonEmptyString"} - }, - "documentation":"", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true - }, - "LaunchCommandList":{ - "type":"list", - "member":{"shape":"NonEmptyString"} - }, - "LaunchOverrides":{ - "type":"structure", - "members":{ - "LaunchCommands":{ - "shape":"LaunchCommandList", - "documentation":"App launch commands and command line parameters that override the launch command configured in the simulation schema.
" - } - }, - "documentation":"Options that apply when the app starts. These options override default behavior.
" - }, - "LifecycleManagementStrategy":{ - "type":"string", - "enum":[ - "Unknown", - "PerWorker", - "BySpatialSubdivision", - "ByRequest" - ] - }, - "ListAppsInput":{ - "type":"structure", - "required":["Simulation"], - "members":{ - "Domain":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the domain that you want to list apps for.
", - "location":"querystring", - "locationName":"domain" - }, - "MaxResults":{ - "shape":"PositiveInteger", - "documentation":"The maximum number of apps to list.
", - "location":"querystring", - "locationName":"maxResults" - }, - "NextToken":{ - "shape":"OptionalString", - "documentation":"If SimSpace Weaver returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
The name of the simulation that you want to list apps for.
", - "location":"querystring", - "locationName":"simulation" - } - } - }, - "ListAppsOutput":{ - "type":"structure", - "members":{ - "Apps":{ - "shape":"SimulationAppList", - "documentation":"The list of apps for the given simulation and domain.
" - }, - "NextToken":{ - "shape":"OptionalString", - "documentation":"If SimSpace Weaver returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
The maximum number of simulations to list.
", - "location":"querystring", - "locationName":"maxResults" - }, - "NextToken":{ - "shape":"OptionalString", - "documentation":"If SimSpace Weaver returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
If SimSpace Weaver returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
The list of simulations.
" - } - } - }, - "ListTagsForResourceInput":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "ResourceArn":{ - "shape":"SimSpaceWeaverArn", - "documentation":"The Amazon Resource Name (ARN) of the resource. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
", - "location":"uri", - "locationName":"ResourceArn" - } - } - }, - "ListTagsForResourceOutput":{ - "type":"structure", - "members":{ - "Tags":{ - "shape":"TagMap", - "documentation":"The list of tags for the resource.
" - } - } - }, - "LiveSimulationState":{ - "type":"structure", - "members":{ - "Clocks":{ - "shape":"SimulationClockList", - "documentation":"A list of simulation clocks.
At this time, a simulation has only one clock.
A list of domains for the simulation. For more information about domains, see Key concepts: Domains in the SimSpace Weaver User Guide.
" - } - }, - "documentation":"A collection of additional state information, such as domain and clock configuration.
" - }, - "LogDestination":{ - "type":"structure", - "members":{ - "CloudWatchLogsLogGroup":{ - "shape":"CloudWatchLogsLogGroup", - "documentation":"An Amazon CloudWatch Logs log group that stores simulation log data. For more information about log groups, see Working with log groups and log streams in the Amazon CloudWatch Logs User Guide.
" - } - }, - "documentation":"The location where SimSpace Weaver sends simulation log data.
" - }, - "LogDestinations":{ - "type":"list", - "member":{"shape":"LogDestination"} - }, - "LogGroupArn":{ - "type":"string", - "max":1600, - "min":0, - "pattern":"^arn:(?:aws|aws-cn|aws-us-gov):log-group:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:role\\/(.+)$" - }, - "LoggingConfiguration":{ - "type":"structure", - "members":{ - "Destinations":{ - "shape":"LogDestinations", - "documentation":"A list of the locations where SimSpace Weaver sends simulation log data.
" - } - }, - "documentation":"The logging configuration for a simulation.
" - }, - "NonEmptyString":{ - "type":"string", - "max":1600, - "min":1 - }, - "ObjectKey":{ - "type":"string", - "max":1024, - "min":1 - }, - "ObjectKeyPrefix":{ - "type":"string", - "max":1024, - "min":0 - }, - "OptionalString":{"type":"string"}, - "PortNumber":{ - "type":"integer", - "box":true, - "max":65535, - "min":0 - }, - "PositiveInteger":{ - "type":"integer", - "box":true, - "min":1 - }, - "ResourceNotFoundException":{ - "type":"structure", - "members":{ - "Message":{"shape":"NonEmptyString"} - }, - "documentation":"", - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "RoleArn":{ - "type":"string", - "max":1600, - "min":0, - "pattern":"^arn:(?:aws|aws-cn|aws-us-gov):iam::(\\d{12})?:role\\/(.+)$" - }, - "S3Destination":{ - "type":"structure", - "required":["BucketName"], - "members":{ - "BucketName":{ - "shape":"BucketName", - "documentation":"The name of an Amazon S3 bucket. For more information about buckets, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide.
" - }, - "ObjectKeyPrefix":{ - "shape":"ObjectKeyPrefix", - "documentation":"A string prefix for an Amazon S3 object key. It's usually a folder name. For more information about folders in Amazon S3, see Organizing objects in the Amazon S3 console using folders in the Amazon Simple Storage Service User Guide.
" - } - }, - "documentation":"An Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates a file.
" - }, - "S3Location":{ - "type":"structure", - "required":[ - "BucketName", - "ObjectKey" - ], - "members":{ - "BucketName":{ - "shape":"BucketName", - "documentation":"The name of an Amazon S3 bucket. For more information about buckets, see Creating, configuring, and working with Amazon S3 buckets in the Amazon Simple Storage Service User Guide.
" - }, - "ObjectKey":{ - "shape":"ObjectKey", - "documentation":"The key name of an object in Amazon S3. For more information about Amazon S3 objects and object keys, see Uploading, downloading, and working with objects in Amazon S3 in the Amazon Simple Storage Service User Guide.
" - } - }, - "documentation":"A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app .zip files and schema file. For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .
" - }, - "ServiceQuotaExceededException":{ - "type":"structure", - "members":{ - "Message":{"shape":"NonEmptyString"} - }, - "documentation":"", - "error":{ - "httpStatusCode":402, - "senderFault":true - }, - "exception":true - }, - "SimSpaceWeaverArn":{ - "type":"string", - "max":1600, - "min":0, - "pattern":"^arn:(?:aws|aws-cn|aws-us-gov):simspaceweaver:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:([a-z]+)\\/(.+)$" - }, - "SimSpaceWeaverLongResourceName":{ - "type":"string", - "max":256, - "min":1, - "pattern":"^[a-zA-Z0-9_.-]+$" - }, - "SimSpaceWeaverResourceName":{ - "type":"string", - "max":64, - "min":1, - "pattern":"^[a-zA-Z0-9_.-]+$" - }, - "SimulationAppEndpointInfo":{ - "type":"structure", - "members":{ - "Address":{ - "shape":"NonEmptyString", - "documentation":"The IP address of the app. SimSpace Weaver dynamically assigns this IP address when the app starts.
" - }, - "IngressPortMappings":{ - "shape":"AppPortMappings", - "documentation":"The inbound TCP/UDP port numbers of the app. The combination of an IP address and a port number form a network endpoint.
" - } - }, - "documentation":"Information about the network endpoint that you can use to connect to your custom or service app. For more information about SimSpace Weaver apps, see Key concepts: Apps in the SimSpace Weaver User Guide..
" - }, - "SimulationAppList":{ - "type":"list", - "member":{"shape":"SimulationAppMetadata"} - }, - "SimulationAppMetadata":{ - "type":"structure", - "members":{ - "Domain":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The domain of the app. For more information about domains, see Key concepts: Domains in the SimSpace Weaver User Guide.
" - }, - "Name":{ - "shape":"SimSpaceWeaverLongResourceName", - "documentation":"The name of the app.
" - }, - "Simulation":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the simulation of the app.
" - }, - "Status":{ - "shape":"SimulationAppStatus", - "documentation":"The current status of the app.
" - }, - "TargetStatus":{ - "shape":"SimulationAppTargetStatus", - "documentation":"The desired status of the app.
" - } - }, - "documentation":"A collection of metadata about the app.
" - }, - "SimulationAppPortMapping":{ - "type":"structure", - "members":{ - "Actual":{ - "shape":"PortNumber", - "documentation":"The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port number when the app starts. SimSpace Weaver maps the Declared port to the Actual port. Clients connect to the app using the app's IP address and the Actual port number.
The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps the Declared port to the Actual port. The source code for the app should bind to the Declared port.
A collection of TCP/UDP ports for a custom or service app.
" - }, - "SimulationAppStatus":{ - "type":"string", - "enum":[ - "STARTING", - "STARTED", - "STOPPING", - "STOPPED", - "ERROR", - "UNKNOWN" - ] - }, - "SimulationAppTargetStatus":{ - "type":"string", - "enum":[ - "UNKNOWN", - "STARTED", - "STOPPED" - ] - }, - "SimulationClock":{ - "type":"structure", - "members":{ - "Status":{ - "shape":"ClockStatus", - "documentation":"The current status of the simulation clock.
" - }, - "TargetStatus":{ - "shape":"ClockTargetStatus", - "documentation":"The desired status of the simulation clock.
" - } - }, - "documentation":"Status information about the simulation clock.
" - }, - "SimulationClockList":{ - "type":"list", - "member":{"shape":"SimulationClock"} - }, - "SimulationList":{ - "type":"list", - "member":{"shape":"SimulationMetadata"} - }, - "SimulationMetadata":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"SimSpaceWeaverArn", - "documentation":"The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).
" - }, - "Name":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the simulation.
" - }, - "Status":{ - "shape":"SimulationStatus", - "documentation":"The current status of the simulation.
" - }, - "TargetStatus":{ - "shape":"SimulationTargetStatus", - "documentation":"The desired status of the simulation.
" - } - }, - "documentation":"A collection of data about the simulation.
" - }, - "SimulationStatus":{ - "type":"string", - "enum":[ - "UNKNOWN", - "STARTING", - "STARTED", - "STOPPING", - "STOPPED", - "FAILED", - "DELETING", - "DELETED", - "SNAPSHOT_IN_PROGRESS" - ] - }, - "SimulationTargetStatus":{ - "type":"string", - "enum":[ - "UNKNOWN", - "STARTED", - "STOPPED", - "DELETED" - ] - }, - "StartAppInput":{ - "type":"structure", - "required":[ - "Domain", - "Name", - "Simulation" - ], - "members":{ - "ClientToken":{ - "shape":"ClientToken", - "documentation":"A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A ClientToken is also known as an idempotency token. A ClientToken expires after 24 hours.
The description of the app.
" - }, - "Domain":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the domain of the app.
" - }, - "LaunchOverrides":{"shape":"LaunchOverrides"}, - "Name":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the app.
" - }, - "Simulation":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the simulation of the app.
" - } - } - }, - "StartAppOutput":{ - "type":"structure", - "members":{ - "Domain":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the domain of the app.
" - }, - "Name":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the app.
" - }, - "Simulation":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the simulation of the app.
" - } - } - }, - "StartClockInput":{ - "type":"structure", - "required":["Simulation"], - "members":{ - "Simulation":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the simulation.
" - } - } - }, - "StartClockOutput":{ - "type":"structure", - "members":{ - } - }, - "StartSimulationInput":{ - "type":"structure", - "required":[ - "Name", - "RoleArn" - ], - "members":{ - "ClientToken":{ - "shape":"ClientToken", - "documentation":"A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A ClientToken is also known as an idempotency token. A ClientToken expires after 24 hours.
The description of the simulation.
" - }, - "MaximumDuration":{ - "shape":"TimeToLiveString", - "documentation":"The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches this limit. The maximum value is 14D, or its equivalent in the other units. The default value is 14D. A value equivalent to 0 makes the simulation immediately transition to Stopping as soon as it reaches Started.
The name of the simulation.
" - }, - "RoleArn":{ - "shape":"RoleArn", - "documentation":"The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to perform actions. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see IAM roles in the Identity and Access Management User Guide.
" - }, - "SchemaS3Location":{ - "shape":"S3Location", - "documentation":"The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .
Provide a SchemaS3Location to start your simulation from a schema.
If you provide a SchemaS3Location then you can't provide a SnapshotS3Location.
The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .
Provide a SnapshotS3Location to start your simulation from a snapshot.
The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.
If you provide a SnapshotS3Location then you can't provide a SchemaS3Location.
A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
" - } - } - }, - "StartSimulationOutput":{ - "type":"structure", - "members":{ - "Arn":{ - "shape":"SimSpaceWeaverArn", - "documentation":"The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).
" - }, - "ExecutionId":{ - "shape":"UUID", - "documentation":"A universally unique identifier (UUID) for this simulation.
" - } - } - }, - "StopAppInput":{ - "type":"structure", - "required":[ - "App", - "Domain", - "Simulation" - ], - "members":{ - "App":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the app.
" - }, - "Domain":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the domain of the app.
" - }, - "Simulation":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the simulation of the app.
" - } - } - }, - "StopAppOutput":{ - "type":"structure", - "members":{ - } - }, - "StopClockInput":{ - "type":"structure", - "required":["Simulation"], - "members":{ - "Simulation":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the simulation.
" - } - } - }, - "StopClockOutput":{ - "type":"structure", - "members":{ - } - }, - "StopSimulationInput":{ - "type":"structure", - "required":["Simulation"], - "members":{ - "Simulation":{ - "shape":"SimSpaceWeaverResourceName", - "documentation":"The name of the simulation.
" - } - } - }, - "StopSimulationOutput":{ - "type":"structure", - "members":{ - } - }, - "TagKey":{ - "type":"string", - "max":128, - "min":1 - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"}, - "max":50, - "min":1 - }, - "TagMap":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"}, - "max":50, - "min":1 - }, - "TagResourceInput":{ - "type":"structure", - "required":[ - "ResourceArn", - "Tags" - ], - "members":{ - "ResourceArn":{ - "shape":"SimSpaceWeaverArn", - "documentation":"The Amazon Resource Name (ARN) of the resource that you want to add tags to. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
", - "location":"uri", - "locationName":"ResourceArn" - }, - "Tags":{ - "shape":"TagMap", - "documentation":"A list of tags to apply to the resource.
" - } - } - }, - "TagResourceOutput":{ - "type":"structure", - "members":{ - } - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0 - }, - "TimeToLiveString":{ - "type":"string", - "max":6, - "min":2, - "pattern":"^\\d{1,5}[mhdMHD]$" - }, - "Timestamp":{"type":"timestamp"}, - "TooManyTagsException":{ - "type":"structure", - "members":{ - "Message":{"shape":"NonEmptyString"} - }, - "documentation":"", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "UUID":{ - "type":"string", - "min":36, - "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - }, - "UntagResourceInput":{ - "type":"structure", - "required":[ - "ResourceArn", - "TagKeys" - ], - "members":{ - "ResourceArn":{ - "shape":"SimSpaceWeaverArn", - "documentation":"The Amazon Resource Name (ARN) of the resource that you want to remove tags from. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
", - "location":"uri", - "locationName":"ResourceArn" - }, - "TagKeys":{ - "shape":"TagKeyList", - "documentation":"A list of tag keys to remove from the resource.
", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UntagResourceOutput":{ - "type":"structure", - "members":{ - } - }, - "ValidationException":{ - "type":"structure", - "members":{ - "Message":{"shape":"NonEmptyString"} - }, - "documentation":"", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - } - }, - "documentation":"SimSpace Weaver (SimSpace Weaver) is a service that you can use to build and run large-scale spatial simulations in the Amazon Web Services Cloud. For example, you can create crowd simulations, large real-world environments, and immersive and interactive experiences. For more information about SimSpace Weaver, see the SimSpace Weaver User Guide .
This API reference describes the API operations and data types that you can use to communicate directly with SimSpace Weaver.
SimSpace Weaver also provides the SimSpace Weaver app SDK, which you use for app development. The SimSpace Weaver app SDK API reference is included in the SimSpace Weaver app SDK documentation. This documentation is part of the SimSpace Weaver app SDK distributable package.
" -} diff --git a/awscli/botocore/utils.py b/awscli/botocore/utils.py index dbbfcd66abb1..d7a08e58dd94 100644 --- a/awscli/botocore/utils.py +++ b/awscli/botocore/utils.py @@ -4101,8 +4101,6 @@ def _get_bearer_env_var_name(signing_name): 'globalaccelerator': 'global-accelerator', 'iot-data': 'iot-data-plane', 'iot-jobs-data': 'iot-jobs-data-plane', - 'iotevents-data': 'iot-events-data', - 'iotevents': 'iot-events', 'iotwireless': 'iot-wireless', 'kinesisanalytics': 'kinesis-analytics', 'kinesisanalyticsv2': 'kinesis-analytics-v2', diff --git a/awscli/examples/iotevents-data/batch-put-message.rst b/awscli/examples/iotevents-data/batch-put-message.rst deleted file mode 100644 index 258b48c6580d..000000000000 --- a/awscli/examples/iotevents-data/batch-put-message.rst +++ /dev/null @@ -1,27 +0,0 @@ -**To send messages (inputs) to AWS IoT Events** - -The following ``batch-put-message`` example sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify ( ``inputName`` ) and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response. :: - - aws iotevents-data batch-put-message \ - --cli-binary-format raw-in-base64-out \ - --cli-input-json file://highPressureMessage.json - -Contents of ``highPressureMessage.json``:: - - { - "messages": [ - { - "messageId": "00001", - "inputName": "PressureInput", - "payload": "{\"motorid\": \"Fulton-A32\", \"sensorData\": {\"pressure\": 80, \"temperature\": 39} }" - } - ] - } - -Output:: - - { - "BatchPutMessageErrorEntries": [] - } - -For more information, see `BatchPutMessage