Skip to content

Type definitions#

Index > IoTEvents > Type definitions

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

InputDefinitionUnionTypeDef#

# InputDefinitionUnionTypeDef Union usage example

from mypy_boto3_iotevents.type_defs import InputDefinitionUnionTypeDef


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


# InputDefinitionUnionTypeDef definition

InputDefinitionUnionTypeDef = Union[
    InputDefinitionTypeDef,  # (1)
    InputDefinitionOutputTypeDef,  # (2)
]
  1. See InputDefinitionTypeDef
  2. See InputDefinitionOutputTypeDef

LoggingOptionsUnionTypeDef#

# LoggingOptionsUnionTypeDef Union usage example

from mypy_boto3_iotevents.type_defs import LoggingOptionsUnionTypeDef


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


# LoggingOptionsUnionTypeDef definition

LoggingOptionsUnionTypeDef = Union[
    LoggingOptionsTypeDef,  # (1)
    LoggingOptionsOutputTypeDef,  # (2)
]
  1. See LoggingOptionsTypeDef
  2. See LoggingOptionsOutputTypeDef

AlarmEventActionsUnionTypeDef#

# AlarmEventActionsUnionTypeDef Union usage example

from mypy_boto3_iotevents.type_defs import AlarmEventActionsUnionTypeDef


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


# AlarmEventActionsUnionTypeDef definition

AlarmEventActionsUnionTypeDef = Union[
    AlarmEventActionsTypeDef,  # (1)
    AlarmEventActionsOutputTypeDef,  # (2)
]
  1. See AlarmEventActionsTypeDef
  2. See AlarmEventActionsOutputTypeDef

AlarmNotificationUnionTypeDef#

# AlarmNotificationUnionTypeDef Union usage example

from mypy_boto3_iotevents.type_defs import AlarmNotificationUnionTypeDef


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


# AlarmNotificationUnionTypeDef definition

AlarmNotificationUnionTypeDef = Union[
    AlarmNotificationTypeDef,  # (1)
    AlarmNotificationOutputTypeDef,  # (2)
]
  1. See AlarmNotificationTypeDef
  2. See AlarmNotificationOutputTypeDef

DetectorModelDefinitionUnionTypeDef#

# DetectorModelDefinitionUnionTypeDef Union usage example

from mypy_boto3_iotevents.type_defs import DetectorModelDefinitionUnionTypeDef


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


# DetectorModelDefinitionUnionTypeDef definition

DetectorModelDefinitionUnionTypeDef = Union[
    DetectorModelDefinitionTypeDef,  # (1)
    DetectorModelDefinitionOutputTypeDef,  # (2)
]
  1. See DetectorModelDefinitionTypeDef
  2. See DetectorModelDefinitionOutputTypeDef

AcknowledgeFlowTypeDef#

# AcknowledgeFlowTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AcknowledgeFlowTypeDef


def get_value() -> AcknowledgeFlowTypeDef:
    return {
        "enabled": ...,
    }


# AcknowledgeFlowTypeDef definition

class AcknowledgeFlowTypeDef(TypedDict):
    enabled: bool,

ClearTimerActionTypeDef#

# ClearTimerActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ClearTimerActionTypeDef


def get_value() -> ClearTimerActionTypeDef:
    return {
        "timerName": ...,
    }


# ClearTimerActionTypeDef definition

class ClearTimerActionTypeDef(TypedDict):
    timerName: str,

ResetTimerActionTypeDef#

# ResetTimerActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ResetTimerActionTypeDef


def get_value() -> ResetTimerActionTypeDef:
    return {
        "timerName": ...,
    }


# ResetTimerActionTypeDef definition

class ResetTimerActionTypeDef(TypedDict):
    timerName: str,

SetTimerActionTypeDef#

# SetTimerActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import SetTimerActionTypeDef


def get_value() -> SetTimerActionTypeDef:
    return {
        "timerName": ...,
    }


# SetTimerActionTypeDef definition

class SetTimerActionTypeDef(TypedDict):
    timerName: str,
    seconds: NotRequired[int],
    durationExpression: NotRequired[str],

SetVariableActionTypeDef#

# SetVariableActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import SetVariableActionTypeDef


def get_value() -> SetVariableActionTypeDef:
    return {
        "variableName": ...,
    }


# SetVariableActionTypeDef definition

class SetVariableActionTypeDef(TypedDict):
    variableName: str,
    value: str,

InitializationConfigurationTypeDef#

# InitializationConfigurationTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import InitializationConfigurationTypeDef


def get_value() -> InitializationConfigurationTypeDef:
    return {
        "disabledOnInitialization": ...,
    }


# InitializationConfigurationTypeDef definition

class InitializationConfigurationTypeDef(TypedDict):
    disabledOnInitialization: bool,

AlarmModelSummaryTypeDef#

# AlarmModelSummaryTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AlarmModelSummaryTypeDef


def get_value() -> AlarmModelSummaryTypeDef:
    return {
        "creationTime": ...,
    }


# AlarmModelSummaryTypeDef definition

class AlarmModelSummaryTypeDef(TypedDict):
    creationTime: NotRequired[datetime],
    alarmModelDescription: NotRequired[str],
    alarmModelName: NotRequired[str],

AlarmModelVersionSummaryTypeDef#

# AlarmModelVersionSummaryTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AlarmModelVersionSummaryTypeDef


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


# AlarmModelVersionSummaryTypeDef definition

class AlarmModelVersionSummaryTypeDef(TypedDict):
    alarmModelName: NotRequired[str],
    alarmModelArn: NotRequired[str],
    alarmModelVersion: NotRequired[str],
    roleArn: NotRequired[str],
    creationTime: NotRequired[datetime],
    lastUpdateTime: NotRequired[datetime],
    status: NotRequired[AlarmModelVersionStatusType],  # (1)
    statusMessage: NotRequired[str],
  1. See AlarmModelVersionStatusType

SimpleRuleTypeDef#

# SimpleRuleTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import SimpleRuleTypeDef


def get_value() -> SimpleRuleTypeDef:
    return {
        "inputProperty": ...,
    }


# SimpleRuleTypeDef definition

class SimpleRuleTypeDef(TypedDict):
    inputProperty: str,
    comparisonOperator: ComparisonOperatorType,  # (1)
    threshold: str,
  1. See ComparisonOperatorType

AnalysisResultLocationTypeDef#

# AnalysisResultLocationTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AnalysisResultLocationTypeDef


def get_value() -> AnalysisResultLocationTypeDef:
    return {
        "path": ...,
    }


# AnalysisResultLocationTypeDef definition

class AnalysisResultLocationTypeDef(TypedDict):
    path: NotRequired[str],

AssetPropertyTimestampTypeDef#

# AssetPropertyTimestampTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AssetPropertyTimestampTypeDef


def get_value() -> AssetPropertyTimestampTypeDef:
    return {
        "timeInSeconds": ...,
    }


# AssetPropertyTimestampTypeDef definition

class AssetPropertyTimestampTypeDef(TypedDict):
    timeInSeconds: str,
    offsetInNanos: NotRequired[str],

AssetPropertyVariantTypeDef#

# AssetPropertyVariantTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AssetPropertyVariantTypeDef


def get_value() -> AssetPropertyVariantTypeDef:
    return {
        "stringValue": ...,
    }


# AssetPropertyVariantTypeDef definition

class AssetPropertyVariantTypeDef(TypedDict):
    stringValue: NotRequired[str],
    integerValue: NotRequired[str],
    doubleValue: NotRequired[str],
    booleanValue: NotRequired[str],

AttributeTypeDef#

# AttributeTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AttributeTypeDef


def get_value() -> AttributeTypeDef:
    return {
        "jsonPath": ...,
    }


# AttributeTypeDef definition

class AttributeTypeDef(TypedDict):
    jsonPath: str,

TagTypeDef#

# TagTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import TagTypeDef


def get_value() -> TagTypeDef:
    return {
        "key": ...,
    }


# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_iotevents.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],

DetectorModelConfigurationTypeDef#

# DetectorModelConfigurationTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DetectorModelConfigurationTypeDef


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


# DetectorModelConfigurationTypeDef definition

class DetectorModelConfigurationTypeDef(TypedDict):
    detectorModelName: NotRequired[str],
    detectorModelVersion: NotRequired[str],
    detectorModelDescription: NotRequired[str],
    detectorModelArn: NotRequired[str],
    roleArn: NotRequired[str],
    creationTime: NotRequired[datetime],
    lastUpdateTime: NotRequired[datetime],
    status: NotRequired[DetectorModelVersionStatusType],  # (1)
    key: NotRequired[str],
    evaluationMethod: NotRequired[EvaluationMethodType],  # (2)
  1. See DetectorModelVersionStatusType
  2. See EvaluationMethodType

InputConfigurationTypeDef#

# InputConfigurationTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import InputConfigurationTypeDef


def get_value() -> InputConfigurationTypeDef:
    return {
        "inputName": ...,
    }


# InputConfigurationTypeDef definition

class InputConfigurationTypeDef(TypedDict):
    inputName: str,
    inputArn: str,
    creationTime: datetime,
    lastUpdateTime: datetime,
    status: InputStatusType,  # (1)
    inputDescription: NotRequired[str],
  1. See InputStatusType

DeleteAlarmModelRequestTypeDef#

# DeleteAlarmModelRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DeleteAlarmModelRequestTypeDef


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


# DeleteAlarmModelRequestTypeDef definition

class DeleteAlarmModelRequestTypeDef(TypedDict):
    alarmModelName: str,

DeleteDetectorModelRequestTypeDef#

# DeleteDetectorModelRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DeleteDetectorModelRequestTypeDef


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


# DeleteDetectorModelRequestTypeDef definition

class DeleteDetectorModelRequestTypeDef(TypedDict):
    detectorModelName: str,

DeleteInputRequestTypeDef#

# DeleteInputRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DeleteInputRequestTypeDef


def get_value() -> DeleteInputRequestTypeDef:
    return {
        "inputName": ...,
    }


# DeleteInputRequestTypeDef definition

class DeleteInputRequestTypeDef(TypedDict):
    inputName: str,

DescribeAlarmModelRequestTypeDef#

# DescribeAlarmModelRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DescribeAlarmModelRequestTypeDef


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


# DescribeAlarmModelRequestTypeDef definition

class DescribeAlarmModelRequestTypeDef(TypedDict):
    alarmModelName: str,
    alarmModelVersion: NotRequired[str],

DescribeDetectorModelAnalysisRequestTypeDef#

# DescribeDetectorModelAnalysisRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DescribeDetectorModelAnalysisRequestTypeDef


def get_value() -> DescribeDetectorModelAnalysisRequestTypeDef:
    return {
        "analysisId": ...,
    }


# DescribeDetectorModelAnalysisRequestTypeDef definition

class DescribeDetectorModelAnalysisRequestTypeDef(TypedDict):
    analysisId: str,

DescribeDetectorModelRequestTypeDef#

# DescribeDetectorModelRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DescribeDetectorModelRequestTypeDef


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


# DescribeDetectorModelRequestTypeDef definition

class DescribeDetectorModelRequestTypeDef(TypedDict):
    detectorModelName: str,
    detectorModelVersion: NotRequired[str],

DescribeInputRequestTypeDef#

# DescribeInputRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DescribeInputRequestTypeDef


def get_value() -> DescribeInputRequestTypeDef:
    return {
        "inputName": ...,
    }


# DescribeInputRequestTypeDef definition

class DescribeInputRequestTypeDef(TypedDict):
    inputName: str,

DetectorDebugOptionTypeDef#

# DetectorDebugOptionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DetectorDebugOptionTypeDef


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


# DetectorDebugOptionTypeDef definition

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

DetectorModelSummaryTypeDef#

# DetectorModelSummaryTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DetectorModelSummaryTypeDef


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


# DetectorModelSummaryTypeDef definition

class DetectorModelSummaryTypeDef(TypedDict):
    detectorModelName: NotRequired[str],
    detectorModelDescription: NotRequired[str],
    creationTime: NotRequired[datetime],

DetectorModelVersionSummaryTypeDef#

# DetectorModelVersionSummaryTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DetectorModelVersionSummaryTypeDef


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


# DetectorModelVersionSummaryTypeDef definition

class DetectorModelVersionSummaryTypeDef(TypedDict):
    detectorModelName: NotRequired[str],
    detectorModelVersion: NotRequired[str],
    detectorModelArn: NotRequired[str],
    roleArn: NotRequired[str],
    creationTime: NotRequired[datetime],
    lastUpdateTime: NotRequired[datetime],
    status: NotRequired[DetectorModelVersionStatusType],  # (1)
    evaluationMethod: NotRequired[EvaluationMethodType],  # (2)
  1. See DetectorModelVersionStatusType
  2. See EvaluationMethodType

PayloadTypeDef#

# PayloadTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import PayloadTypeDef


def get_value() -> PayloadTypeDef:
    return {
        "contentExpression": ...,
    }


# PayloadTypeDef definition

class PayloadTypeDef(TypedDict):
    contentExpression: str,
    type: PayloadTypeType,  # (1)
  1. See PayloadTypeType

EmailContentTypeDef#

# EmailContentTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import EmailContentTypeDef


def get_value() -> EmailContentTypeDef:
    return {
        "subject": ...,
    }


# EmailContentTypeDef definition

class EmailContentTypeDef(TypedDict):
    subject: NotRequired[str],
    additionalMessage: NotRequired[str],

GetDetectorModelAnalysisResultsRequestTypeDef#

# GetDetectorModelAnalysisResultsRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import GetDetectorModelAnalysisResultsRequestTypeDef


def get_value() -> GetDetectorModelAnalysisResultsRequestTypeDef:
    return {
        "analysisId": ...,
    }


# GetDetectorModelAnalysisResultsRequestTypeDef definition

class GetDetectorModelAnalysisResultsRequestTypeDef(TypedDict):
    analysisId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

IotEventsInputIdentifierTypeDef#

# IotEventsInputIdentifierTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import IotEventsInputIdentifierTypeDef


def get_value() -> IotEventsInputIdentifierTypeDef:
    return {
        "inputName": ...,
    }


# IotEventsInputIdentifierTypeDef definition

class IotEventsInputIdentifierTypeDef(TypedDict):
    inputName: str,

InputSummaryTypeDef#

# InputSummaryTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import InputSummaryTypeDef


def get_value() -> InputSummaryTypeDef:
    return {
        "inputName": ...,
    }


# InputSummaryTypeDef definition

class InputSummaryTypeDef(TypedDict):
    inputName: NotRequired[str],
    inputDescription: NotRequired[str],
    inputArn: NotRequired[str],
    creationTime: NotRequired[datetime],
    lastUpdateTime: NotRequired[datetime],
    status: NotRequired[InputStatusType],  # (1)
  1. See InputStatusType

IotSiteWiseAssetModelPropertyIdentifierTypeDef#

# IotSiteWiseAssetModelPropertyIdentifierTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import IotSiteWiseAssetModelPropertyIdentifierTypeDef


def get_value() -> IotSiteWiseAssetModelPropertyIdentifierTypeDef:
    return {
        "assetModelId": ...,
    }


# IotSiteWiseAssetModelPropertyIdentifierTypeDef definition

class IotSiteWiseAssetModelPropertyIdentifierTypeDef(TypedDict):
    assetModelId: str,
    propertyId: str,

ListAlarmModelVersionsRequestTypeDef#

# ListAlarmModelVersionsRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ListAlarmModelVersionsRequestTypeDef


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


# ListAlarmModelVersionsRequestTypeDef definition

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

ListAlarmModelsRequestTypeDef#

# ListAlarmModelsRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ListAlarmModelsRequestTypeDef


def get_value() -> ListAlarmModelsRequestTypeDef:
    return {
        "nextToken": ...,
    }


# ListAlarmModelsRequestTypeDef definition

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

ListDetectorModelVersionsRequestTypeDef#

# ListDetectorModelVersionsRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ListDetectorModelVersionsRequestTypeDef


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


# ListDetectorModelVersionsRequestTypeDef definition

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

ListDetectorModelsRequestTypeDef#

# ListDetectorModelsRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ListDetectorModelsRequestTypeDef


def get_value() -> ListDetectorModelsRequestTypeDef:
    return {
        "nextToken": ...,
    }


# ListDetectorModelsRequestTypeDef definition

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

RoutedResourceTypeDef#

# RoutedResourceTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import RoutedResourceTypeDef


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


# RoutedResourceTypeDef definition

class RoutedResourceTypeDef(TypedDict):
    name: NotRequired[str],
    arn: NotRequired[str],

ListInputsRequestTypeDef#

# ListInputsRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ListInputsRequestTypeDef


def get_value() -> ListInputsRequestTypeDef:
    return {
        "nextToken": ...,
    }


# ListInputsRequestTypeDef definition

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

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceArn: str,

SSOIdentityTypeDef#

# SSOIdentityTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import SSOIdentityTypeDef


def get_value() -> SSOIdentityTypeDef:
    return {
        "identityStoreId": ...,
    }


# SSOIdentityTypeDef definition

class SSOIdentityTypeDef(TypedDict):
    identityStoreId: str,
    userId: NotRequired[str],

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

AlarmCapabilitiesTypeDef#

# AlarmCapabilitiesTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AlarmCapabilitiesTypeDef


def get_value() -> AlarmCapabilitiesTypeDef:
    return {
        "initializationConfiguration": ...,
    }


# AlarmCapabilitiesTypeDef definition

class AlarmCapabilitiesTypeDef(TypedDict):
    initializationConfiguration: NotRequired[InitializationConfigurationTypeDef],  # (1)
    acknowledgeFlow: NotRequired[AcknowledgeFlowTypeDef],  # (2)
  1. See InitializationConfigurationTypeDef
  2. See AcknowledgeFlowTypeDef

AlarmRuleTypeDef#

# AlarmRuleTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AlarmRuleTypeDef


def get_value() -> AlarmRuleTypeDef:
    return {
        "simpleRule": ...,
    }


# AlarmRuleTypeDef definition

class AlarmRuleTypeDef(TypedDict):
    simpleRule: NotRequired[SimpleRuleTypeDef],  # (1)
  1. See SimpleRuleTypeDef

AnalysisResultTypeDef#

# AnalysisResultTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AnalysisResultTypeDef


def get_value() -> AnalysisResultTypeDef:
    return {
        "type": ...,
    }


# AnalysisResultTypeDef definition

class AnalysisResultTypeDef(TypedDict):
    type: NotRequired[str],
    level: NotRequired[AnalysisResultLevelType],  # (1)
    message: NotRequired[str],
    locations: NotRequired[List[AnalysisResultLocationTypeDef]],  # (2)
  1. See AnalysisResultLevelType
  2. See AnalysisResultLocationTypeDef

AssetPropertyValueTypeDef#

# AssetPropertyValueTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AssetPropertyValueTypeDef


def get_value() -> AssetPropertyValueTypeDef:
    return {
        "value": ...,
    }


# AssetPropertyValueTypeDef definition

class AssetPropertyValueTypeDef(TypedDict):
    value: NotRequired[AssetPropertyVariantTypeDef],  # (1)
    timestamp: NotRequired[AssetPropertyTimestampTypeDef],  # (2)
    quality: NotRequired[str],
  1. See AssetPropertyVariantTypeDef
  2. See AssetPropertyTimestampTypeDef

InputDefinitionOutputTypeDef#

# InputDefinitionOutputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import InputDefinitionOutputTypeDef


def get_value() -> InputDefinitionOutputTypeDef:
    return {
        "attributes": ...,
    }


# InputDefinitionOutputTypeDef definition

class InputDefinitionOutputTypeDef(TypedDict):
    attributes: List[AttributeTypeDef],  # (1)
  1. See AttributeTypeDef

InputDefinitionTypeDef#

# InputDefinitionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import InputDefinitionTypeDef


def get_value() -> InputDefinitionTypeDef:
    return {
        "attributes": ...,
    }


# InputDefinitionTypeDef definition

class InputDefinitionTypeDef(TypedDict):
    attributes: Sequence[AttributeTypeDef],  # (1)
  1. See AttributeTypeDef

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateAlarmModelResponseTypeDef#

# CreateAlarmModelResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import CreateAlarmModelResponseTypeDef


def get_value() -> CreateAlarmModelResponseTypeDef:
    return {
        "creationTime": ...,
    }


# CreateAlarmModelResponseTypeDef definition

class CreateAlarmModelResponseTypeDef(TypedDict):
    creationTime: datetime,
    alarmModelArn: str,
    alarmModelVersion: str,
    lastUpdateTime: datetime,
    status: AlarmModelVersionStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AlarmModelVersionStatusType
  2. See ResponseMetadataTypeDef

DescribeDetectorModelAnalysisResponseTypeDef#

# DescribeDetectorModelAnalysisResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DescribeDetectorModelAnalysisResponseTypeDef


def get_value() -> DescribeDetectorModelAnalysisResponseTypeDef:
    return {
        "status": ...,
    }


# DescribeDetectorModelAnalysisResponseTypeDef definition

class DescribeDetectorModelAnalysisResponseTypeDef(TypedDict):
    status: AnalysisStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalysisStatusType
  2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import EmptyResponseMetadataTypeDef


def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }


# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListAlarmModelVersionsResponseTypeDef#

# ListAlarmModelVersionsResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ListAlarmModelVersionsResponseTypeDef


def get_value() -> ListAlarmModelVersionsResponseTypeDef:
    return {
        "alarmModelVersionSummaries": ...,
    }


# ListAlarmModelVersionsResponseTypeDef definition

class ListAlarmModelVersionsResponseTypeDef(TypedDict):
    alarmModelVersionSummaries: List[AlarmModelVersionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AlarmModelVersionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAlarmModelsResponseTypeDef#

# ListAlarmModelsResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ListAlarmModelsResponseTypeDef


def get_value() -> ListAlarmModelsResponseTypeDef:
    return {
        "alarmModelSummaries": ...,
    }


# ListAlarmModelsResponseTypeDef definition

class ListAlarmModelsResponseTypeDef(TypedDict):
    alarmModelSummaries: List[AlarmModelSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AlarmModelSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

StartDetectorModelAnalysisResponseTypeDef#

# StartDetectorModelAnalysisResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import StartDetectorModelAnalysisResponseTypeDef


def get_value() -> StartDetectorModelAnalysisResponseTypeDef:
    return {
        "analysisId": ...,
    }


# StartDetectorModelAnalysisResponseTypeDef definition

class StartDetectorModelAnalysisResponseTypeDef(TypedDict):
    analysisId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateAlarmModelResponseTypeDef#

# UpdateAlarmModelResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import UpdateAlarmModelResponseTypeDef


def get_value() -> UpdateAlarmModelResponseTypeDef:
    return {
        "creationTime": ...,
    }


# UpdateAlarmModelResponseTypeDef definition

class UpdateAlarmModelResponseTypeDef(TypedDict):
    creationTime: datetime,
    alarmModelArn: str,
    alarmModelVersion: str,
    lastUpdateTime: datetime,
    status: AlarmModelVersionStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AlarmModelVersionStatusType
  2. See ResponseMetadataTypeDef

CreateDetectorModelResponseTypeDef#

# CreateDetectorModelResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import CreateDetectorModelResponseTypeDef


def get_value() -> CreateDetectorModelResponseTypeDef:
    return {
        "detectorModelConfiguration": ...,
    }


# CreateDetectorModelResponseTypeDef definition

class CreateDetectorModelResponseTypeDef(TypedDict):
    detectorModelConfiguration: DetectorModelConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DetectorModelConfigurationTypeDef
  2. See ResponseMetadataTypeDef

UpdateDetectorModelResponseTypeDef#

# UpdateDetectorModelResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import UpdateDetectorModelResponseTypeDef


def get_value() -> UpdateDetectorModelResponseTypeDef:
    return {
        "detectorModelConfiguration": ...,
    }


# UpdateDetectorModelResponseTypeDef definition

class UpdateDetectorModelResponseTypeDef(TypedDict):
    detectorModelConfiguration: DetectorModelConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DetectorModelConfigurationTypeDef
  2. See ResponseMetadataTypeDef

CreateInputResponseTypeDef#

# CreateInputResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import CreateInputResponseTypeDef


def get_value() -> CreateInputResponseTypeDef:
    return {
        "inputConfiguration": ...,
    }


# CreateInputResponseTypeDef definition

class CreateInputResponseTypeDef(TypedDict):
    inputConfiguration: InputConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InputConfigurationTypeDef
  2. See ResponseMetadataTypeDef

UpdateInputResponseTypeDef#

# UpdateInputResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import UpdateInputResponseTypeDef


def get_value() -> UpdateInputResponseTypeDef:
    return {
        "inputConfiguration": ...,
    }


# UpdateInputResponseTypeDef definition

class UpdateInputResponseTypeDef(TypedDict):
    inputConfiguration: InputConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InputConfigurationTypeDef
  2. See ResponseMetadataTypeDef

LoggingOptionsOutputTypeDef#

# LoggingOptionsOutputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import LoggingOptionsOutputTypeDef


def get_value() -> LoggingOptionsOutputTypeDef:
    return {
        "roleArn": ...,
    }


# LoggingOptionsOutputTypeDef definition

class LoggingOptionsOutputTypeDef(TypedDict):
    roleArn: str,
    level: LoggingLevelType,  # (1)
    enabled: bool,
    detectorDebugOptions: NotRequired[List[DetectorDebugOptionTypeDef]],  # (2)
  1. See LoggingLevelType
  2. See DetectorDebugOptionTypeDef

LoggingOptionsTypeDef#

# LoggingOptionsTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import LoggingOptionsTypeDef


def get_value() -> LoggingOptionsTypeDef:
    return {
        "roleArn": ...,
    }


# LoggingOptionsTypeDef definition

class LoggingOptionsTypeDef(TypedDict):
    roleArn: str,
    level: LoggingLevelType,  # (1)
    enabled: bool,
    detectorDebugOptions: NotRequired[Sequence[DetectorDebugOptionTypeDef]],  # (2)
  1. See LoggingLevelType
  2. See DetectorDebugOptionTypeDef

ListDetectorModelsResponseTypeDef#

# ListDetectorModelsResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ListDetectorModelsResponseTypeDef


def get_value() -> ListDetectorModelsResponseTypeDef:
    return {
        "detectorModelSummaries": ...,
    }


# ListDetectorModelsResponseTypeDef definition

class ListDetectorModelsResponseTypeDef(TypedDict):
    detectorModelSummaries: List[DetectorModelSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DetectorModelSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListDetectorModelVersionsResponseTypeDef#

# ListDetectorModelVersionsResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ListDetectorModelVersionsResponseTypeDef


def get_value() -> ListDetectorModelVersionsResponseTypeDef:
    return {
        "detectorModelVersionSummaries": ...,
    }


# ListDetectorModelVersionsResponseTypeDef definition

class ListDetectorModelVersionsResponseTypeDef(TypedDict):
    detectorModelVersionSummaries: List[DetectorModelVersionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DetectorModelVersionSummaryTypeDef
  2. See ResponseMetadataTypeDef

DynamoDBActionTypeDef#

# DynamoDBActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DynamoDBActionTypeDef


def get_value() -> DynamoDBActionTypeDef:
    return {
        "hashKeyType": ...,
    }


# DynamoDBActionTypeDef definition

class DynamoDBActionTypeDef(TypedDict):
    hashKeyField: str,
    hashKeyValue: str,
    tableName: str,
    hashKeyType: NotRequired[str],
    rangeKeyType: NotRequired[str],
    rangeKeyField: NotRequired[str],
    rangeKeyValue: NotRequired[str],
    operation: NotRequired[str],
    payloadField: NotRequired[str],
    payload: NotRequired[PayloadTypeDef],  # (1)
  1. See PayloadTypeDef

DynamoDBv2ActionTypeDef#

# DynamoDBv2ActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DynamoDBv2ActionTypeDef


def get_value() -> DynamoDBv2ActionTypeDef:
    return {
        "tableName": ...,
    }


# DynamoDBv2ActionTypeDef definition

class DynamoDBv2ActionTypeDef(TypedDict):
    tableName: str,
    payload: NotRequired[PayloadTypeDef],  # (1)
  1. See PayloadTypeDef

FirehoseActionTypeDef#

# FirehoseActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import FirehoseActionTypeDef


def get_value() -> FirehoseActionTypeDef:
    return {
        "deliveryStreamName": ...,
    }


# FirehoseActionTypeDef definition

class FirehoseActionTypeDef(TypedDict):
    deliveryStreamName: str,
    separator: NotRequired[str],
    payload: NotRequired[PayloadTypeDef],  # (1)
  1. See PayloadTypeDef

IotEventsActionTypeDef#

# IotEventsActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import IotEventsActionTypeDef


def get_value() -> IotEventsActionTypeDef:
    return {
        "inputName": ...,
    }


# IotEventsActionTypeDef definition

class IotEventsActionTypeDef(TypedDict):
    inputName: str,
    payload: NotRequired[PayloadTypeDef],  # (1)
  1. See PayloadTypeDef

IotTopicPublishActionTypeDef#

# IotTopicPublishActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import IotTopicPublishActionTypeDef


def get_value() -> IotTopicPublishActionTypeDef:
    return {
        "mqttTopic": ...,
    }


# IotTopicPublishActionTypeDef definition

class IotTopicPublishActionTypeDef(TypedDict):
    mqttTopic: str,
    payload: NotRequired[PayloadTypeDef],  # (1)
  1. See PayloadTypeDef

LambdaActionTypeDef#

# LambdaActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import LambdaActionTypeDef


def get_value() -> LambdaActionTypeDef:
    return {
        "functionArn": ...,
    }


# LambdaActionTypeDef definition

class LambdaActionTypeDef(TypedDict):
    functionArn: str,
    payload: NotRequired[PayloadTypeDef],  # (1)
  1. See PayloadTypeDef

SNSTopicPublishActionTypeDef#

# SNSTopicPublishActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import SNSTopicPublishActionTypeDef


def get_value() -> SNSTopicPublishActionTypeDef:
    return {
        "targetArn": ...,
    }


# SNSTopicPublishActionTypeDef definition

class SNSTopicPublishActionTypeDef(TypedDict):
    targetArn: str,
    payload: NotRequired[PayloadTypeDef],  # (1)
  1. See PayloadTypeDef

SqsActionTypeDef#

# SqsActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import SqsActionTypeDef


def get_value() -> SqsActionTypeDef:
    return {
        "queueUrl": ...,
    }


# SqsActionTypeDef definition

class SqsActionTypeDef(TypedDict):
    queueUrl: str,
    useBase64: NotRequired[bool],
    payload: NotRequired[PayloadTypeDef],  # (1)
  1. See PayloadTypeDef

ListInputsResponseTypeDef#

# ListInputsResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ListInputsResponseTypeDef


def get_value() -> ListInputsResponseTypeDef:
    return {
        "inputSummaries": ...,
    }


# ListInputsResponseTypeDef definition

class ListInputsResponseTypeDef(TypedDict):
    inputSummaries: List[InputSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See InputSummaryTypeDef
  2. See ResponseMetadataTypeDef

IotSiteWiseInputIdentifierTypeDef#

# IotSiteWiseInputIdentifierTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import IotSiteWiseInputIdentifierTypeDef


def get_value() -> IotSiteWiseInputIdentifierTypeDef:
    return {
        "iotSiteWiseAssetModelPropertyIdentifier": ...,
    }


# IotSiteWiseInputIdentifierTypeDef definition

class IotSiteWiseInputIdentifierTypeDef(TypedDict):
    iotSiteWiseAssetModelPropertyIdentifier: NotRequired[IotSiteWiseAssetModelPropertyIdentifierTypeDef],  # (1)
  1. See IotSiteWiseAssetModelPropertyIdentifierTypeDef

ListInputRoutingsResponseTypeDef#

# ListInputRoutingsResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ListInputRoutingsResponseTypeDef


def get_value() -> ListInputRoutingsResponseTypeDef:
    return {
        "routedResources": ...,
    }


# ListInputRoutingsResponseTypeDef definition

class ListInputRoutingsResponseTypeDef(TypedDict):
    routedResources: List[RoutedResourceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See RoutedResourceTypeDef
  2. See ResponseMetadataTypeDef

RecipientDetailTypeDef#

# RecipientDetailTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import RecipientDetailTypeDef


def get_value() -> RecipientDetailTypeDef:
    return {
        "ssoIdentity": ...,
    }


# RecipientDetailTypeDef definition

class RecipientDetailTypeDef(TypedDict):
    ssoIdentity: NotRequired[SSOIdentityTypeDef],  # (1)
  1. See SSOIdentityTypeDef

GetDetectorModelAnalysisResultsResponseTypeDef#

# GetDetectorModelAnalysisResultsResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import GetDetectorModelAnalysisResultsResponseTypeDef


def get_value() -> GetDetectorModelAnalysisResultsResponseTypeDef:
    return {
        "analysisResults": ...,
    }


# GetDetectorModelAnalysisResultsResponseTypeDef definition

class GetDetectorModelAnalysisResultsResponseTypeDef(TypedDict):
    analysisResults: List[AnalysisResultTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AnalysisResultTypeDef
  2. See ResponseMetadataTypeDef

IotSiteWiseActionTypeDef#

# IotSiteWiseActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import IotSiteWiseActionTypeDef


def get_value() -> IotSiteWiseActionTypeDef:
    return {
        "entryId": ...,
    }


# IotSiteWiseActionTypeDef definition

class IotSiteWiseActionTypeDef(TypedDict):
    entryId: NotRequired[str],
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    propertyAlias: NotRequired[str],
    propertyValue: NotRequired[AssetPropertyValueTypeDef],  # (1)
  1. See AssetPropertyValueTypeDef

InputTypeDef#

# InputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import InputTypeDef


def get_value() -> InputTypeDef:
    return {
        "inputConfiguration": ...,
    }


# InputTypeDef definition

class InputTypeDef(TypedDict):
    inputConfiguration: NotRequired[InputConfigurationTypeDef],  # (1)
    inputDefinition: NotRequired[InputDefinitionOutputTypeDef],  # (2)
  1. See InputConfigurationTypeDef
  2. See InputDefinitionOutputTypeDef

DescribeLoggingOptionsResponseTypeDef#

# DescribeLoggingOptionsResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DescribeLoggingOptionsResponseTypeDef


def get_value() -> DescribeLoggingOptionsResponseTypeDef:
    return {
        "loggingOptions": ...,
    }


# DescribeLoggingOptionsResponseTypeDef definition

class DescribeLoggingOptionsResponseTypeDef(TypedDict):
    loggingOptions: LoggingOptionsOutputTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LoggingOptionsOutputTypeDef
  2. See ResponseMetadataTypeDef

NotificationTargetActionsTypeDef#

# NotificationTargetActionsTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import NotificationTargetActionsTypeDef


def get_value() -> NotificationTargetActionsTypeDef:
    return {
        "lambdaAction": ...,
    }


# NotificationTargetActionsTypeDef definition

class NotificationTargetActionsTypeDef(TypedDict):
    lambdaAction: NotRequired[LambdaActionTypeDef],  # (1)
  1. See LambdaActionTypeDef

InputIdentifierTypeDef#

# InputIdentifierTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import InputIdentifierTypeDef


def get_value() -> InputIdentifierTypeDef:
    return {
        "iotEventsInputIdentifier": ...,
    }


# InputIdentifierTypeDef definition

class InputIdentifierTypeDef(TypedDict):
    iotEventsInputIdentifier: NotRequired[IotEventsInputIdentifierTypeDef],  # (1)
    iotSiteWiseInputIdentifier: NotRequired[IotSiteWiseInputIdentifierTypeDef],  # (2)
  1. See IotEventsInputIdentifierTypeDef
  2. See IotSiteWiseInputIdentifierTypeDef

EmailRecipientsOutputTypeDef#

# EmailRecipientsOutputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import EmailRecipientsOutputTypeDef


def get_value() -> EmailRecipientsOutputTypeDef:
    return {
        "to": ...,
    }


# EmailRecipientsOutputTypeDef definition

class EmailRecipientsOutputTypeDef(TypedDict):
    to: NotRequired[List[RecipientDetailTypeDef]],  # (1)
  1. See RecipientDetailTypeDef

EmailRecipientsTypeDef#

# EmailRecipientsTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import EmailRecipientsTypeDef


def get_value() -> EmailRecipientsTypeDef:
    return {
        "to": ...,
    }


# EmailRecipientsTypeDef definition

class EmailRecipientsTypeDef(TypedDict):
    to: NotRequired[Sequence[RecipientDetailTypeDef]],  # (1)
  1. See RecipientDetailTypeDef

SMSConfigurationOutputTypeDef#

# SMSConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import SMSConfigurationOutputTypeDef


def get_value() -> SMSConfigurationOutputTypeDef:
    return {
        "senderId": ...,
    }


# SMSConfigurationOutputTypeDef definition

class SMSConfigurationOutputTypeDef(TypedDict):
    recipients: List[RecipientDetailTypeDef],  # (1)
    senderId: NotRequired[str],
    additionalMessage: NotRequired[str],
  1. See RecipientDetailTypeDef

SMSConfigurationTypeDef#

# SMSConfigurationTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import SMSConfigurationTypeDef


def get_value() -> SMSConfigurationTypeDef:
    return {
        "senderId": ...,
    }


# SMSConfigurationTypeDef definition

class SMSConfigurationTypeDef(TypedDict):
    recipients: Sequence[RecipientDetailTypeDef],  # (1)
    senderId: NotRequired[str],
    additionalMessage: NotRequired[str],
  1. See RecipientDetailTypeDef

ActionTypeDef#

# ActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ActionTypeDef


def get_value() -> ActionTypeDef:
    return {
        "setVariable": ...,
    }


# ActionTypeDef definition

class ActionTypeDef(TypedDict):
    setVariable: NotRequired[SetVariableActionTypeDef],  # (1)
    sns: NotRequired[SNSTopicPublishActionTypeDef],  # (2)
    iotTopicPublish: NotRequired[IotTopicPublishActionTypeDef],  # (3)
    setTimer: NotRequired[SetTimerActionTypeDef],  # (4)
    clearTimer: NotRequired[ClearTimerActionTypeDef],  # (5)
    resetTimer: NotRequired[ResetTimerActionTypeDef],  # (6)
    lambda: NotRequired[LambdaActionTypeDef],  # (7)
    iotEvents: NotRequired[IotEventsActionTypeDef],  # (8)
    sqs: NotRequired[SqsActionTypeDef],  # (9)
    firehose: NotRequired[FirehoseActionTypeDef],  # (10)
    dynamoDB: NotRequired[DynamoDBActionTypeDef],  # (11)
    dynamoDBv2: NotRequired[DynamoDBv2ActionTypeDef],  # (12)
    iotSiteWise: NotRequired[IotSiteWiseActionTypeDef],  # (13)
  1. See SetVariableActionTypeDef
  2. See SNSTopicPublishActionTypeDef
  3. See IotTopicPublishActionTypeDef
  4. See SetTimerActionTypeDef
  5. See ClearTimerActionTypeDef
  6. See ResetTimerActionTypeDef
  7. See LambdaActionTypeDef
  8. See IotEventsActionTypeDef
  9. See SqsActionTypeDef
  10. See FirehoseActionTypeDef
  11. See DynamoDBActionTypeDef
  12. See DynamoDBv2ActionTypeDef
  13. See IotSiteWiseActionTypeDef

AlarmActionTypeDef#

# AlarmActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AlarmActionTypeDef


def get_value() -> AlarmActionTypeDef:
    return {
        "sns": ...,
    }


# AlarmActionTypeDef definition

class AlarmActionTypeDef(TypedDict):
    sns: NotRequired[SNSTopicPublishActionTypeDef],  # (1)
    iotTopicPublish: NotRequired[IotTopicPublishActionTypeDef],  # (2)
    lambda: NotRequired[LambdaActionTypeDef],  # (3)
    iotEvents: NotRequired[IotEventsActionTypeDef],  # (4)
    sqs: NotRequired[SqsActionTypeDef],  # (5)
    firehose: NotRequired[FirehoseActionTypeDef],  # (6)
    dynamoDB: NotRequired[DynamoDBActionTypeDef],  # (7)
    dynamoDBv2: NotRequired[DynamoDBv2ActionTypeDef],  # (8)
    iotSiteWise: NotRequired[IotSiteWiseActionTypeDef],  # (9)
  1. See SNSTopicPublishActionTypeDef
  2. See IotTopicPublishActionTypeDef
  3. See LambdaActionTypeDef
  4. See IotEventsActionTypeDef
  5. See SqsActionTypeDef
  6. See FirehoseActionTypeDef
  7. See DynamoDBActionTypeDef
  8. See DynamoDBv2ActionTypeDef
  9. See IotSiteWiseActionTypeDef

DescribeInputResponseTypeDef#

# DescribeInputResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DescribeInputResponseTypeDef


def get_value() -> DescribeInputResponseTypeDef:
    return {
        "input": ...,
    }


# DescribeInputResponseTypeDef definition

class DescribeInputResponseTypeDef(TypedDict):
    input: InputTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InputTypeDef
  2. See ResponseMetadataTypeDef

CreateInputRequestTypeDef#

# CreateInputRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import CreateInputRequestTypeDef


def get_value() -> CreateInputRequestTypeDef:
    return {
        "inputName": ...,
    }


# CreateInputRequestTypeDef definition

class CreateInputRequestTypeDef(TypedDict):
    inputName: str,
    inputDefinition: InputDefinitionUnionTypeDef,  # (1)
    inputDescription: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See InputDefinitionTypeDef InputDefinitionOutputTypeDef
  2. See TagTypeDef

UpdateInputRequestTypeDef#

# UpdateInputRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import UpdateInputRequestTypeDef


def get_value() -> UpdateInputRequestTypeDef:
    return {
        "inputName": ...,
    }


# UpdateInputRequestTypeDef definition

class UpdateInputRequestTypeDef(TypedDict):
    inputName: str,
    inputDefinition: InputDefinitionUnionTypeDef,  # (1)
    inputDescription: NotRequired[str],
  1. See InputDefinitionTypeDef InputDefinitionOutputTypeDef

PutLoggingOptionsRequestTypeDef#

# PutLoggingOptionsRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import PutLoggingOptionsRequestTypeDef


def get_value() -> PutLoggingOptionsRequestTypeDef:
    return {
        "loggingOptions": ...,
    }


# PutLoggingOptionsRequestTypeDef definition

class PutLoggingOptionsRequestTypeDef(TypedDict):
    loggingOptions: LoggingOptionsUnionTypeDef,  # (1)
  1. See LoggingOptionsTypeDef LoggingOptionsOutputTypeDef

ListInputRoutingsRequestTypeDef#

# ListInputRoutingsRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import ListInputRoutingsRequestTypeDef


def get_value() -> ListInputRoutingsRequestTypeDef:
    return {
        "inputIdentifier": ...,
    }


# ListInputRoutingsRequestTypeDef definition

class ListInputRoutingsRequestTypeDef(TypedDict):
    inputIdentifier: InputIdentifierTypeDef,  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See InputIdentifierTypeDef

EmailConfigurationOutputTypeDef#

# EmailConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import EmailConfigurationOutputTypeDef


def get_value() -> EmailConfigurationOutputTypeDef:
    return {
        "from": ...,
    }


# EmailConfigurationOutputTypeDef definition

class EmailConfigurationOutputTypeDef(TypedDict):
    from: str,
    recipients: EmailRecipientsOutputTypeDef,  # (2)
    content: NotRequired[EmailContentTypeDef],  # (1)
  1. See EmailContentTypeDef
  2. See EmailRecipientsOutputTypeDef

EmailConfigurationTypeDef#

# EmailConfigurationTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import EmailConfigurationTypeDef


def get_value() -> EmailConfigurationTypeDef:
    return {
        "from": ...,
    }


# EmailConfigurationTypeDef definition

class EmailConfigurationTypeDef(TypedDict):
    from: str,
    recipients: EmailRecipientsTypeDef,  # (2)
    content: NotRequired[EmailContentTypeDef],  # (1)
  1. See EmailContentTypeDef
  2. See EmailRecipientsTypeDef

EventOutputTypeDef#

# EventOutputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import EventOutputTypeDef


def get_value() -> EventOutputTypeDef:
    return {
        "eventName": ...,
    }


# EventOutputTypeDef definition

class EventOutputTypeDef(TypedDict):
    eventName: str,
    condition: NotRequired[str],
    actions: NotRequired[List[ActionTypeDef]],  # (1)
  1. See ActionTypeDef

EventTypeDef#

# EventTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import EventTypeDef


def get_value() -> EventTypeDef:
    return {
        "eventName": ...,
    }


# EventTypeDef definition

class EventTypeDef(TypedDict):
    eventName: str,
    condition: NotRequired[str],
    actions: NotRequired[Sequence[ActionTypeDef]],  # (1)
  1. See ActionTypeDef

TransitionEventOutputTypeDef#

# TransitionEventOutputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import TransitionEventOutputTypeDef


def get_value() -> TransitionEventOutputTypeDef:
    return {
        "eventName": ...,
    }


# TransitionEventOutputTypeDef definition

class TransitionEventOutputTypeDef(TypedDict):
    eventName: str,
    condition: str,
    nextState: str,
    actions: NotRequired[List[ActionTypeDef]],  # (1)
  1. See ActionTypeDef

TransitionEventTypeDef#

# TransitionEventTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import TransitionEventTypeDef


def get_value() -> TransitionEventTypeDef:
    return {
        "eventName": ...,
    }


# TransitionEventTypeDef definition

class TransitionEventTypeDef(TypedDict):
    eventName: str,
    condition: str,
    nextState: str,
    actions: NotRequired[Sequence[ActionTypeDef]],  # (1)
  1. See ActionTypeDef

AlarmEventActionsOutputTypeDef#

# AlarmEventActionsOutputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AlarmEventActionsOutputTypeDef


def get_value() -> AlarmEventActionsOutputTypeDef:
    return {
        "alarmActions": ...,
    }


# AlarmEventActionsOutputTypeDef definition

class AlarmEventActionsOutputTypeDef(TypedDict):
    alarmActions: NotRequired[List[AlarmActionTypeDef]],  # (1)
  1. See AlarmActionTypeDef

AlarmEventActionsTypeDef#

# AlarmEventActionsTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AlarmEventActionsTypeDef


def get_value() -> AlarmEventActionsTypeDef:
    return {
        "alarmActions": ...,
    }


# AlarmEventActionsTypeDef definition

class AlarmEventActionsTypeDef(TypedDict):
    alarmActions: NotRequired[Sequence[AlarmActionTypeDef]],  # (1)
  1. See AlarmActionTypeDef

NotificationActionOutputTypeDef#

# NotificationActionOutputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import NotificationActionOutputTypeDef


def get_value() -> NotificationActionOutputTypeDef:
    return {
        "action": ...,
    }


# NotificationActionOutputTypeDef definition

class NotificationActionOutputTypeDef(TypedDict):
    action: NotificationTargetActionsTypeDef,  # (1)
    smsConfigurations: NotRequired[List[SMSConfigurationOutputTypeDef]],  # (2)
    emailConfigurations: NotRequired[List[EmailConfigurationOutputTypeDef]],  # (3)
  1. See NotificationTargetActionsTypeDef
  2. See SMSConfigurationOutputTypeDef
  3. See EmailConfigurationOutputTypeDef

NotificationActionTypeDef#

# NotificationActionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import NotificationActionTypeDef


def get_value() -> NotificationActionTypeDef:
    return {
        "action": ...,
    }


# NotificationActionTypeDef definition

class NotificationActionTypeDef(TypedDict):
    action: NotificationTargetActionsTypeDef,  # (1)
    smsConfigurations: NotRequired[Sequence[SMSConfigurationTypeDef]],  # (2)
    emailConfigurations: NotRequired[Sequence[EmailConfigurationTypeDef]],  # (3)
  1. See NotificationTargetActionsTypeDef
  2. See SMSConfigurationTypeDef
  3. See EmailConfigurationTypeDef

OnEnterLifecycleOutputTypeDef#

# OnEnterLifecycleOutputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import OnEnterLifecycleOutputTypeDef


def get_value() -> OnEnterLifecycleOutputTypeDef:
    return {
        "events": ...,
    }


# OnEnterLifecycleOutputTypeDef definition

class OnEnterLifecycleOutputTypeDef(TypedDict):
    events: NotRequired[List[EventOutputTypeDef]],  # (1)
  1. See EventOutputTypeDef

OnExitLifecycleOutputTypeDef#

# OnExitLifecycleOutputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import OnExitLifecycleOutputTypeDef


def get_value() -> OnExitLifecycleOutputTypeDef:
    return {
        "events": ...,
    }


# OnExitLifecycleOutputTypeDef definition

class OnExitLifecycleOutputTypeDef(TypedDict):
    events: NotRequired[List[EventOutputTypeDef]],  # (1)
  1. See EventOutputTypeDef

OnEnterLifecycleTypeDef#

# OnEnterLifecycleTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import OnEnterLifecycleTypeDef


def get_value() -> OnEnterLifecycleTypeDef:
    return {
        "events": ...,
    }


# OnEnterLifecycleTypeDef definition

class OnEnterLifecycleTypeDef(TypedDict):
    events: NotRequired[Sequence[EventTypeDef]],  # (1)
  1. See EventTypeDef

OnExitLifecycleTypeDef#

# OnExitLifecycleTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import OnExitLifecycleTypeDef


def get_value() -> OnExitLifecycleTypeDef:
    return {
        "events": ...,
    }


# OnExitLifecycleTypeDef definition

class OnExitLifecycleTypeDef(TypedDict):
    events: NotRequired[Sequence[EventTypeDef]],  # (1)
  1. See EventTypeDef

OnInputLifecycleOutputTypeDef#

# OnInputLifecycleOutputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import OnInputLifecycleOutputTypeDef


def get_value() -> OnInputLifecycleOutputTypeDef:
    return {
        "events": ...,
    }


# OnInputLifecycleOutputTypeDef definition

class OnInputLifecycleOutputTypeDef(TypedDict):
    events: NotRequired[List[EventOutputTypeDef]],  # (1)
    transitionEvents: NotRequired[List[TransitionEventOutputTypeDef]],  # (2)
  1. See EventOutputTypeDef
  2. See TransitionEventOutputTypeDef

OnInputLifecycleTypeDef#

# OnInputLifecycleTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import OnInputLifecycleTypeDef


def get_value() -> OnInputLifecycleTypeDef:
    return {
        "events": ...,
    }


# OnInputLifecycleTypeDef definition

class OnInputLifecycleTypeDef(TypedDict):
    events: NotRequired[Sequence[EventTypeDef]],  # (1)
    transitionEvents: NotRequired[Sequence[TransitionEventTypeDef]],  # (2)
  1. See EventTypeDef
  2. See TransitionEventTypeDef

AlarmNotificationOutputTypeDef#

# AlarmNotificationOutputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AlarmNotificationOutputTypeDef


def get_value() -> AlarmNotificationOutputTypeDef:
    return {
        "notificationActions": ...,
    }


# AlarmNotificationOutputTypeDef definition

class AlarmNotificationOutputTypeDef(TypedDict):
    notificationActions: NotRequired[List[NotificationActionOutputTypeDef]],  # (1)
  1. See NotificationActionOutputTypeDef

AlarmNotificationTypeDef#

# AlarmNotificationTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import AlarmNotificationTypeDef


def get_value() -> AlarmNotificationTypeDef:
    return {
        "notificationActions": ...,
    }


# AlarmNotificationTypeDef definition

class AlarmNotificationTypeDef(TypedDict):
    notificationActions: NotRequired[Sequence[NotificationActionTypeDef]],  # (1)
  1. See NotificationActionTypeDef

StateOutputTypeDef#

# StateOutputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import StateOutputTypeDef


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


# StateOutputTypeDef definition

class StateOutputTypeDef(TypedDict):
    stateName: str,
    onInput: NotRequired[OnInputLifecycleOutputTypeDef],  # (1)
    onEnter: NotRequired[OnEnterLifecycleOutputTypeDef],  # (2)
    onExit: NotRequired[OnExitLifecycleOutputTypeDef],  # (3)
  1. See OnInputLifecycleOutputTypeDef
  2. See OnEnterLifecycleOutputTypeDef
  3. See OnExitLifecycleOutputTypeDef

StateTypeDef#

# StateTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import StateTypeDef


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


# StateTypeDef definition

class StateTypeDef(TypedDict):
    stateName: str,
    onInput: NotRequired[OnInputLifecycleTypeDef],  # (1)
    onEnter: NotRequired[OnEnterLifecycleTypeDef],  # (2)
    onExit: NotRequired[OnExitLifecycleTypeDef],  # (3)
  1. See OnInputLifecycleTypeDef
  2. See OnEnterLifecycleTypeDef
  3. See OnExitLifecycleTypeDef

DescribeAlarmModelResponseTypeDef#

# DescribeAlarmModelResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DescribeAlarmModelResponseTypeDef


def get_value() -> DescribeAlarmModelResponseTypeDef:
    return {
        "creationTime": ...,
    }


# DescribeAlarmModelResponseTypeDef definition

class DescribeAlarmModelResponseTypeDef(TypedDict):
    creationTime: datetime,
    alarmModelArn: str,
    alarmModelVersion: str,
    lastUpdateTime: datetime,
    status: AlarmModelVersionStatusType,  # (1)
    statusMessage: str,
    alarmModelName: str,
    alarmModelDescription: str,
    roleArn: str,
    key: str,
    severity: int,
    alarmRule: AlarmRuleTypeDef,  # (2)
    alarmNotification: AlarmNotificationOutputTypeDef,  # (3)
    alarmEventActions: AlarmEventActionsOutputTypeDef,  # (4)
    alarmCapabilities: AlarmCapabilitiesTypeDef,  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See AlarmModelVersionStatusType
  2. See AlarmRuleTypeDef
  3. See AlarmNotificationOutputTypeDef
  4. See AlarmEventActionsOutputTypeDef
  5. See AlarmCapabilitiesTypeDef
  6. See ResponseMetadataTypeDef

DetectorModelDefinitionOutputTypeDef#

# DetectorModelDefinitionOutputTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DetectorModelDefinitionOutputTypeDef


def get_value() -> DetectorModelDefinitionOutputTypeDef:
    return {
        "states": ...,
    }


# DetectorModelDefinitionOutputTypeDef definition

class DetectorModelDefinitionOutputTypeDef(TypedDict):
    states: List[StateOutputTypeDef],  # (1)
    initialStateName: str,
  1. See StateOutputTypeDef

DetectorModelDefinitionTypeDef#

# DetectorModelDefinitionTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DetectorModelDefinitionTypeDef


def get_value() -> DetectorModelDefinitionTypeDef:
    return {
        "states": ...,
    }


# DetectorModelDefinitionTypeDef definition

class DetectorModelDefinitionTypeDef(TypedDict):
    states: Sequence[StateTypeDef],  # (1)
    initialStateName: str,
  1. See StateTypeDef

CreateAlarmModelRequestTypeDef#

# CreateAlarmModelRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import CreateAlarmModelRequestTypeDef


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


# CreateAlarmModelRequestTypeDef definition

class CreateAlarmModelRequestTypeDef(TypedDict):
    alarmModelName: str,
    roleArn: str,
    alarmRule: AlarmRuleTypeDef,  # (1)
    alarmModelDescription: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    key: NotRequired[str],
    severity: NotRequired[int],
    alarmNotification: NotRequired[AlarmNotificationUnionTypeDef],  # (3)
    alarmEventActions: NotRequired[AlarmEventActionsUnionTypeDef],  # (4)
    alarmCapabilities: NotRequired[AlarmCapabilitiesTypeDef],  # (5)
  1. See AlarmRuleTypeDef
  2. See TagTypeDef
  3. See AlarmNotificationTypeDef AlarmNotificationOutputTypeDef
  4. See AlarmEventActionsTypeDef AlarmEventActionsOutputTypeDef
  5. See AlarmCapabilitiesTypeDef

UpdateAlarmModelRequestTypeDef#

# UpdateAlarmModelRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import UpdateAlarmModelRequestTypeDef


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


# UpdateAlarmModelRequestTypeDef definition

class UpdateAlarmModelRequestTypeDef(TypedDict):
    alarmModelName: str,
    roleArn: str,
    alarmRule: AlarmRuleTypeDef,  # (1)
    alarmModelDescription: NotRequired[str],
    severity: NotRequired[int],
    alarmNotification: NotRequired[AlarmNotificationUnionTypeDef],  # (2)
    alarmEventActions: NotRequired[AlarmEventActionsUnionTypeDef],  # (3)
    alarmCapabilities: NotRequired[AlarmCapabilitiesTypeDef],  # (4)
  1. See AlarmRuleTypeDef
  2. See AlarmNotificationTypeDef AlarmNotificationOutputTypeDef
  3. See AlarmEventActionsTypeDef AlarmEventActionsOutputTypeDef
  4. See AlarmCapabilitiesTypeDef

DetectorModelTypeDef#

# DetectorModelTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DetectorModelTypeDef


def get_value() -> DetectorModelTypeDef:
    return {
        "detectorModelDefinition": ...,
    }


# DetectorModelTypeDef definition

class DetectorModelTypeDef(TypedDict):
    detectorModelDefinition: NotRequired[DetectorModelDefinitionOutputTypeDef],  # (1)
    detectorModelConfiguration: NotRequired[DetectorModelConfigurationTypeDef],  # (2)
  1. See DetectorModelDefinitionOutputTypeDef
  2. See DetectorModelConfigurationTypeDef

DescribeDetectorModelResponseTypeDef#

# DescribeDetectorModelResponseTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import DescribeDetectorModelResponseTypeDef


def get_value() -> DescribeDetectorModelResponseTypeDef:
    return {
        "detectorModel": ...,
    }


# DescribeDetectorModelResponseTypeDef definition

class DescribeDetectorModelResponseTypeDef(TypedDict):
    detectorModel: DetectorModelTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DetectorModelTypeDef
  2. See ResponseMetadataTypeDef

CreateDetectorModelRequestTypeDef#

# CreateDetectorModelRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import CreateDetectorModelRequestTypeDef


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


# CreateDetectorModelRequestTypeDef definition

class CreateDetectorModelRequestTypeDef(TypedDict):
    detectorModelName: str,
    detectorModelDefinition: DetectorModelDefinitionUnionTypeDef,  # (1)
    roleArn: str,
    detectorModelDescription: NotRequired[str],
    key: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    evaluationMethod: NotRequired[EvaluationMethodType],  # (3)
  1. See DetectorModelDefinitionTypeDef DetectorModelDefinitionOutputTypeDef
  2. See TagTypeDef
  3. See EvaluationMethodType

StartDetectorModelAnalysisRequestTypeDef#

# StartDetectorModelAnalysisRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import StartDetectorModelAnalysisRequestTypeDef


def get_value() -> StartDetectorModelAnalysisRequestTypeDef:
    return {
        "detectorModelDefinition": ...,
    }


# StartDetectorModelAnalysisRequestTypeDef definition

class StartDetectorModelAnalysisRequestTypeDef(TypedDict):
    detectorModelDefinition: DetectorModelDefinitionUnionTypeDef,  # (1)
  1. See DetectorModelDefinitionTypeDef DetectorModelDefinitionOutputTypeDef

UpdateDetectorModelRequestTypeDef#

# UpdateDetectorModelRequestTypeDef TypedDict usage example

from mypy_boto3_iotevents.type_defs import UpdateDetectorModelRequestTypeDef


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


# UpdateDetectorModelRequestTypeDef definition

class UpdateDetectorModelRequestTypeDef(TypedDict):
    detectorModelName: str,
    detectorModelDefinition: DetectorModelDefinitionUnionTypeDef,  # (1)
    roleArn: str,
    detectorModelDescription: NotRequired[str],
    evaluationMethod: NotRequired[EvaluationMethodType],  # (2)
  1. See DetectorModelDefinitionTypeDef DetectorModelDefinitionOutputTypeDef
  2. See EvaluationMethodType