Skip to content

Type definitions#

Index > IoTEvents > Type definitions

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

AcknowledgeFlowTypeDef#

# AcknowledgeFlowTypeDef definition

class AcknowledgeFlowTypeDef(TypedDict):
    enabled: bool,

ClearTimerActionTypeDef#

# ClearTimerActionTypeDef definition

class ClearTimerActionTypeDef(TypedDict):
    timerName: str,

ResetTimerActionTypeDef#

# ResetTimerActionTypeDef definition

class ResetTimerActionTypeDef(TypedDict):
    timerName: str,

SetTimerActionTypeDef#

# SetTimerActionTypeDef definition

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

SetVariableActionTypeDef#

# SetVariableActionTypeDef definition

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

InitializationConfigurationTypeDef#

# InitializationConfigurationTypeDef definition

class InitializationConfigurationTypeDef(TypedDict):
    disabledOnInitialization: bool,

AlarmModelSummaryTypeDef#

# AlarmModelSummaryTypeDef definition

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

AlarmModelVersionSummaryTypeDef#

# 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 definition

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

AnalysisResultLocationTypeDef#

# AnalysisResultLocationTypeDef definition

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

AssetPropertyTimestampTypeDef#

# AssetPropertyTimestampTypeDef definition

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

AssetPropertyVariantTypeDef#

# AssetPropertyVariantTypeDef definition

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

AttributeTypeDef#

# AttributeTypeDef definition

class AttributeTypeDef(TypedDict):
    jsonPath: str,

TagTypeDef#

# TagTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DetectorModelConfigurationTypeDef#

# 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 definition

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

DeleteAlarmModelRequestRequestTypeDef#

# DeleteAlarmModelRequestRequestTypeDef definition

class DeleteAlarmModelRequestRequestTypeDef(TypedDict):
    alarmModelName: str,

DeleteDetectorModelRequestRequestTypeDef#

# DeleteDetectorModelRequestRequestTypeDef definition

class DeleteDetectorModelRequestRequestTypeDef(TypedDict):
    detectorModelName: str,

DeleteInputRequestRequestTypeDef#

# DeleteInputRequestRequestTypeDef definition

class DeleteInputRequestRequestTypeDef(TypedDict):
    inputName: str,

DescribeAlarmModelRequestRequestTypeDef#

# DescribeAlarmModelRequestRequestTypeDef definition

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

DescribeDetectorModelAnalysisRequestRequestTypeDef#

# DescribeDetectorModelAnalysisRequestRequestTypeDef definition

class DescribeDetectorModelAnalysisRequestRequestTypeDef(TypedDict):
    analysisId: str,

DescribeDetectorModelRequestRequestTypeDef#

# DescribeDetectorModelRequestRequestTypeDef definition

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

DescribeInputRequestRequestTypeDef#

# DescribeInputRequestRequestTypeDef definition

class DescribeInputRequestRequestTypeDef(TypedDict):
    inputName: str,

DetectorDebugOptionTypeDef#

# DetectorDebugOptionTypeDef definition

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

DetectorModelSummaryTypeDef#

# DetectorModelSummaryTypeDef definition

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

DetectorModelVersionSummaryTypeDef#

# 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 definition

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

EmailContentTypeDef#

# EmailContentTypeDef definition

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

GetDetectorModelAnalysisResultsRequestRequestTypeDef#

# GetDetectorModelAnalysisResultsRequestRequestTypeDef definition

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

IotEventsInputIdentifierTypeDef#

# IotEventsInputIdentifierTypeDef definition

class IotEventsInputIdentifierTypeDef(TypedDict):
    inputName: str,

InputSummaryTypeDef#

# 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 definition

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

ListAlarmModelVersionsRequestRequestTypeDef#

# ListAlarmModelVersionsRequestRequestTypeDef definition

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

ListAlarmModelsRequestRequestTypeDef#

# ListAlarmModelsRequestRequestTypeDef definition

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

ListDetectorModelVersionsRequestRequestTypeDef#

# ListDetectorModelVersionsRequestRequestTypeDef definition

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

ListDetectorModelsRequestRequestTypeDef#

# ListDetectorModelsRequestRequestTypeDef definition

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

RoutedResourceTypeDef#

# RoutedResourceTypeDef definition

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

ListInputsRequestRequestTypeDef#

# ListInputsRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

SSOIdentityTypeDef#

# SSOIdentityTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

AlarmCapabilitiesTypeDef#

# AlarmCapabilitiesTypeDef definition

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

AlarmRuleTypeDef#

# AlarmRuleTypeDef definition

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

AnalysisResultTypeDef#

# 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 definition

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

InputDefinitionTypeDef#

# InputDefinitionTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

CreateAlarmModelResponseTypeDef#

# 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 definition

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

ListAlarmModelVersionsResponseTypeDef#

# ListAlarmModelVersionsResponseTypeDef definition

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

ListAlarmModelsResponseTypeDef#

# ListAlarmModelsResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

StartDetectorModelAnalysisResponseTypeDef#

# StartDetectorModelAnalysisResponseTypeDef definition

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

UpdateAlarmModelResponseTypeDef#

# 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 definition

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

UpdateDetectorModelResponseTypeDef#

# UpdateDetectorModelResponseTypeDef definition

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

CreateInputResponseTypeDef#

# CreateInputResponseTypeDef definition

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

UpdateInputResponseTypeDef#

# UpdateInputResponseTypeDef definition

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

LoggingOptionsTypeDef#

# LoggingOptionsTypeDef definition

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

ListDetectorModelsResponseTypeDef#

# ListDetectorModelsResponseTypeDef definition

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