Skip to content

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],
  1. See AlarmStateNameType

BatchAlarmActionErrorEntryTypeDef#

# BatchAlarmActionErrorEntryTypeDef definition

class BatchAlarmActionErrorEntryTypeDef(TypedDict):
    requestId: NotRequired[str],
    errorCode: NotRequired[ErrorCodeType],  # (1)
    errorMessage: NotRequired[str],
  1. 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],
  1. 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],
  1. 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],
  1. 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],
  1. See ComparisonOperatorType

StateChangeConfigurationTypeDef#

# StateChangeConfigurationTypeDef definition

class StateChangeConfigurationTypeDef(TypedDict):
    triggerType: NotRequired[TriggerTypeType],  # (1)
  1. See TriggerTypeType

BatchAcknowledgeAlarmRequestRequestTypeDef#

# BatchAcknowledgeAlarmRequestRequestTypeDef definition

class BatchAcknowledgeAlarmRequestRequestTypeDef(TypedDict):
    acknowledgeActionRequests: Sequence[AcknowledgeAlarmActionRequestTypeDef],  # (1)
  1. See AcknowledgeAlarmActionRequestTypeDef

BatchAcknowledgeAlarmResponseTypeDef#

# BatchAcknowledgeAlarmResponseTypeDef definition

class BatchAcknowledgeAlarmResponseTypeDef(TypedDict):
    errorEntries: List[BatchAlarmActionErrorEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchAlarmActionErrorEntryTypeDef
  2. See ResponseMetadataTypeDef

BatchDisableAlarmResponseTypeDef#

# BatchDisableAlarmResponseTypeDef definition

class BatchDisableAlarmResponseTypeDef(TypedDict):
    errorEntries: List[BatchAlarmActionErrorEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchAlarmActionErrorEntryTypeDef
  2. See ResponseMetadataTypeDef

BatchEnableAlarmResponseTypeDef#

# BatchEnableAlarmResponseTypeDef definition

class BatchEnableAlarmResponseTypeDef(TypedDict):
    errorEntries: List[BatchAlarmActionErrorEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchAlarmActionErrorEntryTypeDef
  2. See ResponseMetadataTypeDef

BatchResetAlarmResponseTypeDef#

# BatchResetAlarmResponseTypeDef definition

class BatchResetAlarmResponseTypeDef(TypedDict):
    errorEntries: List[BatchAlarmActionErrorEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchAlarmActionErrorEntryTypeDef
  2. See ResponseMetadataTypeDef

BatchSnoozeAlarmResponseTypeDef#

# BatchSnoozeAlarmResponseTypeDef definition

class BatchSnoozeAlarmResponseTypeDef(TypedDict):
    errorEntries: List[BatchAlarmActionErrorEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchAlarmActionErrorEntryTypeDef
  2. See ResponseMetadataTypeDef

ListAlarmsResponseTypeDef#

# ListAlarmsResponseTypeDef definition

class ListAlarmsResponseTypeDef(TypedDict):
    alarmSummaries: List[AlarmSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AlarmSummaryTypeDef
  2. See ResponseMetadataTypeDef

BatchDeleteDetectorResponseTypeDef#

# BatchDeleteDetectorResponseTypeDef definition

class BatchDeleteDetectorResponseTypeDef(TypedDict):
    batchDeleteDetectorErrorEntries: List[BatchDeleteDetectorErrorEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchDeleteDetectorErrorEntryTypeDef
  2. See ResponseMetadataTypeDef

BatchDeleteDetectorRequestRequestTypeDef#

# BatchDeleteDetectorRequestRequestTypeDef definition

class BatchDeleteDetectorRequestRequestTypeDef(TypedDict):
    detectors: Sequence[DeleteDetectorRequestTypeDef],  # (1)
  1. See DeleteDetectorRequestTypeDef

BatchDisableAlarmRequestRequestTypeDef#

# BatchDisableAlarmRequestRequestTypeDef definition

class BatchDisableAlarmRequestRequestTypeDef(TypedDict):
    disableActionRequests: Sequence[DisableAlarmActionRequestTypeDef],  # (1)
  1. See DisableAlarmActionRequestTypeDef

BatchEnableAlarmRequestRequestTypeDef#

# BatchEnableAlarmRequestRequestTypeDef definition

class BatchEnableAlarmRequestRequestTypeDef(TypedDict):
    enableActionRequests: Sequence[EnableAlarmActionRequestTypeDef],  # (1)
  1. See EnableAlarmActionRequestTypeDef

BatchPutMessageResponseTypeDef#

# BatchPutMessageResponseTypeDef definition

class BatchPutMessageResponseTypeDef(TypedDict):
    BatchPutMessageErrorEntries: List[BatchPutMessageErrorEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchPutMessageErrorEntryTypeDef
  2. See ResponseMetadataTypeDef

BatchResetAlarmRequestRequestTypeDef#

# BatchResetAlarmRequestRequestTypeDef definition

class BatchResetAlarmRequestRequestTypeDef(TypedDict):
    resetActionRequests: Sequence[ResetAlarmActionRequestTypeDef],  # (1)
  1. See ResetAlarmActionRequestTypeDef

BatchSnoozeAlarmRequestRequestTypeDef#

# BatchSnoozeAlarmRequestRequestTypeDef definition

class BatchSnoozeAlarmRequestRequestTypeDef(TypedDict):
    snoozeActionRequests: Sequence[SnoozeAlarmActionRequestTypeDef],  # (1)
  1. See SnoozeAlarmActionRequestTypeDef

BatchUpdateDetectorResponseTypeDef#

# BatchUpdateDetectorResponseTypeDef definition

class BatchUpdateDetectorResponseTypeDef(TypedDict):
    batchUpdateDetectorErrorEntries: List[BatchUpdateDetectorErrorEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchUpdateDetectorErrorEntryTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See CustomerActionNameType
  2. See SnoozeActionConfigurationTypeDef
  3. See EnableActionConfigurationTypeDef
  4. See DisableActionConfigurationTypeDef
  5. See AcknowledgeActionConfigurationTypeDef
  6. See ResetActionConfigurationTypeDef

DetectorStateDefinitionTypeDef#

# DetectorStateDefinitionTypeDef definition

class DetectorStateDefinitionTypeDef(TypedDict):
    stateName: str,
    variables: Sequence[VariableDefinitionTypeDef],  # (1)
    timers: Sequence[TimerDefinitionTypeDef],  # (2)
  1. See VariableDefinitionTypeDef
  2. See TimerDefinitionTypeDef

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],
  1. See DetectorStateSummaryTypeDef

DetectorStateTypeDef#

# DetectorStateTypeDef definition

class DetectorStateTypeDef(TypedDict):
    stateName: str,
    variables: List[VariableTypeDef],  # (1)
    timers: List[TimerTypeDef],  # (2)
  1. See VariableTypeDef
  2. See TimerTypeDef

MessageTypeDef#

# MessageTypeDef definition

class MessageTypeDef(TypedDict):
    messageId: str,
    inputName: str,
    payload: Union[str, bytes, IO[Any], StreamingBody],
    timestamp: NotRequired[TimestampValueTypeDef],  # (1)
  1. See TimestampValueTypeDef

RuleEvaluationTypeDef#

# RuleEvaluationTypeDef definition

class RuleEvaluationTypeDef(TypedDict):
    simpleRuleEvaluation: NotRequired[SimpleRuleEvaluationTypeDef],  # (1)
  1. See SimpleRuleEvaluationTypeDef

SystemEventTypeDef#

# SystemEventTypeDef definition

class SystemEventTypeDef(TypedDict):
    eventType: NotRequired[EventTypeType],  # (1)
    stateChangeConfiguration: NotRequired[StateChangeConfigurationTypeDef],  # (2)
  1. See EventTypeType
  2. See StateChangeConfigurationTypeDef

UpdateDetectorRequestTypeDef#

# UpdateDetectorRequestTypeDef definition

class UpdateDetectorRequestTypeDef(TypedDict):
    messageId: str,
    detectorModelName: str,
    state: DetectorStateDefinitionTypeDef,  # (1)
    keyValue: NotRequired[str],
  1. See DetectorStateDefinitionTypeDef

ListDetectorsResponseTypeDef#

# ListDetectorsResponseTypeDef definition

class ListDetectorsResponseTypeDef(TypedDict):
    detectorSummaries: List[DetectorSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DetectorSummaryTypeDef
  2. See ResponseMetadataTypeDef

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],
  1. See DetectorStateTypeDef

BatchPutMessageRequestRequestTypeDef#

# BatchPutMessageRequestRequestTypeDef definition

class BatchPutMessageRequestRequestTypeDef(TypedDict):
    messages: Sequence[MessageTypeDef],  # (1)
  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)
  1. See AlarmStateNameType
  2. See RuleEvaluationTypeDef
  3. See CustomerActionTypeDef
  4. See SystemEventTypeDef

BatchUpdateDetectorRequestRequestTypeDef#

# BatchUpdateDetectorRequestRequestTypeDef definition

class BatchUpdateDetectorRequestRequestTypeDef(TypedDict):
    detectors: Sequence[UpdateDetectorRequestTypeDef],  # (1)
  1. See UpdateDetectorRequestTypeDef

DescribeDetectorResponseTypeDef#

# DescribeDetectorResponseTypeDef definition

class DescribeDetectorResponseTypeDef(TypedDict):
    detector: DetectorTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DetectorTypeDef
  2. See ResponseMetadataTypeDef

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],
  1. See AlarmStateTypeDef

DescribeAlarmResponseTypeDef#

# DescribeAlarmResponseTypeDef definition

class DescribeAlarmResponseTypeDef(TypedDict):
    alarm: AlarmTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AlarmTypeDef
  2. See ResponseMetadataTypeDef