Skip to content

Iotevents Data Classes

AcknowledgeActionConfiguration

note

  • Type: typing.Optional[str]

AcknowledgeAlarmActionRequest

requestId

  • Type:
  • Required: Yes

alarmModelName

  • Type:
  • Required: Yes

keyValue

  • Type: typing.Optional[str]

note

  • Type: typing.Optional[str]

Alarm

alarmModelName

  • Type: typing.Optional[str]

alarmModelVersion

  • Type: typing.Optional[str]

keyValue

  • Type: typing.Optional[str]

alarmState

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.AlarmState]

severity

  • Type: typing.Optional[int]

creationTime

  • Type: typing.Optional[datetime.datetime]

lastUpdateTime

  • Type: typing.Optional[datetime.datetime]

AlarmState

stateName

  • Type: typing.Optional[typing.Literal['ACKNOWLEDGED', 'ACTIVE', 'DISABLED', 'LATCHED', 'NORMAL', 'SNOOZE_DISABLED']]

ruleEvaluation

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.RuleEvaluation]

customerAction

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.CustomerAction]

systemEvent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.SystemEvent]

AlarmSummary

alarmModelName

  • Type: typing.Optional[str]

alarmModelVersion

  • Type: typing.Optional[str]

keyValue

  • Type: typing.Optional[str]

stateName

  • Type: typing.Optional[typing.Literal['ACKNOWLEDGED', 'ACTIVE', 'DISABLED', 'LATCHED', 'NORMAL', 'SNOOZE_DISABLED']]

creationTime

  • Type: typing.Optional[datetime.datetime]

lastUpdateTime

  • Type: typing.Optional[datetime.datetime]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BatchAcknowledgeAlarmRequest

acknowledgeActionRequests

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.AcknowledgeAlarmActionRequest]
  • Required: Yes

BatchAcknowledgeAlarmResponse

errorEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.BatchAlarmActionErrorEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchAlarmActionErrorEntry

requestId

  • Type: typing.Optional[str]

errorCode

  • Type: typing.Optional[typing.Literal['InternalFailureException', 'InvalidRequestException', 'ResourceNotFoundException', 'ServiceUnavailableException', 'ThrottlingException']]

errorMessage

  • Type: typing.Optional[str]

BatchDeleteDetectorErrorEntry

messageId

  • Type: typing.Optional[str]

errorCode

  • Type: typing.Optional[typing.Literal['InternalFailureException', 'InvalidRequestException', 'ResourceNotFoundException', 'ServiceUnavailableException', 'ThrottlingException']]

errorMessage

  • Type: typing.Optional[str]

BatchDeleteDetectorRequest

detectors

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.DeleteDetectorRequest]
  • Required: Yes

BatchDeleteDetectorResponse

batchDeleteDetectorErrorEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.BatchDeleteDetectorErrorEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchDisableAlarmRequest

disableActionRequests

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.DisableAlarmActionRequest]
  • Required: Yes

BatchDisableAlarmResponse

errorEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.BatchAlarmActionErrorEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchEnableAlarmRequest

enableActionRequests

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.EnableAlarmActionRequest]
  • Required: Yes

BatchEnableAlarmResponse

errorEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.BatchAlarmActionErrorEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchPutMessageErrorEntry

messageId

  • Type: typing.Optional[str]

errorCode

  • Type: typing.Optional[typing.Literal['InternalFailureException', 'InvalidRequestException', 'ResourceNotFoundException', 'ServiceUnavailableException', 'ThrottlingException']]

errorMessage

  • Type: typing.Optional[str]

BatchPutMessageRequest

messages

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.Message]
  • Required: Yes

BatchPutMessageResponse

BatchPutMessageErrorEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.BatchPutMessageErrorEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchResetAlarmRequest

resetActionRequests

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.ResetAlarmActionRequest]
  • Required: Yes

BatchResetAlarmResponse

errorEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.BatchAlarmActionErrorEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchSnoozeAlarmRequest

snoozeActionRequests

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.SnoozeAlarmActionRequest]
  • Required: Yes

BatchSnoozeAlarmResponse

errorEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.BatchAlarmActionErrorEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchUpdateDetectorErrorEntry

messageId

  • Type: typing.Optional[str]

errorCode

  • Type: typing.Optional[typing.Literal['InternalFailureException', 'InvalidRequestException', 'ResourceNotFoundException', 'ServiceUnavailableException', 'ThrottlingException']]

errorMessage

  • Type: typing.Optional[str]

BatchUpdateDetectorRequest

detectors

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.UpdateDetectorRequest]
  • Required: Yes

BatchUpdateDetectorResponse

batchUpdateDetectorErrorEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.BatchUpdateDetectorErrorEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CustomerAction

actionName

  • Type: typing.Optional[typing.Literal['ACKNOWLEDGE', 'DISABLE', 'ENABLE', 'RESET', 'SNOOZE']]

snoozeActionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.SnoozeActionConfiguration]

enableActionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.EnableActionConfiguration]

disableActionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.DisableActionConfiguration]

acknowledgeActionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.AcknowledgeActionConfiguration]

resetActionConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.ResetActionConfiguration]

DeleteDetectorRequest

messageId

  • Type:
  • Required: Yes

detectorModelName

  • Type:
  • Required: Yes

keyValue

  • Type: typing.Optional[str]

DescribeAlarmRequest

alarmModelName

  • Type:
  • Required: Yes

keyValue

  • Type: typing.Optional[str]

DescribeAlarmResponse

alarm

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeDetectorRequest

detectorModelName

  • Type:
  • Required: Yes

keyValue

  • Type: typing.Optional[str]

DescribeDetectorResponse

detector

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Detector

detectorModelName

  • Type: typing.Optional[str]

keyValue

  • Type: typing.Optional[str]

detectorModelVersion

  • Type: typing.Optional[str]

state

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.DetectorState]

creationTime

  • Type: typing.Optional[datetime.datetime]

lastUpdateTime

  • Type: typing.Optional[datetime.datetime]

DetectorState

stateName

  • Type:
  • Required: Yes

variables

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.Variable]
  • Required: Yes

timers

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.Timer]
  • Required: Yes

DetectorStateDefinition

stateName

  • Type:
  • Required: Yes

variables

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.VariableDefinition]
  • Required: Yes

timers

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.TimerDefinition]
  • Required: Yes

DetectorStateSummary

stateName

  • Type: typing.Optional[str]

DetectorSummary

detectorModelName

  • Type: typing.Optional[str]

keyValue

  • Type: typing.Optional[str]

detectorModelVersion

  • Type: typing.Optional[str]

state

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.DetectorStateSummary]

creationTime

  • Type: typing.Optional[datetime.datetime]

lastUpdateTime

  • Type: typing.Optional[datetime.datetime]

DisableActionConfiguration

note

  • Type: typing.Optional[str]

DisableAlarmActionRequest

requestId

  • Type:
  • Required: Yes

alarmModelName

  • Type:
  • Required: Yes

keyValue

  • Type: typing.Optional[str]

note

  • Type: typing.Optional[str]

EnableActionConfiguration

note

  • Type: typing.Optional[str]

EnableAlarmActionRequest

requestId

  • Type:
  • Required: Yes

alarmModelName

  • Type:
  • Required: Yes

keyValue

  • Type: typing.Optional[str]

note

  • Type: typing.Optional[str]

ListAlarmsRequest

alarmModelName

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListAlarmsResponse

alarmSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.AlarmSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDetectorsRequest

detectorModelName

  • Type:
  • Required: Yes

stateName

  • Type: typing.Optional[str]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDetectorsResponse

detectorSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.DetectorSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

Message

messageId

  • Type:
  • Required: Yes

inputName

  • Type:
  • Required: Yes

payload

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody]
  • Required: Yes

timestamp

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.TimestampValue]

ResetActionConfiguration

note

  • Type: typing.Optional[str]

ResetAlarmActionRequest

requestId

  • Type:
  • Required: Yes

alarmModelName

  • Type:
  • Required: Yes

keyValue

  • Type: typing.Optional[str]

note

  • Type: typing.Optional[str]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

RuleEvaluation

simpleRuleEvaluation

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.SimpleRuleEvaluation]

SimpleRuleEvaluation

inputPropertyValue

  • Type: typing.Optional[str]

operator

  • Type: typing.Optional[typing.Literal['EQUAL', 'GREATER', 'GREATER_OR_EQUAL', 'LESS', 'LESS_OR_EQUAL', 'NOT_EQUAL']]

thresholdValue

  • Type: typing.Optional[str]

SnoozeActionConfiguration

snoozeDuration

  • Type: typing.Optional[int]

note

  • Type: typing.Optional[str]

SnoozeAlarmActionRequest

requestId

  • Type:
  • Required: Yes

alarmModelName

  • Type:
  • Required: Yes

snoozeDuration

  • Type:
  • Required: Yes

keyValue

  • Type: typing.Optional[str]

note

  • Type: typing.Optional[str]

StateChangeConfiguration

triggerType

  • Type: typing.Optional[typing.Literal['SNOOZE_TIMEOUT']]

SystemEvent

eventType

  • Type: typing.Optional[typing.Literal['STATE_CHANGE']]

stateChangeConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotevents_data.iotevents_data_classes.StateChangeConfiguration]

Timer

name

  • Type:
  • Required: Yes

timestamp

  • Type:
  • Required: Yes

TimerDefinition

name

  • Type:
  • Required: Yes

seconds

  • Type:
  • Required: Yes

TimestampValue

timeInMillis

  • Type: typing.Optional[int]

UpdateDetectorRequest

messageId

  • Type:
  • Required: Yes

detectorModelName

  • Type:
  • Required: Yes

state

  • Type:
  • Required: Yes

keyValue

  • Type: typing.Optional[str]

Variable

name

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes

VariableDefinition

name

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes