Skip to content

Type definitions#

Index > IoTEventsData > Type definitions

Auto-generated documentation for IoTEventsData type annotations stubs module mypy-boto3-iotevents-data.

BlobTypeDef#

# BlobTypeDef Union usage example

from mypy_boto3_iotevents_data.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

AcknowledgeActionConfigurationTypeDef#

# AcknowledgeActionConfigurationTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import AcknowledgeActionConfigurationTypeDef


def get_value() -> AcknowledgeActionConfigurationTypeDef:
    return {
        "note": ...,
    }


# AcknowledgeActionConfigurationTypeDef definition

class AcknowledgeActionConfigurationTypeDef(TypedDict):
    note: NotRequired[str],

AcknowledgeAlarmActionRequestTypeDef#

# AcknowledgeAlarmActionRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import AcknowledgeAlarmActionRequestTypeDef


def get_value() -> AcknowledgeAlarmActionRequestTypeDef:
    return {
        "requestId": ...,
    }


# AcknowledgeAlarmActionRequestTypeDef definition

class AcknowledgeAlarmActionRequestTypeDef(TypedDict):
    requestId: str,
    alarmModelName: str,
    keyValue: NotRequired[str],
    note: NotRequired[str],

AlarmSummaryTypeDef#

# AlarmSummaryTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import AlarmSummaryTypeDef


def get_value() -> AlarmSummaryTypeDef:
    return {
        "alarmModelName": ...,
    }


# AlarmSummaryTypeDef definition

class AlarmSummaryTypeDef(TypedDict):
    alarmModelName: NotRequired[str],
    alarmModelVersion: NotRequired[str],
    keyValue: NotRequired[str],
    stateName: NotRequired[AlarmStateNameType],  # (1)
    creationTime: NotRequired[datetime.datetime],
    lastUpdateTime: NotRequired[datetime.datetime],
  1. See AlarmStateNameType

BatchAlarmActionErrorEntryTypeDef#

# BatchAlarmActionErrorEntryTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchAlarmActionErrorEntryTypeDef


def get_value() -> BatchAlarmActionErrorEntryTypeDef:
    return {
        "requestId": ...,
    }


# BatchAlarmActionErrorEntryTypeDef definition

class BatchAlarmActionErrorEntryTypeDef(TypedDict):
    requestId: NotRequired[str],
    errorCode: NotRequired[ErrorCodeType],  # (1)
    errorMessage: NotRequired[str],
  1. See ErrorCodeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

BatchDeleteDetectorErrorEntryTypeDef#

# BatchDeleteDetectorErrorEntryTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchDeleteDetectorErrorEntryTypeDef


def get_value() -> BatchDeleteDetectorErrorEntryTypeDef:
    return {
        "messageId": ...,
    }


# BatchDeleteDetectorErrorEntryTypeDef definition

class BatchDeleteDetectorErrorEntryTypeDef(TypedDict):
    messageId: NotRequired[str],
    errorCode: NotRequired[ErrorCodeType],  # (1)
    errorMessage: NotRequired[str],
  1. See ErrorCodeType

DeleteDetectorRequestTypeDef#

# DeleteDetectorRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import DeleteDetectorRequestTypeDef


def get_value() -> DeleteDetectorRequestTypeDef:
    return {
        "messageId": ...,
    }


# DeleteDetectorRequestTypeDef definition

class DeleteDetectorRequestTypeDef(TypedDict):
    messageId: str,
    detectorModelName: str,
    keyValue: NotRequired[str],

DisableAlarmActionRequestTypeDef#

# DisableAlarmActionRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import DisableAlarmActionRequestTypeDef


def get_value() -> DisableAlarmActionRequestTypeDef:
    return {
        "requestId": ...,
    }


# DisableAlarmActionRequestTypeDef definition

class DisableAlarmActionRequestTypeDef(TypedDict):
    requestId: str,
    alarmModelName: str,
    keyValue: NotRequired[str],
    note: NotRequired[str],

EnableAlarmActionRequestTypeDef#

# EnableAlarmActionRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import EnableAlarmActionRequestTypeDef


def get_value() -> EnableAlarmActionRequestTypeDef:
    return {
        "requestId": ...,
    }


# EnableAlarmActionRequestTypeDef definition

class EnableAlarmActionRequestTypeDef(TypedDict):
    requestId: str,
    alarmModelName: str,
    keyValue: NotRequired[str],
    note: NotRequired[str],

BatchPutMessageErrorEntryTypeDef#

# BatchPutMessageErrorEntryTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchPutMessageErrorEntryTypeDef


def get_value() -> BatchPutMessageErrorEntryTypeDef:
    return {
        "messageId": ...,
    }


# BatchPutMessageErrorEntryTypeDef definition

class BatchPutMessageErrorEntryTypeDef(TypedDict):
    messageId: NotRequired[str],
    errorCode: NotRequired[ErrorCodeType],  # (1)
    errorMessage: NotRequired[str],
  1. See ErrorCodeType

ResetAlarmActionRequestTypeDef#

# ResetAlarmActionRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import ResetAlarmActionRequestTypeDef


def get_value() -> ResetAlarmActionRequestTypeDef:
    return {
        "requestId": ...,
    }


# ResetAlarmActionRequestTypeDef definition

class ResetAlarmActionRequestTypeDef(TypedDict):
    requestId: str,
    alarmModelName: str,
    keyValue: NotRequired[str],
    note: NotRequired[str],

SnoozeAlarmActionRequestTypeDef#

# SnoozeAlarmActionRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import SnoozeAlarmActionRequestTypeDef


def get_value() -> SnoozeAlarmActionRequestTypeDef:
    return {
        "requestId": ...,
    }


# SnoozeAlarmActionRequestTypeDef definition

class SnoozeAlarmActionRequestTypeDef(TypedDict):
    requestId: str,
    alarmModelName: str,
    snoozeDuration: int,
    keyValue: NotRequired[str],
    note: NotRequired[str],

BatchUpdateDetectorErrorEntryTypeDef#

# BatchUpdateDetectorErrorEntryTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchUpdateDetectorErrorEntryTypeDef


def get_value() -> BatchUpdateDetectorErrorEntryTypeDef:
    return {
        "messageId": ...,
    }


# BatchUpdateDetectorErrorEntryTypeDef definition

class BatchUpdateDetectorErrorEntryTypeDef(TypedDict):
    messageId: NotRequired[str],
    errorCode: NotRequired[ErrorCodeType],  # (1)
    errorMessage: NotRequired[str],
  1. See ErrorCodeType

DisableActionConfigurationTypeDef#

# DisableActionConfigurationTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import DisableActionConfigurationTypeDef


def get_value() -> DisableActionConfigurationTypeDef:
    return {
        "note": ...,
    }


# DisableActionConfigurationTypeDef definition

class DisableActionConfigurationTypeDef(TypedDict):
    note: NotRequired[str],

EnableActionConfigurationTypeDef#

# EnableActionConfigurationTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import EnableActionConfigurationTypeDef


def get_value() -> EnableActionConfigurationTypeDef:
    return {
        "note": ...,
    }


# EnableActionConfigurationTypeDef definition

class EnableActionConfigurationTypeDef(TypedDict):
    note: NotRequired[str],

ResetActionConfigurationTypeDef#

# ResetActionConfigurationTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import ResetActionConfigurationTypeDef


def get_value() -> ResetActionConfigurationTypeDef:
    return {
        "note": ...,
    }


# ResetActionConfigurationTypeDef definition

class ResetActionConfigurationTypeDef(TypedDict):
    note: NotRequired[str],

SnoozeActionConfigurationTypeDef#

# SnoozeActionConfigurationTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import SnoozeActionConfigurationTypeDef


def get_value() -> SnoozeActionConfigurationTypeDef:
    return {
        "snoozeDuration": ...,
    }


# SnoozeActionConfigurationTypeDef definition

class SnoozeActionConfigurationTypeDef(TypedDict):
    snoozeDuration: NotRequired[int],
    note: NotRequired[str],

DescribeAlarmRequestTypeDef#

# DescribeAlarmRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import DescribeAlarmRequestTypeDef


def get_value() -> DescribeAlarmRequestTypeDef:
    return {
        "alarmModelName": ...,
    }


# DescribeAlarmRequestTypeDef definition

class DescribeAlarmRequestTypeDef(TypedDict):
    alarmModelName: str,
    keyValue: NotRequired[str],

DescribeDetectorRequestTypeDef#

# DescribeDetectorRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import DescribeDetectorRequestTypeDef


def get_value() -> DescribeDetectorRequestTypeDef:
    return {
        "detectorModelName": ...,
    }


# DescribeDetectorRequestTypeDef definition

class DescribeDetectorRequestTypeDef(TypedDict):
    detectorModelName: str,
    keyValue: NotRequired[str],

TimerDefinitionTypeDef#

# TimerDefinitionTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import TimerDefinitionTypeDef


def get_value() -> TimerDefinitionTypeDef:
    return {
        "name": ...,
    }


# TimerDefinitionTypeDef definition

class TimerDefinitionTypeDef(TypedDict):
    name: str,
    seconds: int,

VariableDefinitionTypeDef#

# VariableDefinitionTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import VariableDefinitionTypeDef


def get_value() -> VariableDefinitionTypeDef:
    return {
        "name": ...,
    }


# VariableDefinitionTypeDef definition

class VariableDefinitionTypeDef(TypedDict):
    name: str,
    value: str,

DetectorStateSummaryTypeDef#

# DetectorStateSummaryTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import DetectorStateSummaryTypeDef


def get_value() -> DetectorStateSummaryTypeDef:
    return {
        "stateName": ...,
    }


# DetectorStateSummaryTypeDef definition

class DetectorStateSummaryTypeDef(TypedDict):
    stateName: NotRequired[str],

TimerTypeDef#

# TimerTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import TimerTypeDef


def get_value() -> TimerTypeDef:
    return {
        "name": ...,
    }


# TimerTypeDef definition

class TimerTypeDef(TypedDict):
    name: str,
    timestamp: datetime.datetime,

VariableTypeDef#

# VariableTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import VariableTypeDef


def get_value() -> VariableTypeDef:
    return {
        "name": ...,
    }


# VariableTypeDef definition

class VariableTypeDef(TypedDict):
    name: str,
    value: str,

ListAlarmsRequestTypeDef#

# ListAlarmsRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import ListAlarmsRequestTypeDef


def get_value() -> ListAlarmsRequestTypeDef:
    return {
        "alarmModelName": ...,
    }


# ListAlarmsRequestTypeDef definition

class ListAlarmsRequestTypeDef(TypedDict):
    alarmModelName: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListDetectorsRequestTypeDef#

# ListDetectorsRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import ListDetectorsRequestTypeDef


def get_value() -> ListDetectorsRequestTypeDef:
    return {
        "detectorModelName": ...,
    }


# ListDetectorsRequestTypeDef definition

class ListDetectorsRequestTypeDef(TypedDict):
    detectorModelName: str,
    stateName: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

TimestampValueTypeDef#

# TimestampValueTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import TimestampValueTypeDef


def get_value() -> TimestampValueTypeDef:
    return {
        "timeInMillis": ...,
    }


# TimestampValueTypeDef definition

class TimestampValueTypeDef(TypedDict):
    timeInMillis: NotRequired[int],

SimpleRuleEvaluationTypeDef#

# SimpleRuleEvaluationTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import SimpleRuleEvaluationTypeDef


def get_value() -> SimpleRuleEvaluationTypeDef:
    return {
        "inputPropertyValue": ...,
    }


# SimpleRuleEvaluationTypeDef definition

class SimpleRuleEvaluationTypeDef(TypedDict):
    inputPropertyValue: NotRequired[str],
    operator: NotRequired[ComparisonOperatorType],  # (1)
    thresholdValue: NotRequired[str],
  1. See ComparisonOperatorType

StateChangeConfigurationTypeDef#

# StateChangeConfigurationTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import StateChangeConfigurationTypeDef


def get_value() -> StateChangeConfigurationTypeDef:
    return {
        "triggerType": ...,
    }


# StateChangeConfigurationTypeDef definition

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

BatchAcknowledgeAlarmRequestTypeDef#

# BatchAcknowledgeAlarmRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchAcknowledgeAlarmRequestTypeDef


def get_value() -> BatchAcknowledgeAlarmRequestTypeDef:
    return {
        "acknowledgeActionRequests": ...,
    }


# BatchAcknowledgeAlarmRequestTypeDef definition

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

BatchAcknowledgeAlarmResponseTypeDef#

# BatchAcknowledgeAlarmResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchAcknowledgeAlarmResponseTypeDef


def get_value() -> BatchAcknowledgeAlarmResponseTypeDef:
    return {
        "errorEntries": ...,
    }


# BatchAcknowledgeAlarmResponseTypeDef definition

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

BatchDisableAlarmResponseTypeDef#

# BatchDisableAlarmResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchDisableAlarmResponseTypeDef


def get_value() -> BatchDisableAlarmResponseTypeDef:
    return {
        "errorEntries": ...,
    }


# BatchDisableAlarmResponseTypeDef definition

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

BatchEnableAlarmResponseTypeDef#

# BatchEnableAlarmResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchEnableAlarmResponseTypeDef


def get_value() -> BatchEnableAlarmResponseTypeDef:
    return {
        "errorEntries": ...,
    }


# BatchEnableAlarmResponseTypeDef definition

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

BatchResetAlarmResponseTypeDef#

# BatchResetAlarmResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchResetAlarmResponseTypeDef


def get_value() -> BatchResetAlarmResponseTypeDef:
    return {
        "errorEntries": ...,
    }


# BatchResetAlarmResponseTypeDef definition

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

BatchSnoozeAlarmResponseTypeDef#

# BatchSnoozeAlarmResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchSnoozeAlarmResponseTypeDef


def get_value() -> BatchSnoozeAlarmResponseTypeDef:
    return {
        "errorEntries": ...,
    }


# BatchSnoozeAlarmResponseTypeDef definition

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

ListAlarmsResponseTypeDef#

# ListAlarmsResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import ListAlarmsResponseTypeDef


def get_value() -> ListAlarmsResponseTypeDef:
    return {
        "alarmSummaries": ...,
    }


# ListAlarmsResponseTypeDef definition

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

BatchDeleteDetectorResponseTypeDef#

# BatchDeleteDetectorResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchDeleteDetectorResponseTypeDef


def get_value() -> BatchDeleteDetectorResponseTypeDef:
    return {
        "batchDeleteDetectorErrorEntries": ...,
    }


# BatchDeleteDetectorResponseTypeDef definition

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

BatchDeleteDetectorRequestTypeDef#

# BatchDeleteDetectorRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchDeleteDetectorRequestTypeDef


def get_value() -> BatchDeleteDetectorRequestTypeDef:
    return {
        "detectors": ...,
    }


# BatchDeleteDetectorRequestTypeDef definition

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

BatchDisableAlarmRequestTypeDef#

# BatchDisableAlarmRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchDisableAlarmRequestTypeDef


def get_value() -> BatchDisableAlarmRequestTypeDef:
    return {
        "disableActionRequests": ...,
    }


# BatchDisableAlarmRequestTypeDef definition

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

BatchEnableAlarmRequestTypeDef#

# BatchEnableAlarmRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchEnableAlarmRequestTypeDef


def get_value() -> BatchEnableAlarmRequestTypeDef:
    return {
        "enableActionRequests": ...,
    }


# BatchEnableAlarmRequestTypeDef definition

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

BatchPutMessageResponseTypeDef#

# BatchPutMessageResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchPutMessageResponseTypeDef


def get_value() -> BatchPutMessageResponseTypeDef:
    return {
        "BatchPutMessageErrorEntries": ...,
    }


# BatchPutMessageResponseTypeDef definition

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

BatchResetAlarmRequestTypeDef#

# BatchResetAlarmRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchResetAlarmRequestTypeDef


def get_value() -> BatchResetAlarmRequestTypeDef:
    return {
        "resetActionRequests": ...,
    }


# BatchResetAlarmRequestTypeDef definition

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

BatchSnoozeAlarmRequestTypeDef#

# BatchSnoozeAlarmRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchSnoozeAlarmRequestTypeDef


def get_value() -> BatchSnoozeAlarmRequestTypeDef:
    return {
        "snoozeActionRequests": ...,
    }


# BatchSnoozeAlarmRequestTypeDef definition

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

BatchUpdateDetectorResponseTypeDef#

# BatchUpdateDetectorResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchUpdateDetectorResponseTypeDef


def get_value() -> BatchUpdateDetectorResponseTypeDef:
    return {
        "batchUpdateDetectorErrorEntries": ...,
    }


# BatchUpdateDetectorResponseTypeDef definition

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

CustomerActionTypeDef#

# CustomerActionTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import CustomerActionTypeDef


def get_value() -> CustomerActionTypeDef:
    return {
        "actionName": ...,
    }


# 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 TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import DetectorStateDefinitionTypeDef


def get_value() -> DetectorStateDefinitionTypeDef:
    return {
        "stateName": ...,
    }


# DetectorStateDefinitionTypeDef definition

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

DetectorSummaryTypeDef#

# DetectorSummaryTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import DetectorSummaryTypeDef


def get_value() -> DetectorSummaryTypeDef:
    return {
        "detectorModelName": ...,
    }


# DetectorSummaryTypeDef definition

class DetectorSummaryTypeDef(TypedDict):
    detectorModelName: NotRequired[str],
    keyValue: NotRequired[str],
    detectorModelVersion: NotRequired[str],
    state: NotRequired[DetectorStateSummaryTypeDef],  # (1)
    creationTime: NotRequired[datetime.datetime],
    lastUpdateTime: NotRequired[datetime.datetime],
  1. See DetectorStateSummaryTypeDef

DetectorStateTypeDef#

# DetectorStateTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import DetectorStateTypeDef


def get_value() -> DetectorStateTypeDef:
    return {
        "stateName": ...,
    }


# DetectorStateTypeDef definition

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

MessageTypeDef#

# MessageTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import MessageTypeDef


def get_value() -> MessageTypeDef:
    return {
        "messageId": ...,
    }


# MessageTypeDef definition

class MessageTypeDef(TypedDict):
    messageId: str,
    inputName: str,
    payload: BlobTypeDef,
    timestamp: NotRequired[TimestampValueTypeDef],  # (1)
  1. See TimestampValueTypeDef

RuleEvaluationTypeDef#

# RuleEvaluationTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import RuleEvaluationTypeDef


def get_value() -> RuleEvaluationTypeDef:
    return {
        "simpleRuleEvaluation": ...,
    }


# RuleEvaluationTypeDef definition

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

SystemEventTypeDef#

# SystemEventTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import SystemEventTypeDef


def get_value() -> SystemEventTypeDef:
    return {
        "eventType": ...,
    }


# SystemEventTypeDef definition

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

UpdateDetectorRequestTypeDef#

# UpdateDetectorRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import UpdateDetectorRequestTypeDef


def get_value() -> UpdateDetectorRequestTypeDef:
    return {
        "messageId": ...,
    }


# UpdateDetectorRequestTypeDef definition

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

ListDetectorsResponseTypeDef#

# ListDetectorsResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import ListDetectorsResponseTypeDef


def get_value() -> ListDetectorsResponseTypeDef:
    return {
        "detectorSummaries": ...,
    }


# ListDetectorsResponseTypeDef definition

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

DetectorTypeDef#

# DetectorTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import DetectorTypeDef


def get_value() -> DetectorTypeDef:
    return {
        "detectorModelName": ...,
    }


# DetectorTypeDef definition

class DetectorTypeDef(TypedDict):
    detectorModelName: NotRequired[str],
    keyValue: NotRequired[str],
    detectorModelVersion: NotRequired[str],
    state: NotRequired[DetectorStateTypeDef],  # (1)
    creationTime: NotRequired[datetime.datetime],
    lastUpdateTime: NotRequired[datetime.datetime],
  1. See DetectorStateTypeDef

BatchPutMessageRequestTypeDef#

# BatchPutMessageRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchPutMessageRequestTypeDef


def get_value() -> BatchPutMessageRequestTypeDef:
    return {
        "messages": ...,
    }


# BatchPutMessageRequestTypeDef definition

class BatchPutMessageRequestTypeDef(TypedDict):
    messages: Sequence[MessageTypeDef],  # (1)
  1. See Sequence[MessageTypeDef]

AlarmStateTypeDef#

# AlarmStateTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import AlarmStateTypeDef


def get_value() -> AlarmStateTypeDef:
    return {
        "stateName": ...,
    }


# 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

BatchUpdateDetectorRequestTypeDef#

# BatchUpdateDetectorRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import BatchUpdateDetectorRequestTypeDef


def get_value() -> BatchUpdateDetectorRequestTypeDef:
    return {
        "detectors": ...,
    }


# BatchUpdateDetectorRequestTypeDef definition

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

DescribeDetectorResponseTypeDef#

# DescribeDetectorResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import DescribeDetectorResponseTypeDef


def get_value() -> DescribeDetectorResponseTypeDef:
    return {
        "detector": ...,
    }


# DescribeDetectorResponseTypeDef definition

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

AlarmTypeDef#

# AlarmTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import AlarmTypeDef


def get_value() -> AlarmTypeDef:
    return {
        "alarmModelName": ...,
    }


# AlarmTypeDef definition

class AlarmTypeDef(TypedDict):
    alarmModelName: NotRequired[str],
    alarmModelVersion: NotRequired[str],
    keyValue: NotRequired[str],
    alarmState: NotRequired[AlarmStateTypeDef],  # (1)
    severity: NotRequired[int],
    creationTime: NotRequired[datetime.datetime],
    lastUpdateTime: NotRequired[datetime.datetime],
  1. See AlarmStateTypeDef

DescribeAlarmResponseTypeDef#

# DescribeAlarmResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents_data.type_defs import DescribeAlarmResponseTypeDef


def get_value() -> DescribeAlarmResponseTypeDef:
    return {
        "alarm": ...,
    }


# DescribeAlarmResponseTypeDef definition

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