Skip to content

Type definitions#

Index > IoTEvents > Type definitions

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

EmailRecipientsUnionTypeDef#

# EmailRecipientsUnionTypeDef definition

EmailRecipientsUnionTypeDef = Union[
    EmailRecipientsTypeDef,  # (1)
    EmailRecipientsOutputTypeDef,  # (2)
]
  1. See EmailRecipientsTypeDef
  2. See EmailRecipientsOutputTypeDef

SMSConfigurationUnionTypeDef#

# SMSConfigurationUnionTypeDef definition

SMSConfigurationUnionTypeDef = Union[
    SMSConfigurationTypeDef,  # (1)
    SMSConfigurationOutputTypeDef,  # (2)
]
  1. See SMSConfigurationTypeDef
  2. See SMSConfigurationOutputTypeDef

EventUnionTypeDef#

# EventUnionTypeDef definition

EventUnionTypeDef = Union[
    EventTypeDef,  # (1)
    EventOutputTypeDef,  # (2)
]
  1. See EventTypeDef
  2. See EventOutputTypeDef

TransitionEventUnionTypeDef#

# TransitionEventUnionTypeDef definition

TransitionEventUnionTypeDef = Union[
    TransitionEventTypeDef,  # (1)
    TransitionEventOutputTypeDef,  # (2)
]
  1. See TransitionEventTypeDef
  2. See TransitionEventOutputTypeDef

EmailConfigurationUnionTypeDef#

# EmailConfigurationUnionTypeDef definition

EmailConfigurationUnionTypeDef = Union[
    EmailConfigurationTypeDef,  # (1)
    EmailConfigurationOutputTypeDef,  # (2)
]
  1. See EmailConfigurationTypeDef
  2. See EmailConfigurationOutputTypeDef

OnEnterLifecycleUnionTypeDef#

# OnEnterLifecycleUnionTypeDef definition

OnEnterLifecycleUnionTypeDef = Union[
    OnEnterLifecycleTypeDef,  # (1)
    OnEnterLifecycleOutputTypeDef,  # (2)
]
  1. See OnEnterLifecycleTypeDef
  2. See OnEnterLifecycleOutputTypeDef

OnExitLifecycleUnionTypeDef#

# OnExitLifecycleUnionTypeDef definition

OnExitLifecycleUnionTypeDef = Union[
    OnExitLifecycleTypeDef,  # (1)
    OnExitLifecycleOutputTypeDef,  # (2)
]
  1. See OnExitLifecycleTypeDef
  2. See OnExitLifecycleOutputTypeDef

OnInputLifecycleUnionTypeDef#

# OnInputLifecycleUnionTypeDef definition

OnInputLifecycleUnionTypeDef = Union[
    OnInputLifecycleTypeDef,  # (1)
    OnInputLifecycleOutputTypeDef,  # (2)
]
  1. See OnInputLifecycleTypeDef
  2. See OnInputLifecycleOutputTypeDef

NotificationActionUnionTypeDef#

# NotificationActionUnionTypeDef definition

NotificationActionUnionTypeDef = Union[
    NotificationActionTypeDef,  # (1)
    NotificationActionOutputTypeDef,  # (2)
]
  1. See NotificationActionTypeDef
  2. See NotificationActionOutputTypeDef

StateUnionTypeDef#

# StateUnionTypeDef definition

StateUnionTypeDef = Union[
    StateTypeDef,  # (1)
    StateOutputTypeDef,  # (2)
]
  1. See StateTypeDef
  2. See StateOutputTypeDef

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

InputDefinitionOutputTypeDef#

# InputDefinitionOutputTypeDef definition

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

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)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AlarmModelVersionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAlarmModelsResponseTypeDef#

# ListAlarmModelsResponseTypeDef definition

class ListAlarmModelsResponseTypeDef(TypedDict):
    alarmModelSummaries: list[AlarmModelSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  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

LoggingOptionsOutputTypeDef#

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

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

ListDetectorModelsResponseTypeDef#

# ListDetectorModelsResponseTypeDef definition

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

ListDetectorModelVersionsResponseTypeDef#

# ListDetectorModelVersionsResponseTypeDef definition

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

DynamoDBActionTypeDef#

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

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

FirehoseActionTypeDef#

# FirehoseActionTypeDef definition

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

IotEventsActionTypeDef#

# IotEventsActionTypeDef definition

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

IotTopicPublishActionTypeDef#

# IotTopicPublishActionTypeDef definition

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

LambdaActionTypeDef#

# LambdaActionTypeDef definition

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

SNSTopicPublishActionTypeDef#

# SNSTopicPublishActionTypeDef definition

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

SqsActionTypeDef#

# SqsActionTypeDef definition

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

ListInputsResponseTypeDef#

# ListInputsResponseTypeDef definition

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

IotSiteWiseInputIdentifierTypeDef#

# IotSiteWiseInputIdentifierTypeDef definition

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

ListInputRoutingsResponseTypeDef#

# ListInputRoutingsResponseTypeDef definition

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

RecipientDetailTypeDef#

# RecipientDetailTypeDef definition

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

GetDetectorModelAnalysisResultsResponseTypeDef#

# GetDetectorModelAnalysisResultsResponseTypeDef definition

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

IotSiteWiseActionTypeDef#

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

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

CreateInputRequestRequestTypeDef#

# CreateInputRequestRequestTypeDef definition

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

UpdateInputRequestRequestTypeDef#

# UpdateInputRequestRequestTypeDef definition

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

DescribeLoggingOptionsResponseTypeDef#

# DescribeLoggingOptionsResponseTypeDef definition

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

PutLoggingOptionsRequestRequestTypeDef#

# PutLoggingOptionsRequestRequestTypeDef definition

class PutLoggingOptionsRequestRequestTypeDef(TypedDict):
    loggingOptions: LoggingOptionsTypeDef,  # (1)
  1. See LoggingOptionsTypeDef

NotificationTargetActionsTypeDef#

# NotificationTargetActionsTypeDef definition

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

InputIdentifierTypeDef#

# InputIdentifierTypeDef definition

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

EmailRecipientsOutputTypeDef#

# EmailRecipientsOutputTypeDef definition

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

EmailRecipientsTypeDef#

# EmailRecipientsTypeDef definition

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

SMSConfigurationOutputTypeDef#

# SMSConfigurationOutputTypeDef definition

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

SMSConfigurationTypeDef#

# SMSConfigurationTypeDef definition

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

ActionTypeDef#

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

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

ListInputRoutingsRequestRequestTypeDef#

# ListInputRoutingsRequestRequestTypeDef definition

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

EmailConfigurationOutputTypeDef#

# EmailConfigurationOutputTypeDef definition

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

EventOutputTypeDef#

# EventOutputTypeDef definition

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

EventTypeDef#

# EventTypeDef definition

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

TransitionEventOutputTypeDef#

# TransitionEventOutputTypeDef definition

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

TransitionEventTypeDef#

# TransitionEventTypeDef definition

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

AlarmEventActionsOutputTypeDef#

# AlarmEventActionsOutputTypeDef definition

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

AlarmEventActionsTypeDef#

# AlarmEventActionsTypeDef definition

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

NotificationActionOutputTypeDef#

# 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

EmailConfigurationTypeDef#

# EmailConfigurationTypeDef definition

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

OnEnterLifecycleOutputTypeDef#

# OnEnterLifecycleOutputTypeDef definition

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

OnExitLifecycleOutputTypeDef#

# OnExitLifecycleOutputTypeDef definition

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

OnEnterLifecycleTypeDef#

# OnEnterLifecycleTypeDef definition

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

OnInputLifecycleOutputTypeDef#

# OnInputLifecycleOutputTypeDef definition

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

AlarmNotificationOutputTypeDef#

# AlarmNotificationOutputTypeDef definition

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

OnExitLifecycleTypeDef#

# OnExitLifecycleTypeDef definition

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

StateOutputTypeDef#

# 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

OnInputLifecycleTypeDef#

# OnInputLifecycleTypeDef definition

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

DescribeAlarmModelResponseTypeDef#

# 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

NotificationActionTypeDef#

# NotificationActionTypeDef definition

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

DetectorModelDefinitionOutputTypeDef#

# DetectorModelDefinitionOutputTypeDef definition

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

DetectorModelTypeDef#

# DetectorModelTypeDef definition

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

StateTypeDef#

# StateTypeDef definition

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

AlarmNotificationTypeDef#

# AlarmNotificationTypeDef definition

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

DescribeDetectorModelResponseTypeDef#

# DescribeDetectorModelResponseTypeDef definition

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

CreateAlarmModelRequestRequestTypeDef#

# CreateAlarmModelRequestRequestTypeDef definition

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

UpdateAlarmModelRequestRequestTypeDef#

# UpdateAlarmModelRequestRequestTypeDef definition

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

DetectorModelDefinitionTypeDef#

# DetectorModelDefinitionTypeDef definition

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

CreateDetectorModelRequestRequestTypeDef#

# CreateDetectorModelRequestRequestTypeDef definition

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

StartDetectorModelAnalysisRequestRequestTypeDef#

# StartDetectorModelAnalysisRequestRequestTypeDef definition

class StartDetectorModelAnalysisRequestRequestTypeDef(TypedDict):
    detectorModelDefinition: DetectorModelDefinitionTypeDef,  # (1)
  1. See DetectorModelDefinitionTypeDef

UpdateDetectorModelRequestRequestTypeDef#

# UpdateDetectorModelRequestRequestTypeDef definition

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