Type definitions#
Index > IoTEventsData > Type definitions
Auto-generated documentation for IoTEventsData type annotations stubs module mypy-boto3-iotevents-data.
BlobTypeDef#
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]
AcknowledgeActionConfigurationTypeDef#
# AcknowledgeActionConfigurationTypeDef definition
class AcknowledgeActionConfigurationTypeDef(TypedDict):
note: NotRequired[str],
AcknowledgeAlarmActionRequestTypeDef#
# AcknowledgeAlarmActionRequestTypeDef definition
class AcknowledgeAlarmActionRequestTypeDef(TypedDict):
requestId: str,
alarmModelName: str,
keyValue: NotRequired[str],
note: NotRequired[str],
AlarmSummaryTypeDef#
# AlarmSummaryTypeDef definition
class AlarmSummaryTypeDef(TypedDict):
alarmModelName: NotRequired[str],
alarmModelVersion: NotRequired[str],
keyValue: NotRequired[str],
stateName: NotRequired[AlarmStateNameType], # (1)
creationTime: NotRequired[datetime],
lastUpdateTime: NotRequired[datetime],
BatchAlarmActionErrorEntryTypeDef#
# BatchAlarmActionErrorEntryTypeDef definition
class BatchAlarmActionErrorEntryTypeDef(TypedDict):
requestId: NotRequired[str],
errorCode: NotRequired[ErrorCodeType], # (1)
errorMessage: NotRequired[str],
- See ErrorCodeType
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
BatchDeleteDetectorErrorEntryTypeDef#
# BatchDeleteDetectorErrorEntryTypeDef definition
class BatchDeleteDetectorErrorEntryTypeDef(TypedDict):
messageId: NotRequired[str],
errorCode: NotRequired[ErrorCodeType], # (1)
errorMessage: NotRequired[str],
- See ErrorCodeType
DeleteDetectorRequestTypeDef#
# DeleteDetectorRequestTypeDef definition
class DeleteDetectorRequestTypeDef(TypedDict):
messageId: str,
detectorModelName: str,
keyValue: NotRequired[str],
DisableAlarmActionRequestTypeDef#
# DisableAlarmActionRequestTypeDef definition
class DisableAlarmActionRequestTypeDef(TypedDict):
requestId: str,
alarmModelName: str,
keyValue: NotRequired[str],
note: NotRequired[str],
EnableAlarmActionRequestTypeDef#
# EnableAlarmActionRequestTypeDef definition
class EnableAlarmActionRequestTypeDef(TypedDict):
requestId: str,
alarmModelName: str,
keyValue: NotRequired[str],
note: NotRequired[str],
BatchPutMessageErrorEntryTypeDef#
# BatchPutMessageErrorEntryTypeDef definition
class BatchPutMessageErrorEntryTypeDef(TypedDict):
messageId: NotRequired[str],
errorCode: NotRequired[ErrorCodeType], # (1)
errorMessage: NotRequired[str],
- See ErrorCodeType
ResetAlarmActionRequestTypeDef#
# ResetAlarmActionRequestTypeDef definition
class ResetAlarmActionRequestTypeDef(TypedDict):
requestId: str,
alarmModelName: str,
keyValue: NotRequired[str],
note: NotRequired[str],
SnoozeAlarmActionRequestTypeDef#
# SnoozeAlarmActionRequestTypeDef definition
class SnoozeAlarmActionRequestTypeDef(TypedDict):
requestId: str,
alarmModelName: str,
snoozeDuration: int,
keyValue: NotRequired[str],
note: NotRequired[str],
BatchUpdateDetectorErrorEntryTypeDef#
# BatchUpdateDetectorErrorEntryTypeDef definition
class BatchUpdateDetectorErrorEntryTypeDef(TypedDict):
messageId: NotRequired[str],
errorCode: NotRequired[ErrorCodeType], # (1)
errorMessage: NotRequired[str],
- See ErrorCodeType
DisableActionConfigurationTypeDef#
# DisableActionConfigurationTypeDef definition
class DisableActionConfigurationTypeDef(TypedDict):
note: NotRequired[str],
EnableActionConfigurationTypeDef#
# EnableActionConfigurationTypeDef definition
class EnableActionConfigurationTypeDef(TypedDict):
note: NotRequired[str],
ResetActionConfigurationTypeDef#
# ResetActionConfigurationTypeDef definition
class ResetActionConfigurationTypeDef(TypedDict):
note: NotRequired[str],
SnoozeActionConfigurationTypeDef#
# SnoozeActionConfigurationTypeDef definition
class SnoozeActionConfigurationTypeDef(TypedDict):
snoozeDuration: NotRequired[int],
note: NotRequired[str],
DescribeAlarmRequestRequestTypeDef#
# DescribeAlarmRequestRequestTypeDef definition
class DescribeAlarmRequestRequestTypeDef(TypedDict):
alarmModelName: str,
keyValue: NotRequired[str],
DescribeDetectorRequestRequestTypeDef#
# DescribeDetectorRequestRequestTypeDef definition
class DescribeDetectorRequestRequestTypeDef(TypedDict):
detectorModelName: str,
keyValue: NotRequired[str],
TimerDefinitionTypeDef#
# TimerDefinitionTypeDef definition
class TimerDefinitionTypeDef(TypedDict):
name: str,
seconds: int,
VariableDefinitionTypeDef#
# VariableDefinitionTypeDef definition
class VariableDefinitionTypeDef(TypedDict):
name: str,
value: str,
DetectorStateSummaryTypeDef#
# DetectorStateSummaryTypeDef definition
class DetectorStateSummaryTypeDef(TypedDict):
stateName: NotRequired[str],
TimerTypeDef#
# TimerTypeDef definition
class TimerTypeDef(TypedDict):
name: str,
timestamp: datetime,
VariableTypeDef#
# VariableTypeDef definition
class VariableTypeDef(TypedDict):
name: str,
value: str,
ListAlarmsRequestRequestTypeDef#
# ListAlarmsRequestRequestTypeDef definition
class ListAlarmsRequestRequestTypeDef(TypedDict):
alarmModelName: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListDetectorsRequestRequestTypeDef#
# ListDetectorsRequestRequestTypeDef definition
class ListDetectorsRequestRequestTypeDef(TypedDict):
detectorModelName: str,
stateName: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
TimestampValueTypeDef#
# TimestampValueTypeDef definition
class TimestampValueTypeDef(TypedDict):
timeInMillis: NotRequired[int],
SimpleRuleEvaluationTypeDef#
# SimpleRuleEvaluationTypeDef definition
class SimpleRuleEvaluationTypeDef(TypedDict):
inputPropertyValue: NotRequired[str],
operator: NotRequired[ComparisonOperatorType], # (1)
thresholdValue: NotRequired[str],
StateChangeConfigurationTypeDef#
# StateChangeConfigurationTypeDef definition
class StateChangeConfigurationTypeDef(TypedDict):
triggerType: NotRequired[TriggerTypeType], # (1)
- See TriggerTypeType
BatchAcknowledgeAlarmRequestRequestTypeDef#
# BatchAcknowledgeAlarmRequestRequestTypeDef definition
class BatchAcknowledgeAlarmRequestRequestTypeDef(TypedDict):
acknowledgeActionRequests: Sequence[AcknowledgeAlarmActionRequestTypeDef], # (1)
BatchAcknowledgeAlarmResponseTypeDef#
# BatchAcknowledgeAlarmResponseTypeDef definition
class BatchAcknowledgeAlarmResponseTypeDef(TypedDict):
errorEntries: List[BatchAlarmActionErrorEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchDisableAlarmResponseTypeDef#
# BatchDisableAlarmResponseTypeDef definition
class BatchDisableAlarmResponseTypeDef(TypedDict):
errorEntries: List[BatchAlarmActionErrorEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchEnableAlarmResponseTypeDef#
# BatchEnableAlarmResponseTypeDef definition
class BatchEnableAlarmResponseTypeDef(TypedDict):
errorEntries: List[BatchAlarmActionErrorEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchResetAlarmResponseTypeDef#
# BatchResetAlarmResponseTypeDef definition
class BatchResetAlarmResponseTypeDef(TypedDict):
errorEntries: List[BatchAlarmActionErrorEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchSnoozeAlarmResponseTypeDef#
# BatchSnoozeAlarmResponseTypeDef definition
class BatchSnoozeAlarmResponseTypeDef(TypedDict):
errorEntries: List[BatchAlarmActionErrorEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAlarmsResponseTypeDef#
# ListAlarmsResponseTypeDef definition
class ListAlarmsResponseTypeDef(TypedDict):
alarmSummaries: List[AlarmSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchDeleteDetectorResponseTypeDef#
# BatchDeleteDetectorResponseTypeDef definition
class BatchDeleteDetectorResponseTypeDef(TypedDict):
batchDeleteDetectorErrorEntries: List[BatchDeleteDetectorErrorEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchDeleteDetectorRequestRequestTypeDef#
# BatchDeleteDetectorRequestRequestTypeDef definition
class BatchDeleteDetectorRequestRequestTypeDef(TypedDict):
detectors: Sequence[DeleteDetectorRequestTypeDef], # (1)
BatchDisableAlarmRequestRequestTypeDef#
# BatchDisableAlarmRequestRequestTypeDef definition
class BatchDisableAlarmRequestRequestTypeDef(TypedDict):
disableActionRequests: Sequence[DisableAlarmActionRequestTypeDef], # (1)
BatchEnableAlarmRequestRequestTypeDef#
# BatchEnableAlarmRequestRequestTypeDef definition
class BatchEnableAlarmRequestRequestTypeDef(TypedDict):
enableActionRequests: Sequence[EnableAlarmActionRequestTypeDef], # (1)
BatchPutMessageResponseTypeDef#
# BatchPutMessageResponseTypeDef definition
class BatchPutMessageResponseTypeDef(TypedDict):
BatchPutMessageErrorEntries: List[BatchPutMessageErrorEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchResetAlarmRequestRequestTypeDef#
# BatchResetAlarmRequestRequestTypeDef definition
class BatchResetAlarmRequestRequestTypeDef(TypedDict):
resetActionRequests: Sequence[ResetAlarmActionRequestTypeDef], # (1)
BatchSnoozeAlarmRequestRequestTypeDef#
# BatchSnoozeAlarmRequestRequestTypeDef definition
class BatchSnoozeAlarmRequestRequestTypeDef(TypedDict):
snoozeActionRequests: Sequence[SnoozeAlarmActionRequestTypeDef], # (1)
BatchUpdateDetectorResponseTypeDef#
# BatchUpdateDetectorResponseTypeDef definition
class BatchUpdateDetectorResponseTypeDef(TypedDict):
batchUpdateDetectorErrorEntries: List[BatchUpdateDetectorErrorEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CustomerActionTypeDef#
# CustomerActionTypeDef definition
class CustomerActionTypeDef(TypedDict):
actionName: NotRequired[CustomerActionNameType], # (1)
snoozeActionConfiguration: NotRequired[SnoozeActionConfigurationTypeDef], # (2)
enableActionConfiguration: NotRequired[EnableActionConfigurationTypeDef], # (3)
disableActionConfiguration: NotRequired[DisableActionConfigurationTypeDef], # (4)
acknowledgeActionConfiguration: NotRequired[AcknowledgeActionConfigurationTypeDef], # (5)
resetActionConfiguration: NotRequired[ResetActionConfigurationTypeDef], # (6)
- See CustomerActionNameType
- See SnoozeActionConfigurationTypeDef
- See EnableActionConfigurationTypeDef
- See DisableActionConfigurationTypeDef
- See AcknowledgeActionConfigurationTypeDef
- See ResetActionConfigurationTypeDef
DetectorStateDefinitionTypeDef#
# DetectorStateDefinitionTypeDef definition
class DetectorStateDefinitionTypeDef(TypedDict):
stateName: str,
variables: Sequence[VariableDefinitionTypeDef], # (1)
timers: Sequence[TimerDefinitionTypeDef], # (2)
DetectorSummaryTypeDef#
# DetectorSummaryTypeDef definition
class DetectorSummaryTypeDef(TypedDict):
detectorModelName: NotRequired[str],
keyValue: NotRequired[str],
detectorModelVersion: NotRequired[str],
state: NotRequired[DetectorStateSummaryTypeDef], # (1)
creationTime: NotRequired[datetime],
lastUpdateTime: NotRequired[datetime],
DetectorStateTypeDef#
# DetectorStateTypeDef definition
class DetectorStateTypeDef(TypedDict):
stateName: str,
variables: List[VariableTypeDef], # (1)
timers: List[TimerTypeDef], # (2)
- See VariableTypeDef
- See TimerTypeDef
MessageTypeDef#
# MessageTypeDef definition
class MessageTypeDef(TypedDict):
messageId: str,
inputName: str,
payload: Union[str, bytes, IO[Any], StreamingBody],
timestamp: NotRequired[TimestampValueTypeDef], # (1)
RuleEvaluationTypeDef#
# RuleEvaluationTypeDef definition
class RuleEvaluationTypeDef(TypedDict):
simpleRuleEvaluation: NotRequired[SimpleRuleEvaluationTypeDef], # (1)
SystemEventTypeDef#
# SystemEventTypeDef definition
class SystemEventTypeDef(TypedDict):
eventType: NotRequired[EventTypeType], # (1)
stateChangeConfiguration: NotRequired[StateChangeConfigurationTypeDef], # (2)
UpdateDetectorRequestTypeDef#
# UpdateDetectorRequestTypeDef definition
class UpdateDetectorRequestTypeDef(TypedDict):
messageId: str,
detectorModelName: str,
state: DetectorStateDefinitionTypeDef, # (1)
keyValue: NotRequired[str],
ListDetectorsResponseTypeDef#
# ListDetectorsResponseTypeDef definition
class ListDetectorsResponseTypeDef(TypedDict):
detectorSummaries: List[DetectorSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DetectorTypeDef#
# DetectorTypeDef definition
class DetectorTypeDef(TypedDict):
detectorModelName: NotRequired[str],
keyValue: NotRequired[str],
detectorModelVersion: NotRequired[str],
state: NotRequired[DetectorStateTypeDef], # (1)
creationTime: NotRequired[datetime],
lastUpdateTime: NotRequired[datetime],
BatchPutMessageRequestRequestTypeDef#
# BatchPutMessageRequestRequestTypeDef definition
class BatchPutMessageRequestRequestTypeDef(TypedDict):
messages: Sequence[MessageTypeDef], # (1)
- See MessageTypeDef
AlarmStateTypeDef#
# AlarmStateTypeDef definition
class AlarmStateTypeDef(TypedDict):
stateName: NotRequired[AlarmStateNameType], # (1)
ruleEvaluation: NotRequired[RuleEvaluationTypeDef], # (2)
customerAction: NotRequired[CustomerActionTypeDef], # (3)
systemEvent: NotRequired[SystemEventTypeDef], # (4)
BatchUpdateDetectorRequestRequestTypeDef#
# BatchUpdateDetectorRequestRequestTypeDef definition
class BatchUpdateDetectorRequestRequestTypeDef(TypedDict):
detectors: Sequence[UpdateDetectorRequestTypeDef], # (1)
DescribeDetectorResponseTypeDef#
# DescribeDetectorResponseTypeDef definition
class DescribeDetectorResponseTypeDef(TypedDict):
detector: DetectorTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AlarmTypeDef#
# AlarmTypeDef definition
class AlarmTypeDef(TypedDict):
alarmModelName: NotRequired[str],
alarmModelVersion: NotRequired[str],
keyValue: NotRequired[str],
alarmState: NotRequired[AlarmStateTypeDef], # (1)
severity: NotRequired[int],
creationTime: NotRequired[datetime],
lastUpdateTime: NotRequired[datetime],
DescribeAlarmResponseTypeDef#
# DescribeAlarmResponseTypeDef definition
class DescribeAlarmResponseTypeDef(TypedDict):
alarm: AlarmTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AlarmTypeDef
- See ResponseMetadataTypeDef