Type definitions#
Auto-generated documentation for IoT type annotations stubs module types-boto3-iot.
BlobTypeDef#
# BlobTypeDef Union usage example
from types_boto3_iot.type_defs import BlobTypeDef
def get_value() -> BlobTypeDef:
return ...
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]TimestampTypeDef#
# TimestampTypeDef Union usage example
from types_boto3_iot.type_defs import TimestampTypeDef
def get_value() -> TimestampTypeDef:
return ...
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]AggregationTypeUnionTypeDef#
# AggregationTypeUnionTypeDef Union usage example
from types_boto3_iot.type_defs import AggregationTypeUnionTypeDef
def get_value() -> AggregationTypeUnionTypeDef:
return ...
# AggregationTypeUnionTypeDef definition
AggregationTypeUnionTypeDef = Union[
AggregationTypeTypeDef, # (1)
AggregationTypeOutputTypeDef, # (2)
]AttributePayloadUnionTypeDef#
# AttributePayloadUnionTypeDef Union usage example
from types_boto3_iot.type_defs import AttributePayloadUnionTypeDef
def get_value() -> AttributePayloadUnionTypeDef:
return ...
# AttributePayloadUnionTypeDef definition
AttributePayloadUnionTypeDef = Union[
AttributePayloadTypeDef, # (1)
AttributePayloadOutputTypeDef, # (2)
]AuditMitigationActionsTaskTargetUnionTypeDef#
# AuditMitigationActionsTaskTargetUnionTypeDef Union usage example
from types_boto3_iot.type_defs import AuditMitigationActionsTaskTargetUnionTypeDef
def get_value() -> AuditMitigationActionsTaskTargetUnionTypeDef:
return ...
# AuditMitigationActionsTaskTargetUnionTypeDef definition
AuditMitigationActionsTaskTargetUnionTypeDef = Union[
AuditMitigationActionsTaskTargetTypeDef, # (1)
AuditMitigationActionsTaskTargetOutputTypeDef, # (2)
]AuthInfoUnionTypeDef#
# AuthInfoUnionTypeDef Union usage example
from types_boto3_iot.type_defs import AuthInfoUnionTypeDef
def get_value() -> AuthInfoUnionTypeDef:
return ...
# AuthInfoUnionTypeDef definition
AuthInfoUnionTypeDef = Union[
AuthInfoTypeDef, # (1)
AuthInfoOutputTypeDef, # (2)
]- See AuthInfoTypeDef
- See AuthInfoOutputTypeDef
DetectMitigationActionsTaskTargetUnionTypeDef#
# DetectMitigationActionsTaskTargetUnionTypeDef Union usage example
from types_boto3_iot.type_defs import DetectMitigationActionsTaskTargetUnionTypeDef
def get_value() -> DetectMitigationActionsTaskTargetUnionTypeDef:
return ...
# DetectMitigationActionsTaskTargetUnionTypeDef definition
DetectMitigationActionsTaskTargetUnionTypeDef = Union[
DetectMitigationActionsTaskTargetTypeDef, # (1)
DetectMitigationActionsTaskTargetOutputTypeDef, # (2)
]MetricValueUnionTypeDef#
# MetricValueUnionTypeDef Union usage example
from types_boto3_iot.type_defs import MetricValueUnionTypeDef
def get_value() -> MetricValueUnionTypeDef:
return ...
# MetricValueUnionTypeDef definition
MetricValueUnionTypeDef = Union[
MetricValueTypeDef, # (1)
MetricValueOutputTypeDef, # (2)
]AbortConfigUnionTypeDef#
# AbortConfigUnionTypeDef Union usage example
from types_boto3_iot.type_defs import AbortConfigUnionTypeDef
def get_value() -> AbortConfigUnionTypeDef:
return ...
# AbortConfigUnionTypeDef definition
AbortConfigUnionTypeDef = Union[
AbortConfigTypeDef, # (1)
AbortConfigOutputTypeDef, # (2)
]ThingGroupPropertiesUnionTypeDef#
# ThingGroupPropertiesUnionTypeDef Union usage example
from types_boto3_iot.type_defs import ThingGroupPropertiesUnionTypeDef
def get_value() -> ThingGroupPropertiesUnionTypeDef:
return ...
# ThingGroupPropertiesUnionTypeDef definition
ThingGroupPropertiesUnionTypeDef = Union[
ThingGroupPropertiesTypeDef, # (1)
ThingGroupPropertiesOutputTypeDef, # (2)
]CodeSigningSignatureUnionTypeDef#
# CodeSigningSignatureUnionTypeDef Union usage example
from types_boto3_iot.type_defs import CodeSigningSignatureUnionTypeDef
def get_value() -> CodeSigningSignatureUnionTypeDef:
return ...
# CodeSigningSignatureUnionTypeDef definition
CodeSigningSignatureUnionTypeDef = Union[
CodeSigningSignatureTypeDef, # (1)
CodeSigningSignatureOutputTypeDef, # (2)
]CommandParameterValueUnionTypeDef#
# CommandParameterValueUnionTypeDef Union usage example
from types_boto3_iot.type_defs import CommandParameterValueUnionTypeDef
def get_value() -> CommandParameterValueUnionTypeDef:
return ...
# CommandParameterValueUnionTypeDef definition
CommandParameterValueUnionTypeDef = Union[
CommandParameterValueTypeDef, # (1)
CommandParameterValueOutputTypeDef, # (2)
]CommandPayloadUnionTypeDef#
# CommandPayloadUnionTypeDef Union usage example
from types_boto3_iot.type_defs import CommandPayloadUnionTypeDef
def get_value() -> CommandPayloadUnionTypeDef:
return ...
# CommandPayloadUnionTypeDef definition
CommandPayloadUnionTypeDef = Union[
CommandPayloadTypeDef, # (1)
CommandPayloadOutputTypeDef, # (2)
]ViolationEventOccurrenceRangeUnionTypeDef#
# ViolationEventOccurrenceRangeUnionTypeDef Union usage example
from types_boto3_iot.type_defs import ViolationEventOccurrenceRangeUnionTypeDef
def get_value() -> ViolationEventOccurrenceRangeUnionTypeDef:
return ...
# ViolationEventOccurrenceRangeUnionTypeDef definition
ViolationEventOccurrenceRangeUnionTypeDef = Union[
ViolationEventOccurrenceRangeTypeDef, # (1)
ViolationEventOccurrenceRangeOutputTypeDef, # (2)
]SchedulingConfigUnionTypeDef#
# SchedulingConfigUnionTypeDef Union usage example
from types_boto3_iot.type_defs import SchedulingConfigUnionTypeDef
def get_value() -> SchedulingConfigUnionTypeDef:
return ...
# SchedulingConfigUnionTypeDef definition
SchedulingConfigUnionTypeDef = Union[
SchedulingConfigTypeDef, # (1)
SchedulingConfigOutputTypeDef, # (2)
]ThingGroupIndexingConfigurationUnionTypeDef#
# ThingGroupIndexingConfigurationUnionTypeDef Union usage example
from types_boto3_iot.type_defs import ThingGroupIndexingConfigurationUnionTypeDef
def get_value() -> ThingGroupIndexingConfigurationUnionTypeDef:
return ...
# ThingGroupIndexingConfigurationUnionTypeDef definition
ThingGroupIndexingConfigurationUnionTypeDef = Union[
ThingGroupIndexingConfigurationTypeDef, # (1)
ThingGroupIndexingConfigurationOutputTypeDef, # (2)
]JobExecutionsRetryConfigUnionTypeDef#
# JobExecutionsRetryConfigUnionTypeDef Union usage example
from types_boto3_iot.type_defs import JobExecutionsRetryConfigUnionTypeDef
def get_value() -> JobExecutionsRetryConfigUnionTypeDef:
return ...
# JobExecutionsRetryConfigUnionTypeDef definition
JobExecutionsRetryConfigUnionTypeDef = Union[
JobExecutionsRetryConfigTypeDef, # (1)
JobExecutionsRetryConfigOutputTypeDef, # (2)
]KafkaActionUnionTypeDef#
# KafkaActionUnionTypeDef Union usage example
from types_boto3_iot.type_defs import KafkaActionUnionTypeDef
def get_value() -> KafkaActionUnionTypeDef:
return ...
# KafkaActionUnionTypeDef definition
KafkaActionUnionTypeDef = Union[
KafkaActionTypeDef, # (1)
KafkaActionOutputTypeDef, # (2)
]MitigationActionParamsUnionTypeDef#
# MitigationActionParamsUnionTypeDef Union usage example
from types_boto3_iot.type_defs import MitigationActionParamsUnionTypeDef
def get_value() -> MitigationActionParamsUnionTypeDef:
return ...
# MitigationActionParamsUnionTypeDef definition
MitigationActionParamsUnionTypeDef = Union[
MitigationActionParamsTypeDef, # (1)
MitigationActionParamsOutputTypeDef, # (2)
]MqttHeadersUnionTypeDef#
# MqttHeadersUnionTypeDef Union usage example
from types_boto3_iot.type_defs import MqttHeadersUnionTypeDef
def get_value() -> MqttHeadersUnionTypeDef:
return ...
# MqttHeadersUnionTypeDef definition
MqttHeadersUnionTypeDef = Union[
MqttHeadersTypeDef, # (1)
MqttHeadersOutputTypeDef, # (2)
]TimestreamActionUnionTypeDef#
# TimestreamActionUnionTypeDef Union usage example
from types_boto3_iot.type_defs import TimestreamActionUnionTypeDef
def get_value() -> TimestreamActionUnionTypeDef:
return ...
# TimestreamActionUnionTypeDef definition
TimestreamActionUnionTypeDef = Union[
TimestreamActionTypeDef, # (1)
TimestreamActionOutputTypeDef, # (2)
]PutAssetPropertyValueEntryUnionTypeDef#
# PutAssetPropertyValueEntryUnionTypeDef Union usage example
from types_boto3_iot.type_defs import PutAssetPropertyValueEntryUnionTypeDef
def get_value() -> PutAssetPropertyValueEntryUnionTypeDef:
return ...
# PutAssetPropertyValueEntryUnionTypeDef definition
PutAssetPropertyValueEntryUnionTypeDef = Union[
PutAssetPropertyValueEntryTypeDef, # (1)
PutAssetPropertyValueEntryOutputTypeDef, # (2)
]ThingIndexingConfigurationUnionTypeDef#
# ThingIndexingConfigurationUnionTypeDef Union usage example
from types_boto3_iot.type_defs import ThingIndexingConfigurationUnionTypeDef
def get_value() -> ThingIndexingConfigurationUnionTypeDef:
return ...
# ThingIndexingConfigurationUnionTypeDef definition
ThingIndexingConfigurationUnionTypeDef = Union[
ThingIndexingConfigurationTypeDef, # (1)
ThingIndexingConfigurationOutputTypeDef, # (2)
]HttpActionUnionTypeDef#
# HttpActionUnionTypeDef Union usage example
from types_boto3_iot.type_defs import HttpActionUnionTypeDef
def get_value() -> HttpActionUnionTypeDef:
return ...
# HttpActionUnionTypeDef definition
HttpActionUnionTypeDef = Union[
HttpActionTypeDef, # (1)
HttpActionOutputTypeDef, # (2)
]BehaviorCriteriaUnionTypeDef#
# BehaviorCriteriaUnionTypeDef Union usage example
from types_boto3_iot.type_defs import BehaviorCriteriaUnionTypeDef
def get_value() -> BehaviorCriteriaUnionTypeDef:
return ...
# BehaviorCriteriaUnionTypeDef definition
BehaviorCriteriaUnionTypeDef = Union[
BehaviorCriteriaTypeDef, # (1)
BehaviorCriteriaOutputTypeDef, # (2)
]ThingTypePropertiesUnionTypeDef#
# ThingTypePropertiesUnionTypeDef Union usage example
from types_boto3_iot.type_defs import ThingTypePropertiesUnionTypeDef
def get_value() -> ThingTypePropertiesUnionTypeDef:
return ...
# ThingTypePropertiesUnionTypeDef definition
ThingTypePropertiesUnionTypeDef = Union[
ThingTypePropertiesTypeDef, # (1)
ThingTypePropertiesOutputTypeDef, # (2)
]CustomCodeSigningUnionTypeDef#
# CustomCodeSigningUnionTypeDef Union usage example
from types_boto3_iot.type_defs import CustomCodeSigningUnionTypeDef
def get_value() -> CustomCodeSigningUnionTypeDef:
return ...
# CustomCodeSigningUnionTypeDef definition
CustomCodeSigningUnionTypeDef = Union[
CustomCodeSigningTypeDef, # (1)
CustomCodeSigningOutputTypeDef, # (2)
]CommandParameterUnionTypeDef#
# CommandParameterUnionTypeDef Union usage example
from types_boto3_iot.type_defs import CommandParameterUnionTypeDef
def get_value() -> CommandParameterUnionTypeDef:
return ...
# CommandParameterUnionTypeDef definition
CommandParameterUnionTypeDef = Union[
CommandParameterTypeDef, # (1)
CommandParameterOutputTypeDef, # (2)
]RepublishActionUnionTypeDef#
# RepublishActionUnionTypeDef Union usage example
from types_boto3_iot.type_defs import RepublishActionUnionTypeDef
def get_value() -> RepublishActionUnionTypeDef:
return ...
# RepublishActionUnionTypeDef definition
RepublishActionUnionTypeDef = Union[
RepublishActionTypeDef, # (1)
RepublishActionOutputTypeDef, # (2)
]IotSiteWiseActionUnionTypeDef#
# IotSiteWiseActionUnionTypeDef Union usage example
from types_boto3_iot.type_defs import IotSiteWiseActionUnionTypeDef
def get_value() -> IotSiteWiseActionUnionTypeDef:
return ...
# IotSiteWiseActionUnionTypeDef definition
IotSiteWiseActionUnionTypeDef = Union[
IotSiteWiseActionTypeDef, # (1)
IotSiteWiseActionOutputTypeDef, # (2)
]BehaviorUnionTypeDef#
# BehaviorUnionTypeDef Union usage example
from types_boto3_iot.type_defs import BehaviorUnionTypeDef
def get_value() -> BehaviorUnionTypeDef:
return ...
# BehaviorUnionTypeDef definition
BehaviorUnionTypeDef = Union[
BehaviorTypeDef, # (1)
BehaviorOutputTypeDef, # (2)
]- See BehaviorTypeDef
- See BehaviorOutputTypeDef
CodeSigningUnionTypeDef#
# CodeSigningUnionTypeDef Union usage example
from types_boto3_iot.type_defs import CodeSigningUnionTypeDef
def get_value() -> CodeSigningUnionTypeDef:
return ...
# CodeSigningUnionTypeDef definition
CodeSigningUnionTypeDef = Union[
CodeSigningTypeDef, # (1)
CodeSigningOutputTypeDef, # (2)
]ActionUnionTypeDef#
# ActionUnionTypeDef Union usage example
from types_boto3_iot.type_defs import ActionUnionTypeDef
def get_value() -> ActionUnionTypeDef:
return ...
# ActionUnionTypeDef definition
ActionUnionTypeDef = Union[
ActionTypeDef, # (1)
ActionOutputTypeDef, # (2)
]- See ActionTypeDef
- See ActionOutputTypeDef
OTAUpdateFileUnionTypeDef#
# OTAUpdateFileUnionTypeDef Union usage example
from types_boto3_iot.type_defs import OTAUpdateFileUnionTypeDef
def get_value() -> OTAUpdateFileUnionTypeDef:
return ...
# OTAUpdateFileUnionTypeDef definition
OTAUpdateFileUnionTypeDef = Union[
OTAUpdateFileTypeDef, # (1)
OTAUpdateFileOutputTypeDef, # (2)
]AbortCriteriaTypeDef#
# AbortCriteriaTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AbortCriteriaTypeDef
def get_value() -> AbortCriteriaTypeDef:
return {
"failureType": ...,
}
# AbortCriteriaTypeDef definition
class AbortCriteriaTypeDef(TypedDict):
failureType: JobExecutionFailureTypeType, # (1)
action: AbortActionType, # (2)
thresholdPercentage: float,
minNumberOfExecutedThings: int,AcceptCertificateTransferRequestTypeDef#
# AcceptCertificateTransferRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AcceptCertificateTransferRequestTypeDef
def get_value() -> AcceptCertificateTransferRequestTypeDef:
return {
"certificateId": ...,
}
# AcceptCertificateTransferRequestTypeDef definition
class AcceptCertificateTransferRequestTypeDef(TypedDict):
certificateId: str,
setAsActive: NotRequired[bool],CloudwatchAlarmActionTypeDef#
# CloudwatchAlarmActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CloudwatchAlarmActionTypeDef
def get_value() -> CloudwatchAlarmActionTypeDef:
return {
"roleArn": ...,
}
# CloudwatchAlarmActionTypeDef definition
class CloudwatchAlarmActionTypeDef(TypedDict):
roleArn: str,
alarmName: str,
stateReason: str,
stateValue: str,CloudwatchLogsActionTypeDef#
# CloudwatchLogsActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CloudwatchLogsActionTypeDef
def get_value() -> CloudwatchLogsActionTypeDef:
return {
"roleArn": ...,
}
# CloudwatchLogsActionTypeDef definition
class CloudwatchLogsActionTypeDef(TypedDict):
roleArn: str,
logGroupName: str,
batchMode: NotRequired[bool],CloudwatchMetricActionTypeDef#
# CloudwatchMetricActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CloudwatchMetricActionTypeDef
def get_value() -> CloudwatchMetricActionTypeDef:
return {
"roleArn": ...,
}
# CloudwatchMetricActionTypeDef definition
class CloudwatchMetricActionTypeDef(TypedDict):
roleArn: str,
metricNamespace: str,
metricName: str,
metricValue: str,
metricUnit: str,
metricTimestamp: NotRequired[str],DynamoDBActionTypeDef#
# DynamoDBActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DynamoDBActionTypeDef
def get_value() -> DynamoDBActionTypeDef:
return {
"tableName": ...,
}
# DynamoDBActionTypeDef definition
class DynamoDBActionTypeDef(TypedDict):
tableName: str,
roleArn: str,
hashKeyField: str,
hashKeyValue: str,
operation: NotRequired[str],
hashKeyType: NotRequired[DynamoKeyTypeType], # (1)
rangeKeyField: NotRequired[str],
rangeKeyValue: NotRequired[str],
rangeKeyType: NotRequired[DynamoKeyTypeType], # (1)
payloadField: NotRequired[str],- See DynamoKeyTypeType
- See DynamoKeyTypeType
ElasticsearchActionTypeDef#
# ElasticsearchActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ElasticsearchActionTypeDef
def get_value() -> ElasticsearchActionTypeDef:
return {
"roleArn": ...,
}
# ElasticsearchActionTypeDef definition
class ElasticsearchActionTypeDef(TypedDict):
roleArn: str,
endpoint: str,
index: str,
type: str,
id: str,FirehoseActionTypeDef#
# FirehoseActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import FirehoseActionTypeDef
def get_value() -> FirehoseActionTypeDef:
return {
"roleArn": ...,
}
# FirehoseActionTypeDef definition
class FirehoseActionTypeDef(TypedDict):
roleArn: str,
deliveryStreamName: str,
separator: NotRequired[str],
batchMode: NotRequired[bool],IotAnalyticsActionTypeDef#
# IotAnalyticsActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import IotAnalyticsActionTypeDef
def get_value() -> IotAnalyticsActionTypeDef:
return {
"channelArn": ...,
}
# IotAnalyticsActionTypeDef definition
class IotAnalyticsActionTypeDef(TypedDict):
channelArn: NotRequired[str],
channelName: NotRequired[str],
batchMode: NotRequired[bool],
roleArn: NotRequired[str],IotEventsActionTypeDef#
# IotEventsActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import IotEventsActionTypeDef
def get_value() -> IotEventsActionTypeDef:
return {
"inputName": ...,
}
# IotEventsActionTypeDef definition
class IotEventsActionTypeDef(TypedDict):
inputName: str,
roleArn: str,
messageId: NotRequired[str],
batchMode: NotRequired[bool],KinesisActionTypeDef#
# KinesisActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import KinesisActionTypeDef
def get_value() -> KinesisActionTypeDef:
return {
"roleArn": ...,
}
# KinesisActionTypeDef definition
class KinesisActionTypeDef(TypedDict):
roleArn: str,
streamName: str,
partitionKey: NotRequired[str],LambdaActionTypeDef#
# LambdaActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import LambdaActionTypeDef
def get_value() -> LambdaActionTypeDef:
return {
"functionArn": ...,
}
# LambdaActionTypeDef definition
class LambdaActionTypeDef(TypedDict):
functionArn: str,OpenSearchActionTypeDef#
# OpenSearchActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import OpenSearchActionTypeDef
def get_value() -> OpenSearchActionTypeDef:
return {
"roleArn": ...,
}
# OpenSearchActionTypeDef definition
class OpenSearchActionTypeDef(TypedDict):
roleArn: str,
endpoint: str,
index: str,
type: str,
id: str,S3ActionTypeDef#
# S3ActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import S3ActionTypeDef
def get_value() -> S3ActionTypeDef:
return {
"roleArn": ...,
}
# S3ActionTypeDef definition
class S3ActionTypeDef(TypedDict):
roleArn: str,
bucketName: str,
key: str,
cannedAcl: NotRequired[CannedAccessControlListType], # (1)SalesforceActionTypeDef#
# SalesforceActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SalesforceActionTypeDef
def get_value() -> SalesforceActionTypeDef:
return {
"token": ...,
}
# SalesforceActionTypeDef definition
class SalesforceActionTypeDef(TypedDict):
token: str,
url: str,SnsActionTypeDef#
# SnsActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SnsActionTypeDef
def get_value() -> SnsActionTypeDef:
return {
"targetArn": ...,
}
# SnsActionTypeDef definition
class SnsActionTypeDef(TypedDict):
targetArn: str,
roleArn: str,
messageFormat: NotRequired[MessageFormatType], # (1)SqsActionTypeDef#
# SqsActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SqsActionTypeDef
def get_value() -> SqsActionTypeDef:
return {
"roleArn": ...,
}
# SqsActionTypeDef definition
class SqsActionTypeDef(TypedDict):
roleArn: str,
queueUrl: str,
useBase64: NotRequired[bool],StepFunctionsActionTypeDef#
# StepFunctionsActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StepFunctionsActionTypeDef
def get_value() -> StepFunctionsActionTypeDef:
return {
"executionNamePrefix": ...,
}
# StepFunctionsActionTypeDef definition
class StepFunctionsActionTypeDef(TypedDict):
stateMachineName: str,
roleArn: str,
executionNamePrefix: NotRequired[str],MetricValueOutputTypeDef#
# MetricValueOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import MetricValueOutputTypeDef
def get_value() -> MetricValueOutputTypeDef:
return {
"count": ...,
}
# MetricValueOutputTypeDef definition
class MetricValueOutputTypeDef(TypedDict):
count: NotRequired[int],
cidrs: NotRequired[List[str]],
ports: NotRequired[List[int]],
number: NotRequired[float],
numbers: NotRequired[List[float]],
strings: NotRequired[List[str]],ViolationEventAdditionalInfoTypeDef#
# ViolationEventAdditionalInfoTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ViolationEventAdditionalInfoTypeDef
def get_value() -> ViolationEventAdditionalInfoTypeDef:
return {
"confidenceLevel": ...,
}
# ViolationEventAdditionalInfoTypeDef definition
class ViolationEventAdditionalInfoTypeDef(TypedDict):
confidenceLevel: NotRequired[ConfidenceLevelType], # (1)AddThingToBillingGroupRequestTypeDef#
# AddThingToBillingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AddThingToBillingGroupRequestTypeDef
def get_value() -> AddThingToBillingGroupRequestTypeDef:
return {
"billingGroupName": ...,
}
# AddThingToBillingGroupRequestTypeDef definition
class AddThingToBillingGroupRequestTypeDef(TypedDict):
billingGroupName: NotRequired[str],
billingGroupArn: NotRequired[str],
thingName: NotRequired[str],
thingArn: NotRequired[str],AddThingToThingGroupRequestTypeDef#
# AddThingToThingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AddThingToThingGroupRequestTypeDef
def get_value() -> AddThingToThingGroupRequestTypeDef:
return {
"thingGroupName": ...,
}
# AddThingToThingGroupRequestTypeDef definition
class AddThingToThingGroupRequestTypeDef(TypedDict):
thingGroupName: NotRequired[str],
thingGroupArn: NotRequired[str],
thingName: NotRequired[str],
thingArn: NotRequired[str],
overrideDynamicGroups: NotRequired[bool],AddThingsToThingGroupParamsOutputTypeDef#
# AddThingsToThingGroupParamsOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AddThingsToThingGroupParamsOutputTypeDef
def get_value() -> AddThingsToThingGroupParamsOutputTypeDef:
return {
"thingGroupNames": ...,
}
# AddThingsToThingGroupParamsOutputTypeDef definition
class AddThingsToThingGroupParamsOutputTypeDef(TypedDict):
thingGroupNames: List[str],
overrideDynamicGroups: NotRequired[bool],AddThingsToThingGroupParamsTypeDef#
# AddThingsToThingGroupParamsTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AddThingsToThingGroupParamsTypeDef
def get_value() -> AddThingsToThingGroupParamsTypeDef:
return {
"thingGroupNames": ...,
}
# AddThingsToThingGroupParamsTypeDef definition
class AddThingsToThingGroupParamsTypeDef(TypedDict):
thingGroupNames: Sequence[str],
overrideDynamicGroups: NotRequired[bool],AggregationTypeOutputTypeDef#
# AggregationTypeOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AggregationTypeOutputTypeDef
def get_value() -> AggregationTypeOutputTypeDef:
return {
"name": ...,
}
# AggregationTypeOutputTypeDef definition
class AggregationTypeOutputTypeDef(TypedDict):
name: AggregationTypeNameType, # (1)
values: NotRequired[List[str]],AggregationTypeTypeDef#
# AggregationTypeTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AggregationTypeTypeDef
def get_value() -> AggregationTypeTypeDef:
return {
"name": ...,
}
# AggregationTypeTypeDef definition
class AggregationTypeTypeDef(TypedDict):
name: AggregationTypeNameType, # (1)
values: NotRequired[Sequence[str]],AlertTargetTypeDef#
# AlertTargetTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AlertTargetTypeDef
def get_value() -> AlertTargetTypeDef:
return {
"alertTargetArn": ...,
}
# AlertTargetTypeDef definition
class AlertTargetTypeDef(TypedDict):
alertTargetArn: str,
roleArn: str,PolicyTypeDef#
# PolicyTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PolicyTypeDef
def get_value() -> PolicyTypeDef:
return {
"policyName": ...,
}
# PolicyTypeDef definition
class PolicyTypeDef(TypedDict):
policyName: NotRequired[str],
policyArn: NotRequired[str],AssetPropertyTimestampTypeDef#
# AssetPropertyTimestampTypeDef TypedDict usage example
from types_boto3_iot.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 types_boto3_iot.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],ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from types_boto3_iot.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],AssociateTargetsWithJobRequestTypeDef#
# AssociateTargetsWithJobRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AssociateTargetsWithJobRequestTypeDef
def get_value() -> AssociateTargetsWithJobRequestTypeDef:
return {
"targets": ...,
}
# AssociateTargetsWithJobRequestTypeDef definition
class AssociateTargetsWithJobRequestTypeDef(TypedDict):
targets: Sequence[str],
jobId: str,
comment: NotRequired[str],
namespaceId: NotRequired[str],AttachPolicyRequestTypeDef#
# AttachPolicyRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AttachPolicyRequestTypeDef
def get_value() -> AttachPolicyRequestTypeDef:
return {
"policyName": ...,
}
# AttachPolicyRequestTypeDef definition
class AttachPolicyRequestTypeDef(TypedDict):
policyName: str,
target: str,AttachPrincipalPolicyRequestTypeDef#
# AttachPrincipalPolicyRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AttachPrincipalPolicyRequestTypeDef
def get_value() -> AttachPrincipalPolicyRequestTypeDef:
return {
"policyName": ...,
}
# AttachPrincipalPolicyRequestTypeDef definition
class AttachPrincipalPolicyRequestTypeDef(TypedDict):
policyName: str,
principal: str,AttachSecurityProfileRequestTypeDef#
# AttachSecurityProfileRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AttachSecurityProfileRequestTypeDef
def get_value() -> AttachSecurityProfileRequestTypeDef:
return {
"securityProfileName": ...,
}
# AttachSecurityProfileRequestTypeDef definition
class AttachSecurityProfileRequestTypeDef(TypedDict):
securityProfileName: str,
securityProfileTargetArn: str,AttachThingPrincipalRequestTypeDef#
# AttachThingPrincipalRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AttachThingPrincipalRequestTypeDef
def get_value() -> AttachThingPrincipalRequestTypeDef:
return {
"thingName": ...,
}
# AttachThingPrincipalRequestTypeDef definition
class AttachThingPrincipalRequestTypeDef(TypedDict):
thingName: str,
principal: str,
thingPrincipalType: NotRequired[ThingPrincipalTypeType], # (1)AttributePayloadOutputTypeDef#
# AttributePayloadOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AttributePayloadOutputTypeDef
def get_value() -> AttributePayloadOutputTypeDef:
return {
"attributes": ...,
}
# AttributePayloadOutputTypeDef definition
class AttributePayloadOutputTypeDef(TypedDict):
attributes: NotRequired[Dict[str, str]],
merge: NotRequired[bool],AttributePayloadTypeDef#
# AttributePayloadTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AttributePayloadTypeDef
def get_value() -> AttributePayloadTypeDef:
return {
"attributes": ...,
}
# AttributePayloadTypeDef definition
class AttributePayloadTypeDef(TypedDict):
attributes: NotRequired[Mapping[str, str]],
merge: NotRequired[bool],AuditCheckConfigurationTypeDef#
# AuditCheckConfigurationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuditCheckConfigurationTypeDef
def get_value() -> AuditCheckConfigurationTypeDef:
return {
"enabled": ...,
}
# AuditCheckConfigurationTypeDef definition
class AuditCheckConfigurationTypeDef(TypedDict):
enabled: NotRequired[bool],AuditCheckDetailsTypeDef#
# AuditCheckDetailsTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuditCheckDetailsTypeDef
def get_value() -> AuditCheckDetailsTypeDef:
return {
"checkRunStatus": ...,
}
# AuditCheckDetailsTypeDef definition
class AuditCheckDetailsTypeDef(TypedDict):
checkRunStatus: NotRequired[AuditCheckRunStatusType], # (1)
checkCompliant: NotRequired[bool],
totalResourcesCount: NotRequired[int],
nonCompliantResourcesCount: NotRequired[int],
suppressedNonCompliantResourcesCount: NotRequired[int],
errorCode: NotRequired[str],
message: NotRequired[str],AuditMitigationActionExecutionMetadataTypeDef#
# AuditMitigationActionExecutionMetadataTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuditMitigationActionExecutionMetadataTypeDef
def get_value() -> AuditMitigationActionExecutionMetadataTypeDef:
return {
"taskId": ...,
}
# AuditMitigationActionExecutionMetadataTypeDef definition
class AuditMitigationActionExecutionMetadataTypeDef(TypedDict):
taskId: NotRequired[str],
findingId: NotRequired[str],
actionName: NotRequired[str],
actionId: NotRequired[str],
status: NotRequired[AuditMitigationActionsExecutionStatusType], # (1)
startTime: NotRequired[datetime],
endTime: NotRequired[datetime],
errorCode: NotRequired[str],
message: NotRequired[str],AuditMitigationActionsTaskMetadataTypeDef#
# AuditMitigationActionsTaskMetadataTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuditMitigationActionsTaskMetadataTypeDef
def get_value() -> AuditMitigationActionsTaskMetadataTypeDef:
return {
"taskId": ...,
}
# AuditMitigationActionsTaskMetadataTypeDef definition
class AuditMitigationActionsTaskMetadataTypeDef(TypedDict):
taskId: NotRequired[str],
startTime: NotRequired[datetime],
taskStatus: NotRequired[AuditMitigationActionsTaskStatusType], # (1)AuditMitigationActionsTaskTargetOutputTypeDef#
# AuditMitigationActionsTaskTargetOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuditMitigationActionsTaskTargetOutputTypeDef
def get_value() -> AuditMitigationActionsTaskTargetOutputTypeDef:
return {
"auditTaskId": ...,
}
# AuditMitigationActionsTaskTargetOutputTypeDef definition
class AuditMitigationActionsTaskTargetOutputTypeDef(TypedDict):
auditTaskId: NotRequired[str],
findingIds: NotRequired[List[str]],
auditCheckToReasonCodeFilter: NotRequired[Dict[str, List[str]]],AuditMitigationActionsTaskTargetTypeDef#
# AuditMitigationActionsTaskTargetTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuditMitigationActionsTaskTargetTypeDef
def get_value() -> AuditMitigationActionsTaskTargetTypeDef:
return {
"auditTaskId": ...,
}
# AuditMitigationActionsTaskTargetTypeDef definition
class AuditMitigationActionsTaskTargetTypeDef(TypedDict):
auditTaskId: NotRequired[str],
findingIds: NotRequired[Sequence[str]],
auditCheckToReasonCodeFilter: NotRequired[Mapping[str, Sequence[str]]],AuditNotificationTargetTypeDef#
# AuditNotificationTargetTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuditNotificationTargetTypeDef
def get_value() -> AuditNotificationTargetTypeDef:
return {
"targetArn": ...,
}
# AuditNotificationTargetTypeDef definition
class AuditNotificationTargetTypeDef(TypedDict):
targetArn: NotRequired[str],
roleArn: NotRequired[str],
enabled: NotRequired[bool],AuditTaskMetadataTypeDef#
# AuditTaskMetadataTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuditTaskMetadataTypeDef
def get_value() -> AuditTaskMetadataTypeDef:
return {
"taskId": ...,
}
# AuditTaskMetadataTypeDef definition
class AuditTaskMetadataTypeDef(TypedDict):
taskId: NotRequired[str],
taskStatus: NotRequired[AuditTaskStatusType], # (1)
taskType: NotRequired[AuditTaskTypeType], # (2)- See AuditTaskStatusType
- See AuditTaskTypeType
AuthInfoOutputTypeDef#
# AuthInfoOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuthInfoOutputTypeDef
def get_value() -> AuthInfoOutputTypeDef:
return {
"actionType": ...,
}
# AuthInfoOutputTypeDef definition
class AuthInfoOutputTypeDef(TypedDict):
resources: List[str],
actionType: NotRequired[ActionTypeType], # (1)- See ActionTypeType
AuthInfoTypeDef#
# AuthInfoTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuthInfoTypeDef
def get_value() -> AuthInfoTypeDef:
return {
"actionType": ...,
}
# AuthInfoTypeDef definition
class AuthInfoTypeDef(TypedDict):
resources: Sequence[str],
actionType: NotRequired[ActionTypeType], # (1)- See ActionTypeType
AuthorizerConfigTypeDef#
# AuthorizerConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuthorizerConfigTypeDef
def get_value() -> AuthorizerConfigTypeDef:
return {
"defaultAuthorizerName": ...,
}
# AuthorizerConfigTypeDef definition
class AuthorizerConfigTypeDef(TypedDict):
defaultAuthorizerName: NotRequired[str],
allowAuthorizerOverride: NotRequired[bool],AuthorizerDescriptionTypeDef#
# AuthorizerDescriptionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuthorizerDescriptionTypeDef
def get_value() -> AuthorizerDescriptionTypeDef:
return {
"authorizerName": ...,
}
# AuthorizerDescriptionTypeDef definition
class AuthorizerDescriptionTypeDef(TypedDict):
authorizerName: NotRequired[str],
authorizerArn: NotRequired[str],
authorizerFunctionArn: NotRequired[str],
tokenKeyName: NotRequired[str],
tokenSigningPublicKeys: NotRequired[Dict[str, str]],
status: NotRequired[AuthorizerStatusType], # (1)
creationDate: NotRequired[datetime],
lastModifiedDate: NotRequired[datetime],
signingDisabled: NotRequired[bool],
enableCachingForHttp: NotRequired[bool],AuthorizerSummaryTypeDef#
# AuthorizerSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuthorizerSummaryTypeDef
def get_value() -> AuthorizerSummaryTypeDef:
return {
"authorizerName": ...,
}
# AuthorizerSummaryTypeDef definition
class AuthorizerSummaryTypeDef(TypedDict):
authorizerName: NotRequired[str],
authorizerArn: NotRequired[str],AwsJobAbortCriteriaTypeDef#
# AwsJobAbortCriteriaTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AwsJobAbortCriteriaTypeDef
def get_value() -> AwsJobAbortCriteriaTypeDef:
return {
"failureType": ...,
}
# AwsJobAbortCriteriaTypeDef definition
class AwsJobAbortCriteriaTypeDef(TypedDict):
failureType: AwsJobAbortCriteriaFailureTypeType, # (1)
action: AwsJobAbortCriteriaAbortActionType, # (2)
thresholdPercentage: float,
minNumberOfExecutedThings: int,AwsJobRateIncreaseCriteriaTypeDef#
# AwsJobRateIncreaseCriteriaTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AwsJobRateIncreaseCriteriaTypeDef
def get_value() -> AwsJobRateIncreaseCriteriaTypeDef:
return {
"numberOfNotifiedThings": ...,
}
# AwsJobRateIncreaseCriteriaTypeDef definition
class AwsJobRateIncreaseCriteriaTypeDef(TypedDict):
numberOfNotifiedThings: NotRequired[int],
numberOfSucceededThings: NotRequired[int],AwsJobPresignedUrlConfigTypeDef#
# AwsJobPresignedUrlConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AwsJobPresignedUrlConfigTypeDef
def get_value() -> AwsJobPresignedUrlConfigTypeDef:
return {
"expiresInSec": ...,
}
# AwsJobPresignedUrlConfigTypeDef definition
class AwsJobPresignedUrlConfigTypeDef(TypedDict):
expiresInSec: NotRequired[int],AwsJobTimeoutConfigTypeDef#
# AwsJobTimeoutConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AwsJobTimeoutConfigTypeDef
def get_value() -> AwsJobTimeoutConfigTypeDef:
return {
"inProgressTimeoutInMinutes": ...,
}
# AwsJobTimeoutConfigTypeDef definition
class AwsJobTimeoutConfigTypeDef(TypedDict):
inProgressTimeoutInMinutes: NotRequired[int],MachineLearningDetectionConfigTypeDef#
# MachineLearningDetectionConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import MachineLearningDetectionConfigTypeDef
def get_value() -> MachineLearningDetectionConfigTypeDef:
return {
"confidenceLevel": ...,
}
# MachineLearningDetectionConfigTypeDef definition
class MachineLearningDetectionConfigTypeDef(TypedDict):
confidenceLevel: ConfidenceLevelType, # (1)StatisticalThresholdTypeDef#
# StatisticalThresholdTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StatisticalThresholdTypeDef
def get_value() -> StatisticalThresholdTypeDef:
return {
"statistic": ...,
}
# StatisticalThresholdTypeDef definition
class StatisticalThresholdTypeDef(TypedDict):
statistic: NotRequired[str],BehaviorModelTrainingSummaryTypeDef#
# BehaviorModelTrainingSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import BehaviorModelTrainingSummaryTypeDef
def get_value() -> BehaviorModelTrainingSummaryTypeDef:
return {
"securityProfileName": ...,
}
# BehaviorModelTrainingSummaryTypeDef definition
class BehaviorModelTrainingSummaryTypeDef(TypedDict):
securityProfileName: NotRequired[str],
behaviorName: NotRequired[str],
trainingDataCollectionStartDate: NotRequired[datetime],
modelStatus: NotRequired[ModelStatusType], # (1)
datapointsCollectionPercentage: NotRequired[float],
lastModelRefreshDate: NotRequired[datetime],- See ModelStatusType
MetricDimensionTypeDef#
# MetricDimensionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import MetricDimensionTypeDef
def get_value() -> MetricDimensionTypeDef:
return {
"dimensionName": ...,
}
# MetricDimensionTypeDef definition
class MetricDimensionTypeDef(TypedDict):
dimensionName: str,
operator: NotRequired[DimensionValueOperatorType], # (1)BillingGroupMetadataTypeDef#
# BillingGroupMetadataTypeDef TypedDict usage example
from types_boto3_iot.type_defs import BillingGroupMetadataTypeDef
def get_value() -> BillingGroupMetadataTypeDef:
return {
"creationDate": ...,
}
# BillingGroupMetadataTypeDef definition
class BillingGroupMetadataTypeDef(TypedDict):
creationDate: NotRequired[datetime],BillingGroupPropertiesTypeDef#
# BillingGroupPropertiesTypeDef TypedDict usage example
from types_boto3_iot.type_defs import BillingGroupPropertiesTypeDef
def get_value() -> BillingGroupPropertiesTypeDef:
return {
"billingGroupDescription": ...,
}
# BillingGroupPropertiesTypeDef definition
class BillingGroupPropertiesTypeDef(TypedDict):
billingGroupDescription: NotRequired[str],BucketTypeDef#
# BucketTypeDef TypedDict usage example
from types_boto3_iot.type_defs import BucketTypeDef
def get_value() -> BucketTypeDef:
return {
"keyValue": ...,
}
# BucketTypeDef definition
class BucketTypeDef(TypedDict):
keyValue: NotRequired[str],
count: NotRequired[int],TermsAggregationTypeDef#
# TermsAggregationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TermsAggregationTypeDef
def get_value() -> TermsAggregationTypeDef:
return {
"maxBuckets": ...,
}
# TermsAggregationTypeDef definition
class TermsAggregationTypeDef(TypedDict):
maxBuckets: NotRequired[int],CertificateValidityTypeDef#
# CertificateValidityTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CertificateValidityTypeDef
def get_value() -> CertificateValidityTypeDef:
return {
"notBefore": ...,
}
# CertificateValidityTypeDef definition
class CertificateValidityTypeDef(TypedDict):
notBefore: NotRequired[datetime],
notAfter: NotRequired[datetime],CACertificateTypeDef#
# CACertificateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CACertificateTypeDef
def get_value() -> CACertificateTypeDef:
return {
"certificateArn": ...,
}
# CACertificateTypeDef definition
class CACertificateTypeDef(TypedDict):
certificateArn: NotRequired[str],
certificateId: NotRequired[str],
status: NotRequired[CACertificateStatusType], # (1)
creationDate: NotRequired[datetime],CancelAuditMitigationActionsTaskRequestTypeDef#
# CancelAuditMitigationActionsTaskRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CancelAuditMitigationActionsTaskRequestTypeDef
def get_value() -> CancelAuditMitigationActionsTaskRequestTypeDef:
return {
"taskId": ...,
}
# CancelAuditMitigationActionsTaskRequestTypeDef definition
class CancelAuditMitigationActionsTaskRequestTypeDef(TypedDict):
taskId: str,CancelAuditTaskRequestTypeDef#
# CancelAuditTaskRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CancelAuditTaskRequestTypeDef
def get_value() -> CancelAuditTaskRequestTypeDef:
return {
"taskId": ...,
}
# CancelAuditTaskRequestTypeDef definition
class CancelAuditTaskRequestTypeDef(TypedDict):
taskId: str,CancelCertificateTransferRequestTypeDef#
# CancelCertificateTransferRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CancelCertificateTransferRequestTypeDef
def get_value() -> CancelCertificateTransferRequestTypeDef:
return {
"certificateId": ...,
}
# CancelCertificateTransferRequestTypeDef definition
class CancelCertificateTransferRequestTypeDef(TypedDict):
certificateId: str,CancelDetectMitigationActionsTaskRequestTypeDef#
# CancelDetectMitigationActionsTaskRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CancelDetectMitigationActionsTaskRequestTypeDef
def get_value() -> CancelDetectMitigationActionsTaskRequestTypeDef:
return {
"taskId": ...,
}
# CancelDetectMitigationActionsTaskRequestTypeDef definition
class CancelDetectMitigationActionsTaskRequestTypeDef(TypedDict):
taskId: str,CancelJobExecutionRequestTypeDef#
# CancelJobExecutionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CancelJobExecutionRequestTypeDef
def get_value() -> CancelJobExecutionRequestTypeDef:
return {
"jobId": ...,
}
# CancelJobExecutionRequestTypeDef definition
class CancelJobExecutionRequestTypeDef(TypedDict):
jobId: str,
thingName: str,
force: NotRequired[bool],
expectedVersion: NotRequired[int],
statusDetails: NotRequired[Mapping[str, str]],CancelJobRequestTypeDef#
# CancelJobRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CancelJobRequestTypeDef
def get_value() -> CancelJobRequestTypeDef:
return {
"jobId": ...,
}
# CancelJobRequestTypeDef definition
class CancelJobRequestTypeDef(TypedDict):
jobId: str,
reasonCode: NotRequired[str],
comment: NotRequired[str],
force: NotRequired[bool],TransferDataTypeDef#
# TransferDataTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TransferDataTypeDef
def get_value() -> TransferDataTypeDef:
return {
"transferMessage": ...,
}
# TransferDataTypeDef definition
class TransferDataTypeDef(TypedDict):
transferMessage: NotRequired[str],
rejectReason: NotRequired[str],
transferDate: NotRequired[datetime],
acceptDate: NotRequired[datetime],
rejectDate: NotRequired[datetime],CertificateProviderSummaryTypeDef#
# CertificateProviderSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CertificateProviderSummaryTypeDef
def get_value() -> CertificateProviderSummaryTypeDef:
return {
"certificateProviderName": ...,
}
# CertificateProviderSummaryTypeDef definition
class CertificateProviderSummaryTypeDef(TypedDict):
certificateProviderName: NotRequired[str],
certificateProviderArn: NotRequired[str],CertificateTypeDef#
# CertificateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CertificateTypeDef
def get_value() -> CertificateTypeDef:
return {
"certificateArn": ...,
}
# CertificateTypeDef definition
class CertificateTypeDef(TypedDict):
certificateArn: NotRequired[str],
certificateId: NotRequired[str],
status: NotRequired[CertificateStatusType], # (1)
certificateMode: NotRequired[CertificateModeType], # (2)
creationDate: NotRequired[datetime],ClientCertificateConfigTypeDef#
# ClientCertificateConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ClientCertificateConfigTypeDef
def get_value() -> ClientCertificateConfigTypeDef:
return {
"clientCertificateCallbackArn": ...,
}
# ClientCertificateConfigTypeDef definition
class ClientCertificateConfigTypeDef(TypedDict):
clientCertificateCallbackArn: NotRequired[str],CodeSigningCertificateChainTypeDef#
# CodeSigningCertificateChainTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CodeSigningCertificateChainTypeDef
def get_value() -> CodeSigningCertificateChainTypeDef:
return {
"certificateName": ...,
}
# CodeSigningCertificateChainTypeDef definition
class CodeSigningCertificateChainTypeDef(TypedDict):
certificateName: NotRequired[str],
inlineDocument: NotRequired[str],CodeSigningSignatureOutputTypeDef#
# CodeSigningSignatureOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CodeSigningSignatureOutputTypeDef
def get_value() -> CodeSigningSignatureOutputTypeDef:
return {
"inlineDocument": ...,
}
# CodeSigningSignatureOutputTypeDef definition
class CodeSigningSignatureOutputTypeDef(TypedDict):
inlineDocument: NotRequired[bytes],CommandExecutionResultTypeDef#
# CommandExecutionResultTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CommandExecutionResultTypeDef
def get_value() -> CommandExecutionResultTypeDef:
return {
"S": ...,
}
# CommandExecutionResultTypeDef definition
class CommandExecutionResultTypeDef(TypedDict):
S: NotRequired[str],
B: NotRequired[bool],
BIN: NotRequired[bytes],CommandExecutionSummaryTypeDef#
# CommandExecutionSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CommandExecutionSummaryTypeDef
def get_value() -> CommandExecutionSummaryTypeDef:
return {
"commandArn": ...,
}
# CommandExecutionSummaryTypeDef definition
class CommandExecutionSummaryTypeDef(TypedDict):
commandArn: NotRequired[str],
executionId: NotRequired[str],
targetArn: NotRequired[str],
status: NotRequired[CommandExecutionStatusType], # (1)
createdAt: NotRequired[datetime],
startedAt: NotRequired[datetime],
completedAt: NotRequired[datetime],CommandParameterValueOutputTypeDef#
# CommandParameterValueOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CommandParameterValueOutputTypeDef
def get_value() -> CommandParameterValueOutputTypeDef:
return {
"S": ...,
}
# CommandParameterValueOutputTypeDef definition
class CommandParameterValueOutputTypeDef(TypedDict):
S: NotRequired[str],
B: NotRequired[bool],
I: NotRequired[int],
L: NotRequired[int],
D: NotRequired[float],
BIN: NotRequired[bytes],
UL: NotRequired[str],CommandPayloadOutputTypeDef#
# CommandPayloadOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CommandPayloadOutputTypeDef
def get_value() -> CommandPayloadOutputTypeDef:
return {
"content": ...,
}
# CommandPayloadOutputTypeDef definition
class CommandPayloadOutputTypeDef(TypedDict):
content: NotRequired[bytes],
contentType: NotRequired[str],CommandSummaryTypeDef#
# CommandSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CommandSummaryTypeDef
def get_value() -> CommandSummaryTypeDef:
return {
"commandArn": ...,
}
# CommandSummaryTypeDef definition
class CommandSummaryTypeDef(TypedDict):
commandArn: NotRequired[str],
commandId: NotRequired[str],
displayName: NotRequired[str],
deprecated: NotRequired[bool],
createdAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],
pendingDeletion: NotRequired[bool],ConfigurationTypeDef#
# ConfigurationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ConfigurationTypeDef
def get_value() -> ConfigurationTypeDef:
return {
"Enabled": ...,
}
# ConfigurationTypeDef definition
class ConfigurationTypeDef(TypedDict):
Enabled: NotRequired[bool],ConfirmTopicRuleDestinationRequestTypeDef#
# ConfirmTopicRuleDestinationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ConfirmTopicRuleDestinationRequestTypeDef
def get_value() -> ConfirmTopicRuleDestinationRequestTypeDef:
return {
"confirmationToken": ...,
}
# ConfirmTopicRuleDestinationRequestTypeDef definition
class ConfirmTopicRuleDestinationRequestTypeDef(TypedDict):
confirmationToken: str,TagTypeDef#
# TagTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: NotRequired[str],CreateCertificateFromCsrRequestTypeDef#
# CreateCertificateFromCsrRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateCertificateFromCsrRequestTypeDef
def get_value() -> CreateCertificateFromCsrRequestTypeDef:
return {
"certificateSigningRequest": ...,
}
# CreateCertificateFromCsrRequestTypeDef definition
class CreateCertificateFromCsrRequestTypeDef(TypedDict):
certificateSigningRequest: str,
setAsActive: NotRequired[bool],ServerCertificateConfigTypeDef#
# ServerCertificateConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ServerCertificateConfigTypeDef
def get_value() -> ServerCertificateConfigTypeDef:
return {
"enableOCSPCheck": ...,
}
# ServerCertificateConfigTypeDef definition
class ServerCertificateConfigTypeDef(TypedDict):
enableOCSPCheck: NotRequired[bool],
ocspLambdaArn: NotRequired[str],
ocspAuthorizedResponderArn: NotRequired[str],TlsConfigTypeDef#
# TlsConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TlsConfigTypeDef
def get_value() -> TlsConfigTypeDef:
return {
"securityPolicy": ...,
}
# TlsConfigTypeDef definition
class TlsConfigTypeDef(TypedDict):
securityPolicy: NotRequired[str],PresignedUrlConfigTypeDef#
# PresignedUrlConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PresignedUrlConfigTypeDef
def get_value() -> PresignedUrlConfigTypeDef:
return {
"roleArn": ...,
}
# PresignedUrlConfigTypeDef definition
class PresignedUrlConfigTypeDef(TypedDict):
roleArn: NotRequired[str],
expiresInSec: NotRequired[int],TimeoutConfigTypeDef#
# TimeoutConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TimeoutConfigTypeDef
def get_value() -> TimeoutConfigTypeDef:
return {
"inProgressTimeoutInMinutes": ...,
}
# TimeoutConfigTypeDef definition
class TimeoutConfigTypeDef(TypedDict):
inProgressTimeoutInMinutes: NotRequired[int],MaintenanceWindowTypeDef#
# MaintenanceWindowTypeDef TypedDict usage example
from types_boto3_iot.type_defs import MaintenanceWindowTypeDef
def get_value() -> MaintenanceWindowTypeDef:
return {
"startTime": ...,
}
# MaintenanceWindowTypeDef definition
class MaintenanceWindowTypeDef(TypedDict):
startTime: str,
durationInMinutes: int,CreateKeysAndCertificateRequestTypeDef#
# CreateKeysAndCertificateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateKeysAndCertificateRequestTypeDef
def get_value() -> CreateKeysAndCertificateRequestTypeDef:
return {
"setAsActive": ...,
}
# CreateKeysAndCertificateRequestTypeDef definition
class CreateKeysAndCertificateRequestTypeDef(TypedDict):
setAsActive: NotRequired[bool],KeyPairTypeDef#
# KeyPairTypeDef TypedDict usage example
from types_boto3_iot.type_defs import KeyPairTypeDef
def get_value() -> KeyPairTypeDef:
return {
"PublicKey": ...,
}
# KeyPairTypeDef definition
class KeyPairTypeDef(TypedDict):
PublicKey: NotRequired[str],
PrivateKey: NotRequired[str],CreatePackageRequestTypeDef#
# CreatePackageRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreatePackageRequestTypeDef
def get_value() -> CreatePackageRequestTypeDef:
return {
"packageName": ...,
}
# CreatePackageRequestTypeDef definition
class CreatePackageRequestTypeDef(TypedDict):
packageName: str,
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
clientToken: NotRequired[str],CreatePolicyVersionRequestTypeDef#
# CreatePolicyVersionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreatePolicyVersionRequestTypeDef
def get_value() -> CreatePolicyVersionRequestTypeDef:
return {
"policyName": ...,
}
# CreatePolicyVersionRequestTypeDef definition
class CreatePolicyVersionRequestTypeDef(TypedDict):
policyName: str,
policyDocument: str,
setAsDefault: NotRequired[bool],CreateProvisioningClaimRequestTypeDef#
# CreateProvisioningClaimRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateProvisioningClaimRequestTypeDef
def get_value() -> CreateProvisioningClaimRequestTypeDef:
return {
"templateName": ...,
}
# CreateProvisioningClaimRequestTypeDef definition
class CreateProvisioningClaimRequestTypeDef(TypedDict):
templateName: str,ProvisioningHookTypeDef#
# ProvisioningHookTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ProvisioningHookTypeDef
def get_value() -> ProvisioningHookTypeDef:
return {
"payloadVersion": ...,
}
# ProvisioningHookTypeDef definition
class ProvisioningHookTypeDef(TypedDict):
targetArn: str,
payloadVersion: NotRequired[str],CreateProvisioningTemplateVersionRequestTypeDef#
# CreateProvisioningTemplateVersionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateProvisioningTemplateVersionRequestTypeDef
def get_value() -> CreateProvisioningTemplateVersionRequestTypeDef:
return {
"templateName": ...,
}
# CreateProvisioningTemplateVersionRequestTypeDef definition
class CreateProvisioningTemplateVersionRequestTypeDef(TypedDict):
templateName: str,
templateBody: str,
setAsDefault: NotRequired[bool],MetricsExportConfigTypeDef#
# MetricsExportConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import MetricsExportConfigTypeDef
def get_value() -> MetricsExportConfigTypeDef:
return {
"mqttTopic": ...,
}
# MetricsExportConfigTypeDef definition
class MetricsExportConfigTypeDef(TypedDict):
mqttTopic: str,
roleArn: str,DeleteAccountAuditConfigurationRequestTypeDef#
# DeleteAccountAuditConfigurationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteAccountAuditConfigurationRequestTypeDef
def get_value() -> DeleteAccountAuditConfigurationRequestTypeDef:
return {
"deleteScheduledAudits": ...,
}
# DeleteAccountAuditConfigurationRequestTypeDef definition
class DeleteAccountAuditConfigurationRequestTypeDef(TypedDict):
deleteScheduledAudits: NotRequired[bool],DeleteAuthorizerRequestTypeDef#
# DeleteAuthorizerRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteAuthorizerRequestTypeDef
def get_value() -> DeleteAuthorizerRequestTypeDef:
return {
"authorizerName": ...,
}
# DeleteAuthorizerRequestTypeDef definition
class DeleteAuthorizerRequestTypeDef(TypedDict):
authorizerName: str,DeleteBillingGroupRequestTypeDef#
# DeleteBillingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteBillingGroupRequestTypeDef
def get_value() -> DeleteBillingGroupRequestTypeDef:
return {
"billingGroupName": ...,
}
# DeleteBillingGroupRequestTypeDef definition
class DeleteBillingGroupRequestTypeDef(TypedDict):
billingGroupName: str,
expectedVersion: NotRequired[int],DeleteCACertificateRequestTypeDef#
# DeleteCACertificateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteCACertificateRequestTypeDef
def get_value() -> DeleteCACertificateRequestTypeDef:
return {
"certificateId": ...,
}
# DeleteCACertificateRequestTypeDef definition
class DeleteCACertificateRequestTypeDef(TypedDict):
certificateId: str,DeleteCertificateProviderRequestTypeDef#
# DeleteCertificateProviderRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteCertificateProviderRequestTypeDef
def get_value() -> DeleteCertificateProviderRequestTypeDef:
return {
"certificateProviderName": ...,
}
# DeleteCertificateProviderRequestTypeDef definition
class DeleteCertificateProviderRequestTypeDef(TypedDict):
certificateProviderName: str,DeleteCertificateRequestTypeDef#
# DeleteCertificateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteCertificateRequestTypeDef
def get_value() -> DeleteCertificateRequestTypeDef:
return {
"certificateId": ...,
}
# DeleteCertificateRequestTypeDef definition
class DeleteCertificateRequestTypeDef(TypedDict):
certificateId: str,
forceDelete: NotRequired[bool],DeleteCommandExecutionRequestTypeDef#
# DeleteCommandExecutionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteCommandExecutionRequestTypeDef
def get_value() -> DeleteCommandExecutionRequestTypeDef:
return {
"executionId": ...,
}
# DeleteCommandExecutionRequestTypeDef definition
class DeleteCommandExecutionRequestTypeDef(TypedDict):
executionId: str,
targetArn: str,DeleteCommandRequestTypeDef#
# DeleteCommandRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteCommandRequestTypeDef
def get_value() -> DeleteCommandRequestTypeDef:
return {
"commandId": ...,
}
# DeleteCommandRequestTypeDef definition
class DeleteCommandRequestTypeDef(TypedDict):
commandId: str,DeleteCustomMetricRequestTypeDef#
# DeleteCustomMetricRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteCustomMetricRequestTypeDef
def get_value() -> DeleteCustomMetricRequestTypeDef:
return {
"metricName": ...,
}
# DeleteCustomMetricRequestTypeDef definition
class DeleteCustomMetricRequestTypeDef(TypedDict):
metricName: str,DeleteDimensionRequestTypeDef#
# DeleteDimensionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteDimensionRequestTypeDef
def get_value() -> DeleteDimensionRequestTypeDef:
return {
"name": ...,
}
# DeleteDimensionRequestTypeDef definition
class DeleteDimensionRequestTypeDef(TypedDict):
name: str,DeleteDomainConfigurationRequestTypeDef#
# DeleteDomainConfigurationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteDomainConfigurationRequestTypeDef
def get_value() -> DeleteDomainConfigurationRequestTypeDef:
return {
"domainConfigurationName": ...,
}
# DeleteDomainConfigurationRequestTypeDef definition
class DeleteDomainConfigurationRequestTypeDef(TypedDict):
domainConfigurationName: str,DeleteDynamicThingGroupRequestTypeDef#
# DeleteDynamicThingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteDynamicThingGroupRequestTypeDef
def get_value() -> DeleteDynamicThingGroupRequestTypeDef:
return {
"thingGroupName": ...,
}
# DeleteDynamicThingGroupRequestTypeDef definition
class DeleteDynamicThingGroupRequestTypeDef(TypedDict):
thingGroupName: str,
expectedVersion: NotRequired[int],DeleteFleetMetricRequestTypeDef#
# DeleteFleetMetricRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteFleetMetricRequestTypeDef
def get_value() -> DeleteFleetMetricRequestTypeDef:
return {
"metricName": ...,
}
# DeleteFleetMetricRequestTypeDef definition
class DeleteFleetMetricRequestTypeDef(TypedDict):
metricName: str,
expectedVersion: NotRequired[int],DeleteJobExecutionRequestTypeDef#
# DeleteJobExecutionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteJobExecutionRequestTypeDef
def get_value() -> DeleteJobExecutionRequestTypeDef:
return {
"jobId": ...,
}
# DeleteJobExecutionRequestTypeDef definition
class DeleteJobExecutionRequestTypeDef(TypedDict):
jobId: str,
thingName: str,
executionNumber: int,
force: NotRequired[bool],
namespaceId: NotRequired[str],DeleteJobRequestTypeDef#
# DeleteJobRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteJobRequestTypeDef
def get_value() -> DeleteJobRequestTypeDef:
return {
"jobId": ...,
}
# DeleteJobRequestTypeDef definition
class DeleteJobRequestTypeDef(TypedDict):
jobId: str,
force: NotRequired[bool],
namespaceId: NotRequired[str],DeleteJobTemplateRequestTypeDef#
# DeleteJobTemplateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteJobTemplateRequestTypeDef
def get_value() -> DeleteJobTemplateRequestTypeDef:
return {
"jobTemplateId": ...,
}
# DeleteJobTemplateRequestTypeDef definition
class DeleteJobTemplateRequestTypeDef(TypedDict):
jobTemplateId: str,DeleteMitigationActionRequestTypeDef#
# DeleteMitigationActionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteMitigationActionRequestTypeDef
def get_value() -> DeleteMitigationActionRequestTypeDef:
return {
"actionName": ...,
}
# DeleteMitigationActionRequestTypeDef definition
class DeleteMitigationActionRequestTypeDef(TypedDict):
actionName: str,DeleteOTAUpdateRequestTypeDef#
# DeleteOTAUpdateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteOTAUpdateRequestTypeDef
def get_value() -> DeleteOTAUpdateRequestTypeDef:
return {
"otaUpdateId": ...,
}
# DeleteOTAUpdateRequestTypeDef definition
class DeleteOTAUpdateRequestTypeDef(TypedDict):
otaUpdateId: str,
deleteStream: NotRequired[bool],
forceDeleteAWSJob: NotRequired[bool],DeletePackageRequestTypeDef#
# DeletePackageRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeletePackageRequestTypeDef
def get_value() -> DeletePackageRequestTypeDef:
return {
"packageName": ...,
}
# DeletePackageRequestTypeDef definition
class DeletePackageRequestTypeDef(TypedDict):
packageName: str,
clientToken: NotRequired[str],DeletePackageVersionRequestTypeDef#
# DeletePackageVersionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeletePackageVersionRequestTypeDef
def get_value() -> DeletePackageVersionRequestTypeDef:
return {
"packageName": ...,
}
# DeletePackageVersionRequestTypeDef definition
class DeletePackageVersionRequestTypeDef(TypedDict):
packageName: str,
versionName: str,
clientToken: NotRequired[str],DeletePolicyRequestTypeDef#
# DeletePolicyRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeletePolicyRequestTypeDef
def get_value() -> DeletePolicyRequestTypeDef:
return {
"policyName": ...,
}
# DeletePolicyRequestTypeDef definition
class DeletePolicyRequestTypeDef(TypedDict):
policyName: str,DeletePolicyVersionRequestTypeDef#
# DeletePolicyVersionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeletePolicyVersionRequestTypeDef
def get_value() -> DeletePolicyVersionRequestTypeDef:
return {
"policyName": ...,
}
# DeletePolicyVersionRequestTypeDef definition
class DeletePolicyVersionRequestTypeDef(TypedDict):
policyName: str,
policyVersionId: str,DeleteProvisioningTemplateRequestTypeDef#
# DeleteProvisioningTemplateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteProvisioningTemplateRequestTypeDef
def get_value() -> DeleteProvisioningTemplateRequestTypeDef:
return {
"templateName": ...,
}
# DeleteProvisioningTemplateRequestTypeDef definition
class DeleteProvisioningTemplateRequestTypeDef(TypedDict):
templateName: str,DeleteProvisioningTemplateVersionRequestTypeDef#
# DeleteProvisioningTemplateVersionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteProvisioningTemplateVersionRequestTypeDef
def get_value() -> DeleteProvisioningTemplateVersionRequestTypeDef:
return {
"templateName": ...,
}
# DeleteProvisioningTemplateVersionRequestTypeDef definition
class DeleteProvisioningTemplateVersionRequestTypeDef(TypedDict):
templateName: str,
versionId: int,DeleteRoleAliasRequestTypeDef#
# DeleteRoleAliasRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteRoleAliasRequestTypeDef
def get_value() -> DeleteRoleAliasRequestTypeDef:
return {
"roleAlias": ...,
}
# DeleteRoleAliasRequestTypeDef definition
class DeleteRoleAliasRequestTypeDef(TypedDict):
roleAlias: str,DeleteScheduledAuditRequestTypeDef#
# DeleteScheduledAuditRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteScheduledAuditRequestTypeDef
def get_value() -> DeleteScheduledAuditRequestTypeDef:
return {
"scheduledAuditName": ...,
}
# DeleteScheduledAuditRequestTypeDef definition
class DeleteScheduledAuditRequestTypeDef(TypedDict):
scheduledAuditName: str,DeleteSecurityProfileRequestTypeDef#
# DeleteSecurityProfileRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteSecurityProfileRequestTypeDef
def get_value() -> DeleteSecurityProfileRequestTypeDef:
return {
"securityProfileName": ...,
}
# DeleteSecurityProfileRequestTypeDef definition
class DeleteSecurityProfileRequestTypeDef(TypedDict):
securityProfileName: str,
expectedVersion: NotRequired[int],DeleteStreamRequestTypeDef#
# DeleteStreamRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteStreamRequestTypeDef
def get_value() -> DeleteStreamRequestTypeDef:
return {
"streamId": ...,
}
# DeleteStreamRequestTypeDef definition
class DeleteStreamRequestTypeDef(TypedDict):
streamId: str,DeleteThingGroupRequestTypeDef#
# DeleteThingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteThingGroupRequestTypeDef
def get_value() -> DeleteThingGroupRequestTypeDef:
return {
"thingGroupName": ...,
}
# DeleteThingGroupRequestTypeDef definition
class DeleteThingGroupRequestTypeDef(TypedDict):
thingGroupName: str,
expectedVersion: NotRequired[int],DeleteThingRequestTypeDef#
# DeleteThingRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteThingRequestTypeDef
def get_value() -> DeleteThingRequestTypeDef:
return {
"thingName": ...,
}
# DeleteThingRequestTypeDef definition
class DeleteThingRequestTypeDef(TypedDict):
thingName: str,
expectedVersion: NotRequired[int],DeleteThingTypeRequestTypeDef#
# DeleteThingTypeRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteThingTypeRequestTypeDef
def get_value() -> DeleteThingTypeRequestTypeDef:
return {
"thingTypeName": ...,
}
# DeleteThingTypeRequestTypeDef definition
class DeleteThingTypeRequestTypeDef(TypedDict):
thingTypeName: str,DeleteTopicRuleDestinationRequestTypeDef#
# DeleteTopicRuleDestinationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteTopicRuleDestinationRequestTypeDef
def get_value() -> DeleteTopicRuleDestinationRequestTypeDef:
return {
"arn": ...,
}
# DeleteTopicRuleDestinationRequestTypeDef definition
class DeleteTopicRuleDestinationRequestTypeDef(TypedDict):
arn: str,DeleteTopicRuleRequestTypeDef#
# DeleteTopicRuleRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteTopicRuleRequestTypeDef
def get_value() -> DeleteTopicRuleRequestTypeDef:
return {
"ruleName": ...,
}
# DeleteTopicRuleRequestTypeDef definition
class DeleteTopicRuleRequestTypeDef(TypedDict):
ruleName: str,DeleteV2LoggingLevelRequestTypeDef#
# DeleteV2LoggingLevelRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteV2LoggingLevelRequestTypeDef
def get_value() -> DeleteV2LoggingLevelRequestTypeDef:
return {
"targetType": ...,
}
# DeleteV2LoggingLevelRequestTypeDef definition
class DeleteV2LoggingLevelRequestTypeDef(TypedDict):
targetType: LogTargetTypeType, # (1)
targetName: str,DeprecateThingTypeRequestTypeDef#
# DeprecateThingTypeRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeprecateThingTypeRequestTypeDef
def get_value() -> DeprecateThingTypeRequestTypeDef:
return {
"thingTypeName": ...,
}
# DeprecateThingTypeRequestTypeDef definition
class DeprecateThingTypeRequestTypeDef(TypedDict):
thingTypeName: str,
undoDeprecate: NotRequired[bool],DescribeAuditFindingRequestTypeDef#
# DescribeAuditFindingRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeAuditFindingRequestTypeDef
def get_value() -> DescribeAuditFindingRequestTypeDef:
return {
"findingId": ...,
}
# DescribeAuditFindingRequestTypeDef definition
class DescribeAuditFindingRequestTypeDef(TypedDict):
findingId: str,DescribeAuditMitigationActionsTaskRequestTypeDef#
# DescribeAuditMitigationActionsTaskRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeAuditMitigationActionsTaskRequestTypeDef
def get_value() -> DescribeAuditMitigationActionsTaskRequestTypeDef:
return {
"taskId": ...,
}
# DescribeAuditMitigationActionsTaskRequestTypeDef definition
class DescribeAuditMitigationActionsTaskRequestTypeDef(TypedDict):
taskId: str,TaskStatisticsForAuditCheckTypeDef#
# TaskStatisticsForAuditCheckTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TaskStatisticsForAuditCheckTypeDef
def get_value() -> TaskStatisticsForAuditCheckTypeDef:
return {
"totalFindingsCount": ...,
}
# TaskStatisticsForAuditCheckTypeDef definition
class TaskStatisticsForAuditCheckTypeDef(TypedDict):
totalFindingsCount: NotRequired[int],
failedFindingsCount: NotRequired[int],
succeededFindingsCount: NotRequired[int],
skippedFindingsCount: NotRequired[int],
canceledFindingsCount: NotRequired[int],DescribeAuditTaskRequestTypeDef#
# DescribeAuditTaskRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeAuditTaskRequestTypeDef
def get_value() -> DescribeAuditTaskRequestTypeDef:
return {
"taskId": ...,
}
# DescribeAuditTaskRequestTypeDef definition
class DescribeAuditTaskRequestTypeDef(TypedDict):
taskId: str,TaskStatisticsTypeDef#
# TaskStatisticsTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TaskStatisticsTypeDef
def get_value() -> TaskStatisticsTypeDef:
return {
"totalChecks": ...,
}
# TaskStatisticsTypeDef definition
class TaskStatisticsTypeDef(TypedDict):
totalChecks: NotRequired[int],
inProgressChecks: NotRequired[int],
waitingForDataCollectionChecks: NotRequired[int],
compliantChecks: NotRequired[int],
nonCompliantChecks: NotRequired[int],
failedChecks: NotRequired[int],
canceledChecks: NotRequired[int],DescribeAuthorizerRequestTypeDef#
# DescribeAuthorizerRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeAuthorizerRequestTypeDef
def get_value() -> DescribeAuthorizerRequestTypeDef:
return {
"authorizerName": ...,
}
# DescribeAuthorizerRequestTypeDef definition
class DescribeAuthorizerRequestTypeDef(TypedDict):
authorizerName: str,DescribeBillingGroupRequestTypeDef#
# DescribeBillingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeBillingGroupRequestTypeDef
def get_value() -> DescribeBillingGroupRequestTypeDef:
return {
"billingGroupName": ...,
}
# DescribeBillingGroupRequestTypeDef definition
class DescribeBillingGroupRequestTypeDef(TypedDict):
billingGroupName: str,DescribeCACertificateRequestTypeDef#
# DescribeCACertificateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeCACertificateRequestTypeDef
def get_value() -> DescribeCACertificateRequestTypeDef:
return {
"certificateId": ...,
}
# DescribeCACertificateRequestTypeDef definition
class DescribeCACertificateRequestTypeDef(TypedDict):
certificateId: str,RegistrationConfigTypeDef#
# RegistrationConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RegistrationConfigTypeDef
def get_value() -> RegistrationConfigTypeDef:
return {
"templateBody": ...,
}
# RegistrationConfigTypeDef definition
class RegistrationConfigTypeDef(TypedDict):
templateBody: NotRequired[str],
roleArn: NotRequired[str],
templateName: NotRequired[str],DescribeCertificateProviderRequestTypeDef#
# DescribeCertificateProviderRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeCertificateProviderRequestTypeDef
def get_value() -> DescribeCertificateProviderRequestTypeDef:
return {
"certificateProviderName": ...,
}
# DescribeCertificateProviderRequestTypeDef definition
class DescribeCertificateProviderRequestTypeDef(TypedDict):
certificateProviderName: str,DescribeCertificateRequestTypeDef#
# DescribeCertificateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeCertificateRequestTypeDef
def get_value() -> DescribeCertificateRequestTypeDef:
return {
"certificateId": ...,
}
# DescribeCertificateRequestTypeDef definition
class DescribeCertificateRequestTypeDef(TypedDict):
certificateId: str,DescribeCustomMetricRequestTypeDef#
# DescribeCustomMetricRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeCustomMetricRequestTypeDef
def get_value() -> DescribeCustomMetricRequestTypeDef:
return {
"metricName": ...,
}
# DescribeCustomMetricRequestTypeDef definition
class DescribeCustomMetricRequestTypeDef(TypedDict):
metricName: str,DescribeDetectMitigationActionsTaskRequestTypeDef#
# DescribeDetectMitigationActionsTaskRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeDetectMitigationActionsTaskRequestTypeDef
def get_value() -> DescribeDetectMitigationActionsTaskRequestTypeDef:
return {
"taskId": ...,
}
# DescribeDetectMitigationActionsTaskRequestTypeDef definition
class DescribeDetectMitigationActionsTaskRequestTypeDef(TypedDict):
taskId: str,DescribeDimensionRequestTypeDef#
# DescribeDimensionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeDimensionRequestTypeDef
def get_value() -> DescribeDimensionRequestTypeDef:
return {
"name": ...,
}
# DescribeDimensionRequestTypeDef definition
class DescribeDimensionRequestTypeDef(TypedDict):
name: str,DescribeDomainConfigurationRequestTypeDef#
# DescribeDomainConfigurationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeDomainConfigurationRequestTypeDef
def get_value() -> DescribeDomainConfigurationRequestTypeDef:
return {
"domainConfigurationName": ...,
}
# DescribeDomainConfigurationRequestTypeDef definition
class DescribeDomainConfigurationRequestTypeDef(TypedDict):
domainConfigurationName: str,ServerCertificateSummaryTypeDef#
# ServerCertificateSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ServerCertificateSummaryTypeDef
def get_value() -> ServerCertificateSummaryTypeDef:
return {
"serverCertificateArn": ...,
}
# ServerCertificateSummaryTypeDef definition
class ServerCertificateSummaryTypeDef(TypedDict):
serverCertificateArn: NotRequired[str],
serverCertificateStatus: NotRequired[ServerCertificateStatusType], # (1)
serverCertificateStatusDetail: NotRequired[str],DescribeEndpointRequestTypeDef#
# DescribeEndpointRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeEndpointRequestTypeDef
def get_value() -> DescribeEndpointRequestTypeDef:
return {
"endpointType": ...,
}
# DescribeEndpointRequestTypeDef definition
class DescribeEndpointRequestTypeDef(TypedDict):
endpointType: NotRequired[str],DescribeFleetMetricRequestTypeDef#
# DescribeFleetMetricRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeFleetMetricRequestTypeDef
def get_value() -> DescribeFleetMetricRequestTypeDef:
return {
"metricName": ...,
}
# DescribeFleetMetricRequestTypeDef definition
class DescribeFleetMetricRequestTypeDef(TypedDict):
metricName: str,DescribeIndexRequestTypeDef#
# DescribeIndexRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeIndexRequestTypeDef
def get_value() -> DescribeIndexRequestTypeDef:
return {
"indexName": ...,
}
# DescribeIndexRequestTypeDef definition
class DescribeIndexRequestTypeDef(TypedDict):
indexName: str,DescribeJobExecutionRequestTypeDef#
# DescribeJobExecutionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeJobExecutionRequestTypeDef
def get_value() -> DescribeJobExecutionRequestTypeDef:
return {
"jobId": ...,
}
# DescribeJobExecutionRequestTypeDef definition
class DescribeJobExecutionRequestTypeDef(TypedDict):
jobId: str,
thingName: str,
executionNumber: NotRequired[int],DescribeJobRequestTypeDef#
# DescribeJobRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeJobRequestTypeDef
def get_value() -> DescribeJobRequestTypeDef:
return {
"jobId": ...,
}
# DescribeJobRequestTypeDef definition
class DescribeJobRequestTypeDef(TypedDict):
jobId: str,
beforeSubstitution: NotRequired[bool],DescribeJobTemplateRequestTypeDef#
# DescribeJobTemplateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeJobTemplateRequestTypeDef
def get_value() -> DescribeJobTemplateRequestTypeDef:
return {
"jobTemplateId": ...,
}
# DescribeJobTemplateRequestTypeDef definition
class DescribeJobTemplateRequestTypeDef(TypedDict):
jobTemplateId: str,DescribeManagedJobTemplateRequestTypeDef#
# DescribeManagedJobTemplateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeManagedJobTemplateRequestTypeDef
def get_value() -> DescribeManagedJobTemplateRequestTypeDef:
return {
"templateName": ...,
}
# DescribeManagedJobTemplateRequestTypeDef definition
class DescribeManagedJobTemplateRequestTypeDef(TypedDict):
templateName: str,
templateVersion: NotRequired[str],DocumentParameterTypeDef#
# DocumentParameterTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DocumentParameterTypeDef
def get_value() -> DocumentParameterTypeDef:
return {
"key": ...,
}
# DocumentParameterTypeDef definition
class DocumentParameterTypeDef(TypedDict):
key: NotRequired[str],
description: NotRequired[str],
regex: NotRequired[str],
example: NotRequired[str],
optional: NotRequired[bool],DescribeMitigationActionRequestTypeDef#
# DescribeMitigationActionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeMitigationActionRequestTypeDef
def get_value() -> DescribeMitigationActionRequestTypeDef:
return {
"actionName": ...,
}
# DescribeMitigationActionRequestTypeDef definition
class DescribeMitigationActionRequestTypeDef(TypedDict):
actionName: str,DescribeProvisioningTemplateRequestTypeDef#
# DescribeProvisioningTemplateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeProvisioningTemplateRequestTypeDef
def get_value() -> DescribeProvisioningTemplateRequestTypeDef:
return {
"templateName": ...,
}
# DescribeProvisioningTemplateRequestTypeDef definition
class DescribeProvisioningTemplateRequestTypeDef(TypedDict):
templateName: str,DescribeProvisioningTemplateVersionRequestTypeDef#
# DescribeProvisioningTemplateVersionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeProvisioningTemplateVersionRequestTypeDef
def get_value() -> DescribeProvisioningTemplateVersionRequestTypeDef:
return {
"templateName": ...,
}
# DescribeProvisioningTemplateVersionRequestTypeDef definition
class DescribeProvisioningTemplateVersionRequestTypeDef(TypedDict):
templateName: str,
versionId: int,DescribeRoleAliasRequestTypeDef#
# DescribeRoleAliasRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeRoleAliasRequestTypeDef
def get_value() -> DescribeRoleAliasRequestTypeDef:
return {
"roleAlias": ...,
}
# DescribeRoleAliasRequestTypeDef definition
class DescribeRoleAliasRequestTypeDef(TypedDict):
roleAlias: str,RoleAliasDescriptionTypeDef#
# RoleAliasDescriptionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RoleAliasDescriptionTypeDef
def get_value() -> RoleAliasDescriptionTypeDef:
return {
"roleAlias": ...,
}
# RoleAliasDescriptionTypeDef definition
class RoleAliasDescriptionTypeDef(TypedDict):
roleAlias: NotRequired[str],
roleAliasArn: NotRequired[str],
roleArn: NotRequired[str],
owner: NotRequired[str],
credentialDurationSeconds: NotRequired[int],
creationDate: NotRequired[datetime],
lastModifiedDate: NotRequired[datetime],DescribeScheduledAuditRequestTypeDef#
# DescribeScheduledAuditRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeScheduledAuditRequestTypeDef
def get_value() -> DescribeScheduledAuditRequestTypeDef:
return {
"scheduledAuditName": ...,
}
# DescribeScheduledAuditRequestTypeDef definition
class DescribeScheduledAuditRequestTypeDef(TypedDict):
scheduledAuditName: str,DescribeSecurityProfileRequestTypeDef#
# DescribeSecurityProfileRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeSecurityProfileRequestTypeDef
def get_value() -> DescribeSecurityProfileRequestTypeDef:
return {
"securityProfileName": ...,
}
# DescribeSecurityProfileRequestTypeDef definition
class DescribeSecurityProfileRequestTypeDef(TypedDict):
securityProfileName: str,DescribeStreamRequestTypeDef#
# DescribeStreamRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeStreamRequestTypeDef
def get_value() -> DescribeStreamRequestTypeDef:
return {
"streamId": ...,
}
# DescribeStreamRequestTypeDef definition
class DescribeStreamRequestTypeDef(TypedDict):
streamId: str,DescribeThingGroupRequestTypeDef#
# DescribeThingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeThingGroupRequestTypeDef
def get_value() -> DescribeThingGroupRequestTypeDef:
return {
"thingGroupName": ...,
}
# DescribeThingGroupRequestTypeDef definition
class DescribeThingGroupRequestTypeDef(TypedDict):
thingGroupName: str,DescribeThingRegistrationTaskRequestTypeDef#
# DescribeThingRegistrationTaskRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeThingRegistrationTaskRequestTypeDef
def get_value() -> DescribeThingRegistrationTaskRequestTypeDef:
return {
"taskId": ...,
}
# DescribeThingRegistrationTaskRequestTypeDef definition
class DescribeThingRegistrationTaskRequestTypeDef(TypedDict):
taskId: str,DescribeThingRequestTypeDef#
# DescribeThingRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeThingRequestTypeDef
def get_value() -> DescribeThingRequestTypeDef:
return {
"thingName": ...,
}
# DescribeThingRequestTypeDef definition
class DescribeThingRequestTypeDef(TypedDict):
thingName: str,DescribeThingTypeRequestTypeDef#
# DescribeThingTypeRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeThingTypeRequestTypeDef
def get_value() -> DescribeThingTypeRequestTypeDef:
return {
"thingTypeName": ...,
}
# DescribeThingTypeRequestTypeDef definition
class DescribeThingTypeRequestTypeDef(TypedDict):
thingTypeName: str,ThingTypeMetadataTypeDef#
# ThingTypeMetadataTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingTypeMetadataTypeDef
def get_value() -> ThingTypeMetadataTypeDef:
return {
"deprecated": ...,
}
# ThingTypeMetadataTypeDef definition
class ThingTypeMetadataTypeDef(TypedDict):
deprecated: NotRequired[bool],
deprecationDate: NotRequired[datetime],
creationDate: NotRequired[datetime],S3DestinationTypeDef#
# S3DestinationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import S3DestinationTypeDef
def get_value() -> S3DestinationTypeDef:
return {
"bucket": ...,
}
# S3DestinationTypeDef definition
class S3DestinationTypeDef(TypedDict):
bucket: NotRequired[str],
prefix: NotRequired[str],DetachPolicyRequestTypeDef#
# DetachPolicyRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DetachPolicyRequestTypeDef
def get_value() -> DetachPolicyRequestTypeDef:
return {
"policyName": ...,
}
# DetachPolicyRequestTypeDef definition
class DetachPolicyRequestTypeDef(TypedDict):
policyName: str,
target: str,DetachPrincipalPolicyRequestTypeDef#
# DetachPrincipalPolicyRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DetachPrincipalPolicyRequestTypeDef
def get_value() -> DetachPrincipalPolicyRequestTypeDef:
return {
"policyName": ...,
}
# DetachPrincipalPolicyRequestTypeDef definition
class DetachPrincipalPolicyRequestTypeDef(TypedDict):
policyName: str,
principal: str,DetachSecurityProfileRequestTypeDef#
# DetachSecurityProfileRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DetachSecurityProfileRequestTypeDef
def get_value() -> DetachSecurityProfileRequestTypeDef:
return {
"securityProfileName": ...,
}
# DetachSecurityProfileRequestTypeDef definition
class DetachSecurityProfileRequestTypeDef(TypedDict):
securityProfileName: str,
securityProfileTargetArn: str,DetachThingPrincipalRequestTypeDef#
# DetachThingPrincipalRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DetachThingPrincipalRequestTypeDef
def get_value() -> DetachThingPrincipalRequestTypeDef:
return {
"thingName": ...,
}
# DetachThingPrincipalRequestTypeDef definition
class DetachThingPrincipalRequestTypeDef(TypedDict):
thingName: str,
principal: str,DetectMitigationActionExecutionTypeDef#
# DetectMitigationActionExecutionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DetectMitigationActionExecutionTypeDef
def get_value() -> DetectMitigationActionExecutionTypeDef:
return {
"taskId": ...,
}
# DetectMitigationActionExecutionTypeDef definition
class DetectMitigationActionExecutionTypeDef(TypedDict):
taskId: NotRequired[str],
violationId: NotRequired[str],
actionName: NotRequired[str],
thingName: NotRequired[str],
executionStartDate: NotRequired[datetime],
executionEndDate: NotRequired[datetime],
status: NotRequired[DetectMitigationActionExecutionStatusType], # (1)
errorCode: NotRequired[str],
message: NotRequired[str],DetectMitigationActionsTaskStatisticsTypeDef#
# DetectMitigationActionsTaskStatisticsTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DetectMitigationActionsTaskStatisticsTypeDef
def get_value() -> DetectMitigationActionsTaskStatisticsTypeDef:
return {
"actionsExecuted": ...,
}
# DetectMitigationActionsTaskStatisticsTypeDef definition
class DetectMitigationActionsTaskStatisticsTypeDef(TypedDict):
actionsExecuted: NotRequired[int],
actionsSkipped: NotRequired[int],
actionsFailed: NotRequired[int],DetectMitigationActionsTaskTargetOutputTypeDef#
# DetectMitigationActionsTaskTargetOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DetectMitigationActionsTaskTargetOutputTypeDef
def get_value() -> DetectMitigationActionsTaskTargetOutputTypeDef:
return {
"violationIds": ...,
}
# DetectMitigationActionsTaskTargetOutputTypeDef definition
class DetectMitigationActionsTaskTargetOutputTypeDef(TypedDict):
violationIds: NotRequired[List[str]],
securityProfileName: NotRequired[str],
behaviorName: NotRequired[str],ViolationEventOccurrenceRangeOutputTypeDef#
# ViolationEventOccurrenceRangeOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ViolationEventOccurrenceRangeOutputTypeDef
def get_value() -> ViolationEventOccurrenceRangeOutputTypeDef:
return {
"startTime": ...,
}
# ViolationEventOccurrenceRangeOutputTypeDef definition
class ViolationEventOccurrenceRangeOutputTypeDef(TypedDict):
startTime: datetime,
endTime: datetime,DetectMitigationActionsTaskTargetTypeDef#
# DetectMitigationActionsTaskTargetTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DetectMitigationActionsTaskTargetTypeDef
def get_value() -> DetectMitigationActionsTaskTargetTypeDef:
return {
"violationIds": ...,
}
# DetectMitigationActionsTaskTargetTypeDef definition
class DetectMitigationActionsTaskTargetTypeDef(TypedDict):
violationIds: NotRequired[Sequence[str]],
securityProfileName: NotRequired[str],
behaviorName: NotRequired[str],DisableTopicRuleRequestTypeDef#
# DisableTopicRuleRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DisableTopicRuleRequestTypeDef
def get_value() -> DisableTopicRuleRequestTypeDef:
return {
"ruleName": ...,
}
# DisableTopicRuleRequestTypeDef definition
class DisableTopicRuleRequestTypeDef(TypedDict):
ruleName: str,DisassociateSbomFromPackageVersionRequestTypeDef#
# DisassociateSbomFromPackageVersionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DisassociateSbomFromPackageVersionRequestTypeDef
def get_value() -> DisassociateSbomFromPackageVersionRequestTypeDef:
return {
"packageName": ...,
}
# DisassociateSbomFromPackageVersionRequestTypeDef definition
class DisassociateSbomFromPackageVersionRequestTypeDef(TypedDict):
packageName: str,
versionName: str,
clientToken: NotRequired[str],DomainConfigurationSummaryTypeDef#
# DomainConfigurationSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DomainConfigurationSummaryTypeDef
def get_value() -> DomainConfigurationSummaryTypeDef:
return {
"domainConfigurationName": ...,
}
# DomainConfigurationSummaryTypeDef definition
class DomainConfigurationSummaryTypeDef(TypedDict):
domainConfigurationName: NotRequired[str],
domainConfigurationArn: NotRequired[str],
serviceType: NotRequired[ServiceTypeType], # (1)- See ServiceTypeType
PutItemInputTypeDef#
# PutItemInputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PutItemInputTypeDef
def get_value() -> PutItemInputTypeDef:
return {
"tableName": ...,
}
# PutItemInputTypeDef definition
class PutItemInputTypeDef(TypedDict):
tableName: str,EffectivePolicyTypeDef#
# EffectivePolicyTypeDef TypedDict usage example
from types_boto3_iot.type_defs import EffectivePolicyTypeDef
def get_value() -> EffectivePolicyTypeDef:
return {
"policyName": ...,
}
# EffectivePolicyTypeDef definition
class EffectivePolicyTypeDef(TypedDict):
policyName: NotRequired[str],
policyArn: NotRequired[str],
policyDocument: NotRequired[str],EnableIoTLoggingParamsTypeDef#
# EnableIoTLoggingParamsTypeDef TypedDict usage example
from types_boto3_iot.type_defs import EnableIoTLoggingParamsTypeDef
def get_value() -> EnableIoTLoggingParamsTypeDef:
return {
"roleArnForLogging": ...,
}
# EnableIoTLoggingParamsTypeDef definition
class EnableIoTLoggingParamsTypeDef(TypedDict):
roleArnForLogging: str,
logLevel: LogLevelType, # (1)- See LogLevelType
EnableTopicRuleRequestTypeDef#
# EnableTopicRuleRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import EnableTopicRuleRequestTypeDef
def get_value() -> EnableTopicRuleRequestTypeDef:
return {
"ruleName": ...,
}
# EnableTopicRuleRequestTypeDef definition
class EnableTopicRuleRequestTypeDef(TypedDict):
ruleName: str,ErrorInfoTypeDef#
# ErrorInfoTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ErrorInfoTypeDef
def get_value() -> ErrorInfoTypeDef:
return {
"code": ...,
}
# ErrorInfoTypeDef definition
class ErrorInfoTypeDef(TypedDict):
code: NotRequired[str],
message: NotRequired[str],RateIncreaseCriteriaTypeDef#
# RateIncreaseCriteriaTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RateIncreaseCriteriaTypeDef
def get_value() -> RateIncreaseCriteriaTypeDef:
return {
"numberOfNotifiedThings": ...,
}
# RateIncreaseCriteriaTypeDef definition
class RateIncreaseCriteriaTypeDef(TypedDict):
numberOfNotifiedThings: NotRequired[int],
numberOfSucceededThings: NotRequired[int],FieldTypeDef#
# FieldTypeDef TypedDict usage example
from types_boto3_iot.type_defs import FieldTypeDef
def get_value() -> FieldTypeDef:
return {
"name": ...,
}
# FieldTypeDef definition
class FieldTypeDef(TypedDict):
name: NotRequired[str],
type: NotRequired[FieldTypeType], # (1)- See FieldTypeType
S3LocationTypeDef#
# S3LocationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import S3LocationTypeDef
def get_value() -> S3LocationTypeDef:
return {
"bucket": ...,
}
# S3LocationTypeDef definition
class S3LocationTypeDef(TypedDict):
bucket: NotRequired[str],
key: NotRequired[str],
version: NotRequired[str],StreamTypeDef#
# StreamTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StreamTypeDef
def get_value() -> StreamTypeDef:
return {
"streamId": ...,
}
# StreamTypeDef definition
class StreamTypeDef(TypedDict):
streamId: NotRequired[str],
fileId: NotRequired[int],FleetMetricNameAndArnTypeDef#
# FleetMetricNameAndArnTypeDef TypedDict usage example
from types_boto3_iot.type_defs import FleetMetricNameAndArnTypeDef
def get_value() -> FleetMetricNameAndArnTypeDef:
return {
"metricName": ...,
}
# FleetMetricNameAndArnTypeDef definition
class FleetMetricNameAndArnTypeDef(TypedDict):
metricName: NotRequired[str],
metricArn: NotRequired[str],GeoLocationTargetTypeDef#
# GeoLocationTargetTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GeoLocationTargetTypeDef
def get_value() -> GeoLocationTargetTypeDef:
return {
"name": ...,
}
# GeoLocationTargetTypeDef definition
class GeoLocationTargetTypeDef(TypedDict):
name: NotRequired[str],
order: NotRequired[TargetFieldOrderType], # (1)PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],GetBehaviorModelTrainingSummariesRequestTypeDef#
# GetBehaviorModelTrainingSummariesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetBehaviorModelTrainingSummariesRequestTypeDef
def get_value() -> GetBehaviorModelTrainingSummariesRequestTypeDef:
return {
"securityProfileName": ...,
}
# GetBehaviorModelTrainingSummariesRequestTypeDef definition
class GetBehaviorModelTrainingSummariesRequestTypeDef(TypedDict):
securityProfileName: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],GetCardinalityRequestTypeDef#
# GetCardinalityRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetCardinalityRequestTypeDef
def get_value() -> GetCardinalityRequestTypeDef:
return {
"queryString": ...,
}
# GetCardinalityRequestTypeDef definition
class GetCardinalityRequestTypeDef(TypedDict):
queryString: str,
indexName: NotRequired[str],
aggregationField: NotRequired[str],
queryVersion: NotRequired[str],GetCommandExecutionRequestTypeDef#
# GetCommandExecutionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetCommandExecutionRequestTypeDef
def get_value() -> GetCommandExecutionRequestTypeDef:
return {
"executionId": ...,
}
# GetCommandExecutionRequestTypeDef definition
class GetCommandExecutionRequestTypeDef(TypedDict):
executionId: str,
targetArn: str,
includeResult: NotRequired[bool],StatusReasonTypeDef#
# StatusReasonTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StatusReasonTypeDef
def get_value() -> StatusReasonTypeDef:
return {
"reasonCode": ...,
}
# StatusReasonTypeDef definition
class StatusReasonTypeDef(TypedDict):
reasonCode: str,
reasonDescription: NotRequired[str],GetCommandRequestTypeDef#
# GetCommandRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetCommandRequestTypeDef
def get_value() -> GetCommandRequestTypeDef:
return {
"commandId": ...,
}
# GetCommandRequestTypeDef definition
class GetCommandRequestTypeDef(TypedDict):
commandId: str,GetEffectivePoliciesRequestTypeDef#
# GetEffectivePoliciesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetEffectivePoliciesRequestTypeDef
def get_value() -> GetEffectivePoliciesRequestTypeDef:
return {
"principal": ...,
}
# GetEffectivePoliciesRequestTypeDef definition
class GetEffectivePoliciesRequestTypeDef(TypedDict):
principal: NotRequired[str],
cognitoIdentityPoolId: NotRequired[str],
thingName: NotRequired[str],GetJobDocumentRequestTypeDef#
# GetJobDocumentRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetJobDocumentRequestTypeDef
def get_value() -> GetJobDocumentRequestTypeDef:
return {
"jobId": ...,
}
# GetJobDocumentRequestTypeDef definition
class GetJobDocumentRequestTypeDef(TypedDict):
jobId: str,
beforeSubstitution: NotRequired[bool],GetOTAUpdateRequestTypeDef#
# GetOTAUpdateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetOTAUpdateRequestTypeDef
def get_value() -> GetOTAUpdateRequestTypeDef:
return {
"otaUpdateId": ...,
}
# GetOTAUpdateRequestTypeDef definition
class GetOTAUpdateRequestTypeDef(TypedDict):
otaUpdateId: str,VersionUpdateByJobsConfigTypeDef#
# VersionUpdateByJobsConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import VersionUpdateByJobsConfigTypeDef
def get_value() -> VersionUpdateByJobsConfigTypeDef:
return {
"enabled": ...,
}
# VersionUpdateByJobsConfigTypeDef definition
class VersionUpdateByJobsConfigTypeDef(TypedDict):
enabled: NotRequired[bool],
roleArn: NotRequired[str],GetPackageRequestTypeDef#
# GetPackageRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetPackageRequestTypeDef
def get_value() -> GetPackageRequestTypeDef:
return {
"packageName": ...,
}
# GetPackageRequestTypeDef definition
class GetPackageRequestTypeDef(TypedDict):
packageName: str,GetPackageVersionRequestTypeDef#
# GetPackageVersionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetPackageVersionRequestTypeDef
def get_value() -> GetPackageVersionRequestTypeDef:
return {
"packageName": ...,
}
# GetPackageVersionRequestTypeDef definition
class GetPackageVersionRequestTypeDef(TypedDict):
packageName: str,
versionName: str,GetPercentilesRequestTypeDef#
# GetPercentilesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetPercentilesRequestTypeDef
def get_value() -> GetPercentilesRequestTypeDef:
return {
"queryString": ...,
}
# GetPercentilesRequestTypeDef definition
class GetPercentilesRequestTypeDef(TypedDict):
queryString: str,
indexName: NotRequired[str],
aggregationField: NotRequired[str],
queryVersion: NotRequired[str],
percents: NotRequired[Sequence[float]],PercentPairTypeDef#
# PercentPairTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PercentPairTypeDef
def get_value() -> PercentPairTypeDef:
return {
"percent": ...,
}
# PercentPairTypeDef definition
class PercentPairTypeDef(TypedDict):
percent: NotRequired[float],
value: NotRequired[float],GetPolicyRequestTypeDef#
# GetPolicyRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetPolicyRequestTypeDef
def get_value() -> GetPolicyRequestTypeDef:
return {
"policyName": ...,
}
# GetPolicyRequestTypeDef definition
class GetPolicyRequestTypeDef(TypedDict):
policyName: str,GetPolicyVersionRequestTypeDef#
# GetPolicyVersionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetPolicyVersionRequestTypeDef
def get_value() -> GetPolicyVersionRequestTypeDef:
return {
"policyName": ...,
}
# GetPolicyVersionRequestTypeDef definition
class GetPolicyVersionRequestTypeDef(TypedDict):
policyName: str,
policyVersionId: str,GetStatisticsRequestTypeDef#
# GetStatisticsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetStatisticsRequestTypeDef
def get_value() -> GetStatisticsRequestTypeDef:
return {
"queryString": ...,
}
# GetStatisticsRequestTypeDef definition
class GetStatisticsRequestTypeDef(TypedDict):
queryString: str,
indexName: NotRequired[str],
aggregationField: NotRequired[str],
queryVersion: NotRequired[str],StatisticsTypeDef#
# StatisticsTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StatisticsTypeDef
def get_value() -> StatisticsTypeDef:
return {
"count": ...,
}
# StatisticsTypeDef definition
class StatisticsTypeDef(TypedDict):
count: NotRequired[int],
average: NotRequired[float],
sum: NotRequired[float],
minimum: NotRequired[float],
maximum: NotRequired[float],
sumOfSquares: NotRequired[float],
variance: NotRequired[float],
stdDeviation: NotRequired[float],GetThingConnectivityDataRequestTypeDef#
# GetThingConnectivityDataRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetThingConnectivityDataRequestTypeDef
def get_value() -> GetThingConnectivityDataRequestTypeDef:
return {
"thingName": ...,
}
# GetThingConnectivityDataRequestTypeDef definition
class GetThingConnectivityDataRequestTypeDef(TypedDict):
thingName: str,GetTopicRuleDestinationRequestTypeDef#
# GetTopicRuleDestinationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetTopicRuleDestinationRequestTypeDef
def get_value() -> GetTopicRuleDestinationRequestTypeDef:
return {
"arn": ...,
}
# GetTopicRuleDestinationRequestTypeDef definition
class GetTopicRuleDestinationRequestTypeDef(TypedDict):
arn: str,GetTopicRuleRequestTypeDef#
# GetTopicRuleRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetTopicRuleRequestTypeDef
def get_value() -> GetTopicRuleRequestTypeDef:
return {
"ruleName": ...,
}
# GetTopicRuleRequestTypeDef definition
class GetTopicRuleRequestTypeDef(TypedDict):
ruleName: str,GroupNameAndArnTypeDef#
# GroupNameAndArnTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GroupNameAndArnTypeDef
def get_value() -> GroupNameAndArnTypeDef:
return {
"groupName": ...,
}
# GroupNameAndArnTypeDef definition
class GroupNameAndArnTypeDef(TypedDict):
groupName: NotRequired[str],
groupArn: NotRequired[str],HttpActionHeaderTypeDef#
# HttpActionHeaderTypeDef TypedDict usage example
from types_boto3_iot.type_defs import HttpActionHeaderTypeDef
def get_value() -> HttpActionHeaderTypeDef:
return {
"key": ...,
}
# HttpActionHeaderTypeDef definition
class HttpActionHeaderTypeDef(TypedDict):
key: str,
value: str,SigV4AuthorizationTypeDef#
# SigV4AuthorizationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SigV4AuthorizationTypeDef
def get_value() -> SigV4AuthorizationTypeDef:
return {
"signingRegion": ...,
}
# SigV4AuthorizationTypeDef definition
class SigV4AuthorizationTypeDef(TypedDict):
signingRegion: str,
serviceName: str,
roleArn: str,HttpContextTypeDef#
# HttpContextTypeDef TypedDict usage example
from types_boto3_iot.type_defs import HttpContextTypeDef
def get_value() -> HttpContextTypeDef:
return {
"headers": ...,
}
# HttpContextTypeDef definition
class HttpContextTypeDef(TypedDict):
headers: NotRequired[Mapping[str, str]],
queryString: NotRequired[str],HttpUrlDestinationConfigurationTypeDef#
# HttpUrlDestinationConfigurationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import HttpUrlDestinationConfigurationTypeDef
def get_value() -> HttpUrlDestinationConfigurationTypeDef:
return {
"confirmationUrl": ...,
}
# HttpUrlDestinationConfigurationTypeDef definition
class HttpUrlDestinationConfigurationTypeDef(TypedDict):
confirmationUrl: str,HttpUrlDestinationPropertiesTypeDef#
# HttpUrlDestinationPropertiesTypeDef TypedDict usage example
from types_boto3_iot.type_defs import HttpUrlDestinationPropertiesTypeDef
def get_value() -> HttpUrlDestinationPropertiesTypeDef:
return {
"confirmationUrl": ...,
}
# HttpUrlDestinationPropertiesTypeDef definition
class HttpUrlDestinationPropertiesTypeDef(TypedDict):
confirmationUrl: NotRequired[str],HttpUrlDestinationSummaryTypeDef#
# HttpUrlDestinationSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import HttpUrlDestinationSummaryTypeDef
def get_value() -> HttpUrlDestinationSummaryTypeDef:
return {
"confirmationUrl": ...,
}
# HttpUrlDestinationSummaryTypeDef definition
class HttpUrlDestinationSummaryTypeDef(TypedDict):
confirmationUrl: NotRequired[str],IssuerCertificateIdentifierTypeDef#
# IssuerCertificateIdentifierTypeDef TypedDict usage example
from types_boto3_iot.type_defs import IssuerCertificateIdentifierTypeDef
def get_value() -> IssuerCertificateIdentifierTypeDef:
return {
"issuerCertificateSubject": ...,
}
# IssuerCertificateIdentifierTypeDef definition
class IssuerCertificateIdentifierTypeDef(TypedDict):
issuerCertificateSubject: NotRequired[str],
issuerId: NotRequired[str],
issuerCertificateSerialNumber: NotRequired[str],JobExecutionStatusDetailsTypeDef#
# JobExecutionStatusDetailsTypeDef TypedDict usage example
from types_boto3_iot.type_defs import JobExecutionStatusDetailsTypeDef
def get_value() -> JobExecutionStatusDetailsTypeDef:
return {
"detailsMap": ...,
}
# JobExecutionStatusDetailsTypeDef definition
class JobExecutionStatusDetailsTypeDef(TypedDict):
detailsMap: NotRequired[Dict[str, str]],JobExecutionSummaryTypeDef#
# JobExecutionSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import JobExecutionSummaryTypeDef
def get_value() -> JobExecutionSummaryTypeDef:
return {
"status": ...,
}
# JobExecutionSummaryTypeDef definition
class JobExecutionSummaryTypeDef(TypedDict):
status: NotRequired[JobExecutionStatusType], # (1)
queuedAt: NotRequired[datetime],
startedAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],
executionNumber: NotRequired[int],
retryAttempt: NotRequired[int],RetryCriteriaTypeDef#
# RetryCriteriaTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RetryCriteriaTypeDef
def get_value() -> RetryCriteriaTypeDef:
return {
"failureType": ...,
}
# RetryCriteriaTypeDef definition
class RetryCriteriaTypeDef(TypedDict):
failureType: RetryableFailureTypeType, # (1)
numberOfRetries: int,JobProcessDetailsTypeDef#
# JobProcessDetailsTypeDef TypedDict usage example
from types_boto3_iot.type_defs import JobProcessDetailsTypeDef
def get_value() -> JobProcessDetailsTypeDef:
return {
"processingTargets": ...,
}
# JobProcessDetailsTypeDef definition
class JobProcessDetailsTypeDef(TypedDict):
processingTargets: NotRequired[List[str]],
numberOfCanceledThings: NotRequired[int],
numberOfSucceededThings: NotRequired[int],
numberOfFailedThings: NotRequired[int],
numberOfRejectedThings: NotRequired[int],
numberOfQueuedThings: NotRequired[int],
numberOfInProgressThings: NotRequired[int],
numberOfRemovedThings: NotRequired[int],
numberOfTimedOutThings: NotRequired[int],JobSummaryTypeDef#
# JobSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import JobSummaryTypeDef
def get_value() -> JobSummaryTypeDef:
return {
"jobArn": ...,
}
# JobSummaryTypeDef definition
class JobSummaryTypeDef(TypedDict):
jobArn: NotRequired[str],
jobId: NotRequired[str],
thingGroupId: NotRequired[str],
targetSelection: NotRequired[TargetSelectionType], # (1)
status: NotRequired[JobStatusType], # (2)
createdAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],
completedAt: NotRequired[datetime],
isConcurrent: NotRequired[bool],- See TargetSelectionType
- See JobStatusType
JobTemplateSummaryTypeDef#
# JobTemplateSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import JobTemplateSummaryTypeDef
def get_value() -> JobTemplateSummaryTypeDef:
return {
"jobTemplateArn": ...,
}
# JobTemplateSummaryTypeDef definition
class JobTemplateSummaryTypeDef(TypedDict):
jobTemplateArn: NotRequired[str],
jobTemplateId: NotRequired[str],
description: NotRequired[str],
createdAt: NotRequired[datetime],ScheduledJobRolloutTypeDef#
# ScheduledJobRolloutTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ScheduledJobRolloutTypeDef
def get_value() -> ScheduledJobRolloutTypeDef:
return {
"startTime": ...,
}
# ScheduledJobRolloutTypeDef definition
class ScheduledJobRolloutTypeDef(TypedDict):
startTime: NotRequired[str],KafkaActionHeaderTypeDef#
# KafkaActionHeaderTypeDef TypedDict usage example
from types_boto3_iot.type_defs import KafkaActionHeaderTypeDef
def get_value() -> KafkaActionHeaderTypeDef:
return {
"key": ...,
}
# KafkaActionHeaderTypeDef definition
class KafkaActionHeaderTypeDef(TypedDict):
key: str,
value: str,ListActiveViolationsRequestTypeDef#
# ListActiveViolationsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListActiveViolationsRequestTypeDef
def get_value() -> ListActiveViolationsRequestTypeDef:
return {
"thingName": ...,
}
# ListActiveViolationsRequestTypeDef definition
class ListActiveViolationsRequestTypeDef(TypedDict):
thingName: NotRequired[str],
securityProfileName: NotRequired[str],
behaviorCriteriaType: NotRequired[BehaviorCriteriaTypeType], # (1)
listSuppressedAlerts: NotRequired[bool],
verificationState: NotRequired[VerificationStateType], # (2)
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListAttachedPoliciesRequestTypeDef#
# ListAttachedPoliciesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAttachedPoliciesRequestTypeDef
def get_value() -> ListAttachedPoliciesRequestTypeDef:
return {
"target": ...,
}
# ListAttachedPoliciesRequestTypeDef definition
class ListAttachedPoliciesRequestTypeDef(TypedDict):
target: str,
recursive: NotRequired[bool],
marker: NotRequired[str],
pageSize: NotRequired[int],ListAuditMitigationActionsExecutionsRequestTypeDef#
# ListAuditMitigationActionsExecutionsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuditMitigationActionsExecutionsRequestTypeDef
def get_value() -> ListAuditMitigationActionsExecutionsRequestTypeDef:
return {
"taskId": ...,
}
# ListAuditMitigationActionsExecutionsRequestTypeDef definition
class ListAuditMitigationActionsExecutionsRequestTypeDef(TypedDict):
taskId: str,
findingId: str,
actionStatus: NotRequired[AuditMitigationActionsExecutionStatusType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListAuthorizersRequestTypeDef#
# ListAuthorizersRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuthorizersRequestTypeDef
def get_value() -> ListAuthorizersRequestTypeDef:
return {
"pageSize": ...,
}
# ListAuthorizersRequestTypeDef definition
class ListAuthorizersRequestTypeDef(TypedDict):
pageSize: NotRequired[int],
marker: NotRequired[str],
ascendingOrder: NotRequired[bool],
status: NotRequired[AuthorizerStatusType], # (1)ListBillingGroupsRequestTypeDef#
# ListBillingGroupsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListBillingGroupsRequestTypeDef
def get_value() -> ListBillingGroupsRequestTypeDef:
return {
"nextToken": ...,
}
# ListBillingGroupsRequestTypeDef definition
class ListBillingGroupsRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
namePrefixFilter: NotRequired[str],ListCACertificatesRequestTypeDef#
# ListCACertificatesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCACertificatesRequestTypeDef
def get_value() -> ListCACertificatesRequestTypeDef:
return {
"pageSize": ...,
}
# ListCACertificatesRequestTypeDef definition
class ListCACertificatesRequestTypeDef(TypedDict):
pageSize: NotRequired[int],
marker: NotRequired[str],
ascendingOrder: NotRequired[bool],
templateName: NotRequired[str],ListCertificateProvidersRequestTypeDef#
# ListCertificateProvidersRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCertificateProvidersRequestTypeDef
def get_value() -> ListCertificateProvidersRequestTypeDef:
return {
"nextToken": ...,
}
# ListCertificateProvidersRequestTypeDef definition
class ListCertificateProvidersRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
ascendingOrder: NotRequired[bool],ListCertificatesByCARequestTypeDef#
# ListCertificatesByCARequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCertificatesByCARequestTypeDef
def get_value() -> ListCertificatesByCARequestTypeDef:
return {
"caCertificateId": ...,
}
# ListCertificatesByCARequestTypeDef definition
class ListCertificatesByCARequestTypeDef(TypedDict):
caCertificateId: str,
pageSize: NotRequired[int],
marker: NotRequired[str],
ascendingOrder: NotRequired[bool],ListCertificatesRequestTypeDef#
# ListCertificatesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCertificatesRequestTypeDef
def get_value() -> ListCertificatesRequestTypeDef:
return {
"pageSize": ...,
}
# ListCertificatesRequestTypeDef definition
class ListCertificatesRequestTypeDef(TypedDict):
pageSize: NotRequired[int],
marker: NotRequired[str],
ascendingOrder: NotRequired[bool],TimeFilterTypeDef#
# TimeFilterTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TimeFilterTypeDef
def get_value() -> TimeFilterTypeDef:
return {
"after": ...,
}
# TimeFilterTypeDef definition
class TimeFilterTypeDef(TypedDict):
after: NotRequired[str],
before: NotRequired[str],ListCommandsRequestTypeDef#
# ListCommandsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCommandsRequestTypeDef
def get_value() -> ListCommandsRequestTypeDef:
return {
"maxResults": ...,
}
# ListCommandsRequestTypeDef definition
class ListCommandsRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
namespace: NotRequired[CommandNamespaceType], # (1)
commandParameterName: NotRequired[str],
sortOrder: NotRequired[SortOrderType], # (2)- See CommandNamespaceType
- See SortOrderType
ListCustomMetricsRequestTypeDef#
# ListCustomMetricsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCustomMetricsRequestTypeDef
def get_value() -> ListCustomMetricsRequestTypeDef:
return {
"nextToken": ...,
}
# ListCustomMetricsRequestTypeDef definition
class ListCustomMetricsRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListDimensionsRequestTypeDef#
# ListDimensionsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListDimensionsRequestTypeDef
def get_value() -> ListDimensionsRequestTypeDef:
return {
"nextToken": ...,
}
# ListDimensionsRequestTypeDef definition
class ListDimensionsRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListDomainConfigurationsRequestTypeDef#
# ListDomainConfigurationsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListDomainConfigurationsRequestTypeDef
def get_value() -> ListDomainConfigurationsRequestTypeDef:
return {
"marker": ...,
}
# ListDomainConfigurationsRequestTypeDef definition
class ListDomainConfigurationsRequestTypeDef(TypedDict):
marker: NotRequired[str],
pageSize: NotRequired[int],
serviceType: NotRequired[ServiceTypeType], # (1)- See ServiceTypeType
ListFleetMetricsRequestTypeDef#
# ListFleetMetricsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListFleetMetricsRequestTypeDef
def get_value() -> ListFleetMetricsRequestTypeDef:
return {
"nextToken": ...,
}
# ListFleetMetricsRequestTypeDef definition
class ListFleetMetricsRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListIndicesRequestTypeDef#
# ListIndicesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListIndicesRequestTypeDef
def get_value() -> ListIndicesRequestTypeDef:
return {
"nextToken": ...,
}
# ListIndicesRequestTypeDef definition
class ListIndicesRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListJobExecutionsForJobRequestTypeDef#
# ListJobExecutionsForJobRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListJobExecutionsForJobRequestTypeDef
def get_value() -> ListJobExecutionsForJobRequestTypeDef:
return {
"jobId": ...,
}
# ListJobExecutionsForJobRequestTypeDef definition
class ListJobExecutionsForJobRequestTypeDef(TypedDict):
jobId: str,
status: NotRequired[JobExecutionStatusType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListJobExecutionsForThingRequestTypeDef#
# ListJobExecutionsForThingRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListJobExecutionsForThingRequestTypeDef
def get_value() -> ListJobExecutionsForThingRequestTypeDef:
return {
"thingName": ...,
}
# ListJobExecutionsForThingRequestTypeDef definition
class ListJobExecutionsForThingRequestTypeDef(TypedDict):
thingName: str,
status: NotRequired[JobExecutionStatusType], # (1)
namespaceId: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
jobId: NotRequired[str],ListJobTemplatesRequestTypeDef#
# ListJobTemplatesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListJobTemplatesRequestTypeDef
def get_value() -> ListJobTemplatesRequestTypeDef:
return {
"maxResults": ...,
}
# ListJobTemplatesRequestTypeDef definition
class ListJobTemplatesRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListJobsRequestTypeDef#
# ListJobsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListJobsRequestTypeDef
def get_value() -> ListJobsRequestTypeDef:
return {
"status": ...,
}
# ListJobsRequestTypeDef definition
class ListJobsRequestTypeDef(TypedDict):
status: NotRequired[JobStatusType], # (1)
targetSelection: NotRequired[TargetSelectionType], # (2)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
thingGroupName: NotRequired[str],
thingGroupId: NotRequired[str],
namespaceId: NotRequired[str],- See JobStatusType
- See TargetSelectionType
ListManagedJobTemplatesRequestTypeDef#
# ListManagedJobTemplatesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListManagedJobTemplatesRequestTypeDef
def get_value() -> ListManagedJobTemplatesRequestTypeDef:
return {
"templateName": ...,
}
# ListManagedJobTemplatesRequestTypeDef definition
class ListManagedJobTemplatesRequestTypeDef(TypedDict):
templateName: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],ManagedJobTemplateSummaryTypeDef#
# ManagedJobTemplateSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ManagedJobTemplateSummaryTypeDef
def get_value() -> ManagedJobTemplateSummaryTypeDef:
return {
"templateArn": ...,
}
# ManagedJobTemplateSummaryTypeDef definition
class ManagedJobTemplateSummaryTypeDef(TypedDict):
templateArn: NotRequired[str],
templateName: NotRequired[str],
description: NotRequired[str],
environments: NotRequired[List[str]],
templateVersion: NotRequired[str],ListMitigationActionsRequestTypeDef#
# ListMitigationActionsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListMitigationActionsRequestTypeDef
def get_value() -> ListMitigationActionsRequestTypeDef:
return {
"actionType": ...,
}
# ListMitigationActionsRequestTypeDef definition
class ListMitigationActionsRequestTypeDef(TypedDict):
actionType: NotRequired[MitigationActionTypeType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],MitigationActionIdentifierTypeDef#
# MitigationActionIdentifierTypeDef TypedDict usage example
from types_boto3_iot.type_defs import MitigationActionIdentifierTypeDef
def get_value() -> MitigationActionIdentifierTypeDef:
return {
"actionName": ...,
}
# MitigationActionIdentifierTypeDef definition
class MitigationActionIdentifierTypeDef(TypedDict):
actionName: NotRequired[str],
actionArn: NotRequired[str],
creationDate: NotRequired[datetime],ListOTAUpdatesRequestTypeDef#
# ListOTAUpdatesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListOTAUpdatesRequestTypeDef
def get_value() -> ListOTAUpdatesRequestTypeDef:
return {
"maxResults": ...,
}
# ListOTAUpdatesRequestTypeDef definition
class ListOTAUpdatesRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
otaUpdateStatus: NotRequired[OTAUpdateStatusType], # (1)OTAUpdateSummaryTypeDef#
# OTAUpdateSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import OTAUpdateSummaryTypeDef
def get_value() -> OTAUpdateSummaryTypeDef:
return {
"otaUpdateId": ...,
}
# OTAUpdateSummaryTypeDef definition
class OTAUpdateSummaryTypeDef(TypedDict):
otaUpdateId: NotRequired[str],
otaUpdateArn: NotRequired[str],
creationDate: NotRequired[datetime],ListOutgoingCertificatesRequestTypeDef#
# ListOutgoingCertificatesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListOutgoingCertificatesRequestTypeDef
def get_value() -> ListOutgoingCertificatesRequestTypeDef:
return {
"pageSize": ...,
}
# ListOutgoingCertificatesRequestTypeDef definition
class ListOutgoingCertificatesRequestTypeDef(TypedDict):
pageSize: NotRequired[int],
marker: NotRequired[str],
ascendingOrder: NotRequired[bool],OutgoingCertificateTypeDef#
# OutgoingCertificateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import OutgoingCertificateTypeDef
def get_value() -> OutgoingCertificateTypeDef:
return {
"certificateArn": ...,
}
# OutgoingCertificateTypeDef definition
class OutgoingCertificateTypeDef(TypedDict):
certificateArn: NotRequired[str],
certificateId: NotRequired[str],
transferredTo: NotRequired[str],
transferDate: NotRequired[datetime],
transferMessage: NotRequired[str],
creationDate: NotRequired[datetime],ListPackageVersionsRequestTypeDef#
# ListPackageVersionsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPackageVersionsRequestTypeDef
def get_value() -> ListPackageVersionsRequestTypeDef:
return {
"packageName": ...,
}
# ListPackageVersionsRequestTypeDef definition
class ListPackageVersionsRequestTypeDef(TypedDict):
packageName: str,
status: NotRequired[PackageVersionStatusType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],PackageVersionSummaryTypeDef#
# PackageVersionSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PackageVersionSummaryTypeDef
def get_value() -> PackageVersionSummaryTypeDef:
return {
"packageName": ...,
}
# PackageVersionSummaryTypeDef definition
class PackageVersionSummaryTypeDef(TypedDict):
packageName: NotRequired[str],
versionName: NotRequired[str],
status: NotRequired[PackageVersionStatusType], # (1)
creationDate: NotRequired[datetime],
lastModifiedDate: NotRequired[datetime],ListPackagesRequestTypeDef#
# ListPackagesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPackagesRequestTypeDef
def get_value() -> ListPackagesRequestTypeDef:
return {
"maxResults": ...,
}
# ListPackagesRequestTypeDef definition
class ListPackagesRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],PackageSummaryTypeDef#
# PackageSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PackageSummaryTypeDef
def get_value() -> PackageSummaryTypeDef:
return {
"packageName": ...,
}
# PackageSummaryTypeDef definition
class PackageSummaryTypeDef(TypedDict):
packageName: NotRequired[str],
defaultVersionName: NotRequired[str],
creationDate: NotRequired[datetime],
lastModifiedDate: NotRequired[datetime],ListPoliciesRequestTypeDef#
# ListPoliciesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPoliciesRequestTypeDef
def get_value() -> ListPoliciesRequestTypeDef:
return {
"marker": ...,
}
# ListPoliciesRequestTypeDef definition
class ListPoliciesRequestTypeDef(TypedDict):
marker: NotRequired[str],
pageSize: NotRequired[int],
ascendingOrder: NotRequired[bool],ListPolicyPrincipalsRequestTypeDef#
# ListPolicyPrincipalsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPolicyPrincipalsRequestTypeDef
def get_value() -> ListPolicyPrincipalsRequestTypeDef:
return {
"policyName": ...,
}
# ListPolicyPrincipalsRequestTypeDef definition
class ListPolicyPrincipalsRequestTypeDef(TypedDict):
policyName: str,
marker: NotRequired[str],
pageSize: NotRequired[int],
ascendingOrder: NotRequired[bool],ListPolicyVersionsRequestTypeDef#
# ListPolicyVersionsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPolicyVersionsRequestTypeDef
def get_value() -> ListPolicyVersionsRequestTypeDef:
return {
"policyName": ...,
}
# ListPolicyVersionsRequestTypeDef definition
class ListPolicyVersionsRequestTypeDef(TypedDict):
policyName: str,PolicyVersionTypeDef#
# PolicyVersionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PolicyVersionTypeDef
def get_value() -> PolicyVersionTypeDef:
return {
"versionId": ...,
}
# PolicyVersionTypeDef definition
class PolicyVersionTypeDef(TypedDict):
versionId: NotRequired[str],
isDefaultVersion: NotRequired[bool],
createDate: NotRequired[datetime],ListPrincipalPoliciesRequestTypeDef#
# ListPrincipalPoliciesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPrincipalPoliciesRequestTypeDef
def get_value() -> ListPrincipalPoliciesRequestTypeDef:
return {
"principal": ...,
}
# ListPrincipalPoliciesRequestTypeDef definition
class ListPrincipalPoliciesRequestTypeDef(TypedDict):
principal: str,
marker: NotRequired[str],
pageSize: NotRequired[int],
ascendingOrder: NotRequired[bool],ListPrincipalThingsRequestTypeDef#
# ListPrincipalThingsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPrincipalThingsRequestTypeDef
def get_value() -> ListPrincipalThingsRequestTypeDef:
return {
"principal": ...,
}
# ListPrincipalThingsRequestTypeDef definition
class ListPrincipalThingsRequestTypeDef(TypedDict):
principal: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListPrincipalThingsV2RequestTypeDef#
# ListPrincipalThingsV2RequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPrincipalThingsV2RequestTypeDef
def get_value() -> ListPrincipalThingsV2RequestTypeDef:
return {
"principal": ...,
}
# ListPrincipalThingsV2RequestTypeDef definition
class ListPrincipalThingsV2RequestTypeDef(TypedDict):
principal: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
thingPrincipalType: NotRequired[ThingPrincipalTypeType], # (1)PrincipalThingObjectTypeDef#
# PrincipalThingObjectTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PrincipalThingObjectTypeDef
def get_value() -> PrincipalThingObjectTypeDef:
return {
"thingName": ...,
}
# PrincipalThingObjectTypeDef definition
class PrincipalThingObjectTypeDef(TypedDict):
thingName: str,
thingPrincipalType: NotRequired[ThingPrincipalTypeType], # (1)ListProvisioningTemplateVersionsRequestTypeDef#
# ListProvisioningTemplateVersionsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListProvisioningTemplateVersionsRequestTypeDef
def get_value() -> ListProvisioningTemplateVersionsRequestTypeDef:
return {
"templateName": ...,
}
# ListProvisioningTemplateVersionsRequestTypeDef definition
class ListProvisioningTemplateVersionsRequestTypeDef(TypedDict):
templateName: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],ProvisioningTemplateVersionSummaryTypeDef#
# ProvisioningTemplateVersionSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ProvisioningTemplateVersionSummaryTypeDef
def get_value() -> ProvisioningTemplateVersionSummaryTypeDef:
return {
"versionId": ...,
}
# ProvisioningTemplateVersionSummaryTypeDef definition
class ProvisioningTemplateVersionSummaryTypeDef(TypedDict):
versionId: NotRequired[int],
creationDate: NotRequired[datetime],
isDefaultVersion: NotRequired[bool],ListProvisioningTemplatesRequestTypeDef#
# ListProvisioningTemplatesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListProvisioningTemplatesRequestTypeDef
def get_value() -> ListProvisioningTemplatesRequestTypeDef:
return {
"maxResults": ...,
}
# ListProvisioningTemplatesRequestTypeDef definition
class ListProvisioningTemplatesRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],ProvisioningTemplateSummaryTypeDef#
# ProvisioningTemplateSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ProvisioningTemplateSummaryTypeDef
def get_value() -> ProvisioningTemplateSummaryTypeDef:
return {
"templateArn": ...,
}
# ProvisioningTemplateSummaryTypeDef definition
class ProvisioningTemplateSummaryTypeDef(TypedDict):
templateArn: NotRequired[str],
templateName: NotRequired[str],
description: NotRequired[str],
creationDate: NotRequired[datetime],
lastModifiedDate: NotRequired[datetime],
enabled: NotRequired[bool],
type: NotRequired[TemplateTypeType], # (1)- See TemplateTypeType
ListRelatedResourcesForAuditFindingRequestTypeDef#
# ListRelatedResourcesForAuditFindingRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListRelatedResourcesForAuditFindingRequestTypeDef
def get_value() -> ListRelatedResourcesForAuditFindingRequestTypeDef:
return {
"findingId": ...,
}
# ListRelatedResourcesForAuditFindingRequestTypeDef definition
class ListRelatedResourcesForAuditFindingRequestTypeDef(TypedDict):
findingId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListRoleAliasesRequestTypeDef#
# ListRoleAliasesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListRoleAliasesRequestTypeDef
def get_value() -> ListRoleAliasesRequestTypeDef:
return {
"pageSize": ...,
}
# ListRoleAliasesRequestTypeDef definition
class ListRoleAliasesRequestTypeDef(TypedDict):
pageSize: NotRequired[int],
marker: NotRequired[str],
ascendingOrder: NotRequired[bool],ListSbomValidationResultsRequestTypeDef#
# ListSbomValidationResultsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListSbomValidationResultsRequestTypeDef
def get_value() -> ListSbomValidationResultsRequestTypeDef:
return {
"packageName": ...,
}
# ListSbomValidationResultsRequestTypeDef definition
class ListSbomValidationResultsRequestTypeDef(TypedDict):
packageName: str,
versionName: str,
validationResult: NotRequired[SbomValidationResultType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],SbomValidationResultSummaryTypeDef#
# SbomValidationResultSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SbomValidationResultSummaryTypeDef
def get_value() -> SbomValidationResultSummaryTypeDef:
return {
"fileName": ...,
}
# SbomValidationResultSummaryTypeDef definition
class SbomValidationResultSummaryTypeDef(TypedDict):
fileName: NotRequired[str],
validationResult: NotRequired[SbomValidationResultType], # (1)
errorCode: NotRequired[SbomValidationErrorCodeType], # (2)
errorMessage: NotRequired[str],ListScheduledAuditsRequestTypeDef#
# ListScheduledAuditsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListScheduledAuditsRequestTypeDef
def get_value() -> ListScheduledAuditsRequestTypeDef:
return {
"nextToken": ...,
}
# ListScheduledAuditsRequestTypeDef definition
class ListScheduledAuditsRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],ScheduledAuditMetadataTypeDef#
# ScheduledAuditMetadataTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ScheduledAuditMetadataTypeDef
def get_value() -> ScheduledAuditMetadataTypeDef:
return {
"scheduledAuditName": ...,
}
# ScheduledAuditMetadataTypeDef definition
class ScheduledAuditMetadataTypeDef(TypedDict):
scheduledAuditName: NotRequired[str],
scheduledAuditArn: NotRequired[str],
frequency: NotRequired[AuditFrequencyType], # (1)
dayOfMonth: NotRequired[str],
dayOfWeek: NotRequired[DayOfWeekType], # (2)- See AuditFrequencyType
- See DayOfWeekType
ListSecurityProfilesForTargetRequestTypeDef#
# ListSecurityProfilesForTargetRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListSecurityProfilesForTargetRequestTypeDef
def get_value() -> ListSecurityProfilesForTargetRequestTypeDef:
return {
"securityProfileTargetArn": ...,
}
# ListSecurityProfilesForTargetRequestTypeDef definition
class ListSecurityProfilesForTargetRequestTypeDef(TypedDict):
securityProfileTargetArn: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
recursive: NotRequired[bool],ListSecurityProfilesRequestTypeDef#
# ListSecurityProfilesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListSecurityProfilesRequestTypeDef
def get_value() -> ListSecurityProfilesRequestTypeDef:
return {
"nextToken": ...,
}
# ListSecurityProfilesRequestTypeDef definition
class ListSecurityProfilesRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
dimensionName: NotRequired[str],
metricName: NotRequired[str],SecurityProfileIdentifierTypeDef#
# SecurityProfileIdentifierTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SecurityProfileIdentifierTypeDef
def get_value() -> SecurityProfileIdentifierTypeDef:
return {
"name": ...,
}
# SecurityProfileIdentifierTypeDef definition
class SecurityProfileIdentifierTypeDef(TypedDict):
name: str,
arn: str,ListStreamsRequestTypeDef#
# ListStreamsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListStreamsRequestTypeDef
def get_value() -> ListStreamsRequestTypeDef:
return {
"maxResults": ...,
}
# ListStreamsRequestTypeDef definition
class ListStreamsRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ascendingOrder: NotRequired[bool],StreamSummaryTypeDef#
# StreamSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StreamSummaryTypeDef
def get_value() -> StreamSummaryTypeDef:
return {
"streamId": ...,
}
# StreamSummaryTypeDef definition
class StreamSummaryTypeDef(TypedDict):
streamId: NotRequired[str],
streamArn: NotRequired[str],
streamVersion: NotRequired[int],
description: NotRequired[str],ListTagsForResourceRequestTypeDef#
# ListTagsForResourceRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListTagsForResourceRequestTypeDef
def get_value() -> ListTagsForResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# ListTagsForResourceRequestTypeDef definition
class ListTagsForResourceRequestTypeDef(TypedDict):
resourceArn: str,
nextToken: NotRequired[str],ListTargetsForPolicyRequestTypeDef#
# ListTargetsForPolicyRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListTargetsForPolicyRequestTypeDef
def get_value() -> ListTargetsForPolicyRequestTypeDef:
return {
"policyName": ...,
}
# ListTargetsForPolicyRequestTypeDef definition
class ListTargetsForPolicyRequestTypeDef(TypedDict):
policyName: str,
marker: NotRequired[str],
pageSize: NotRequired[int],ListTargetsForSecurityProfileRequestTypeDef#
# ListTargetsForSecurityProfileRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListTargetsForSecurityProfileRequestTypeDef
def get_value() -> ListTargetsForSecurityProfileRequestTypeDef:
return {
"securityProfileName": ...,
}
# ListTargetsForSecurityProfileRequestTypeDef definition
class ListTargetsForSecurityProfileRequestTypeDef(TypedDict):
securityProfileName: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],SecurityProfileTargetTypeDef#
# SecurityProfileTargetTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SecurityProfileTargetTypeDef
def get_value() -> SecurityProfileTargetTypeDef:
return {
"arn": ...,
}
# SecurityProfileTargetTypeDef definition
class SecurityProfileTargetTypeDef(TypedDict):
arn: str,ListThingGroupsForThingRequestTypeDef#
# ListThingGroupsForThingRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingGroupsForThingRequestTypeDef
def get_value() -> ListThingGroupsForThingRequestTypeDef:
return {
"thingName": ...,
}
# ListThingGroupsForThingRequestTypeDef definition
class ListThingGroupsForThingRequestTypeDef(TypedDict):
thingName: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListThingGroupsRequestTypeDef#
# ListThingGroupsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingGroupsRequestTypeDef
def get_value() -> ListThingGroupsRequestTypeDef:
return {
"nextToken": ...,
}
# ListThingGroupsRequestTypeDef definition
class ListThingGroupsRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
parentGroup: NotRequired[str],
namePrefixFilter: NotRequired[str],
recursive: NotRequired[bool],ListThingPrincipalsRequestTypeDef#
# ListThingPrincipalsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingPrincipalsRequestTypeDef
def get_value() -> ListThingPrincipalsRequestTypeDef:
return {
"thingName": ...,
}
# ListThingPrincipalsRequestTypeDef definition
class ListThingPrincipalsRequestTypeDef(TypedDict):
thingName: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListThingPrincipalsV2RequestTypeDef#
# ListThingPrincipalsV2RequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingPrincipalsV2RequestTypeDef
def get_value() -> ListThingPrincipalsV2RequestTypeDef:
return {
"thingName": ...,
}
# ListThingPrincipalsV2RequestTypeDef definition
class ListThingPrincipalsV2RequestTypeDef(TypedDict):
thingName: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
thingPrincipalType: NotRequired[ThingPrincipalTypeType], # (1)ThingPrincipalObjectTypeDef#
# ThingPrincipalObjectTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingPrincipalObjectTypeDef
def get_value() -> ThingPrincipalObjectTypeDef:
return {
"principal": ...,
}
# ThingPrincipalObjectTypeDef definition
class ThingPrincipalObjectTypeDef(TypedDict):
principal: str,
thingPrincipalType: NotRequired[ThingPrincipalTypeType], # (1)ListThingRegistrationTaskReportsRequestTypeDef#
# ListThingRegistrationTaskReportsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingRegistrationTaskReportsRequestTypeDef
def get_value() -> ListThingRegistrationTaskReportsRequestTypeDef:
return {
"taskId": ...,
}
# ListThingRegistrationTaskReportsRequestTypeDef definition
class ListThingRegistrationTaskReportsRequestTypeDef(TypedDict):
taskId: str,
reportType: ReportTypeType, # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],- See ReportTypeType
ListThingRegistrationTasksRequestTypeDef#
# ListThingRegistrationTasksRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingRegistrationTasksRequestTypeDef
def get_value() -> ListThingRegistrationTasksRequestTypeDef:
return {
"nextToken": ...,
}
# ListThingRegistrationTasksRequestTypeDef definition
class ListThingRegistrationTasksRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
status: NotRequired[StatusType], # (1)- See StatusType
ListThingTypesRequestTypeDef#
# ListThingTypesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingTypesRequestTypeDef
def get_value() -> ListThingTypesRequestTypeDef:
return {
"nextToken": ...,
}
# ListThingTypesRequestTypeDef definition
class ListThingTypesRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
thingTypeName: NotRequired[str],ListThingsInBillingGroupRequestTypeDef#
# ListThingsInBillingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingsInBillingGroupRequestTypeDef
def get_value() -> ListThingsInBillingGroupRequestTypeDef:
return {
"billingGroupName": ...,
}
# ListThingsInBillingGroupRequestTypeDef definition
class ListThingsInBillingGroupRequestTypeDef(TypedDict):
billingGroupName: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListThingsInThingGroupRequestTypeDef#
# ListThingsInThingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingsInThingGroupRequestTypeDef
def get_value() -> ListThingsInThingGroupRequestTypeDef:
return {
"thingGroupName": ...,
}
# ListThingsInThingGroupRequestTypeDef definition
class ListThingsInThingGroupRequestTypeDef(TypedDict):
thingGroupName: str,
recursive: NotRequired[bool],
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListThingsRequestTypeDef#
# ListThingsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingsRequestTypeDef
def get_value() -> ListThingsRequestTypeDef:
return {
"nextToken": ...,
}
# ListThingsRequestTypeDef definition
class ListThingsRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
attributeName: NotRequired[str],
attributeValue: NotRequired[str],
thingTypeName: NotRequired[str],
usePrefixAttributeValue: NotRequired[bool],ThingAttributeTypeDef#
# ThingAttributeTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingAttributeTypeDef
def get_value() -> ThingAttributeTypeDef:
return {
"thingName": ...,
}
# ThingAttributeTypeDef definition
class ThingAttributeTypeDef(TypedDict):
thingName: NotRequired[str],
thingTypeName: NotRequired[str],
thingArn: NotRequired[str],
attributes: NotRequired[Dict[str, str]],
version: NotRequired[int],ListTopicRuleDestinationsRequestTypeDef#
# ListTopicRuleDestinationsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListTopicRuleDestinationsRequestTypeDef
def get_value() -> ListTopicRuleDestinationsRequestTypeDef:
return {
"maxResults": ...,
}
# ListTopicRuleDestinationsRequestTypeDef definition
class ListTopicRuleDestinationsRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListTopicRulesRequestTypeDef#
# ListTopicRulesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListTopicRulesRequestTypeDef
def get_value() -> ListTopicRulesRequestTypeDef:
return {
"topic": ...,
}
# ListTopicRulesRequestTypeDef definition
class ListTopicRulesRequestTypeDef(TypedDict):
topic: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ruleDisabled: NotRequired[bool],TopicRuleListItemTypeDef#
# TopicRuleListItemTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TopicRuleListItemTypeDef
def get_value() -> TopicRuleListItemTypeDef:
return {
"ruleArn": ...,
}
# TopicRuleListItemTypeDef definition
class TopicRuleListItemTypeDef(TypedDict):
ruleArn: NotRequired[str],
ruleName: NotRequired[str],
topicPattern: NotRequired[str],
createdAt: NotRequired[datetime],
ruleDisabled: NotRequired[bool],ListV2LoggingLevelsRequestTypeDef#
# ListV2LoggingLevelsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListV2LoggingLevelsRequestTypeDef
def get_value() -> ListV2LoggingLevelsRequestTypeDef:
return {
"targetType": ...,
}
# ListV2LoggingLevelsRequestTypeDef definition
class ListV2LoggingLevelsRequestTypeDef(TypedDict):
targetType: NotRequired[LogTargetTypeType], # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],LocationTimestampTypeDef#
# LocationTimestampTypeDef TypedDict usage example
from types_boto3_iot.type_defs import LocationTimestampTypeDef
def get_value() -> LocationTimestampTypeDef:
return {
"value": ...,
}
# LocationTimestampTypeDef definition
class LocationTimestampTypeDef(TypedDict):
value: str,
unit: NotRequired[str],LogTargetTypeDef#
# LogTargetTypeDef TypedDict usage example
from types_boto3_iot.type_defs import LogTargetTypeDef
def get_value() -> LogTargetTypeDef:
return {
"targetType": ...,
}
# LogTargetTypeDef definition
class LogTargetTypeDef(TypedDict):
targetType: LogTargetTypeType, # (1)
targetName: NotRequired[str],LoggingOptionsPayloadTypeDef#
# LoggingOptionsPayloadTypeDef TypedDict usage example
from types_boto3_iot.type_defs import LoggingOptionsPayloadTypeDef
def get_value() -> LoggingOptionsPayloadTypeDef:
return {
"roleArn": ...,
}
# LoggingOptionsPayloadTypeDef definition
class LoggingOptionsPayloadTypeDef(TypedDict):
roleArn: str,
logLevel: NotRequired[LogLevelType], # (1)- See LogLevelType
MetricValueTypeDef#
# MetricValueTypeDef TypedDict usage example
from types_boto3_iot.type_defs import MetricValueTypeDef
def get_value() -> MetricValueTypeDef:
return {
"count": ...,
}
# MetricValueTypeDef definition
class MetricValueTypeDef(TypedDict):
count: NotRequired[int],
cidrs: NotRequired[Sequence[str]],
ports: NotRequired[Sequence[int]],
number: NotRequired[float],
numbers: NotRequired[Sequence[float]],
strings: NotRequired[Sequence[str]],PublishFindingToSnsParamsTypeDef#
# PublishFindingToSnsParamsTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PublishFindingToSnsParamsTypeDef
def get_value() -> PublishFindingToSnsParamsTypeDef:
return {
"topicArn": ...,
}
# PublishFindingToSnsParamsTypeDef definition
class PublishFindingToSnsParamsTypeDef(TypedDict):
topicArn: str,ReplaceDefaultPolicyVersionParamsTypeDef#
# ReplaceDefaultPolicyVersionParamsTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ReplaceDefaultPolicyVersionParamsTypeDef
def get_value() -> ReplaceDefaultPolicyVersionParamsTypeDef:
return {
"templateName": ...,
}
# ReplaceDefaultPolicyVersionParamsTypeDef definition
class ReplaceDefaultPolicyVersionParamsTypeDef(TypedDict):
templateName: PolicyTemplateNameType, # (1)UpdateCACertificateParamsTypeDef#
# UpdateCACertificateParamsTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateCACertificateParamsTypeDef
def get_value() -> UpdateCACertificateParamsTypeDef:
return {
"action": ...,
}
# UpdateCACertificateParamsTypeDef definition
class UpdateCACertificateParamsTypeDef(TypedDict):
action: CACertificateUpdateActionType, # (1)UpdateDeviceCertificateParamsTypeDef#
# UpdateDeviceCertificateParamsTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateDeviceCertificateParamsTypeDef
def get_value() -> UpdateDeviceCertificateParamsTypeDef:
return {
"action": ...,
}
# UpdateDeviceCertificateParamsTypeDef definition
class UpdateDeviceCertificateParamsTypeDef(TypedDict):
action: DeviceCertificateUpdateActionType, # (1)PropagatingAttributeTypeDef#
# PropagatingAttributeTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PropagatingAttributeTypeDef
def get_value() -> PropagatingAttributeTypeDef:
return {
"userPropertyKey": ...,
}
# PropagatingAttributeTypeDef definition
class PropagatingAttributeTypeDef(TypedDict):
userPropertyKey: NotRequired[str],
thingAttribute: NotRequired[str],
connectionAttribute: NotRequired[str],UserPropertyTypeDef#
# UserPropertyTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UserPropertyTypeDef
def get_value() -> UserPropertyTypeDef:
return {
"key": ...,
}
# UserPropertyTypeDef definition
class UserPropertyTypeDef(TypedDict):
key: str,
value: str,PolicyVersionIdentifierTypeDef#
# PolicyVersionIdentifierTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PolicyVersionIdentifierTypeDef
def get_value() -> PolicyVersionIdentifierTypeDef:
return {
"policyName": ...,
}
# PolicyVersionIdentifierTypeDef definition
class PolicyVersionIdentifierTypeDef(TypedDict):
policyName: NotRequired[str],
policyVersionId: NotRequired[str],PutVerificationStateOnViolationRequestTypeDef#
# PutVerificationStateOnViolationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PutVerificationStateOnViolationRequestTypeDef
def get_value() -> PutVerificationStateOnViolationRequestTypeDef:
return {
"violationId": ...,
}
# PutVerificationStateOnViolationRequestTypeDef definition
class PutVerificationStateOnViolationRequestTypeDef(TypedDict):
violationId: str,
verificationState: VerificationStateType, # (1)
verificationStateDescription: NotRequired[str],RegisterCertificateRequestTypeDef#
# RegisterCertificateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RegisterCertificateRequestTypeDef
def get_value() -> RegisterCertificateRequestTypeDef:
return {
"certificatePem": ...,
}
# RegisterCertificateRequestTypeDef definition
class RegisterCertificateRequestTypeDef(TypedDict):
certificatePem: str,
caCertificatePem: NotRequired[str],
setAsActive: NotRequired[bool],
status: NotRequired[CertificateStatusType], # (1)RegisterCertificateWithoutCARequestTypeDef#
# RegisterCertificateWithoutCARequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RegisterCertificateWithoutCARequestTypeDef
def get_value() -> RegisterCertificateWithoutCARequestTypeDef:
return {
"certificatePem": ...,
}
# RegisterCertificateWithoutCARequestTypeDef definition
class RegisterCertificateWithoutCARequestTypeDef(TypedDict):
certificatePem: str,
status: NotRequired[CertificateStatusType], # (1)RegisterThingRequestTypeDef#
# RegisterThingRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RegisterThingRequestTypeDef
def get_value() -> RegisterThingRequestTypeDef:
return {
"templateBody": ...,
}
# RegisterThingRequestTypeDef definition
class RegisterThingRequestTypeDef(TypedDict):
templateBody: str,
parameters: NotRequired[Mapping[str, str]],RejectCertificateTransferRequestTypeDef#
# RejectCertificateTransferRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RejectCertificateTransferRequestTypeDef
def get_value() -> RejectCertificateTransferRequestTypeDef:
return {
"certificateId": ...,
}
# RejectCertificateTransferRequestTypeDef definition
class RejectCertificateTransferRequestTypeDef(TypedDict):
certificateId: str,
rejectReason: NotRequired[str],RemoveThingFromBillingGroupRequestTypeDef#
# RemoveThingFromBillingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RemoveThingFromBillingGroupRequestTypeDef
def get_value() -> RemoveThingFromBillingGroupRequestTypeDef:
return {
"billingGroupName": ...,
}
# RemoveThingFromBillingGroupRequestTypeDef definition
class RemoveThingFromBillingGroupRequestTypeDef(TypedDict):
billingGroupName: NotRequired[str],
billingGroupArn: NotRequired[str],
thingName: NotRequired[str],
thingArn: NotRequired[str],RemoveThingFromThingGroupRequestTypeDef#
# RemoveThingFromThingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RemoveThingFromThingGroupRequestTypeDef
def get_value() -> RemoveThingFromThingGroupRequestTypeDef:
return {
"thingGroupName": ...,
}
# RemoveThingFromThingGroupRequestTypeDef definition
class RemoveThingFromThingGroupRequestTypeDef(TypedDict):
thingGroupName: NotRequired[str],
thingGroupArn: NotRequired[str],
thingName: NotRequired[str],
thingArn: NotRequired[str],SearchIndexRequestTypeDef#
# SearchIndexRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SearchIndexRequestTypeDef
def get_value() -> SearchIndexRequestTypeDef:
return {
"queryString": ...,
}
# SearchIndexRequestTypeDef definition
class SearchIndexRequestTypeDef(TypedDict):
queryString: str,
indexName: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
queryVersion: NotRequired[str],ThingGroupDocumentTypeDef#
# ThingGroupDocumentTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingGroupDocumentTypeDef
def get_value() -> ThingGroupDocumentTypeDef:
return {
"thingGroupName": ...,
}
# ThingGroupDocumentTypeDef definition
class ThingGroupDocumentTypeDef(TypedDict):
thingGroupName: NotRequired[str],
thingGroupId: NotRequired[str],
thingGroupDescription: NotRequired[str],
attributes: NotRequired[Dict[str, str]],
parentGroupNames: NotRequired[List[str]],SetDefaultAuthorizerRequestTypeDef#
# SetDefaultAuthorizerRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SetDefaultAuthorizerRequestTypeDef
def get_value() -> SetDefaultAuthorizerRequestTypeDef:
return {
"authorizerName": ...,
}
# SetDefaultAuthorizerRequestTypeDef definition
class SetDefaultAuthorizerRequestTypeDef(TypedDict):
authorizerName: str,SetDefaultPolicyVersionRequestTypeDef#
# SetDefaultPolicyVersionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SetDefaultPolicyVersionRequestTypeDef
def get_value() -> SetDefaultPolicyVersionRequestTypeDef:
return {
"policyName": ...,
}
# SetDefaultPolicyVersionRequestTypeDef definition
class SetDefaultPolicyVersionRequestTypeDef(TypedDict):
policyName: str,
policyVersionId: str,SetV2LoggingOptionsRequestTypeDef#
# SetV2LoggingOptionsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SetV2LoggingOptionsRequestTypeDef
def get_value() -> SetV2LoggingOptionsRequestTypeDef:
return {
"roleArn": ...,
}
# SetV2LoggingOptionsRequestTypeDef definition
class SetV2LoggingOptionsRequestTypeDef(TypedDict):
roleArn: NotRequired[str],
defaultLogLevel: NotRequired[LogLevelType], # (1)
disableAllLogs: NotRequired[bool],- See LogLevelType
SigningProfileParameterTypeDef#
# SigningProfileParameterTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SigningProfileParameterTypeDef
def get_value() -> SigningProfileParameterTypeDef:
return {
"certificateArn": ...,
}
# SigningProfileParameterTypeDef definition
class SigningProfileParameterTypeDef(TypedDict):
certificateArn: NotRequired[str],
platform: NotRequired[str],
certificatePathOnDevice: NotRequired[str],StartOnDemandAuditTaskRequestTypeDef#
# StartOnDemandAuditTaskRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StartOnDemandAuditTaskRequestTypeDef
def get_value() -> StartOnDemandAuditTaskRequestTypeDef:
return {
"targetCheckNames": ...,
}
# StartOnDemandAuditTaskRequestTypeDef definition
class StartOnDemandAuditTaskRequestTypeDef(TypedDict):
targetCheckNames: Sequence[str],StartThingRegistrationTaskRequestTypeDef#
# StartThingRegistrationTaskRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StartThingRegistrationTaskRequestTypeDef
def get_value() -> StartThingRegistrationTaskRequestTypeDef:
return {
"templateBody": ...,
}
# StartThingRegistrationTaskRequestTypeDef definition
class StartThingRegistrationTaskRequestTypeDef(TypedDict):
templateBody: str,
inputFileBucket: str,
inputFileKey: str,
roleArn: str,StopThingRegistrationTaskRequestTypeDef#
# StopThingRegistrationTaskRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StopThingRegistrationTaskRequestTypeDef
def get_value() -> StopThingRegistrationTaskRequestTypeDef:
return {
"taskId": ...,
}
# StopThingRegistrationTaskRequestTypeDef definition
class StopThingRegistrationTaskRequestTypeDef(TypedDict):
taskId: str,TlsContextTypeDef#
# TlsContextTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TlsContextTypeDef
def get_value() -> TlsContextTypeDef:
return {
"serverName": ...,
}
# TlsContextTypeDef definition
class TlsContextTypeDef(TypedDict):
serverName: NotRequired[str],ThingConnectivityTypeDef#
# ThingConnectivityTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingConnectivityTypeDef
def get_value() -> ThingConnectivityTypeDef:
return {
"connected": ...,
}
# ThingConnectivityTypeDef definition
class ThingConnectivityTypeDef(TypedDict):
connected: NotRequired[bool],
timestamp: NotRequired[int],
disconnectReason: NotRequired[str],TimestreamDimensionTypeDef#
# TimestreamDimensionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TimestreamDimensionTypeDef
def get_value() -> TimestreamDimensionTypeDef:
return {
"name": ...,
}
# TimestreamDimensionTypeDef definition
class TimestreamDimensionTypeDef(TypedDict):
name: str,
value: str,TimestreamTimestampTypeDef#
# TimestreamTimestampTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TimestreamTimestampTypeDef
def get_value() -> TimestreamTimestampTypeDef:
return {
"value": ...,
}
# TimestreamTimestampTypeDef definition
class TimestreamTimestampTypeDef(TypedDict):
value: str,
unit: str,VpcDestinationConfigurationTypeDef#
# VpcDestinationConfigurationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import VpcDestinationConfigurationTypeDef
def get_value() -> VpcDestinationConfigurationTypeDef:
return {
"subnetIds": ...,
}
# VpcDestinationConfigurationTypeDef definition
class VpcDestinationConfigurationTypeDef(TypedDict):
subnetIds: Sequence[str],
vpcId: str,
roleArn: str,
securityGroups: NotRequired[Sequence[str]],VpcDestinationSummaryTypeDef#
# VpcDestinationSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import VpcDestinationSummaryTypeDef
def get_value() -> VpcDestinationSummaryTypeDef:
return {
"subnetIds": ...,
}
# VpcDestinationSummaryTypeDef definition
class VpcDestinationSummaryTypeDef(TypedDict):
subnetIds: NotRequired[List[str]],
securityGroups: NotRequired[List[str]],
vpcId: NotRequired[str],
roleArn: NotRequired[str],VpcDestinationPropertiesTypeDef#
# VpcDestinationPropertiesTypeDef TypedDict usage example
from types_boto3_iot.type_defs import VpcDestinationPropertiesTypeDef
def get_value() -> VpcDestinationPropertiesTypeDef:
return {
"subnetIds": ...,
}
# VpcDestinationPropertiesTypeDef definition
class VpcDestinationPropertiesTypeDef(TypedDict):
subnetIds: NotRequired[List[str]],
securityGroups: NotRequired[List[str]],
vpcId: NotRequired[str],
roleArn: NotRequired[str],TransferCertificateRequestTypeDef#
# TransferCertificateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TransferCertificateRequestTypeDef
def get_value() -> TransferCertificateRequestTypeDef:
return {
"certificateId": ...,
}
# TransferCertificateRequestTypeDef definition
class TransferCertificateRequestTypeDef(TypedDict):
certificateId: str,
targetAwsAccount: str,
transferMessage: NotRequired[str],UntagResourceRequestTypeDef#
# UntagResourceRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UntagResourceRequestTypeDef
def get_value() -> UntagResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# UntagResourceRequestTypeDef definition
class UntagResourceRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],UpdateAuthorizerRequestTypeDef#
# UpdateAuthorizerRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateAuthorizerRequestTypeDef
def get_value() -> UpdateAuthorizerRequestTypeDef:
return {
"authorizerName": ...,
}
# UpdateAuthorizerRequestTypeDef definition
class UpdateAuthorizerRequestTypeDef(TypedDict):
authorizerName: str,
authorizerFunctionArn: NotRequired[str],
tokenKeyName: NotRequired[str],
tokenSigningPublicKeys: NotRequired[Mapping[str, str]],
status: NotRequired[AuthorizerStatusType], # (1)
enableCachingForHttp: NotRequired[bool],UpdateCertificateProviderRequestTypeDef#
# UpdateCertificateProviderRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateCertificateProviderRequestTypeDef
def get_value() -> UpdateCertificateProviderRequestTypeDef:
return {
"certificateProviderName": ...,
}
# UpdateCertificateProviderRequestTypeDef definition
class UpdateCertificateProviderRequestTypeDef(TypedDict):
certificateProviderName: str,
lambdaFunctionArn: NotRequired[str],
accountDefaultForOperations: NotRequired[Sequence[CertificateProviderOperationType]], # (1)UpdateCertificateRequestTypeDef#
# UpdateCertificateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateCertificateRequestTypeDef
def get_value() -> UpdateCertificateRequestTypeDef:
return {
"certificateId": ...,
}
# UpdateCertificateRequestTypeDef definition
class UpdateCertificateRequestTypeDef(TypedDict):
certificateId: str,
newStatus: CertificateStatusType, # (1)UpdateCommandRequestTypeDef#
# UpdateCommandRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateCommandRequestTypeDef
def get_value() -> UpdateCommandRequestTypeDef:
return {
"commandId": ...,
}
# UpdateCommandRequestTypeDef definition
class UpdateCommandRequestTypeDef(TypedDict):
commandId: str,
displayName: NotRequired[str],
description: NotRequired[str],
deprecated: NotRequired[bool],UpdateCustomMetricRequestTypeDef#
# UpdateCustomMetricRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateCustomMetricRequestTypeDef
def get_value() -> UpdateCustomMetricRequestTypeDef:
return {
"metricName": ...,
}
# UpdateCustomMetricRequestTypeDef definition
class UpdateCustomMetricRequestTypeDef(TypedDict):
metricName: str,
displayName: str,UpdateDimensionRequestTypeDef#
# UpdateDimensionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateDimensionRequestTypeDef
def get_value() -> UpdateDimensionRequestTypeDef:
return {
"name": ...,
}
# UpdateDimensionRequestTypeDef definition
class UpdateDimensionRequestTypeDef(TypedDict):
name: str,
stringValues: Sequence[str],UpdatePackageRequestTypeDef#
# UpdatePackageRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdatePackageRequestTypeDef
def get_value() -> UpdatePackageRequestTypeDef:
return {
"packageName": ...,
}
# UpdatePackageRequestTypeDef definition
class UpdatePackageRequestTypeDef(TypedDict):
packageName: str,
description: NotRequired[str],
defaultVersionName: NotRequired[str],
unsetDefaultVersion: NotRequired[bool],
clientToken: NotRequired[str],UpdateRoleAliasRequestTypeDef#
# UpdateRoleAliasRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateRoleAliasRequestTypeDef
def get_value() -> UpdateRoleAliasRequestTypeDef:
return {
"roleAlias": ...,
}
# UpdateRoleAliasRequestTypeDef definition
class UpdateRoleAliasRequestTypeDef(TypedDict):
roleAlias: str,
roleArn: NotRequired[str],
credentialDurationSeconds: NotRequired[int],UpdateScheduledAuditRequestTypeDef#
# UpdateScheduledAuditRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateScheduledAuditRequestTypeDef
def get_value() -> UpdateScheduledAuditRequestTypeDef:
return {
"scheduledAuditName": ...,
}
# UpdateScheduledAuditRequestTypeDef definition
class UpdateScheduledAuditRequestTypeDef(TypedDict):
scheduledAuditName: str,
frequency: NotRequired[AuditFrequencyType], # (1)
dayOfMonth: NotRequired[str],
dayOfWeek: NotRequired[DayOfWeekType], # (2)
targetCheckNames: NotRequired[Sequence[str]],- See AuditFrequencyType
- See DayOfWeekType
UpdateThingGroupsForThingRequestTypeDef#
# UpdateThingGroupsForThingRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateThingGroupsForThingRequestTypeDef
def get_value() -> UpdateThingGroupsForThingRequestTypeDef:
return {
"thingName": ...,
}
# UpdateThingGroupsForThingRequestTypeDef definition
class UpdateThingGroupsForThingRequestTypeDef(TypedDict):
thingName: NotRequired[str],
thingGroupsToAdd: NotRequired[Sequence[str]],
thingGroupsToRemove: NotRequired[Sequence[str]],
overrideDynamicGroups: NotRequired[bool],UpdateTopicRuleDestinationRequestTypeDef#
# UpdateTopicRuleDestinationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateTopicRuleDestinationRequestTypeDef
def get_value() -> UpdateTopicRuleDestinationRequestTypeDef:
return {
"arn": ...,
}
# UpdateTopicRuleDestinationRequestTypeDef definition
class UpdateTopicRuleDestinationRequestTypeDef(TypedDict):
arn: str,
status: TopicRuleDestinationStatusType, # (1)ValidationErrorTypeDef#
# ValidationErrorTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ValidationErrorTypeDef
def get_value() -> ValidationErrorTypeDef:
return {
"errorMessage": ...,
}
# ValidationErrorTypeDef definition
class ValidationErrorTypeDef(TypedDict):
errorMessage: NotRequired[str],AbortConfigOutputTypeDef#
# AbortConfigOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AbortConfigOutputTypeDef
def get_value() -> AbortConfigOutputTypeDef:
return {
"criteriaList": ...,
}
# AbortConfigOutputTypeDef definition
class AbortConfigOutputTypeDef(TypedDict):
criteriaList: List[AbortCriteriaTypeDef], # (1)AbortConfigTypeDef#
# AbortConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AbortConfigTypeDef
def get_value() -> AbortConfigTypeDef:
return {
"criteriaList": ...,
}
# AbortConfigTypeDef definition
class AbortConfigTypeDef(TypedDict):
criteriaList: Sequence[AbortCriteriaTypeDef], # (1)MetricDatumTypeDef#
# MetricDatumTypeDef TypedDict usage example
from types_boto3_iot.type_defs import MetricDatumTypeDef
def get_value() -> MetricDatumTypeDef:
return {
"timestamp": ...,
}
# MetricDatumTypeDef definition
class MetricDatumTypeDef(TypedDict):
timestamp: NotRequired[datetime],
value: NotRequired[MetricValueOutputTypeDef], # (1)AllowedTypeDef#
# AllowedTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AllowedTypeDef
def get_value() -> AllowedTypeDef:
return {
"policies": ...,
}
# AllowedTypeDef definition
class AllowedTypeDef(TypedDict):
policies: NotRequired[List[PolicyTypeDef]], # (1)- See PolicyTypeDef
ExplicitDenyTypeDef#
# ExplicitDenyTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ExplicitDenyTypeDef
def get_value() -> ExplicitDenyTypeDef:
return {
"policies": ...,
}
# ExplicitDenyTypeDef definition
class ExplicitDenyTypeDef(TypedDict):
policies: NotRequired[List[PolicyTypeDef]], # (1)- See PolicyTypeDef
ImplicitDenyTypeDef#
# ImplicitDenyTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ImplicitDenyTypeDef
def get_value() -> ImplicitDenyTypeDef:
return {
"policies": ...,
}
# ImplicitDenyTypeDef definition
class ImplicitDenyTypeDef(TypedDict):
policies: NotRequired[List[PolicyTypeDef]], # (1)- See PolicyTypeDef
AssetPropertyValueTypeDef#
# AssetPropertyValueTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AssetPropertyValueTypeDef
def get_value() -> AssetPropertyValueTypeDef:
return {
"value": ...,
}
# AssetPropertyValueTypeDef definition
class AssetPropertyValueTypeDef(TypedDict):
value: AssetPropertyVariantTypeDef, # (1)
timestamp: AssetPropertyTimestampTypeDef, # (2)
quality: NotRequired[str],AssociateTargetsWithJobResponseTypeDef#
# AssociateTargetsWithJobResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AssociateTargetsWithJobResponseTypeDef
def get_value() -> AssociateTargetsWithJobResponseTypeDef:
return {
"jobArn": ...,
}
# AssociateTargetsWithJobResponseTypeDef definition
class AssociateTargetsWithJobResponseTypeDef(TypedDict):
jobArn: str,
jobId: str,
description: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CancelJobResponseTypeDef#
# CancelJobResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CancelJobResponseTypeDef
def get_value() -> CancelJobResponseTypeDef:
return {
"jobArn": ...,
}
# CancelJobResponseTypeDef definition
class CancelJobResponseTypeDef(TypedDict):
jobArn: str,
jobId: str,
description: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateAuthorizerResponseTypeDef#
# CreateAuthorizerResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateAuthorizerResponseTypeDef
def get_value() -> CreateAuthorizerResponseTypeDef:
return {
"authorizerName": ...,
}
# CreateAuthorizerResponseTypeDef definition
class CreateAuthorizerResponseTypeDef(TypedDict):
authorizerName: str,
authorizerArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateBillingGroupResponseTypeDef#
# CreateBillingGroupResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateBillingGroupResponseTypeDef
def get_value() -> CreateBillingGroupResponseTypeDef:
return {
"billingGroupName": ...,
}
# CreateBillingGroupResponseTypeDef definition
class CreateBillingGroupResponseTypeDef(TypedDict):
billingGroupName: str,
billingGroupArn: str,
billingGroupId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateCertificateFromCsrResponseTypeDef#
# CreateCertificateFromCsrResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateCertificateFromCsrResponseTypeDef
def get_value() -> CreateCertificateFromCsrResponseTypeDef:
return {
"certificateArn": ...,
}
# CreateCertificateFromCsrResponseTypeDef definition
class CreateCertificateFromCsrResponseTypeDef(TypedDict):
certificateArn: str,
certificateId: str,
certificatePem: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateCertificateProviderResponseTypeDef#
# CreateCertificateProviderResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateCertificateProviderResponseTypeDef
def get_value() -> CreateCertificateProviderResponseTypeDef:
return {
"certificateProviderName": ...,
}
# CreateCertificateProviderResponseTypeDef definition
class CreateCertificateProviderResponseTypeDef(TypedDict):
certificateProviderName: str,
certificateProviderArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateCommandResponseTypeDef#
# CreateCommandResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateCommandResponseTypeDef
def get_value() -> CreateCommandResponseTypeDef:
return {
"commandId": ...,
}
# CreateCommandResponseTypeDef definition
class CreateCommandResponseTypeDef(TypedDict):
commandId: str,
commandArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateCustomMetricResponseTypeDef#
# CreateCustomMetricResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateCustomMetricResponseTypeDef
def get_value() -> CreateCustomMetricResponseTypeDef:
return {
"metricName": ...,
}
# CreateCustomMetricResponseTypeDef definition
class CreateCustomMetricResponseTypeDef(TypedDict):
metricName: str,
metricArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateDimensionResponseTypeDef#
# CreateDimensionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateDimensionResponseTypeDef
def get_value() -> CreateDimensionResponseTypeDef:
return {
"name": ...,
}
# CreateDimensionResponseTypeDef definition
class CreateDimensionResponseTypeDef(TypedDict):
name: str,
arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateDomainConfigurationResponseTypeDef#
# CreateDomainConfigurationResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateDomainConfigurationResponseTypeDef
def get_value() -> CreateDomainConfigurationResponseTypeDef:
return {
"domainConfigurationName": ...,
}
# CreateDomainConfigurationResponseTypeDef definition
class CreateDomainConfigurationResponseTypeDef(TypedDict):
domainConfigurationName: str,
domainConfigurationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateDynamicThingGroupResponseTypeDef#
# CreateDynamicThingGroupResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateDynamicThingGroupResponseTypeDef
def get_value() -> CreateDynamicThingGroupResponseTypeDef:
return {
"thingGroupName": ...,
}
# CreateDynamicThingGroupResponseTypeDef definition
class CreateDynamicThingGroupResponseTypeDef(TypedDict):
thingGroupName: str,
thingGroupArn: str,
thingGroupId: str,
indexName: str,
queryString: str,
queryVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateFleetMetricResponseTypeDef#
# CreateFleetMetricResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateFleetMetricResponseTypeDef
def get_value() -> CreateFleetMetricResponseTypeDef:
return {
"metricName": ...,
}
# CreateFleetMetricResponseTypeDef definition
class CreateFleetMetricResponseTypeDef(TypedDict):
metricName: str,
metricArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateJobResponseTypeDef#
# CreateJobResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateJobResponseTypeDef
def get_value() -> CreateJobResponseTypeDef:
return {
"jobArn": ...,
}
# CreateJobResponseTypeDef definition
class CreateJobResponseTypeDef(TypedDict):
jobArn: str,
jobId: str,
description: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateJobTemplateResponseTypeDef#
# CreateJobTemplateResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateJobTemplateResponseTypeDef
def get_value() -> CreateJobTemplateResponseTypeDef:
return {
"jobTemplateArn": ...,
}
# CreateJobTemplateResponseTypeDef definition
class CreateJobTemplateResponseTypeDef(TypedDict):
jobTemplateArn: str,
jobTemplateId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateMitigationActionResponseTypeDef#
# CreateMitigationActionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateMitigationActionResponseTypeDef
def get_value() -> CreateMitigationActionResponseTypeDef:
return {
"actionArn": ...,
}
# CreateMitigationActionResponseTypeDef definition
class CreateMitigationActionResponseTypeDef(TypedDict):
actionArn: str,
actionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateOTAUpdateResponseTypeDef#
# CreateOTAUpdateResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateOTAUpdateResponseTypeDef
def get_value() -> CreateOTAUpdateResponseTypeDef:
return {
"otaUpdateId": ...,
}
# CreateOTAUpdateResponseTypeDef definition
class CreateOTAUpdateResponseTypeDef(TypedDict):
otaUpdateId: str,
awsIotJobId: str,
otaUpdateArn: str,
awsIotJobArn: str,
otaUpdateStatus: OTAUpdateStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreatePackageResponseTypeDef#
# CreatePackageResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreatePackageResponseTypeDef
def get_value() -> CreatePackageResponseTypeDef:
return {
"packageName": ...,
}
# CreatePackageResponseTypeDef definition
class CreatePackageResponseTypeDef(TypedDict):
packageName: str,
packageArn: str,
description: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreatePackageVersionResponseTypeDef#
# CreatePackageVersionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreatePackageVersionResponseTypeDef
def get_value() -> CreatePackageVersionResponseTypeDef:
return {
"packageVersionArn": ...,
}
# CreatePackageVersionResponseTypeDef definition
class CreatePackageVersionResponseTypeDef(TypedDict):
packageVersionArn: str,
packageName: str,
versionName: str,
description: str,
attributes: Dict[str, str],
status: PackageVersionStatusType, # (1)
errorReason: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreatePolicyResponseTypeDef#
# CreatePolicyResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreatePolicyResponseTypeDef
def get_value() -> CreatePolicyResponseTypeDef:
return {
"policyName": ...,
}
# CreatePolicyResponseTypeDef definition
class CreatePolicyResponseTypeDef(TypedDict):
policyName: str,
policyArn: str,
policyDocument: str,
policyVersionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreatePolicyVersionResponseTypeDef#
# CreatePolicyVersionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreatePolicyVersionResponseTypeDef
def get_value() -> CreatePolicyVersionResponseTypeDef:
return {
"policyArn": ...,
}
# CreatePolicyVersionResponseTypeDef definition
class CreatePolicyVersionResponseTypeDef(TypedDict):
policyArn: str,
policyDocument: str,
policyVersionId: str,
isDefaultVersion: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateProvisioningTemplateResponseTypeDef#
# CreateProvisioningTemplateResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateProvisioningTemplateResponseTypeDef
def get_value() -> CreateProvisioningTemplateResponseTypeDef:
return {
"templateArn": ...,
}
# CreateProvisioningTemplateResponseTypeDef definition
class CreateProvisioningTemplateResponseTypeDef(TypedDict):
templateArn: str,
templateName: str,
defaultVersionId: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateProvisioningTemplateVersionResponseTypeDef#
# CreateProvisioningTemplateVersionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateProvisioningTemplateVersionResponseTypeDef
def get_value() -> CreateProvisioningTemplateVersionResponseTypeDef:
return {
"templateArn": ...,
}
# CreateProvisioningTemplateVersionResponseTypeDef definition
class CreateProvisioningTemplateVersionResponseTypeDef(TypedDict):
templateArn: str,
templateName: str,
versionId: int,
isDefaultVersion: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateRoleAliasResponseTypeDef#
# CreateRoleAliasResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateRoleAliasResponseTypeDef
def get_value() -> CreateRoleAliasResponseTypeDef:
return {
"roleAlias": ...,
}
# CreateRoleAliasResponseTypeDef definition
class CreateRoleAliasResponseTypeDef(TypedDict):
roleAlias: str,
roleAliasArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateScheduledAuditResponseTypeDef#
# CreateScheduledAuditResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateScheduledAuditResponseTypeDef
def get_value() -> CreateScheduledAuditResponseTypeDef:
return {
"scheduledAuditArn": ...,
}
# CreateScheduledAuditResponseTypeDef definition
class CreateScheduledAuditResponseTypeDef(TypedDict):
scheduledAuditArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateSecurityProfileResponseTypeDef#
# CreateSecurityProfileResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateSecurityProfileResponseTypeDef
def get_value() -> CreateSecurityProfileResponseTypeDef:
return {
"securityProfileName": ...,
}
# CreateSecurityProfileResponseTypeDef definition
class CreateSecurityProfileResponseTypeDef(TypedDict):
securityProfileName: str,
securityProfileArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateStreamResponseTypeDef#
# CreateStreamResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateStreamResponseTypeDef
def get_value() -> CreateStreamResponseTypeDef:
return {
"streamId": ...,
}
# CreateStreamResponseTypeDef definition
class CreateStreamResponseTypeDef(TypedDict):
streamId: str,
streamArn: str,
description: str,
streamVersion: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateThingGroupResponseTypeDef#
# CreateThingGroupResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateThingGroupResponseTypeDef
def get_value() -> CreateThingGroupResponseTypeDef:
return {
"thingGroupName": ...,
}
# CreateThingGroupResponseTypeDef definition
class CreateThingGroupResponseTypeDef(TypedDict):
thingGroupName: str,
thingGroupArn: str,
thingGroupId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateThingResponseTypeDef#
# CreateThingResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateThingResponseTypeDef
def get_value() -> CreateThingResponseTypeDef:
return {
"thingName": ...,
}
# CreateThingResponseTypeDef definition
class CreateThingResponseTypeDef(TypedDict):
thingName: str,
thingArn: str,
thingId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateThingTypeResponseTypeDef#
# CreateThingTypeResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateThingTypeResponseTypeDef
def get_value() -> CreateThingTypeResponseTypeDef:
return {
"thingTypeName": ...,
}
# CreateThingTypeResponseTypeDef definition
class CreateThingTypeResponseTypeDef(TypedDict):
thingTypeName: str,
thingTypeArn: str,
thingTypeId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)DeleteCommandResponseTypeDef#
# DeleteCommandResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteCommandResponseTypeDef
def get_value() -> DeleteCommandResponseTypeDef:
return {
"statusCode": ...,
}
# DeleteCommandResponseTypeDef definition
class DeleteCommandResponseTypeDef(TypedDict):
statusCode: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)DescribeCertificateProviderResponseTypeDef#
# DescribeCertificateProviderResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeCertificateProviderResponseTypeDef
def get_value() -> DescribeCertificateProviderResponseTypeDef:
return {
"certificateProviderName": ...,
}
# DescribeCertificateProviderResponseTypeDef definition
class DescribeCertificateProviderResponseTypeDef(TypedDict):
certificateProviderName: str,
certificateProviderArn: str,
lambdaFunctionArn: str,
accountDefaultForOperations: List[CertificateProviderOperationType], # (1)
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeCustomMetricResponseTypeDef#
# DescribeCustomMetricResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeCustomMetricResponseTypeDef
def get_value() -> DescribeCustomMetricResponseTypeDef:
return {
"metricName": ...,
}
# DescribeCustomMetricResponseTypeDef definition
class DescribeCustomMetricResponseTypeDef(TypedDict):
metricName: str,
metricArn: str,
metricType: CustomMetricTypeType, # (1)
displayName: str,
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeDimensionResponseTypeDef#
# DescribeDimensionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeDimensionResponseTypeDef
def get_value() -> DescribeDimensionResponseTypeDef:
return {
"name": ...,
}
# DescribeDimensionResponseTypeDef definition
class DescribeDimensionResponseTypeDef(TypedDict):
name: str,
arn: str,
type: DimensionTypeType, # (1)
stringValues: List[str],
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeEndpointResponseTypeDef#
# DescribeEndpointResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeEndpointResponseTypeDef
def get_value() -> DescribeEndpointResponseTypeDef:
return {
"endpointAddress": ...,
}
# DescribeEndpointResponseTypeDef definition
class DescribeEndpointResponseTypeDef(TypedDict):
endpointAddress: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)DescribeFleetMetricResponseTypeDef#
# DescribeFleetMetricResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeFleetMetricResponseTypeDef
def get_value() -> DescribeFleetMetricResponseTypeDef:
return {
"metricName": ...,
}
# DescribeFleetMetricResponseTypeDef definition
class DescribeFleetMetricResponseTypeDef(TypedDict):
metricName: str,
queryString: str,
aggregationType: AggregationTypeOutputTypeDef, # (1)
period: int,
aggregationField: str,
description: str,
queryVersion: str,
indexName: str,
creationDate: datetime,
lastModifiedDate: datetime,
unit: FleetMetricUnitType, # (2)
version: int,
metricArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)DescribeIndexResponseTypeDef#
# DescribeIndexResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeIndexResponseTypeDef
def get_value() -> DescribeIndexResponseTypeDef:
return {
"indexName": ...,
}
# DescribeIndexResponseTypeDef definition
class DescribeIndexResponseTypeDef(TypedDict):
indexName: str,
indexStatus: IndexStatusType, # (1)
schema: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeProvisioningTemplateVersionResponseTypeDef#
# DescribeProvisioningTemplateVersionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeProvisioningTemplateVersionResponseTypeDef
def get_value() -> DescribeProvisioningTemplateVersionResponseTypeDef:
return {
"versionId": ...,
}
# DescribeProvisioningTemplateVersionResponseTypeDef definition
class DescribeProvisioningTemplateVersionResponseTypeDef(TypedDict):
versionId: int,
creationDate: datetime,
templateBody: str,
isDefaultVersion: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)DescribeScheduledAuditResponseTypeDef#
# DescribeScheduledAuditResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeScheduledAuditResponseTypeDef
def get_value() -> DescribeScheduledAuditResponseTypeDef:
return {
"frequency": ...,
}
# DescribeScheduledAuditResponseTypeDef definition
class DescribeScheduledAuditResponseTypeDef(TypedDict):
frequency: AuditFrequencyType, # (1)
dayOfMonth: str,
dayOfWeek: DayOfWeekType, # (2)
targetCheckNames: List[str],
scheduledAuditName: str,
scheduledAuditArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See AuditFrequencyType
- See DayOfWeekType
- See ResponseMetadataTypeDef
DescribeThingRegistrationTaskResponseTypeDef#
# DescribeThingRegistrationTaskResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeThingRegistrationTaskResponseTypeDef
def get_value() -> DescribeThingRegistrationTaskResponseTypeDef:
return {
"taskId": ...,
}
# DescribeThingRegistrationTaskResponseTypeDef definition
class DescribeThingRegistrationTaskResponseTypeDef(TypedDict):
taskId: str,
creationDate: datetime,
lastModifiedDate: datetime,
templateBody: str,
inputFileBucket: str,
inputFileKey: str,
roleArn: str,
status: StatusType, # (1)
message: str,
successCount: int,
failureCount: int,
percentageProgress: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See StatusType
- See ResponseMetadataTypeDef
DescribeThingResponseTypeDef#
# DescribeThingResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeThingResponseTypeDef
def get_value() -> DescribeThingResponseTypeDef:
return {
"defaultClientId": ...,
}
# DescribeThingResponseTypeDef definition
class DescribeThingResponseTypeDef(TypedDict):
defaultClientId: str,
thingName: str,
thingId: str,
thingArn: str,
thingTypeName: str,
attributes: Dict[str, str],
version: int,
billingGroupName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef TypedDict usage example
from types_boto3_iot.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetCardinalityResponseTypeDef#
# GetCardinalityResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetCardinalityResponseTypeDef
def get_value() -> GetCardinalityResponseTypeDef:
return {
"cardinality": ...,
}
# GetCardinalityResponseTypeDef definition
class GetCardinalityResponseTypeDef(TypedDict):
cardinality: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetJobDocumentResponseTypeDef#
# GetJobDocumentResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetJobDocumentResponseTypeDef
def get_value() -> GetJobDocumentResponseTypeDef:
return {
"document": ...,
}
# GetJobDocumentResponseTypeDef definition
class GetJobDocumentResponseTypeDef(TypedDict):
document: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetLoggingOptionsResponseTypeDef#
# GetLoggingOptionsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetLoggingOptionsResponseTypeDef
def get_value() -> GetLoggingOptionsResponseTypeDef:
return {
"roleArn": ...,
}
# GetLoggingOptionsResponseTypeDef definition
class GetLoggingOptionsResponseTypeDef(TypedDict):
roleArn: str,
logLevel: LogLevelType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See LogLevelType
- See ResponseMetadataTypeDef
GetPackageResponseTypeDef#
# GetPackageResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetPackageResponseTypeDef
def get_value() -> GetPackageResponseTypeDef:
return {
"packageName": ...,
}
# GetPackageResponseTypeDef definition
class GetPackageResponseTypeDef(TypedDict):
packageName: str,
packageArn: str,
description: str,
defaultVersionName: str,
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetPolicyResponseTypeDef#
# GetPolicyResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetPolicyResponseTypeDef
def get_value() -> GetPolicyResponseTypeDef:
return {
"policyName": ...,
}
# GetPolicyResponseTypeDef definition
class GetPolicyResponseTypeDef(TypedDict):
policyName: str,
policyArn: str,
policyDocument: str,
defaultVersionId: str,
creationDate: datetime,
lastModifiedDate: datetime,
generationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetPolicyVersionResponseTypeDef#
# GetPolicyVersionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetPolicyVersionResponseTypeDef
def get_value() -> GetPolicyVersionResponseTypeDef:
return {
"policyArn": ...,
}
# GetPolicyVersionResponseTypeDef definition
class GetPolicyVersionResponseTypeDef(TypedDict):
policyArn: str,
policyName: str,
policyDocument: str,
policyVersionId: str,
isDefaultVersion: bool,
creationDate: datetime,
lastModifiedDate: datetime,
generationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetRegistrationCodeResponseTypeDef#
# GetRegistrationCodeResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetRegistrationCodeResponseTypeDef
def get_value() -> GetRegistrationCodeResponseTypeDef:
return {
"registrationCode": ...,
}
# GetRegistrationCodeResponseTypeDef definition
class GetRegistrationCodeResponseTypeDef(TypedDict):
registrationCode: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetThingConnectivityDataResponseTypeDef#
# GetThingConnectivityDataResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetThingConnectivityDataResponseTypeDef
def get_value() -> GetThingConnectivityDataResponseTypeDef:
return {
"thingName": ...,
}
# GetThingConnectivityDataResponseTypeDef definition
class GetThingConnectivityDataResponseTypeDef(TypedDict):
thingName: str,
connected: bool,
timestamp: datetime,
disconnectReason: DisconnectReasonValueType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetV2LoggingOptionsResponseTypeDef#
# GetV2LoggingOptionsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetV2LoggingOptionsResponseTypeDef
def get_value() -> GetV2LoggingOptionsResponseTypeDef:
return {
"roleArn": ...,
}
# GetV2LoggingOptionsResponseTypeDef definition
class GetV2LoggingOptionsResponseTypeDef(TypedDict):
roleArn: str,
defaultLogLevel: LogLevelType, # (1)
disableAllLogs: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See LogLevelType
- See ResponseMetadataTypeDef
ListAttachedPoliciesResponseTypeDef#
# ListAttachedPoliciesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAttachedPoliciesResponseTypeDef
def get_value() -> ListAttachedPoliciesResponseTypeDef:
return {
"policies": ...,
}
# ListAttachedPoliciesResponseTypeDef definition
class ListAttachedPoliciesResponseTypeDef(TypedDict):
policies: List[PolicyTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See PolicyTypeDef
- See ResponseMetadataTypeDef
ListCustomMetricsResponseTypeDef#
# ListCustomMetricsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCustomMetricsResponseTypeDef
def get_value() -> ListCustomMetricsResponseTypeDef:
return {
"metricNames": ...,
}
# ListCustomMetricsResponseTypeDef definition
class ListCustomMetricsResponseTypeDef(TypedDict):
metricNames: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
nextToken: NotRequired[str],ListDimensionsResponseTypeDef#
# ListDimensionsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListDimensionsResponseTypeDef
def get_value() -> ListDimensionsResponseTypeDef:
return {
"dimensionNames": ...,
}
# ListDimensionsResponseTypeDef definition
class ListDimensionsResponseTypeDef(TypedDict):
dimensionNames: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
nextToken: NotRequired[str],ListIndicesResponseTypeDef#
# ListIndicesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListIndicesResponseTypeDef
def get_value() -> ListIndicesResponseTypeDef:
return {
"indexNames": ...,
}
# ListIndicesResponseTypeDef definition
class ListIndicesResponseTypeDef(TypedDict):
indexNames: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
nextToken: NotRequired[str],ListPoliciesResponseTypeDef#
# ListPoliciesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPoliciesResponseTypeDef
def get_value() -> ListPoliciesResponseTypeDef:
return {
"policies": ...,
}
# ListPoliciesResponseTypeDef definition
class ListPoliciesResponseTypeDef(TypedDict):
policies: List[PolicyTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See PolicyTypeDef
- See ResponseMetadataTypeDef
ListPolicyPrincipalsResponseTypeDef#
# ListPolicyPrincipalsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPolicyPrincipalsResponseTypeDef
def get_value() -> ListPolicyPrincipalsResponseTypeDef:
return {
"principals": ...,
}
# ListPolicyPrincipalsResponseTypeDef definition
class ListPolicyPrincipalsResponseTypeDef(TypedDict):
principals: List[str],
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ListPrincipalPoliciesResponseTypeDef#
# ListPrincipalPoliciesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPrincipalPoliciesResponseTypeDef
def get_value() -> ListPrincipalPoliciesResponseTypeDef:
return {
"policies": ...,
}
# ListPrincipalPoliciesResponseTypeDef definition
class ListPrincipalPoliciesResponseTypeDef(TypedDict):
policies: List[PolicyTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See PolicyTypeDef
- See ResponseMetadataTypeDef
ListPrincipalThingsResponseTypeDef#
# ListPrincipalThingsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPrincipalThingsResponseTypeDef
def get_value() -> ListPrincipalThingsResponseTypeDef:
return {
"things": ...,
}
# ListPrincipalThingsResponseTypeDef definition
class ListPrincipalThingsResponseTypeDef(TypedDict):
things: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
nextToken: NotRequired[str],ListRoleAliasesResponseTypeDef#
# ListRoleAliasesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListRoleAliasesResponseTypeDef
def get_value() -> ListRoleAliasesResponseTypeDef:
return {
"roleAliases": ...,
}
# ListRoleAliasesResponseTypeDef definition
class ListRoleAliasesResponseTypeDef(TypedDict):
roleAliases: List[str],
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ListTargetsForPolicyResponseTypeDef#
# ListTargetsForPolicyResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListTargetsForPolicyResponseTypeDef
def get_value() -> ListTargetsForPolicyResponseTypeDef:
return {
"targets": ...,
}
# ListTargetsForPolicyResponseTypeDef definition
class ListTargetsForPolicyResponseTypeDef(TypedDict):
targets: List[str],
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ListThingPrincipalsResponseTypeDef#
# ListThingPrincipalsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingPrincipalsResponseTypeDef
def get_value() -> ListThingPrincipalsResponseTypeDef:
return {
"principals": ...,
}
# ListThingPrincipalsResponseTypeDef definition
class ListThingPrincipalsResponseTypeDef(TypedDict):
principals: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
nextToken: NotRequired[str],ListThingRegistrationTaskReportsResponseTypeDef#
# ListThingRegistrationTaskReportsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingRegistrationTaskReportsResponseTypeDef
def get_value() -> ListThingRegistrationTaskReportsResponseTypeDef:
return {
"resourceLinks": ...,
}
# ListThingRegistrationTaskReportsResponseTypeDef definition
class ListThingRegistrationTaskReportsResponseTypeDef(TypedDict):
resourceLinks: List[str],
reportType: ReportTypeType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListThingRegistrationTasksResponseTypeDef#
# ListThingRegistrationTasksResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingRegistrationTasksResponseTypeDef
def get_value() -> ListThingRegistrationTasksResponseTypeDef:
return {
"taskIds": ...,
}
# ListThingRegistrationTasksResponseTypeDef definition
class ListThingRegistrationTasksResponseTypeDef(TypedDict):
taskIds: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
nextToken: NotRequired[str],ListThingsInBillingGroupResponseTypeDef#
# ListThingsInBillingGroupResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingsInBillingGroupResponseTypeDef
def get_value() -> ListThingsInBillingGroupResponseTypeDef:
return {
"things": ...,
}
# ListThingsInBillingGroupResponseTypeDef definition
class ListThingsInBillingGroupResponseTypeDef(TypedDict):
things: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
nextToken: NotRequired[str],ListThingsInThingGroupResponseTypeDef#
# ListThingsInThingGroupResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingsInThingGroupResponseTypeDef
def get_value() -> ListThingsInThingGroupResponseTypeDef:
return {
"things": ...,
}
# ListThingsInThingGroupResponseTypeDef definition
class ListThingsInThingGroupResponseTypeDef(TypedDict):
things: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
nextToken: NotRequired[str],RegisterCACertificateResponseTypeDef#
# RegisterCACertificateResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RegisterCACertificateResponseTypeDef
def get_value() -> RegisterCACertificateResponseTypeDef:
return {
"certificateArn": ...,
}
# RegisterCACertificateResponseTypeDef definition
class RegisterCACertificateResponseTypeDef(TypedDict):
certificateArn: str,
certificateId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)RegisterCertificateResponseTypeDef#
# RegisterCertificateResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RegisterCertificateResponseTypeDef
def get_value() -> RegisterCertificateResponseTypeDef:
return {
"certificateArn": ...,
}
# RegisterCertificateResponseTypeDef definition
class RegisterCertificateResponseTypeDef(TypedDict):
certificateArn: str,
certificateId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)RegisterCertificateWithoutCAResponseTypeDef#
# RegisterCertificateWithoutCAResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RegisterCertificateWithoutCAResponseTypeDef
def get_value() -> RegisterCertificateWithoutCAResponseTypeDef:
return {
"certificateArn": ...,
}
# RegisterCertificateWithoutCAResponseTypeDef definition
class RegisterCertificateWithoutCAResponseTypeDef(TypedDict):
certificateArn: str,
certificateId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)RegisterThingResponseTypeDef#
# RegisterThingResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RegisterThingResponseTypeDef
def get_value() -> RegisterThingResponseTypeDef:
return {
"certificatePem": ...,
}
# RegisterThingResponseTypeDef definition
class RegisterThingResponseTypeDef(TypedDict):
certificatePem: str,
resourceArns: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)SetDefaultAuthorizerResponseTypeDef#
# SetDefaultAuthorizerResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SetDefaultAuthorizerResponseTypeDef
def get_value() -> SetDefaultAuthorizerResponseTypeDef:
return {
"authorizerName": ...,
}
# SetDefaultAuthorizerResponseTypeDef definition
class SetDefaultAuthorizerResponseTypeDef(TypedDict):
authorizerName: str,
authorizerArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartAuditMitigationActionsTaskResponseTypeDef#
# StartAuditMitigationActionsTaskResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StartAuditMitigationActionsTaskResponseTypeDef
def get_value() -> StartAuditMitigationActionsTaskResponseTypeDef:
return {
"taskId": ...,
}
# StartAuditMitigationActionsTaskResponseTypeDef definition
class StartAuditMitigationActionsTaskResponseTypeDef(TypedDict):
taskId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartDetectMitigationActionsTaskResponseTypeDef#
# StartDetectMitigationActionsTaskResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StartDetectMitigationActionsTaskResponseTypeDef
def get_value() -> StartDetectMitigationActionsTaskResponseTypeDef:
return {
"taskId": ...,
}
# StartDetectMitigationActionsTaskResponseTypeDef definition
class StartDetectMitigationActionsTaskResponseTypeDef(TypedDict):
taskId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartOnDemandAuditTaskResponseTypeDef#
# StartOnDemandAuditTaskResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StartOnDemandAuditTaskResponseTypeDef
def get_value() -> StartOnDemandAuditTaskResponseTypeDef:
return {
"taskId": ...,
}
# StartOnDemandAuditTaskResponseTypeDef definition
class StartOnDemandAuditTaskResponseTypeDef(TypedDict):
taskId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)StartThingRegistrationTaskResponseTypeDef#
# StartThingRegistrationTaskResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StartThingRegistrationTaskResponseTypeDef
def get_value() -> StartThingRegistrationTaskResponseTypeDef:
return {
"taskId": ...,
}
# StartThingRegistrationTaskResponseTypeDef definition
class StartThingRegistrationTaskResponseTypeDef(TypedDict):
taskId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)TestInvokeAuthorizerResponseTypeDef#
# TestInvokeAuthorizerResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TestInvokeAuthorizerResponseTypeDef
def get_value() -> TestInvokeAuthorizerResponseTypeDef:
return {
"isAuthenticated": ...,
}
# TestInvokeAuthorizerResponseTypeDef definition
class TestInvokeAuthorizerResponseTypeDef(TypedDict):
isAuthenticated: bool,
principalId: str,
policyDocuments: List[str],
refreshAfterInSeconds: int,
disconnectAfterInSeconds: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)TransferCertificateResponseTypeDef#
# TransferCertificateResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TransferCertificateResponseTypeDef
def get_value() -> TransferCertificateResponseTypeDef:
return {
"transferredCertificateArn": ...,
}
# TransferCertificateResponseTypeDef definition
class TransferCertificateResponseTypeDef(TypedDict):
transferredCertificateArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateAuthorizerResponseTypeDef#
# UpdateAuthorizerResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateAuthorizerResponseTypeDef
def get_value() -> UpdateAuthorizerResponseTypeDef:
return {
"authorizerName": ...,
}
# UpdateAuthorizerResponseTypeDef definition
class UpdateAuthorizerResponseTypeDef(TypedDict):
authorizerName: str,
authorizerArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateBillingGroupResponseTypeDef#
# UpdateBillingGroupResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateBillingGroupResponseTypeDef
def get_value() -> UpdateBillingGroupResponseTypeDef:
return {
"version": ...,
}
# UpdateBillingGroupResponseTypeDef definition
class UpdateBillingGroupResponseTypeDef(TypedDict):
version: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateCertificateProviderResponseTypeDef#
# UpdateCertificateProviderResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateCertificateProviderResponseTypeDef
def get_value() -> UpdateCertificateProviderResponseTypeDef:
return {
"certificateProviderName": ...,
}
# UpdateCertificateProviderResponseTypeDef definition
class UpdateCertificateProviderResponseTypeDef(TypedDict):
certificateProviderName: str,
certificateProviderArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateCommandResponseTypeDef#
# UpdateCommandResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateCommandResponseTypeDef
def get_value() -> UpdateCommandResponseTypeDef:
return {
"commandId": ...,
}
# UpdateCommandResponseTypeDef definition
class UpdateCommandResponseTypeDef(TypedDict):
commandId: str,
displayName: str,
description: str,
deprecated: bool,
lastUpdatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateCustomMetricResponseTypeDef#
# UpdateCustomMetricResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateCustomMetricResponseTypeDef
def get_value() -> UpdateCustomMetricResponseTypeDef:
return {
"metricName": ...,
}
# UpdateCustomMetricResponseTypeDef definition
class UpdateCustomMetricResponseTypeDef(TypedDict):
metricName: str,
metricArn: str,
metricType: CustomMetricTypeType, # (1)
displayName: str,
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateDimensionResponseTypeDef#
# UpdateDimensionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateDimensionResponseTypeDef
def get_value() -> UpdateDimensionResponseTypeDef:
return {
"name": ...,
}
# UpdateDimensionResponseTypeDef definition
class UpdateDimensionResponseTypeDef(TypedDict):
name: str,
arn: str,
type: DimensionTypeType, # (1)
stringValues: List[str],
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateDomainConfigurationResponseTypeDef#
# UpdateDomainConfigurationResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateDomainConfigurationResponseTypeDef
def get_value() -> UpdateDomainConfigurationResponseTypeDef:
return {
"domainConfigurationName": ...,
}
# UpdateDomainConfigurationResponseTypeDef definition
class UpdateDomainConfigurationResponseTypeDef(TypedDict):
domainConfigurationName: str,
domainConfigurationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateDynamicThingGroupResponseTypeDef#
# UpdateDynamicThingGroupResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateDynamicThingGroupResponseTypeDef
def get_value() -> UpdateDynamicThingGroupResponseTypeDef:
return {
"version": ...,
}
# UpdateDynamicThingGroupResponseTypeDef definition
class UpdateDynamicThingGroupResponseTypeDef(TypedDict):
version: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateMitigationActionResponseTypeDef#
# UpdateMitigationActionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateMitigationActionResponseTypeDef
def get_value() -> UpdateMitigationActionResponseTypeDef:
return {
"actionArn": ...,
}
# UpdateMitigationActionResponseTypeDef definition
class UpdateMitigationActionResponseTypeDef(TypedDict):
actionArn: str,
actionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateRoleAliasResponseTypeDef#
# UpdateRoleAliasResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateRoleAliasResponseTypeDef
def get_value() -> UpdateRoleAliasResponseTypeDef:
return {
"roleAlias": ...,
}
# UpdateRoleAliasResponseTypeDef definition
class UpdateRoleAliasResponseTypeDef(TypedDict):
roleAlias: str,
roleAliasArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateScheduledAuditResponseTypeDef#
# UpdateScheduledAuditResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateScheduledAuditResponseTypeDef
def get_value() -> UpdateScheduledAuditResponseTypeDef:
return {
"scheduledAuditArn": ...,
}
# UpdateScheduledAuditResponseTypeDef definition
class UpdateScheduledAuditResponseTypeDef(TypedDict):
scheduledAuditArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateStreamResponseTypeDef#
# UpdateStreamResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateStreamResponseTypeDef
def get_value() -> UpdateStreamResponseTypeDef:
return {
"streamId": ...,
}
# UpdateStreamResponseTypeDef definition
class UpdateStreamResponseTypeDef(TypedDict):
streamId: str,
streamArn: str,
description: str,
streamVersion: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)UpdateThingGroupResponseTypeDef#
# UpdateThingGroupResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateThingGroupResponseTypeDef
def get_value() -> UpdateThingGroupResponseTypeDef:
return {
"version": ...,
}
# UpdateThingGroupResponseTypeDef definition
class UpdateThingGroupResponseTypeDef(TypedDict):
version: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ThingGroupPropertiesOutputTypeDef#
# ThingGroupPropertiesOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingGroupPropertiesOutputTypeDef
def get_value() -> ThingGroupPropertiesOutputTypeDef:
return {
"thingGroupDescription": ...,
}
# ThingGroupPropertiesOutputTypeDef definition
class ThingGroupPropertiesOutputTypeDef(TypedDict):
thingGroupDescription: NotRequired[str],
attributePayload: NotRequired[AttributePayloadOutputTypeDef], # (1)ThingGroupPropertiesTypeDef#
# ThingGroupPropertiesTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingGroupPropertiesTypeDef
def get_value() -> ThingGroupPropertiesTypeDef:
return {
"thingGroupDescription": ...,
}
# ThingGroupPropertiesTypeDef definition
class ThingGroupPropertiesTypeDef(TypedDict):
thingGroupDescription: NotRequired[str],
attributePayload: NotRequired[AttributePayloadTypeDef], # (1)ListAuditMitigationActionsExecutionsResponseTypeDef#
# ListAuditMitigationActionsExecutionsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuditMitigationActionsExecutionsResponseTypeDef
def get_value() -> ListAuditMitigationActionsExecutionsResponseTypeDef:
return {
"actionsExecutions": ...,
}
# ListAuditMitigationActionsExecutionsResponseTypeDef definition
class ListAuditMitigationActionsExecutionsResponseTypeDef(TypedDict):
actionsExecutions: List[AuditMitigationActionExecutionMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListAuditMitigationActionsTasksResponseTypeDef#
# ListAuditMitigationActionsTasksResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuditMitigationActionsTasksResponseTypeDef
def get_value() -> ListAuditMitigationActionsTasksResponseTypeDef:
return {
"tasks": ...,
}
# ListAuditMitigationActionsTasksResponseTypeDef definition
class ListAuditMitigationActionsTasksResponseTypeDef(TypedDict):
tasks: List[AuditMitigationActionsTaskMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],DescribeAccountAuditConfigurationResponseTypeDef#
# DescribeAccountAuditConfigurationResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeAccountAuditConfigurationResponseTypeDef
def get_value() -> DescribeAccountAuditConfigurationResponseTypeDef:
return {
"roleArn": ...,
}
# DescribeAccountAuditConfigurationResponseTypeDef definition
class DescribeAccountAuditConfigurationResponseTypeDef(TypedDict):
roleArn: str,
auditNotificationTargetConfigurations: Dict[AuditNotificationTypeType, AuditNotificationTargetTypeDef], # (1)
auditCheckConfigurations: Dict[str, AuditCheckConfigurationTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See AuditNotificationTypeType AuditNotificationTargetTypeDef
- See AuditCheckConfigurationTypeDef
- See ResponseMetadataTypeDef
UpdateAccountAuditConfigurationRequestTypeDef#
# UpdateAccountAuditConfigurationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateAccountAuditConfigurationRequestTypeDef
def get_value() -> UpdateAccountAuditConfigurationRequestTypeDef:
return {
"roleArn": ...,
}
# UpdateAccountAuditConfigurationRequestTypeDef definition
class UpdateAccountAuditConfigurationRequestTypeDef(TypedDict):
roleArn: NotRequired[str],
auditNotificationTargetConfigurations: NotRequired[Mapping[AuditNotificationTypeType, AuditNotificationTargetTypeDef]], # (1)
auditCheckConfigurations: NotRequired[Mapping[str, AuditCheckConfigurationTypeDef]], # (2)ListAuditTasksResponseTypeDef#
# ListAuditTasksResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuditTasksResponseTypeDef
def get_value() -> ListAuditTasksResponseTypeDef:
return {
"tasks": ...,
}
# ListAuditTasksResponseTypeDef definition
class ListAuditTasksResponseTypeDef(TypedDict):
tasks: List[AuditTaskMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],DescribeAuthorizerResponseTypeDef#
# DescribeAuthorizerResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeAuthorizerResponseTypeDef
def get_value() -> DescribeAuthorizerResponseTypeDef:
return {
"authorizerDescription": ...,
}
# DescribeAuthorizerResponseTypeDef definition
class DescribeAuthorizerResponseTypeDef(TypedDict):
authorizerDescription: AuthorizerDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeDefaultAuthorizerResponseTypeDef#
# DescribeDefaultAuthorizerResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeDefaultAuthorizerResponseTypeDef
def get_value() -> DescribeDefaultAuthorizerResponseTypeDef:
return {
"authorizerDescription": ...,
}
# DescribeDefaultAuthorizerResponseTypeDef definition
class DescribeDefaultAuthorizerResponseTypeDef(TypedDict):
authorizerDescription: AuthorizerDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListAuthorizersResponseTypeDef#
# ListAuthorizersResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuthorizersResponseTypeDef
def get_value() -> ListAuthorizersResponseTypeDef:
return {
"authorizers": ...,
}
# ListAuthorizersResponseTypeDef definition
class ListAuthorizersResponseTypeDef(TypedDict):
authorizers: List[AuthorizerSummaryTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)AwsJobAbortConfigTypeDef#
# AwsJobAbortConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AwsJobAbortConfigTypeDef
def get_value() -> AwsJobAbortConfigTypeDef:
return {
"abortCriteriaList": ...,
}
# AwsJobAbortConfigTypeDef definition
class AwsJobAbortConfigTypeDef(TypedDict):
abortCriteriaList: Sequence[AwsJobAbortCriteriaTypeDef], # (1)AwsJobExponentialRolloutRateTypeDef#
# AwsJobExponentialRolloutRateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AwsJobExponentialRolloutRateTypeDef
def get_value() -> AwsJobExponentialRolloutRateTypeDef:
return {
"baseRatePerMinute": ...,
}
# AwsJobExponentialRolloutRateTypeDef definition
class AwsJobExponentialRolloutRateTypeDef(TypedDict):
baseRatePerMinute: int,
incrementFactor: float,
rateIncreaseCriteria: AwsJobRateIncreaseCriteriaTypeDef, # (1)BehaviorCriteriaOutputTypeDef#
# BehaviorCriteriaOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import BehaviorCriteriaOutputTypeDef
def get_value() -> BehaviorCriteriaOutputTypeDef:
return {
"comparisonOperator": ...,
}
# BehaviorCriteriaOutputTypeDef definition
class BehaviorCriteriaOutputTypeDef(TypedDict):
comparisonOperator: NotRequired[ComparisonOperatorType], # (1)
value: NotRequired[MetricValueOutputTypeDef], # (2)
durationSeconds: NotRequired[int],
consecutiveDatapointsToAlarm: NotRequired[int],
consecutiveDatapointsToClear: NotRequired[int],
statisticalThreshold: NotRequired[StatisticalThresholdTypeDef], # (3)
mlDetectionConfig: NotRequired[MachineLearningDetectionConfigTypeDef], # (4)- See ComparisonOperatorType
- See MetricValueOutputTypeDef
- See StatisticalThresholdTypeDef
- See MachineLearningDetectionConfigTypeDef
GetBehaviorModelTrainingSummariesResponseTypeDef#
# GetBehaviorModelTrainingSummariesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetBehaviorModelTrainingSummariesResponseTypeDef
def get_value() -> GetBehaviorModelTrainingSummariesResponseTypeDef:
return {
"summaries": ...,
}
# GetBehaviorModelTrainingSummariesResponseTypeDef definition
class GetBehaviorModelTrainingSummariesResponseTypeDef(TypedDict):
summaries: List[BehaviorModelTrainingSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],MetricToRetainTypeDef#
# MetricToRetainTypeDef TypedDict usage example
from types_boto3_iot.type_defs import MetricToRetainTypeDef
def get_value() -> MetricToRetainTypeDef:
return {
"metric": ...,
}
# MetricToRetainTypeDef definition
class MetricToRetainTypeDef(TypedDict):
metric: str,
metricDimension: NotRequired[MetricDimensionTypeDef], # (1)
exportMetric: NotRequired[bool],DescribeBillingGroupResponseTypeDef#
# DescribeBillingGroupResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeBillingGroupResponseTypeDef
def get_value() -> DescribeBillingGroupResponseTypeDef:
return {
"billingGroupName": ...,
}
# DescribeBillingGroupResponseTypeDef definition
class DescribeBillingGroupResponseTypeDef(TypedDict):
billingGroupName: str,
billingGroupId: str,
billingGroupArn: str,
version: int,
billingGroupProperties: BillingGroupPropertiesTypeDef, # (1)
billingGroupMetadata: BillingGroupMetadataTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)UpdateBillingGroupRequestTypeDef#
# UpdateBillingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateBillingGroupRequestTypeDef
def get_value() -> UpdateBillingGroupRequestTypeDef:
return {
"billingGroupName": ...,
}
# UpdateBillingGroupRequestTypeDef definition
class UpdateBillingGroupRequestTypeDef(TypedDict):
billingGroupName: str,
billingGroupProperties: BillingGroupPropertiesTypeDef, # (1)
expectedVersion: NotRequired[int],CodeSigningSignatureTypeDef#
# CodeSigningSignatureTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CodeSigningSignatureTypeDef
def get_value() -> CodeSigningSignatureTypeDef:
return {
"inlineDocument": ...,
}
# CodeSigningSignatureTypeDef definition
class CodeSigningSignatureTypeDef(TypedDict):
inlineDocument: NotRequired[BlobTypeDef],CommandParameterValueTypeDef#
# CommandParameterValueTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CommandParameterValueTypeDef
def get_value() -> CommandParameterValueTypeDef:
return {
"S": ...,
}
# CommandParameterValueTypeDef definition
class CommandParameterValueTypeDef(TypedDict):
S: NotRequired[str],
B: NotRequired[bool],
I: NotRequired[int],
L: NotRequired[int],
D: NotRequired[float],
BIN: NotRequired[BlobTypeDef],
UL: NotRequired[str],CommandPayloadTypeDef#
# CommandPayloadTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CommandPayloadTypeDef
def get_value() -> CommandPayloadTypeDef:
return {
"content": ...,
}
# CommandPayloadTypeDef definition
class CommandPayloadTypeDef(TypedDict):
content: NotRequired[BlobTypeDef],
contentType: NotRequired[str],MqttContextTypeDef#
# MqttContextTypeDef TypedDict usage example
from types_boto3_iot.type_defs import MqttContextTypeDef
def get_value() -> MqttContextTypeDef:
return {
"username": ...,
}
# MqttContextTypeDef definition
class MqttContextTypeDef(TypedDict):
username: NotRequired[str],
password: NotRequired[BlobTypeDef],
clientId: NotRequired[str],GetBucketsAggregationResponseTypeDef#
# GetBucketsAggregationResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetBucketsAggregationResponseTypeDef
def get_value() -> GetBucketsAggregationResponseTypeDef:
return {
"totalCount": ...,
}
# GetBucketsAggregationResponseTypeDef definition
class GetBucketsAggregationResponseTypeDef(TypedDict):
totalCount: int,
buckets: List[BucketTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See BucketTypeDef
- See ResponseMetadataTypeDef
BucketsAggregationTypeTypeDef#
# BucketsAggregationTypeTypeDef TypedDict usage example
from types_boto3_iot.type_defs import BucketsAggregationTypeTypeDef
def get_value() -> BucketsAggregationTypeTypeDef:
return {
"termsAggregation": ...,
}
# BucketsAggregationTypeTypeDef definition
class BucketsAggregationTypeTypeDef(TypedDict):
termsAggregation: NotRequired[TermsAggregationTypeDef], # (1)CACertificateDescriptionTypeDef#
# CACertificateDescriptionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CACertificateDescriptionTypeDef
def get_value() -> CACertificateDescriptionTypeDef:
return {
"certificateArn": ...,
}
# CACertificateDescriptionTypeDef definition
class CACertificateDescriptionTypeDef(TypedDict):
certificateArn: NotRequired[str],
certificateId: NotRequired[str],
status: NotRequired[CACertificateStatusType], # (1)
certificatePem: NotRequired[str],
ownedBy: NotRequired[str],
creationDate: NotRequired[datetime],
autoRegistrationStatus: NotRequired[AutoRegistrationStatusType], # (2)
lastModifiedDate: NotRequired[datetime],
customerVersion: NotRequired[int],
generationId: NotRequired[str],
validity: NotRequired[CertificateValidityTypeDef], # (3)
certificateMode: NotRequired[CertificateModeType], # (4)- See CACertificateStatusType
- See AutoRegistrationStatusType
- See CertificateValidityTypeDef
- See CertificateModeType
ListCACertificatesResponseTypeDef#
# ListCACertificatesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCACertificatesResponseTypeDef
def get_value() -> ListCACertificatesResponseTypeDef:
return {
"certificates": ...,
}
# ListCACertificatesResponseTypeDef definition
class ListCACertificatesResponseTypeDef(TypedDict):
certificates: List[CACertificateTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)CertificateDescriptionTypeDef#
# CertificateDescriptionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CertificateDescriptionTypeDef
def get_value() -> CertificateDescriptionTypeDef:
return {
"certificateArn": ...,
}
# CertificateDescriptionTypeDef definition
class CertificateDescriptionTypeDef(TypedDict):
certificateArn: NotRequired[str],
certificateId: NotRequired[str],
caCertificateId: NotRequired[str],
status: NotRequired[CertificateStatusType], # (1)
certificatePem: NotRequired[str],
ownedBy: NotRequired[str],
previousOwnedBy: NotRequired[str],
creationDate: NotRequired[datetime],
lastModifiedDate: NotRequired[datetime],
customerVersion: NotRequired[int],
transferData: NotRequired[TransferDataTypeDef], # (2)
generationId: NotRequired[str],
validity: NotRequired[CertificateValidityTypeDef], # (3)
certificateMode: NotRequired[CertificateModeType], # (4)- See CertificateStatusType
- See TransferDataTypeDef
- See CertificateValidityTypeDef
- See CertificateModeType
ListCertificateProvidersResponseTypeDef#
# ListCertificateProvidersResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCertificateProvidersResponseTypeDef
def get_value() -> ListCertificateProvidersResponseTypeDef:
return {
"certificateProviders": ...,
}
# ListCertificateProvidersResponseTypeDef definition
class ListCertificateProvidersResponseTypeDef(TypedDict):
certificateProviders: List[CertificateProviderSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListCertificatesByCAResponseTypeDef#
# ListCertificatesByCAResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCertificatesByCAResponseTypeDef
def get_value() -> ListCertificatesByCAResponseTypeDef:
return {
"certificates": ...,
}
# ListCertificatesByCAResponseTypeDef definition
class ListCertificatesByCAResponseTypeDef(TypedDict):
certificates: List[CertificateTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListCertificatesResponseTypeDef#
# ListCertificatesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCertificatesResponseTypeDef
def get_value() -> ListCertificatesResponseTypeDef:
return {
"certificates": ...,
}
# ListCertificatesResponseTypeDef definition
class ListCertificatesResponseTypeDef(TypedDict):
certificates: List[CertificateTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)CustomCodeSigningOutputTypeDef#
# CustomCodeSigningOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CustomCodeSigningOutputTypeDef
def get_value() -> CustomCodeSigningOutputTypeDef:
return {
"signature": ...,
}
# CustomCodeSigningOutputTypeDef definition
class CustomCodeSigningOutputTypeDef(TypedDict):
signature: NotRequired[CodeSigningSignatureOutputTypeDef], # (1)
certificateChain: NotRequired[CodeSigningCertificateChainTypeDef], # (2)
hashAlgorithm: NotRequired[str],
signatureAlgorithm: NotRequired[str],ListCommandExecutionsResponseTypeDef#
# ListCommandExecutionsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCommandExecutionsResponseTypeDef
def get_value() -> ListCommandExecutionsResponseTypeDef:
return {
"commandExecutions": ...,
}
# ListCommandExecutionsResponseTypeDef definition
class ListCommandExecutionsResponseTypeDef(TypedDict):
commandExecutions: List[CommandExecutionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],CommandParameterOutputTypeDef#
# CommandParameterOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CommandParameterOutputTypeDef
def get_value() -> CommandParameterOutputTypeDef:
return {
"name": ...,
}
# CommandParameterOutputTypeDef definition
class CommandParameterOutputTypeDef(TypedDict):
name: str,
value: NotRequired[CommandParameterValueOutputTypeDef], # (1)
defaultValue: NotRequired[CommandParameterValueOutputTypeDef], # (1)
description: NotRequired[str],ListCommandsResponseTypeDef#
# ListCommandsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCommandsResponseTypeDef
def get_value() -> ListCommandsResponseTypeDef:
return {
"commands": ...,
}
# ListCommandsResponseTypeDef definition
class ListCommandsResponseTypeDef(TypedDict):
commands: List[CommandSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],DescribeEventConfigurationsResponseTypeDef#
# DescribeEventConfigurationsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeEventConfigurationsResponseTypeDef
def get_value() -> DescribeEventConfigurationsResponseTypeDef:
return {
"eventConfigurations": ...,
}
# DescribeEventConfigurationsResponseTypeDef definition
class DescribeEventConfigurationsResponseTypeDef(TypedDict):
eventConfigurations: Dict[EventTypeType, ConfigurationTypeDef], # (1)
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateEventConfigurationsRequestTypeDef#
# UpdateEventConfigurationsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateEventConfigurationsRequestTypeDef
def get_value() -> UpdateEventConfigurationsRequestTypeDef:
return {
"eventConfigurations": ...,
}
# UpdateEventConfigurationsRequestTypeDef definition
class UpdateEventConfigurationsRequestTypeDef(TypedDict):
eventConfigurations: NotRequired[Mapping[EventTypeType, ConfigurationTypeDef]], # (1)ListAuditMitigationActionsTasksRequestTypeDef#
# ListAuditMitigationActionsTasksRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuditMitigationActionsTasksRequestTypeDef
def get_value() -> ListAuditMitigationActionsTasksRequestTypeDef:
return {
"startTime": ...,
}
# ListAuditMitigationActionsTasksRequestTypeDef definition
class ListAuditMitigationActionsTasksRequestTypeDef(TypedDict):
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,
auditTaskId: NotRequired[str],
findingId: NotRequired[str],
taskStatus: NotRequired[AuditMitigationActionsTaskStatusType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListAuditTasksRequestTypeDef#
# ListAuditTasksRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuditTasksRequestTypeDef
def get_value() -> ListAuditTasksRequestTypeDef:
return {
"startTime": ...,
}
# ListAuditTasksRequestTypeDef definition
class ListAuditTasksRequestTypeDef(TypedDict):
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,
taskType: NotRequired[AuditTaskTypeType], # (1)
taskStatus: NotRequired[AuditTaskStatusType], # (2)
nextToken: NotRequired[str],
maxResults: NotRequired[int],- See AuditTaskTypeType
- See AuditTaskStatusType
ListDetectMitigationActionsExecutionsRequestTypeDef#
# ListDetectMitigationActionsExecutionsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListDetectMitigationActionsExecutionsRequestTypeDef
def get_value() -> ListDetectMitigationActionsExecutionsRequestTypeDef:
return {
"taskId": ...,
}
# ListDetectMitigationActionsExecutionsRequestTypeDef definition
class ListDetectMitigationActionsExecutionsRequestTypeDef(TypedDict):
taskId: NotRequired[str],
violationId: NotRequired[str],
thingName: NotRequired[str],
startTime: NotRequired[TimestampTypeDef],
endTime: NotRequired[TimestampTypeDef],
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListDetectMitigationActionsTasksRequestTypeDef#
# ListDetectMitigationActionsTasksRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListDetectMitigationActionsTasksRequestTypeDef
def get_value() -> ListDetectMitigationActionsTasksRequestTypeDef:
return {
"startTime": ...,
}
# ListDetectMitigationActionsTasksRequestTypeDef definition
class ListDetectMitigationActionsTasksRequestTypeDef(TypedDict):
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListMetricValuesRequestTypeDef#
# ListMetricValuesRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListMetricValuesRequestTypeDef
def get_value() -> ListMetricValuesRequestTypeDef:
return {
"thingName": ...,
}
# ListMetricValuesRequestTypeDef definition
class ListMetricValuesRequestTypeDef(TypedDict):
thingName: str,
metricName: str,
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,
dimensionName: NotRequired[str],
dimensionValueOperator: NotRequired[DimensionValueOperatorType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],ListViolationEventsRequestTypeDef#
# ListViolationEventsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListViolationEventsRequestTypeDef
def get_value() -> ListViolationEventsRequestTypeDef:
return {
"startTime": ...,
}
# ListViolationEventsRequestTypeDef definition
class ListViolationEventsRequestTypeDef(TypedDict):
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,
thingName: NotRequired[str],
securityProfileName: NotRequired[str],
behaviorCriteriaType: NotRequired[BehaviorCriteriaTypeType], # (1)
listSuppressedAlerts: NotRequired[bool],
verificationState: NotRequired[VerificationStateType], # (2)
nextToken: NotRequired[str],
maxResults: NotRequired[int],ViolationEventOccurrenceRangeTypeDef#
# ViolationEventOccurrenceRangeTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ViolationEventOccurrenceRangeTypeDef
def get_value() -> ViolationEventOccurrenceRangeTypeDef:
return {
"startTime": ...,
}
# ViolationEventOccurrenceRangeTypeDef definition
class ViolationEventOccurrenceRangeTypeDef(TypedDict):
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,CreateAuthorizerRequestTypeDef#
# CreateAuthorizerRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateAuthorizerRequestTypeDef
def get_value() -> CreateAuthorizerRequestTypeDef:
return {
"authorizerName": ...,
}
# CreateAuthorizerRequestTypeDef definition
class CreateAuthorizerRequestTypeDef(TypedDict):
authorizerName: str,
authorizerFunctionArn: str,
tokenKeyName: NotRequired[str],
tokenSigningPublicKeys: NotRequired[Mapping[str, str]],
status: NotRequired[AuthorizerStatusType], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)
signingDisabled: NotRequired[bool],
enableCachingForHttp: NotRequired[bool],- See AuthorizerStatusType
- See TagTypeDef
CreateBillingGroupRequestTypeDef#
# CreateBillingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateBillingGroupRequestTypeDef
def get_value() -> CreateBillingGroupRequestTypeDef:
return {
"billingGroupName": ...,
}
# CreateBillingGroupRequestTypeDef definition
class CreateBillingGroupRequestTypeDef(TypedDict):
billingGroupName: str,
billingGroupProperties: NotRequired[BillingGroupPropertiesTypeDef], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)CreateCertificateProviderRequestTypeDef#
# CreateCertificateProviderRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateCertificateProviderRequestTypeDef
def get_value() -> CreateCertificateProviderRequestTypeDef:
return {
"certificateProviderName": ...,
}
# CreateCertificateProviderRequestTypeDef definition
class CreateCertificateProviderRequestTypeDef(TypedDict):
certificateProviderName: str,
lambdaFunctionArn: str,
accountDefaultForOperations: Sequence[CertificateProviderOperationType], # (1)
clientToken: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)CreateCustomMetricRequestTypeDef#
# CreateCustomMetricRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateCustomMetricRequestTypeDef
def get_value() -> CreateCustomMetricRequestTypeDef:
return {
"metricName": ...,
}
# CreateCustomMetricRequestTypeDef definition
class CreateCustomMetricRequestTypeDef(TypedDict):
metricName: str,
metricType: CustomMetricTypeType, # (1)
clientRequestToken: str,
displayName: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)- See CustomMetricTypeType
- See TagTypeDef
CreateDimensionRequestTypeDef#
# CreateDimensionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateDimensionRequestTypeDef
def get_value() -> CreateDimensionRequestTypeDef:
return {
"name": ...,
}
# CreateDimensionRequestTypeDef definition
class CreateDimensionRequestTypeDef(TypedDict):
name: str,
type: DimensionTypeType, # (1)
stringValues: Sequence[str],
clientRequestToken: str,
tags: NotRequired[Sequence[TagTypeDef]], # (2)- See DimensionTypeType
- See TagTypeDef
CreatePolicyRequestTypeDef#
# CreatePolicyRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreatePolicyRequestTypeDef
def get_value() -> CreatePolicyRequestTypeDef:
return {
"policyName": ...,
}
# CreatePolicyRequestTypeDef definition
class CreatePolicyRequestTypeDef(TypedDict):
policyName: str,
policyDocument: str,
tags: NotRequired[Sequence[TagTypeDef]], # (1)- See TagTypeDef
CreateRoleAliasRequestTypeDef#
# CreateRoleAliasRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateRoleAliasRequestTypeDef
def get_value() -> CreateRoleAliasRequestTypeDef:
return {
"roleAlias": ...,
}
# CreateRoleAliasRequestTypeDef definition
class CreateRoleAliasRequestTypeDef(TypedDict):
roleAlias: str,
roleArn: str,
credentialDurationSeconds: NotRequired[int],
tags: NotRequired[Sequence[TagTypeDef]], # (1)- See TagTypeDef
CreateScheduledAuditRequestTypeDef#
# CreateScheduledAuditRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateScheduledAuditRequestTypeDef
def get_value() -> CreateScheduledAuditRequestTypeDef:
return {
"frequency": ...,
}
# CreateScheduledAuditRequestTypeDef definition
class CreateScheduledAuditRequestTypeDef(TypedDict):
frequency: AuditFrequencyType, # (1)
targetCheckNames: Sequence[str],
scheduledAuditName: str,
dayOfMonth: NotRequired[str],
dayOfWeek: NotRequired[DayOfWeekType], # (2)
tags: NotRequired[Sequence[TagTypeDef]], # (3)- See AuditFrequencyType
- See DayOfWeekType
- See TagTypeDef
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestTypeDef#
# TagResourceRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TagResourceRequestTypeDef
def get_value() -> TagResourceRequestTypeDef:
return {
"resourceArn": ...,
}
# TagResourceRequestTypeDef definition
class TagResourceRequestTypeDef(TypedDict):
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)- See TagTypeDef
CreateDomainConfigurationRequestTypeDef#
# CreateDomainConfigurationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateDomainConfigurationRequestTypeDef
def get_value() -> CreateDomainConfigurationRequestTypeDef:
return {
"domainConfigurationName": ...,
}
# CreateDomainConfigurationRequestTypeDef definition
class CreateDomainConfigurationRequestTypeDef(TypedDict):
domainConfigurationName: str,
domainName: NotRequired[str],
serverCertificateArns: NotRequired[Sequence[str]],
validationCertificateArn: NotRequired[str],
authorizerConfig: NotRequired[AuthorizerConfigTypeDef], # (1)
serviceType: NotRequired[ServiceTypeType], # (2)
tags: NotRequired[Sequence[TagTypeDef]], # (3)
tlsConfig: NotRequired[TlsConfigTypeDef], # (4)
serverCertificateConfig: NotRequired[ServerCertificateConfigTypeDef], # (5)
authenticationType: NotRequired[AuthenticationTypeType], # (6)
applicationProtocol: NotRequired[ApplicationProtocolType], # (7)
clientCertificateConfig: NotRequired[ClientCertificateConfigTypeDef], # (8)- See AuthorizerConfigTypeDef
- See ServiceTypeType
- See TagTypeDef
- See TlsConfigTypeDef
- See ServerCertificateConfigTypeDef
- See AuthenticationTypeType
- See ApplicationProtocolType
- See ClientCertificateConfigTypeDef
UpdateDomainConfigurationRequestTypeDef#
# UpdateDomainConfigurationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateDomainConfigurationRequestTypeDef
def get_value() -> UpdateDomainConfigurationRequestTypeDef:
return {
"domainConfigurationName": ...,
}
# UpdateDomainConfigurationRequestTypeDef definition
class UpdateDomainConfigurationRequestTypeDef(TypedDict):
domainConfigurationName: str,
authorizerConfig: NotRequired[AuthorizerConfigTypeDef], # (1)
domainConfigurationStatus: NotRequired[DomainConfigurationStatusType], # (2)
removeAuthorizerConfig: NotRequired[bool],
tlsConfig: NotRequired[TlsConfigTypeDef], # (3)
serverCertificateConfig: NotRequired[ServerCertificateConfigTypeDef], # (4)
authenticationType: NotRequired[AuthenticationTypeType], # (5)
applicationProtocol: NotRequired[ApplicationProtocolType], # (6)
clientCertificateConfig: NotRequired[ClientCertificateConfigTypeDef], # (7)- See AuthorizerConfigTypeDef
- See DomainConfigurationStatusType
- See TlsConfigTypeDef
- See ServerCertificateConfigTypeDef
- See AuthenticationTypeType
- See ApplicationProtocolType
- See ClientCertificateConfigTypeDef
SchedulingConfigOutputTypeDef#
# SchedulingConfigOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SchedulingConfigOutputTypeDef
def get_value() -> SchedulingConfigOutputTypeDef:
return {
"startTime": ...,
}
# SchedulingConfigOutputTypeDef definition
class SchedulingConfigOutputTypeDef(TypedDict):
startTime: NotRequired[str],
endTime: NotRequired[str],
endBehavior: NotRequired[JobEndBehaviorType], # (1)
maintenanceWindows: NotRequired[List[MaintenanceWindowTypeDef]], # (2)SchedulingConfigTypeDef#
# SchedulingConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SchedulingConfigTypeDef
def get_value() -> SchedulingConfigTypeDef:
return {
"startTime": ...,
}
# SchedulingConfigTypeDef definition
class SchedulingConfigTypeDef(TypedDict):
startTime: NotRequired[str],
endTime: NotRequired[str],
endBehavior: NotRequired[JobEndBehaviorType], # (1)
maintenanceWindows: NotRequired[Sequence[MaintenanceWindowTypeDef]], # (2)CreateKeysAndCertificateResponseTypeDef#
# CreateKeysAndCertificateResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateKeysAndCertificateResponseTypeDef
def get_value() -> CreateKeysAndCertificateResponseTypeDef:
return {
"certificateArn": ...,
}
# CreateKeysAndCertificateResponseTypeDef definition
class CreateKeysAndCertificateResponseTypeDef(TypedDict):
certificateArn: str,
certificateId: str,
certificatePem: str,
keyPair: KeyPairTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateProvisioningClaimResponseTypeDef#
# CreateProvisioningClaimResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateProvisioningClaimResponseTypeDef
def get_value() -> CreateProvisioningClaimResponseTypeDef:
return {
"certificateId": ...,
}
# CreateProvisioningClaimResponseTypeDef definition
class CreateProvisioningClaimResponseTypeDef(TypedDict):
certificateId: str,
certificatePem: str,
keyPair: KeyPairTypeDef, # (1)
expiration: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateProvisioningTemplateRequestTypeDef#
# CreateProvisioningTemplateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateProvisioningTemplateRequestTypeDef
def get_value() -> CreateProvisioningTemplateRequestTypeDef:
return {
"templateName": ...,
}
# CreateProvisioningTemplateRequestTypeDef definition
class CreateProvisioningTemplateRequestTypeDef(TypedDict):
templateName: str,
templateBody: str,
provisioningRoleArn: str,
description: NotRequired[str],
enabled: NotRequired[bool],
preProvisioningHook: NotRequired[ProvisioningHookTypeDef], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)
type: NotRequired[TemplateTypeType], # (3)- See ProvisioningHookTypeDef
- See TagTypeDef
- See TemplateTypeType
DescribeProvisioningTemplateResponseTypeDef#
# DescribeProvisioningTemplateResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeProvisioningTemplateResponseTypeDef
def get_value() -> DescribeProvisioningTemplateResponseTypeDef:
return {
"templateArn": ...,
}
# DescribeProvisioningTemplateResponseTypeDef definition
class DescribeProvisioningTemplateResponseTypeDef(TypedDict):
templateArn: str,
templateName: str,
description: str,
creationDate: datetime,
lastModifiedDate: datetime,
defaultVersionId: int,
templateBody: str,
enabled: bool,
provisioningRoleArn: str,
preProvisioningHook: ProvisioningHookTypeDef, # (1)
type: TemplateTypeType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)UpdateProvisioningTemplateRequestTypeDef#
# UpdateProvisioningTemplateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateProvisioningTemplateRequestTypeDef
def get_value() -> UpdateProvisioningTemplateRequestTypeDef:
return {
"templateName": ...,
}
# UpdateProvisioningTemplateRequestTypeDef definition
class UpdateProvisioningTemplateRequestTypeDef(TypedDict):
templateName: str,
description: NotRequired[str],
enabled: NotRequired[bool],
defaultVersionId: NotRequired[int],
provisioningRoleArn: NotRequired[str],
preProvisioningHook: NotRequired[ProvisioningHookTypeDef], # (1)
removePreProvisioningHook: NotRequired[bool],DescribeAuditTaskResponseTypeDef#
# DescribeAuditTaskResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeAuditTaskResponseTypeDef
def get_value() -> DescribeAuditTaskResponseTypeDef:
return {
"taskStatus": ...,
}
# DescribeAuditTaskResponseTypeDef definition
class DescribeAuditTaskResponseTypeDef(TypedDict):
taskStatus: AuditTaskStatusType, # (1)
taskType: AuditTaskTypeType, # (2)
taskStartTime: datetime,
taskStatistics: TaskStatisticsTypeDef, # (3)
scheduledAuditName: str,
auditDetails: Dict[str, AuditCheckDetailsTypeDef], # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See AuditTaskStatusType
- See AuditTaskTypeType
- See TaskStatisticsTypeDef
- See AuditCheckDetailsTypeDef
- See ResponseMetadataTypeDef
RegisterCACertificateRequestTypeDef#
# RegisterCACertificateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RegisterCACertificateRequestTypeDef
def get_value() -> RegisterCACertificateRequestTypeDef:
return {
"caCertificate": ...,
}
# RegisterCACertificateRequestTypeDef definition
class RegisterCACertificateRequestTypeDef(TypedDict):
caCertificate: str,
verificationCertificate: NotRequired[str],
setAsActive: NotRequired[bool],
allowAutoRegistration: NotRequired[bool],
registrationConfig: NotRequired[RegistrationConfigTypeDef], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)
certificateMode: NotRequired[CertificateModeType], # (3)- See RegistrationConfigTypeDef
- See TagTypeDef
- See CertificateModeType
UpdateCACertificateRequestTypeDef#
# UpdateCACertificateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateCACertificateRequestTypeDef
def get_value() -> UpdateCACertificateRequestTypeDef:
return {
"certificateId": ...,
}
# UpdateCACertificateRequestTypeDef definition
class UpdateCACertificateRequestTypeDef(TypedDict):
certificateId: str,
newStatus: NotRequired[CACertificateStatusType], # (1)
newAutoRegistrationStatus: NotRequired[AutoRegistrationStatusType], # (2)
registrationConfig: NotRequired[RegistrationConfigTypeDef], # (3)
removeAutoRegistration: NotRequired[bool],DescribeDomainConfigurationResponseTypeDef#
# DescribeDomainConfigurationResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeDomainConfigurationResponseTypeDef
def get_value() -> DescribeDomainConfigurationResponseTypeDef:
return {
"domainConfigurationName": ...,
}
# DescribeDomainConfigurationResponseTypeDef definition
class DescribeDomainConfigurationResponseTypeDef(TypedDict):
domainConfigurationName: str,
domainConfigurationArn: str,
domainName: str,
serverCertificates: List[ServerCertificateSummaryTypeDef], # (1)
authorizerConfig: AuthorizerConfigTypeDef, # (2)
domainConfigurationStatus: DomainConfigurationStatusType, # (3)
serviceType: ServiceTypeType, # (4)
domainType: DomainTypeType, # (5)
lastStatusChangeDate: datetime,
tlsConfig: TlsConfigTypeDef, # (6)
serverCertificateConfig: ServerCertificateConfigTypeDef, # (7)
authenticationType: AuthenticationTypeType, # (8)
applicationProtocol: ApplicationProtocolType, # (9)
clientCertificateConfig: ClientCertificateConfigTypeDef, # (10)
ResponseMetadata: ResponseMetadataTypeDef, # (11)- See ServerCertificateSummaryTypeDef
- See AuthorizerConfigTypeDef
- See DomainConfigurationStatusType
- See ServiceTypeType
- See DomainTypeType
- See TlsConfigTypeDef
- See ServerCertificateConfigTypeDef
- See AuthenticationTypeType
- See ApplicationProtocolType
- See ClientCertificateConfigTypeDef
- See ResponseMetadataTypeDef
DescribeManagedJobTemplateResponseTypeDef#
# DescribeManagedJobTemplateResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeManagedJobTemplateResponseTypeDef
def get_value() -> DescribeManagedJobTemplateResponseTypeDef:
return {
"templateName": ...,
}
# DescribeManagedJobTemplateResponseTypeDef definition
class DescribeManagedJobTemplateResponseTypeDef(TypedDict):
templateName: str,
templateArn: str,
description: str,
templateVersion: str,
environments: List[str],
documentParameters: List[DocumentParameterTypeDef], # (1)
document: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)DescribeRoleAliasResponseTypeDef#
# DescribeRoleAliasResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeRoleAliasResponseTypeDef
def get_value() -> DescribeRoleAliasResponseTypeDef:
return {
"roleAliasDescription": ...,
}
# DescribeRoleAliasResponseTypeDef definition
class DescribeRoleAliasResponseTypeDef(TypedDict):
roleAliasDescription: RoleAliasDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)DestinationTypeDef#
# DestinationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DestinationTypeDef
def get_value() -> DestinationTypeDef:
return {
"s3Destination": ...,
}
# DestinationTypeDef definition
class DestinationTypeDef(TypedDict):
s3Destination: NotRequired[S3DestinationTypeDef], # (1)ListDetectMitigationActionsExecutionsResponseTypeDef#
# ListDetectMitigationActionsExecutionsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListDetectMitigationActionsExecutionsResponseTypeDef
def get_value() -> ListDetectMitigationActionsExecutionsResponseTypeDef:
return {
"actionsExecutions": ...,
}
# ListDetectMitigationActionsExecutionsResponseTypeDef definition
class ListDetectMitigationActionsExecutionsResponseTypeDef(TypedDict):
actionsExecutions: List[DetectMitigationActionExecutionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListDomainConfigurationsResponseTypeDef#
# ListDomainConfigurationsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListDomainConfigurationsResponseTypeDef
def get_value() -> ListDomainConfigurationsResponseTypeDef:
return {
"domainConfigurations": ...,
}
# ListDomainConfigurationsResponseTypeDef definition
class ListDomainConfigurationsResponseTypeDef(TypedDict):
domainConfigurations: List[DomainConfigurationSummaryTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)DynamoDBv2ActionTypeDef#
# DynamoDBv2ActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DynamoDBv2ActionTypeDef
def get_value() -> DynamoDBv2ActionTypeDef:
return {
"roleArn": ...,
}
# DynamoDBv2ActionTypeDef definition
class DynamoDBv2ActionTypeDef(TypedDict):
roleArn: str,
putItem: PutItemInputTypeDef, # (1)GetEffectivePoliciesResponseTypeDef#
# GetEffectivePoliciesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetEffectivePoliciesResponseTypeDef
def get_value() -> GetEffectivePoliciesResponseTypeDef:
return {
"effectivePolicies": ...,
}
# GetEffectivePoliciesResponseTypeDef definition
class GetEffectivePoliciesResponseTypeDef(TypedDict):
effectivePolicies: List[EffectivePolicyTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ExponentialRolloutRateTypeDef#
# ExponentialRolloutRateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ExponentialRolloutRateTypeDef
def get_value() -> ExponentialRolloutRateTypeDef:
return {
"baseRatePerMinute": ...,
}
# ExponentialRolloutRateTypeDef definition
class ExponentialRolloutRateTypeDef(TypedDict):
baseRatePerMinute: int,
incrementFactor: float,
rateIncreaseCriteria: RateIncreaseCriteriaTypeDef, # (1)ThingGroupIndexingConfigurationOutputTypeDef#
# ThingGroupIndexingConfigurationOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingGroupIndexingConfigurationOutputTypeDef
def get_value() -> ThingGroupIndexingConfigurationOutputTypeDef:
return {
"thingGroupIndexingMode": ...,
}
# ThingGroupIndexingConfigurationOutputTypeDef definition
class ThingGroupIndexingConfigurationOutputTypeDef(TypedDict):
thingGroupIndexingMode: ThingGroupIndexingModeType, # (1)
managedFields: NotRequired[List[FieldTypeDef]], # (2)
customFields: NotRequired[List[FieldTypeDef]], # (2)- See ThingGroupIndexingModeType
- See FieldTypeDef
- See FieldTypeDef
ThingGroupIndexingConfigurationTypeDef#
# ThingGroupIndexingConfigurationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingGroupIndexingConfigurationTypeDef
def get_value() -> ThingGroupIndexingConfigurationTypeDef:
return {
"thingGroupIndexingMode": ...,
}
# ThingGroupIndexingConfigurationTypeDef definition
class ThingGroupIndexingConfigurationTypeDef(TypedDict):
thingGroupIndexingMode: ThingGroupIndexingModeType, # (1)
managedFields: NotRequired[Sequence[FieldTypeDef]], # (2)
customFields: NotRequired[Sequence[FieldTypeDef]], # (2)- See ThingGroupIndexingModeType
- See FieldTypeDef
- See FieldTypeDef
PackageVersionArtifactTypeDef#
# PackageVersionArtifactTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PackageVersionArtifactTypeDef
def get_value() -> PackageVersionArtifactTypeDef:
return {
"s3Location": ...,
}
# PackageVersionArtifactTypeDef definition
class PackageVersionArtifactTypeDef(TypedDict):
s3Location: NotRequired[S3LocationTypeDef], # (1)SbomTypeDef#
# SbomTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SbomTypeDef
def get_value() -> SbomTypeDef:
return {
"s3Location": ...,
}
# SbomTypeDef definition
class SbomTypeDef(TypedDict):
s3Location: NotRequired[S3LocationTypeDef], # (1)StreamFileTypeDef#
# StreamFileTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StreamFileTypeDef
def get_value() -> StreamFileTypeDef:
return {
"fileId": ...,
}
# StreamFileTypeDef definition
class StreamFileTypeDef(TypedDict):
fileId: NotRequired[int],
s3Location: NotRequired[S3LocationTypeDef], # (1)FileLocationTypeDef#
# FileLocationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import FileLocationTypeDef
def get_value() -> FileLocationTypeDef:
return {
"stream": ...,
}
# FileLocationTypeDef definition
class FileLocationTypeDef(TypedDict):
stream: NotRequired[StreamTypeDef], # (1)
s3Location: NotRequired[S3LocationTypeDef], # (2)- See StreamTypeDef
- See S3LocationTypeDef
ListFleetMetricsResponseTypeDef#
# ListFleetMetricsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListFleetMetricsResponseTypeDef
def get_value() -> ListFleetMetricsResponseTypeDef:
return {
"fleetMetrics": ...,
}
# ListFleetMetricsResponseTypeDef definition
class ListFleetMetricsResponseTypeDef(TypedDict):
fleetMetrics: List[FleetMetricNameAndArnTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],IndexingFilterOutputTypeDef#
# IndexingFilterOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import IndexingFilterOutputTypeDef
def get_value() -> IndexingFilterOutputTypeDef:
return {
"namedShadowNames": ...,
}
# IndexingFilterOutputTypeDef definition
class IndexingFilterOutputTypeDef(TypedDict):
namedShadowNames: NotRequired[List[str]],
geoLocations: NotRequired[List[GeoLocationTargetTypeDef]], # (1)IndexingFilterTypeDef#
# IndexingFilterTypeDef TypedDict usage example
from types_boto3_iot.type_defs import IndexingFilterTypeDef
def get_value() -> IndexingFilterTypeDef:
return {
"namedShadowNames": ...,
}
# IndexingFilterTypeDef definition
class IndexingFilterTypeDef(TypedDict):
namedShadowNames: NotRequired[Sequence[str]],
geoLocations: NotRequired[Sequence[GeoLocationTargetTypeDef]], # (1)GetBehaviorModelTrainingSummariesRequestPaginateTypeDef#
# GetBehaviorModelTrainingSummariesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetBehaviorModelTrainingSummariesRequestPaginateTypeDef
def get_value() -> GetBehaviorModelTrainingSummariesRequestPaginateTypeDef:
return {
"securityProfileName": ...,
}
# GetBehaviorModelTrainingSummariesRequestPaginateTypeDef definition
class GetBehaviorModelTrainingSummariesRequestPaginateTypeDef(TypedDict):
securityProfileName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListActiveViolationsRequestPaginateTypeDef#
# ListActiveViolationsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListActiveViolationsRequestPaginateTypeDef
def get_value() -> ListActiveViolationsRequestPaginateTypeDef:
return {
"thingName": ...,
}
# ListActiveViolationsRequestPaginateTypeDef definition
class ListActiveViolationsRequestPaginateTypeDef(TypedDict):
thingName: NotRequired[str],
securityProfileName: NotRequired[str],
behaviorCriteriaType: NotRequired[BehaviorCriteriaTypeType], # (1)
listSuppressedAlerts: NotRequired[bool],
verificationState: NotRequired[VerificationStateType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)ListAttachedPoliciesRequestPaginateTypeDef#
# ListAttachedPoliciesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAttachedPoliciesRequestPaginateTypeDef
def get_value() -> ListAttachedPoliciesRequestPaginateTypeDef:
return {
"target": ...,
}
# ListAttachedPoliciesRequestPaginateTypeDef definition
class ListAttachedPoliciesRequestPaginateTypeDef(TypedDict):
target: str,
recursive: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListAuditMitigationActionsExecutionsRequestPaginateTypeDef#
# ListAuditMitigationActionsExecutionsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuditMitigationActionsExecutionsRequestPaginateTypeDef
def get_value() -> ListAuditMitigationActionsExecutionsRequestPaginateTypeDef:
return {
"taskId": ...,
}
# ListAuditMitigationActionsExecutionsRequestPaginateTypeDef definition
class ListAuditMitigationActionsExecutionsRequestPaginateTypeDef(TypedDict):
taskId: str,
findingId: str,
actionStatus: NotRequired[AuditMitigationActionsExecutionStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListAuditMitigationActionsTasksRequestPaginateTypeDef#
# ListAuditMitigationActionsTasksRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuditMitigationActionsTasksRequestPaginateTypeDef
def get_value() -> ListAuditMitigationActionsTasksRequestPaginateTypeDef:
return {
"startTime": ...,
}
# ListAuditMitigationActionsTasksRequestPaginateTypeDef definition
class ListAuditMitigationActionsTasksRequestPaginateTypeDef(TypedDict):
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,
auditTaskId: NotRequired[str],
findingId: NotRequired[str],
taskStatus: NotRequired[AuditMitigationActionsTaskStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListAuditTasksRequestPaginateTypeDef#
# ListAuditTasksRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuditTasksRequestPaginateTypeDef
def get_value() -> ListAuditTasksRequestPaginateTypeDef:
return {
"startTime": ...,
}
# ListAuditTasksRequestPaginateTypeDef definition
class ListAuditTasksRequestPaginateTypeDef(TypedDict):
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,
taskType: NotRequired[AuditTaskTypeType], # (1)
taskStatus: NotRequired[AuditTaskStatusType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)ListAuthorizersRequestPaginateTypeDef#
# ListAuthorizersRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuthorizersRequestPaginateTypeDef
def get_value() -> ListAuthorizersRequestPaginateTypeDef:
return {
"ascendingOrder": ...,
}
# ListAuthorizersRequestPaginateTypeDef definition
class ListAuthorizersRequestPaginateTypeDef(TypedDict):
ascendingOrder: NotRequired[bool],
status: NotRequired[AuthorizerStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListBillingGroupsRequestPaginateTypeDef#
# ListBillingGroupsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListBillingGroupsRequestPaginateTypeDef
def get_value() -> ListBillingGroupsRequestPaginateTypeDef:
return {
"namePrefixFilter": ...,
}
# ListBillingGroupsRequestPaginateTypeDef definition
class ListBillingGroupsRequestPaginateTypeDef(TypedDict):
namePrefixFilter: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListCACertificatesRequestPaginateTypeDef#
# ListCACertificatesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCACertificatesRequestPaginateTypeDef
def get_value() -> ListCACertificatesRequestPaginateTypeDef:
return {
"ascendingOrder": ...,
}
# ListCACertificatesRequestPaginateTypeDef definition
class ListCACertificatesRequestPaginateTypeDef(TypedDict):
ascendingOrder: NotRequired[bool],
templateName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListCertificatesByCARequestPaginateTypeDef#
# ListCertificatesByCARequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCertificatesByCARequestPaginateTypeDef
def get_value() -> ListCertificatesByCARequestPaginateTypeDef:
return {
"caCertificateId": ...,
}
# ListCertificatesByCARequestPaginateTypeDef definition
class ListCertificatesByCARequestPaginateTypeDef(TypedDict):
caCertificateId: str,
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListCertificatesRequestPaginateTypeDef#
# ListCertificatesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCertificatesRequestPaginateTypeDef
def get_value() -> ListCertificatesRequestPaginateTypeDef:
return {
"ascendingOrder": ...,
}
# ListCertificatesRequestPaginateTypeDef definition
class ListCertificatesRequestPaginateTypeDef(TypedDict):
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListCommandsRequestPaginateTypeDef#
# ListCommandsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCommandsRequestPaginateTypeDef
def get_value() -> ListCommandsRequestPaginateTypeDef:
return {
"namespace": ...,
}
# ListCommandsRequestPaginateTypeDef definition
class ListCommandsRequestPaginateTypeDef(TypedDict):
namespace: NotRequired[CommandNamespaceType], # (1)
commandParameterName: NotRequired[str],
sortOrder: NotRequired[SortOrderType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See CommandNamespaceType
- See SortOrderType
- See PaginatorConfigTypeDef
ListCustomMetricsRequestPaginateTypeDef#
# ListCustomMetricsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCustomMetricsRequestPaginateTypeDef
def get_value() -> ListCustomMetricsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListCustomMetricsRequestPaginateTypeDef definition
class ListCustomMetricsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListDetectMitigationActionsExecutionsRequestPaginateTypeDef#
# ListDetectMitigationActionsExecutionsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListDetectMitigationActionsExecutionsRequestPaginateTypeDef
def get_value() -> ListDetectMitigationActionsExecutionsRequestPaginateTypeDef:
return {
"taskId": ...,
}
# ListDetectMitigationActionsExecutionsRequestPaginateTypeDef definition
class ListDetectMitigationActionsExecutionsRequestPaginateTypeDef(TypedDict):
taskId: NotRequired[str],
violationId: NotRequired[str],
thingName: NotRequired[str],
startTime: NotRequired[TimestampTypeDef],
endTime: NotRequired[TimestampTypeDef],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListDetectMitigationActionsTasksRequestPaginateTypeDef#
# ListDetectMitigationActionsTasksRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListDetectMitigationActionsTasksRequestPaginateTypeDef
def get_value() -> ListDetectMitigationActionsTasksRequestPaginateTypeDef:
return {
"startTime": ...,
}
# ListDetectMitigationActionsTasksRequestPaginateTypeDef definition
class ListDetectMitigationActionsTasksRequestPaginateTypeDef(TypedDict):
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListDimensionsRequestPaginateTypeDef#
# ListDimensionsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListDimensionsRequestPaginateTypeDef
def get_value() -> ListDimensionsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListDimensionsRequestPaginateTypeDef definition
class ListDimensionsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListDomainConfigurationsRequestPaginateTypeDef#
# ListDomainConfigurationsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListDomainConfigurationsRequestPaginateTypeDef
def get_value() -> ListDomainConfigurationsRequestPaginateTypeDef:
return {
"serviceType": ...,
}
# ListDomainConfigurationsRequestPaginateTypeDef definition
class ListDomainConfigurationsRequestPaginateTypeDef(TypedDict):
serviceType: NotRequired[ServiceTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListFleetMetricsRequestPaginateTypeDef#
# ListFleetMetricsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListFleetMetricsRequestPaginateTypeDef
def get_value() -> ListFleetMetricsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListFleetMetricsRequestPaginateTypeDef definition
class ListFleetMetricsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListIndicesRequestPaginateTypeDef#
# ListIndicesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListIndicesRequestPaginateTypeDef
def get_value() -> ListIndicesRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListIndicesRequestPaginateTypeDef definition
class ListIndicesRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListJobExecutionsForJobRequestPaginateTypeDef#
# ListJobExecutionsForJobRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListJobExecutionsForJobRequestPaginateTypeDef
def get_value() -> ListJobExecutionsForJobRequestPaginateTypeDef:
return {
"jobId": ...,
}
# ListJobExecutionsForJobRequestPaginateTypeDef definition
class ListJobExecutionsForJobRequestPaginateTypeDef(TypedDict):
jobId: str,
status: NotRequired[JobExecutionStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListJobExecutionsForThingRequestPaginateTypeDef#
# ListJobExecutionsForThingRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListJobExecutionsForThingRequestPaginateTypeDef
def get_value() -> ListJobExecutionsForThingRequestPaginateTypeDef:
return {
"thingName": ...,
}
# ListJobExecutionsForThingRequestPaginateTypeDef definition
class ListJobExecutionsForThingRequestPaginateTypeDef(TypedDict):
thingName: str,
status: NotRequired[JobExecutionStatusType], # (1)
namespaceId: NotRequired[str],
jobId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListJobTemplatesRequestPaginateTypeDef#
# ListJobTemplatesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListJobTemplatesRequestPaginateTypeDef
def get_value() -> ListJobTemplatesRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListJobTemplatesRequestPaginateTypeDef definition
class ListJobTemplatesRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListJobsRequestPaginateTypeDef#
# ListJobsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListJobsRequestPaginateTypeDef
def get_value() -> ListJobsRequestPaginateTypeDef:
return {
"status": ...,
}
# ListJobsRequestPaginateTypeDef definition
class ListJobsRequestPaginateTypeDef(TypedDict):
status: NotRequired[JobStatusType], # (1)
targetSelection: NotRequired[TargetSelectionType], # (2)
thingGroupName: NotRequired[str],
thingGroupId: NotRequired[str],
namespaceId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)- See JobStatusType
- See TargetSelectionType
- See PaginatorConfigTypeDef
ListManagedJobTemplatesRequestPaginateTypeDef#
# ListManagedJobTemplatesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListManagedJobTemplatesRequestPaginateTypeDef
def get_value() -> ListManagedJobTemplatesRequestPaginateTypeDef:
return {
"templateName": ...,
}
# ListManagedJobTemplatesRequestPaginateTypeDef definition
class ListManagedJobTemplatesRequestPaginateTypeDef(TypedDict):
templateName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListMetricValuesRequestPaginateTypeDef#
# ListMetricValuesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListMetricValuesRequestPaginateTypeDef
def get_value() -> ListMetricValuesRequestPaginateTypeDef:
return {
"thingName": ...,
}
# ListMetricValuesRequestPaginateTypeDef definition
class ListMetricValuesRequestPaginateTypeDef(TypedDict):
thingName: str,
metricName: str,
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,
dimensionName: NotRequired[str],
dimensionValueOperator: NotRequired[DimensionValueOperatorType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListMitigationActionsRequestPaginateTypeDef#
# ListMitigationActionsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListMitigationActionsRequestPaginateTypeDef
def get_value() -> ListMitigationActionsRequestPaginateTypeDef:
return {
"actionType": ...,
}
# ListMitigationActionsRequestPaginateTypeDef definition
class ListMitigationActionsRequestPaginateTypeDef(TypedDict):
actionType: NotRequired[MitigationActionTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListOTAUpdatesRequestPaginateTypeDef#
# ListOTAUpdatesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListOTAUpdatesRequestPaginateTypeDef
def get_value() -> ListOTAUpdatesRequestPaginateTypeDef:
return {
"otaUpdateStatus": ...,
}
# ListOTAUpdatesRequestPaginateTypeDef definition
class ListOTAUpdatesRequestPaginateTypeDef(TypedDict):
otaUpdateStatus: NotRequired[OTAUpdateStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListOutgoingCertificatesRequestPaginateTypeDef#
# ListOutgoingCertificatesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListOutgoingCertificatesRequestPaginateTypeDef
def get_value() -> ListOutgoingCertificatesRequestPaginateTypeDef:
return {
"ascendingOrder": ...,
}
# ListOutgoingCertificatesRequestPaginateTypeDef definition
class ListOutgoingCertificatesRequestPaginateTypeDef(TypedDict):
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListPackageVersionsRequestPaginateTypeDef#
# ListPackageVersionsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPackageVersionsRequestPaginateTypeDef
def get_value() -> ListPackageVersionsRequestPaginateTypeDef:
return {
"packageName": ...,
}
# ListPackageVersionsRequestPaginateTypeDef definition
class ListPackageVersionsRequestPaginateTypeDef(TypedDict):
packageName: str,
status: NotRequired[PackageVersionStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListPackagesRequestPaginateTypeDef#
# ListPackagesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPackagesRequestPaginateTypeDef
def get_value() -> ListPackagesRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListPackagesRequestPaginateTypeDef definition
class ListPackagesRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListPoliciesRequestPaginateTypeDef#
# ListPoliciesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPoliciesRequestPaginateTypeDef
def get_value() -> ListPoliciesRequestPaginateTypeDef:
return {
"ascendingOrder": ...,
}
# ListPoliciesRequestPaginateTypeDef definition
class ListPoliciesRequestPaginateTypeDef(TypedDict):
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListPolicyPrincipalsRequestPaginateTypeDef#
# ListPolicyPrincipalsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPolicyPrincipalsRequestPaginateTypeDef
def get_value() -> ListPolicyPrincipalsRequestPaginateTypeDef:
return {
"policyName": ...,
}
# ListPolicyPrincipalsRequestPaginateTypeDef definition
class ListPolicyPrincipalsRequestPaginateTypeDef(TypedDict):
policyName: str,
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListPrincipalPoliciesRequestPaginateTypeDef#
# ListPrincipalPoliciesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPrincipalPoliciesRequestPaginateTypeDef
def get_value() -> ListPrincipalPoliciesRequestPaginateTypeDef:
return {
"principal": ...,
}
# ListPrincipalPoliciesRequestPaginateTypeDef definition
class ListPrincipalPoliciesRequestPaginateTypeDef(TypedDict):
principal: str,
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListPrincipalThingsRequestPaginateTypeDef#
# ListPrincipalThingsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPrincipalThingsRequestPaginateTypeDef
def get_value() -> ListPrincipalThingsRequestPaginateTypeDef:
return {
"principal": ...,
}
# ListPrincipalThingsRequestPaginateTypeDef definition
class ListPrincipalThingsRequestPaginateTypeDef(TypedDict):
principal: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListPrincipalThingsV2RequestPaginateTypeDef#
# ListPrincipalThingsV2RequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPrincipalThingsV2RequestPaginateTypeDef
def get_value() -> ListPrincipalThingsV2RequestPaginateTypeDef:
return {
"principal": ...,
}
# ListPrincipalThingsV2RequestPaginateTypeDef definition
class ListPrincipalThingsV2RequestPaginateTypeDef(TypedDict):
principal: str,
thingPrincipalType: NotRequired[ThingPrincipalTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListProvisioningTemplateVersionsRequestPaginateTypeDef#
# ListProvisioningTemplateVersionsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListProvisioningTemplateVersionsRequestPaginateTypeDef
def get_value() -> ListProvisioningTemplateVersionsRequestPaginateTypeDef:
return {
"templateName": ...,
}
# ListProvisioningTemplateVersionsRequestPaginateTypeDef definition
class ListProvisioningTemplateVersionsRequestPaginateTypeDef(TypedDict):
templateName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListProvisioningTemplatesRequestPaginateTypeDef#
# ListProvisioningTemplatesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListProvisioningTemplatesRequestPaginateTypeDef
def get_value() -> ListProvisioningTemplatesRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListProvisioningTemplatesRequestPaginateTypeDef definition
class ListProvisioningTemplatesRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListRelatedResourcesForAuditFindingRequestPaginateTypeDef#
# ListRelatedResourcesForAuditFindingRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListRelatedResourcesForAuditFindingRequestPaginateTypeDef
def get_value() -> ListRelatedResourcesForAuditFindingRequestPaginateTypeDef:
return {
"findingId": ...,
}
# ListRelatedResourcesForAuditFindingRequestPaginateTypeDef definition
class ListRelatedResourcesForAuditFindingRequestPaginateTypeDef(TypedDict):
findingId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListRoleAliasesRequestPaginateTypeDef#
# ListRoleAliasesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListRoleAliasesRequestPaginateTypeDef
def get_value() -> ListRoleAliasesRequestPaginateTypeDef:
return {
"ascendingOrder": ...,
}
# ListRoleAliasesRequestPaginateTypeDef definition
class ListRoleAliasesRequestPaginateTypeDef(TypedDict):
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListSbomValidationResultsRequestPaginateTypeDef#
# ListSbomValidationResultsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListSbomValidationResultsRequestPaginateTypeDef
def get_value() -> ListSbomValidationResultsRequestPaginateTypeDef:
return {
"packageName": ...,
}
# ListSbomValidationResultsRequestPaginateTypeDef definition
class ListSbomValidationResultsRequestPaginateTypeDef(TypedDict):
packageName: str,
versionName: str,
validationResult: NotRequired[SbomValidationResultType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListScheduledAuditsRequestPaginateTypeDef#
# ListScheduledAuditsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListScheduledAuditsRequestPaginateTypeDef
def get_value() -> ListScheduledAuditsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListScheduledAuditsRequestPaginateTypeDef definition
class ListScheduledAuditsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListSecurityProfilesForTargetRequestPaginateTypeDef#
# ListSecurityProfilesForTargetRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListSecurityProfilesForTargetRequestPaginateTypeDef
def get_value() -> ListSecurityProfilesForTargetRequestPaginateTypeDef:
return {
"securityProfileTargetArn": ...,
}
# ListSecurityProfilesForTargetRequestPaginateTypeDef definition
class ListSecurityProfilesForTargetRequestPaginateTypeDef(TypedDict):
securityProfileTargetArn: str,
recursive: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListSecurityProfilesRequestPaginateTypeDef#
# ListSecurityProfilesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListSecurityProfilesRequestPaginateTypeDef
def get_value() -> ListSecurityProfilesRequestPaginateTypeDef:
return {
"dimensionName": ...,
}
# ListSecurityProfilesRequestPaginateTypeDef definition
class ListSecurityProfilesRequestPaginateTypeDef(TypedDict):
dimensionName: NotRequired[str],
metricName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListStreamsRequestPaginateTypeDef#
# ListStreamsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListStreamsRequestPaginateTypeDef
def get_value() -> ListStreamsRequestPaginateTypeDef:
return {
"ascendingOrder": ...,
}
# ListStreamsRequestPaginateTypeDef definition
class ListStreamsRequestPaginateTypeDef(TypedDict):
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListTagsForResourceRequestPaginateTypeDef#
# ListTagsForResourceRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListTagsForResourceRequestPaginateTypeDef
def get_value() -> ListTagsForResourceRequestPaginateTypeDef:
return {
"resourceArn": ...,
}
# ListTagsForResourceRequestPaginateTypeDef definition
class ListTagsForResourceRequestPaginateTypeDef(TypedDict):
resourceArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListTargetsForPolicyRequestPaginateTypeDef#
# ListTargetsForPolicyRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListTargetsForPolicyRequestPaginateTypeDef
def get_value() -> ListTargetsForPolicyRequestPaginateTypeDef:
return {
"policyName": ...,
}
# ListTargetsForPolicyRequestPaginateTypeDef definition
class ListTargetsForPolicyRequestPaginateTypeDef(TypedDict):
policyName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListTargetsForSecurityProfileRequestPaginateTypeDef#
# ListTargetsForSecurityProfileRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListTargetsForSecurityProfileRequestPaginateTypeDef
def get_value() -> ListTargetsForSecurityProfileRequestPaginateTypeDef:
return {
"securityProfileName": ...,
}
# ListTargetsForSecurityProfileRequestPaginateTypeDef definition
class ListTargetsForSecurityProfileRequestPaginateTypeDef(TypedDict):
securityProfileName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListThingGroupsForThingRequestPaginateTypeDef#
# ListThingGroupsForThingRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingGroupsForThingRequestPaginateTypeDef
def get_value() -> ListThingGroupsForThingRequestPaginateTypeDef:
return {
"thingName": ...,
}
# ListThingGroupsForThingRequestPaginateTypeDef definition
class ListThingGroupsForThingRequestPaginateTypeDef(TypedDict):
thingName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListThingGroupsRequestPaginateTypeDef#
# ListThingGroupsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingGroupsRequestPaginateTypeDef
def get_value() -> ListThingGroupsRequestPaginateTypeDef:
return {
"parentGroup": ...,
}
# ListThingGroupsRequestPaginateTypeDef definition
class ListThingGroupsRequestPaginateTypeDef(TypedDict):
parentGroup: NotRequired[str],
namePrefixFilter: NotRequired[str],
recursive: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListThingPrincipalsRequestPaginateTypeDef#
# ListThingPrincipalsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingPrincipalsRequestPaginateTypeDef
def get_value() -> ListThingPrincipalsRequestPaginateTypeDef:
return {
"thingName": ...,
}
# ListThingPrincipalsRequestPaginateTypeDef definition
class ListThingPrincipalsRequestPaginateTypeDef(TypedDict):
thingName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListThingPrincipalsV2RequestPaginateTypeDef#
# ListThingPrincipalsV2RequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingPrincipalsV2RequestPaginateTypeDef
def get_value() -> ListThingPrincipalsV2RequestPaginateTypeDef:
return {
"thingName": ...,
}
# ListThingPrincipalsV2RequestPaginateTypeDef definition
class ListThingPrincipalsV2RequestPaginateTypeDef(TypedDict):
thingName: str,
thingPrincipalType: NotRequired[ThingPrincipalTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListThingRegistrationTaskReportsRequestPaginateTypeDef#
# ListThingRegistrationTaskReportsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingRegistrationTaskReportsRequestPaginateTypeDef
def get_value() -> ListThingRegistrationTaskReportsRequestPaginateTypeDef:
return {
"taskId": ...,
}
# ListThingRegistrationTaskReportsRequestPaginateTypeDef definition
class ListThingRegistrationTaskReportsRequestPaginateTypeDef(TypedDict):
taskId: str,
reportType: ReportTypeType, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)- See ReportTypeType
- See PaginatorConfigTypeDef
ListThingRegistrationTasksRequestPaginateTypeDef#
# ListThingRegistrationTasksRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingRegistrationTasksRequestPaginateTypeDef
def get_value() -> ListThingRegistrationTasksRequestPaginateTypeDef:
return {
"status": ...,
}
# ListThingRegistrationTasksRequestPaginateTypeDef definition
class ListThingRegistrationTasksRequestPaginateTypeDef(TypedDict):
status: NotRequired[StatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)- See StatusType
- See PaginatorConfigTypeDef
ListThingTypesRequestPaginateTypeDef#
# ListThingTypesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingTypesRequestPaginateTypeDef
def get_value() -> ListThingTypesRequestPaginateTypeDef:
return {
"thingTypeName": ...,
}
# ListThingTypesRequestPaginateTypeDef definition
class ListThingTypesRequestPaginateTypeDef(TypedDict):
thingTypeName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListThingsInBillingGroupRequestPaginateTypeDef#
# ListThingsInBillingGroupRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingsInBillingGroupRequestPaginateTypeDef
def get_value() -> ListThingsInBillingGroupRequestPaginateTypeDef:
return {
"billingGroupName": ...,
}
# ListThingsInBillingGroupRequestPaginateTypeDef definition
class ListThingsInBillingGroupRequestPaginateTypeDef(TypedDict):
billingGroupName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListThingsInThingGroupRequestPaginateTypeDef#
# ListThingsInThingGroupRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingsInThingGroupRequestPaginateTypeDef
def get_value() -> ListThingsInThingGroupRequestPaginateTypeDef:
return {
"thingGroupName": ...,
}
# ListThingsInThingGroupRequestPaginateTypeDef definition
class ListThingsInThingGroupRequestPaginateTypeDef(TypedDict):
thingGroupName: str,
recursive: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListThingsRequestPaginateTypeDef#
# ListThingsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingsRequestPaginateTypeDef
def get_value() -> ListThingsRequestPaginateTypeDef:
return {
"attributeName": ...,
}
# ListThingsRequestPaginateTypeDef definition
class ListThingsRequestPaginateTypeDef(TypedDict):
attributeName: NotRequired[str],
attributeValue: NotRequired[str],
thingTypeName: NotRequired[str],
usePrefixAttributeValue: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListTopicRuleDestinationsRequestPaginateTypeDef#
# ListTopicRuleDestinationsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListTopicRuleDestinationsRequestPaginateTypeDef
def get_value() -> ListTopicRuleDestinationsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListTopicRuleDestinationsRequestPaginateTypeDef definition
class ListTopicRuleDestinationsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListTopicRulesRequestPaginateTypeDef#
# ListTopicRulesRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListTopicRulesRequestPaginateTypeDef
def get_value() -> ListTopicRulesRequestPaginateTypeDef:
return {
"topic": ...,
}
# ListTopicRulesRequestPaginateTypeDef definition
class ListTopicRulesRequestPaginateTypeDef(TypedDict):
topic: NotRequired[str],
ruleDisabled: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListV2LoggingLevelsRequestPaginateTypeDef#
# ListV2LoggingLevelsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListV2LoggingLevelsRequestPaginateTypeDef
def get_value() -> ListV2LoggingLevelsRequestPaginateTypeDef:
return {
"targetType": ...,
}
# ListV2LoggingLevelsRequestPaginateTypeDef definition
class ListV2LoggingLevelsRequestPaginateTypeDef(TypedDict):
targetType: NotRequired[LogTargetTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListViolationEventsRequestPaginateTypeDef#
# ListViolationEventsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListViolationEventsRequestPaginateTypeDef
def get_value() -> ListViolationEventsRequestPaginateTypeDef:
return {
"startTime": ...,
}
# ListViolationEventsRequestPaginateTypeDef definition
class ListViolationEventsRequestPaginateTypeDef(TypedDict):
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,
thingName: NotRequired[str],
securityProfileName: NotRequired[str],
behaviorCriteriaType: NotRequired[BehaviorCriteriaTypeType], # (1)
listSuppressedAlerts: NotRequired[bool],
verificationState: NotRequired[VerificationStateType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)GetCommandExecutionResponseTypeDef#
# GetCommandExecutionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetCommandExecutionResponseTypeDef
def get_value() -> GetCommandExecutionResponseTypeDef:
return {
"executionId": ...,
}
# GetCommandExecutionResponseTypeDef definition
class GetCommandExecutionResponseTypeDef(TypedDict):
executionId: str,
commandArn: str,
targetArn: str,
status: CommandExecutionStatusType, # (1)
statusReason: StatusReasonTypeDef, # (2)
result: Dict[str, CommandExecutionResultTypeDef], # (3)
parameters: Dict[str, CommandParameterValueOutputTypeDef], # (4)
executionTimeoutSeconds: int,
createdAt: datetime,
lastUpdatedAt: datetime,
startedAt: datetime,
completedAt: datetime,
timeToLive: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See CommandExecutionStatusType
- See StatusReasonTypeDef
- See CommandExecutionResultTypeDef
- See CommandParameterValueOutputTypeDef
- See ResponseMetadataTypeDef
GetPackageConfigurationResponseTypeDef#
# GetPackageConfigurationResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetPackageConfigurationResponseTypeDef
def get_value() -> GetPackageConfigurationResponseTypeDef:
return {
"versionUpdateByJobsConfig": ...,
}
# GetPackageConfigurationResponseTypeDef definition
class GetPackageConfigurationResponseTypeDef(TypedDict):
versionUpdateByJobsConfig: VersionUpdateByJobsConfigTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdatePackageConfigurationRequestTypeDef#
# UpdatePackageConfigurationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdatePackageConfigurationRequestTypeDef
def get_value() -> UpdatePackageConfigurationRequestTypeDef:
return {
"versionUpdateByJobsConfig": ...,
}
# UpdatePackageConfigurationRequestTypeDef definition
class UpdatePackageConfigurationRequestTypeDef(TypedDict):
versionUpdateByJobsConfig: NotRequired[VersionUpdateByJobsConfigTypeDef], # (1)
clientToken: NotRequired[str],GetPercentilesResponseTypeDef#
# GetPercentilesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetPercentilesResponseTypeDef
def get_value() -> GetPercentilesResponseTypeDef:
return {
"percentiles": ...,
}
# GetPercentilesResponseTypeDef definition
class GetPercentilesResponseTypeDef(TypedDict):
percentiles: List[PercentPairTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetStatisticsResponseTypeDef#
# GetStatisticsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetStatisticsResponseTypeDef
def get_value() -> GetStatisticsResponseTypeDef:
return {
"statistics": ...,
}
# GetStatisticsResponseTypeDef definition
class GetStatisticsResponseTypeDef(TypedDict):
statistics: StatisticsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListBillingGroupsResponseTypeDef#
# ListBillingGroupsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListBillingGroupsResponseTypeDef
def get_value() -> ListBillingGroupsResponseTypeDef:
return {
"billingGroups": ...,
}
# ListBillingGroupsResponseTypeDef definition
class ListBillingGroupsResponseTypeDef(TypedDict):
billingGroups: List[GroupNameAndArnTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListThingGroupsForThingResponseTypeDef#
# ListThingGroupsForThingResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingGroupsForThingResponseTypeDef
def get_value() -> ListThingGroupsForThingResponseTypeDef:
return {
"thingGroups": ...,
}
# ListThingGroupsForThingResponseTypeDef definition
class ListThingGroupsForThingResponseTypeDef(TypedDict):
thingGroups: List[GroupNameAndArnTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListThingGroupsResponseTypeDef#
# ListThingGroupsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingGroupsResponseTypeDef
def get_value() -> ListThingGroupsResponseTypeDef:
return {
"thingGroups": ...,
}
# ListThingGroupsResponseTypeDef definition
class ListThingGroupsResponseTypeDef(TypedDict):
thingGroups: List[GroupNameAndArnTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ThingGroupMetadataTypeDef#
# ThingGroupMetadataTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingGroupMetadataTypeDef
def get_value() -> ThingGroupMetadataTypeDef:
return {
"parentGroupName": ...,
}
# ThingGroupMetadataTypeDef definition
class ThingGroupMetadataTypeDef(TypedDict):
parentGroupName: NotRequired[str],
rootToParentThingGroups: NotRequired[List[GroupNameAndArnTypeDef]], # (1)
creationDate: NotRequired[datetime],HttpAuthorizationTypeDef#
# HttpAuthorizationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import HttpAuthorizationTypeDef
def get_value() -> HttpAuthorizationTypeDef:
return {
"sigv4": ...,
}
# HttpAuthorizationTypeDef definition
class HttpAuthorizationTypeDef(TypedDict):
sigv4: NotRequired[SigV4AuthorizationTypeDef], # (1)JobExecutionTypeDef#
# JobExecutionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import JobExecutionTypeDef
def get_value() -> JobExecutionTypeDef:
return {
"jobId": ...,
}
# JobExecutionTypeDef definition
class JobExecutionTypeDef(TypedDict):
jobId: NotRequired[str],
status: NotRequired[JobExecutionStatusType], # (1)
forceCanceled: NotRequired[bool],
statusDetails: NotRequired[JobExecutionStatusDetailsTypeDef], # (2)
thingArn: NotRequired[str],
queuedAt: NotRequired[datetime],
startedAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],
executionNumber: NotRequired[int],
versionNumber: NotRequired[int],
approximateSecondsBeforeTimedOut: NotRequired[int],JobExecutionSummaryForJobTypeDef#
# JobExecutionSummaryForJobTypeDef TypedDict usage example
from types_boto3_iot.type_defs import JobExecutionSummaryForJobTypeDef
def get_value() -> JobExecutionSummaryForJobTypeDef:
return {
"thingArn": ...,
}
# JobExecutionSummaryForJobTypeDef definition
class JobExecutionSummaryForJobTypeDef(TypedDict):
thingArn: NotRequired[str],
jobExecutionSummary: NotRequired[JobExecutionSummaryTypeDef], # (1)JobExecutionSummaryForThingTypeDef#
# JobExecutionSummaryForThingTypeDef TypedDict usage example
from types_boto3_iot.type_defs import JobExecutionSummaryForThingTypeDef
def get_value() -> JobExecutionSummaryForThingTypeDef:
return {
"jobId": ...,
}
# JobExecutionSummaryForThingTypeDef definition
class JobExecutionSummaryForThingTypeDef(TypedDict):
jobId: NotRequired[str],
jobExecutionSummary: NotRequired[JobExecutionSummaryTypeDef], # (1)JobExecutionsRetryConfigOutputTypeDef#
# JobExecutionsRetryConfigOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import JobExecutionsRetryConfigOutputTypeDef
def get_value() -> JobExecutionsRetryConfigOutputTypeDef:
return {
"criteriaList": ...,
}
# JobExecutionsRetryConfigOutputTypeDef definition
class JobExecutionsRetryConfigOutputTypeDef(TypedDict):
criteriaList: List[RetryCriteriaTypeDef], # (1)JobExecutionsRetryConfigTypeDef#
# JobExecutionsRetryConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import JobExecutionsRetryConfigTypeDef
def get_value() -> JobExecutionsRetryConfigTypeDef:
return {
"criteriaList": ...,
}
# JobExecutionsRetryConfigTypeDef definition
class JobExecutionsRetryConfigTypeDef(TypedDict):
criteriaList: Sequence[RetryCriteriaTypeDef], # (1)ListJobsResponseTypeDef#
# ListJobsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListJobsResponseTypeDef
def get_value() -> ListJobsResponseTypeDef:
return {
"jobs": ...,
}
# ListJobsResponseTypeDef definition
class ListJobsResponseTypeDef(TypedDict):
jobs: List[JobSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListJobTemplatesResponseTypeDef#
# ListJobTemplatesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListJobTemplatesResponseTypeDef
def get_value() -> ListJobTemplatesResponseTypeDef:
return {
"jobTemplates": ...,
}
# ListJobTemplatesResponseTypeDef definition
class ListJobTemplatesResponseTypeDef(TypedDict):
jobTemplates: List[JobTemplateSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],KafkaActionOutputTypeDef#
# KafkaActionOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import KafkaActionOutputTypeDef
def get_value() -> KafkaActionOutputTypeDef:
return {
"destinationArn": ...,
}
# KafkaActionOutputTypeDef definition
class KafkaActionOutputTypeDef(TypedDict):
destinationArn: str,
topic: str,
clientProperties: Dict[str, str],
key: NotRequired[str],
partition: NotRequired[str],
headers: NotRequired[List[KafkaActionHeaderTypeDef]], # (1)KafkaActionTypeDef#
# KafkaActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import KafkaActionTypeDef
def get_value() -> KafkaActionTypeDef:
return {
"destinationArn": ...,
}
# KafkaActionTypeDef definition
class KafkaActionTypeDef(TypedDict):
destinationArn: str,
topic: str,
clientProperties: Mapping[str, str],
key: NotRequired[str],
partition: NotRequired[str],
headers: NotRequired[Sequence[KafkaActionHeaderTypeDef]], # (1)ListCommandExecutionsRequestPaginateTypeDef#
# ListCommandExecutionsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCommandExecutionsRequestPaginateTypeDef
def get_value() -> ListCommandExecutionsRequestPaginateTypeDef:
return {
"namespace": ...,
}
# ListCommandExecutionsRequestPaginateTypeDef definition
class ListCommandExecutionsRequestPaginateTypeDef(TypedDict):
namespace: NotRequired[CommandNamespaceType], # (1)
status: NotRequired[CommandExecutionStatusType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
startedTimeFilter: NotRequired[TimeFilterTypeDef], # (4)
completedTimeFilter: NotRequired[TimeFilterTypeDef], # (4)
targetArn: NotRequired[str],
commandArn: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (6)- See CommandNamespaceType
- See CommandExecutionStatusType
- See SortOrderType
- See TimeFilterTypeDef
- See TimeFilterTypeDef
- See PaginatorConfigTypeDef
ListCommandExecutionsRequestTypeDef#
# ListCommandExecutionsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListCommandExecutionsRequestTypeDef
def get_value() -> ListCommandExecutionsRequestTypeDef:
return {
"maxResults": ...,
}
# ListCommandExecutionsRequestTypeDef definition
class ListCommandExecutionsRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
namespace: NotRequired[CommandNamespaceType], # (1)
status: NotRequired[CommandExecutionStatusType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
startedTimeFilter: NotRequired[TimeFilterTypeDef], # (4)
completedTimeFilter: NotRequired[TimeFilterTypeDef], # (4)
targetArn: NotRequired[str],
commandArn: NotRequired[str],- See CommandNamespaceType
- See CommandExecutionStatusType
- See SortOrderType
- See TimeFilterTypeDef
- See TimeFilterTypeDef
ListManagedJobTemplatesResponseTypeDef#
# ListManagedJobTemplatesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListManagedJobTemplatesResponseTypeDef
def get_value() -> ListManagedJobTemplatesResponseTypeDef:
return {
"managedJobTemplates": ...,
}
# ListManagedJobTemplatesResponseTypeDef definition
class ListManagedJobTemplatesResponseTypeDef(TypedDict):
managedJobTemplates: List[ManagedJobTemplateSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListMitigationActionsResponseTypeDef#
# ListMitigationActionsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListMitigationActionsResponseTypeDef
def get_value() -> ListMitigationActionsResponseTypeDef:
return {
"actionIdentifiers": ...,
}
# ListMitigationActionsResponseTypeDef definition
class ListMitigationActionsResponseTypeDef(TypedDict):
actionIdentifiers: List[MitigationActionIdentifierTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListOTAUpdatesResponseTypeDef#
# ListOTAUpdatesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListOTAUpdatesResponseTypeDef
def get_value() -> ListOTAUpdatesResponseTypeDef:
return {
"otaUpdates": ...,
}
# ListOTAUpdatesResponseTypeDef definition
class ListOTAUpdatesResponseTypeDef(TypedDict):
otaUpdates: List[OTAUpdateSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListOutgoingCertificatesResponseTypeDef#
# ListOutgoingCertificatesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListOutgoingCertificatesResponseTypeDef
def get_value() -> ListOutgoingCertificatesResponseTypeDef:
return {
"outgoingCertificates": ...,
}
# ListOutgoingCertificatesResponseTypeDef definition
class ListOutgoingCertificatesResponseTypeDef(TypedDict):
outgoingCertificates: List[OutgoingCertificateTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListPackageVersionsResponseTypeDef#
# ListPackageVersionsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPackageVersionsResponseTypeDef
def get_value() -> ListPackageVersionsResponseTypeDef:
return {
"packageVersionSummaries": ...,
}
# ListPackageVersionsResponseTypeDef definition
class ListPackageVersionsResponseTypeDef(TypedDict):
packageVersionSummaries: List[PackageVersionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListPackagesResponseTypeDef#
# ListPackagesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPackagesResponseTypeDef
def get_value() -> ListPackagesResponseTypeDef:
return {
"packageSummaries": ...,
}
# ListPackagesResponseTypeDef definition
class ListPackagesResponseTypeDef(TypedDict):
packageSummaries: List[PackageSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListPolicyVersionsResponseTypeDef#
# ListPolicyVersionsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPolicyVersionsResponseTypeDef
def get_value() -> ListPolicyVersionsResponseTypeDef:
return {
"policyVersions": ...,
}
# ListPolicyVersionsResponseTypeDef definition
class ListPolicyVersionsResponseTypeDef(TypedDict):
policyVersions: List[PolicyVersionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListPrincipalThingsV2ResponseTypeDef#
# ListPrincipalThingsV2ResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListPrincipalThingsV2ResponseTypeDef
def get_value() -> ListPrincipalThingsV2ResponseTypeDef:
return {
"principalThingObjects": ...,
}
# ListPrincipalThingsV2ResponseTypeDef definition
class ListPrincipalThingsV2ResponseTypeDef(TypedDict):
principalThingObjects: List[PrincipalThingObjectTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListProvisioningTemplateVersionsResponseTypeDef#
# ListProvisioningTemplateVersionsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListProvisioningTemplateVersionsResponseTypeDef
def get_value() -> ListProvisioningTemplateVersionsResponseTypeDef:
return {
"versions": ...,
}
# ListProvisioningTemplateVersionsResponseTypeDef definition
class ListProvisioningTemplateVersionsResponseTypeDef(TypedDict):
versions: List[ProvisioningTemplateVersionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListProvisioningTemplatesResponseTypeDef#
# ListProvisioningTemplatesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListProvisioningTemplatesResponseTypeDef
def get_value() -> ListProvisioningTemplatesResponseTypeDef:
return {
"templates": ...,
}
# ListProvisioningTemplatesResponseTypeDef definition
class ListProvisioningTemplatesResponseTypeDef(TypedDict):
templates: List[ProvisioningTemplateSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListSbomValidationResultsResponseTypeDef#
# ListSbomValidationResultsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListSbomValidationResultsResponseTypeDef
def get_value() -> ListSbomValidationResultsResponseTypeDef:
return {
"validationResultSummaries": ...,
}
# ListSbomValidationResultsResponseTypeDef definition
class ListSbomValidationResultsResponseTypeDef(TypedDict):
validationResultSummaries: List[SbomValidationResultSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListScheduledAuditsResponseTypeDef#
# ListScheduledAuditsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListScheduledAuditsResponseTypeDef
def get_value() -> ListScheduledAuditsResponseTypeDef:
return {
"scheduledAudits": ...,
}
# ListScheduledAuditsResponseTypeDef definition
class ListScheduledAuditsResponseTypeDef(TypedDict):
scheduledAudits: List[ScheduledAuditMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListSecurityProfilesResponseTypeDef#
# ListSecurityProfilesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListSecurityProfilesResponseTypeDef
def get_value() -> ListSecurityProfilesResponseTypeDef:
return {
"securityProfileIdentifiers": ...,
}
# ListSecurityProfilesResponseTypeDef definition
class ListSecurityProfilesResponseTypeDef(TypedDict):
securityProfileIdentifiers: List[SecurityProfileIdentifierTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListStreamsResponseTypeDef#
# ListStreamsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListStreamsResponseTypeDef
def get_value() -> ListStreamsResponseTypeDef:
return {
"streams": ...,
}
# ListStreamsResponseTypeDef definition
class ListStreamsResponseTypeDef(TypedDict):
streams: List[StreamSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListTargetsForSecurityProfileResponseTypeDef#
# ListTargetsForSecurityProfileResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListTargetsForSecurityProfileResponseTypeDef
def get_value() -> ListTargetsForSecurityProfileResponseTypeDef:
return {
"securityProfileTargets": ...,
}
# ListTargetsForSecurityProfileResponseTypeDef definition
class ListTargetsForSecurityProfileResponseTypeDef(TypedDict):
securityProfileTargets: List[SecurityProfileTargetTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],SecurityProfileTargetMappingTypeDef#
# SecurityProfileTargetMappingTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SecurityProfileTargetMappingTypeDef
def get_value() -> SecurityProfileTargetMappingTypeDef:
return {
"securityProfileIdentifier": ...,
}
# SecurityProfileTargetMappingTypeDef definition
class SecurityProfileTargetMappingTypeDef(TypedDict):
securityProfileIdentifier: NotRequired[SecurityProfileIdentifierTypeDef], # (1)
target: NotRequired[SecurityProfileTargetTypeDef], # (2)ListThingPrincipalsV2ResponseTypeDef#
# ListThingPrincipalsV2ResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingPrincipalsV2ResponseTypeDef
def get_value() -> ListThingPrincipalsV2ResponseTypeDef:
return {
"thingPrincipalObjects": ...,
}
# ListThingPrincipalsV2ResponseTypeDef definition
class ListThingPrincipalsV2ResponseTypeDef(TypedDict):
thingPrincipalObjects: List[ThingPrincipalObjectTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListThingsResponseTypeDef#
# ListThingsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingsResponseTypeDef
def get_value() -> ListThingsResponseTypeDef:
return {
"things": ...,
}
# ListThingsResponseTypeDef definition
class ListThingsResponseTypeDef(TypedDict):
things: List[ThingAttributeTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListTopicRulesResponseTypeDef#
# ListTopicRulesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListTopicRulesResponseTypeDef
def get_value() -> ListTopicRulesResponseTypeDef:
return {
"rules": ...,
}
# ListTopicRulesResponseTypeDef definition
class ListTopicRulesResponseTypeDef(TypedDict):
rules: List[TopicRuleListItemTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],LocationActionTypeDef#
# LocationActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import LocationActionTypeDef
def get_value() -> LocationActionTypeDef:
return {
"roleArn": ...,
}
# LocationActionTypeDef definition
class LocationActionTypeDef(TypedDict):
roleArn: str,
trackerName: str,
deviceId: str,
latitude: str,
longitude: str,
timestamp: NotRequired[LocationTimestampTypeDef], # (1)LogTargetConfigurationTypeDef#
# LogTargetConfigurationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import LogTargetConfigurationTypeDef
def get_value() -> LogTargetConfigurationTypeDef:
return {
"logTarget": ...,
}
# LogTargetConfigurationTypeDef definition
class LogTargetConfigurationTypeDef(TypedDict):
logTarget: NotRequired[LogTargetTypeDef], # (1)
logLevel: NotRequired[LogLevelType], # (2)- See LogTargetTypeDef
- See LogLevelType
SetV2LoggingLevelRequestTypeDef#
# SetV2LoggingLevelRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SetV2LoggingLevelRequestTypeDef
def get_value() -> SetV2LoggingLevelRequestTypeDef:
return {
"logTarget": ...,
}
# SetV2LoggingLevelRequestTypeDef definition
class SetV2LoggingLevelRequestTypeDef(TypedDict):
logTarget: LogTargetTypeDef, # (1)
logLevel: LogLevelType, # (2)- See LogTargetTypeDef
- See LogLevelType
SetLoggingOptionsRequestTypeDef#
# SetLoggingOptionsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SetLoggingOptionsRequestTypeDef
def get_value() -> SetLoggingOptionsRequestTypeDef:
return {
"loggingOptionsPayload": ...,
}
# SetLoggingOptionsRequestTypeDef definition
class SetLoggingOptionsRequestTypeDef(TypedDict):
loggingOptionsPayload: LoggingOptionsPayloadTypeDef, # (1)MitigationActionParamsOutputTypeDef#
# MitigationActionParamsOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import MitigationActionParamsOutputTypeDef
def get_value() -> MitigationActionParamsOutputTypeDef:
return {
"updateDeviceCertificateParams": ...,
}
# MitigationActionParamsOutputTypeDef definition
class MitigationActionParamsOutputTypeDef(TypedDict):
updateDeviceCertificateParams: NotRequired[UpdateDeviceCertificateParamsTypeDef], # (1)
updateCACertificateParams: NotRequired[UpdateCACertificateParamsTypeDef], # (2)
addThingsToThingGroupParams: NotRequired[AddThingsToThingGroupParamsOutputTypeDef], # (3)
replaceDefaultPolicyVersionParams: NotRequired[ReplaceDefaultPolicyVersionParamsTypeDef], # (4)
enableIoTLoggingParams: NotRequired[EnableIoTLoggingParamsTypeDef], # (5)
publishFindingToSnsParams: NotRequired[PublishFindingToSnsParamsTypeDef], # (6)- See UpdateDeviceCertificateParamsTypeDef
- See UpdateCACertificateParamsTypeDef
- See AddThingsToThingGroupParamsOutputTypeDef
- See ReplaceDefaultPolicyVersionParamsTypeDef
- See EnableIoTLoggingParamsTypeDef
- See PublishFindingToSnsParamsTypeDef
MitigationActionParamsTypeDef#
# MitigationActionParamsTypeDef TypedDict usage example
from types_boto3_iot.type_defs import MitigationActionParamsTypeDef
def get_value() -> MitigationActionParamsTypeDef:
return {
"updateDeviceCertificateParams": ...,
}
# MitigationActionParamsTypeDef definition
class MitigationActionParamsTypeDef(TypedDict):
updateDeviceCertificateParams: NotRequired[UpdateDeviceCertificateParamsTypeDef], # (1)
updateCACertificateParams: NotRequired[UpdateCACertificateParamsTypeDef], # (2)
addThingsToThingGroupParams: NotRequired[AddThingsToThingGroupParamsTypeDef], # (3)
replaceDefaultPolicyVersionParams: NotRequired[ReplaceDefaultPolicyVersionParamsTypeDef], # (4)
enableIoTLoggingParams: NotRequired[EnableIoTLoggingParamsTypeDef], # (5)
publishFindingToSnsParams: NotRequired[PublishFindingToSnsParamsTypeDef], # (6)- See UpdateDeviceCertificateParamsTypeDef
- See UpdateCACertificateParamsTypeDef
- See AddThingsToThingGroupParamsTypeDef
- See ReplaceDefaultPolicyVersionParamsTypeDef
- See EnableIoTLoggingParamsTypeDef
- See PublishFindingToSnsParamsTypeDef
Mqtt5ConfigurationOutputTypeDef#
# Mqtt5ConfigurationOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import Mqtt5ConfigurationOutputTypeDef
def get_value() -> Mqtt5ConfigurationOutputTypeDef:
return {
"propagatingAttributes": ...,
}
# Mqtt5ConfigurationOutputTypeDef definition
class Mqtt5ConfigurationOutputTypeDef(TypedDict):
propagatingAttributes: NotRequired[List[PropagatingAttributeTypeDef]], # (1)Mqtt5ConfigurationTypeDef#
# Mqtt5ConfigurationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import Mqtt5ConfigurationTypeDef
def get_value() -> Mqtt5ConfigurationTypeDef:
return {
"propagatingAttributes": ...,
}
# Mqtt5ConfigurationTypeDef definition
class Mqtt5ConfigurationTypeDef(TypedDict):
propagatingAttributes: NotRequired[Sequence[PropagatingAttributeTypeDef]], # (1)MqttHeadersOutputTypeDef#
# MqttHeadersOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import MqttHeadersOutputTypeDef
def get_value() -> MqttHeadersOutputTypeDef:
return {
"payloadFormatIndicator": ...,
}
# MqttHeadersOutputTypeDef definition
class MqttHeadersOutputTypeDef(TypedDict):
payloadFormatIndicator: NotRequired[str],
contentType: NotRequired[str],
responseTopic: NotRequired[str],
correlationData: NotRequired[str],
messageExpiry: NotRequired[str],
userProperties: NotRequired[List[UserPropertyTypeDef]], # (1)MqttHeadersTypeDef#
# MqttHeadersTypeDef TypedDict usage example
from types_boto3_iot.type_defs import MqttHeadersTypeDef
def get_value() -> MqttHeadersTypeDef:
return {
"payloadFormatIndicator": ...,
}
# MqttHeadersTypeDef definition
class MqttHeadersTypeDef(TypedDict):
payloadFormatIndicator: NotRequired[str],
contentType: NotRequired[str],
responseTopic: NotRequired[str],
correlationData: NotRequired[str],
messageExpiry: NotRequired[str],
userProperties: NotRequired[Sequence[UserPropertyTypeDef]], # (1)ResourceIdentifierTypeDef#
# ResourceIdentifierTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ResourceIdentifierTypeDef
def get_value() -> ResourceIdentifierTypeDef:
return {
"deviceCertificateId": ...,
}
# ResourceIdentifierTypeDef definition
class ResourceIdentifierTypeDef(TypedDict):
deviceCertificateId: NotRequired[str],
caCertificateId: NotRequired[str],
cognitoIdentityPoolId: NotRequired[str],
clientId: NotRequired[str],
policyVersionIdentifier: NotRequired[PolicyVersionIdentifierTypeDef], # (1)
account: NotRequired[str],
iamRoleArn: NotRequired[str],
roleAliasArn: NotRequired[str],
issuerCertificateIdentifier: NotRequired[IssuerCertificateIdentifierTypeDef], # (2)
deviceCertificateArn: NotRequired[str],ThingDocumentTypeDef#
# ThingDocumentTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingDocumentTypeDef
def get_value() -> ThingDocumentTypeDef:
return {
"thingName": ...,
}
# ThingDocumentTypeDef definition
class ThingDocumentTypeDef(TypedDict):
thingName: NotRequired[str],
thingId: NotRequired[str],
thingTypeName: NotRequired[str],
thingGroupNames: NotRequired[List[str]],
attributes: NotRequired[Dict[str, str]],
shadow: NotRequired[str],
deviceDefender: NotRequired[str],
connectivity: NotRequired[ThingConnectivityTypeDef], # (1)TimestreamActionOutputTypeDef#
# TimestreamActionOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TimestreamActionOutputTypeDef
def get_value() -> TimestreamActionOutputTypeDef:
return {
"roleArn": ...,
}
# TimestreamActionOutputTypeDef definition
class TimestreamActionOutputTypeDef(TypedDict):
roleArn: str,
databaseName: str,
tableName: str,
dimensions: List[TimestreamDimensionTypeDef], # (1)
timestamp: NotRequired[TimestreamTimestampTypeDef], # (2)TimestreamActionTypeDef#
# TimestreamActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TimestreamActionTypeDef
def get_value() -> TimestreamActionTypeDef:
return {
"roleArn": ...,
}
# TimestreamActionTypeDef definition
class TimestreamActionTypeDef(TypedDict):
roleArn: str,
databaseName: str,
tableName: str,
dimensions: Sequence[TimestreamDimensionTypeDef], # (1)
timestamp: NotRequired[TimestreamTimestampTypeDef], # (2)TopicRuleDestinationConfigurationTypeDef#
# TopicRuleDestinationConfigurationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TopicRuleDestinationConfigurationTypeDef
def get_value() -> TopicRuleDestinationConfigurationTypeDef:
return {
"httpUrlConfiguration": ...,
}
# TopicRuleDestinationConfigurationTypeDef definition
class TopicRuleDestinationConfigurationTypeDef(TypedDict):
httpUrlConfiguration: NotRequired[HttpUrlDestinationConfigurationTypeDef], # (1)
vpcConfiguration: NotRequired[VpcDestinationConfigurationTypeDef], # (2)TopicRuleDestinationSummaryTypeDef#
# TopicRuleDestinationSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TopicRuleDestinationSummaryTypeDef
def get_value() -> TopicRuleDestinationSummaryTypeDef:
return {
"arn": ...,
}
# TopicRuleDestinationSummaryTypeDef definition
class TopicRuleDestinationSummaryTypeDef(TypedDict):
arn: NotRequired[str],
status: NotRequired[TopicRuleDestinationStatusType], # (1)
createdAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],
statusReason: NotRequired[str],
httpUrlSummary: NotRequired[HttpUrlDestinationSummaryTypeDef], # (2)
vpcDestinationSummary: NotRequired[VpcDestinationSummaryTypeDef], # (3)- See TopicRuleDestinationStatusType
- See HttpUrlDestinationSummaryTypeDef
- See VpcDestinationSummaryTypeDef
TopicRuleDestinationTypeDef#
# TopicRuleDestinationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TopicRuleDestinationTypeDef
def get_value() -> TopicRuleDestinationTypeDef:
return {
"arn": ...,
}
# TopicRuleDestinationTypeDef definition
class TopicRuleDestinationTypeDef(TypedDict):
arn: NotRequired[str],
status: NotRequired[TopicRuleDestinationStatusType], # (1)
createdAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],
statusReason: NotRequired[str],
httpUrlProperties: NotRequired[HttpUrlDestinationPropertiesTypeDef], # (2)
vpcProperties: NotRequired[VpcDestinationPropertiesTypeDef], # (3)- See TopicRuleDestinationStatusType
- See HttpUrlDestinationPropertiesTypeDef
- See VpcDestinationPropertiesTypeDef
ValidateSecurityProfileBehaviorsResponseTypeDef#
# ValidateSecurityProfileBehaviorsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ValidateSecurityProfileBehaviorsResponseTypeDef
def get_value() -> ValidateSecurityProfileBehaviorsResponseTypeDef:
return {
"valid": ...,
}
# ValidateSecurityProfileBehaviorsResponseTypeDef definition
class ValidateSecurityProfileBehaviorsResponseTypeDef(TypedDict):
valid: bool,
validationErrors: List[ValidationErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListMetricValuesResponseTypeDef#
# ListMetricValuesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListMetricValuesResponseTypeDef
def get_value() -> ListMetricValuesResponseTypeDef:
return {
"metricDatumList": ...,
}
# ListMetricValuesResponseTypeDef definition
class ListMetricValuesResponseTypeDef(TypedDict):
metricDatumList: List[MetricDatumTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],CreateFleetMetricRequestTypeDef#
# CreateFleetMetricRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateFleetMetricRequestTypeDef
def get_value() -> CreateFleetMetricRequestTypeDef:
return {
"metricName": ...,
}
# CreateFleetMetricRequestTypeDef definition
class CreateFleetMetricRequestTypeDef(TypedDict):
metricName: str,
queryString: str,
aggregationType: AggregationTypeUnionTypeDef, # (1)
period: int,
aggregationField: str,
description: NotRequired[str],
queryVersion: NotRequired[str],
indexName: NotRequired[str],
unit: NotRequired[FleetMetricUnitType], # (2)
tags: NotRequired[Sequence[TagTypeDef]], # (3)UpdateFleetMetricRequestTypeDef#
# UpdateFleetMetricRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateFleetMetricRequestTypeDef
def get_value() -> UpdateFleetMetricRequestTypeDef:
return {
"metricName": ...,
}
# UpdateFleetMetricRequestTypeDef definition
class UpdateFleetMetricRequestTypeDef(TypedDict):
metricName: str,
indexName: str,
queryString: NotRequired[str],
aggregationType: NotRequired[AggregationTypeUnionTypeDef], # (1)
period: NotRequired[int],
aggregationField: NotRequired[str],
description: NotRequired[str],
queryVersion: NotRequired[str],
unit: NotRequired[FleetMetricUnitType], # (2)
expectedVersion: NotRequired[int],DeniedTypeDef#
# DeniedTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeniedTypeDef
def get_value() -> DeniedTypeDef:
return {
"implicitDeny": ...,
}
# DeniedTypeDef definition
class DeniedTypeDef(TypedDict):
implicitDeny: NotRequired[ImplicitDenyTypeDef], # (1)
explicitDeny: NotRequired[ExplicitDenyTypeDef], # (2)PutAssetPropertyValueEntryOutputTypeDef#
# PutAssetPropertyValueEntryOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PutAssetPropertyValueEntryOutputTypeDef
def get_value() -> PutAssetPropertyValueEntryOutputTypeDef:
return {
"entryId": ...,
}
# PutAssetPropertyValueEntryOutputTypeDef definition
class PutAssetPropertyValueEntryOutputTypeDef(TypedDict):
propertyValues: List[AssetPropertyValueTypeDef], # (1)
entryId: NotRequired[str],
assetId: NotRequired[str],
propertyId: NotRequired[str],
propertyAlias: NotRequired[str],PutAssetPropertyValueEntryTypeDef#
# PutAssetPropertyValueEntryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import PutAssetPropertyValueEntryTypeDef
def get_value() -> PutAssetPropertyValueEntryTypeDef:
return {
"entryId": ...,
}
# PutAssetPropertyValueEntryTypeDef definition
class PutAssetPropertyValueEntryTypeDef(TypedDict):
propertyValues: Sequence[AssetPropertyValueTypeDef], # (1)
entryId: NotRequired[str],
assetId: NotRequired[str],
propertyId: NotRequired[str],
propertyAlias: NotRequired[str],CreateThingRequestTypeDef#
# CreateThingRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateThingRequestTypeDef
def get_value() -> CreateThingRequestTypeDef:
return {
"thingName": ...,
}
# CreateThingRequestTypeDef definition
class CreateThingRequestTypeDef(TypedDict):
thingName: str,
thingTypeName: NotRequired[str],
attributePayload: NotRequired[AttributePayloadUnionTypeDef], # (1)
billingGroupName: NotRequired[str],UpdateThingRequestTypeDef#
# UpdateThingRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateThingRequestTypeDef
def get_value() -> UpdateThingRequestTypeDef:
return {
"thingName": ...,
}
# UpdateThingRequestTypeDef definition
class UpdateThingRequestTypeDef(TypedDict):
thingName: str,
thingTypeName: NotRequired[str],
attributePayload: NotRequired[AttributePayloadUnionTypeDef], # (1)
expectedVersion: NotRequired[int],
removeThingType: NotRequired[bool],StartAuditMitigationActionsTaskRequestTypeDef#
# StartAuditMitigationActionsTaskRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StartAuditMitigationActionsTaskRequestTypeDef
def get_value() -> StartAuditMitigationActionsTaskRequestTypeDef:
return {
"taskId": ...,
}
# StartAuditMitigationActionsTaskRequestTypeDef definition
class StartAuditMitigationActionsTaskRequestTypeDef(TypedDict):
taskId: str,
target: AuditMitigationActionsTaskTargetUnionTypeDef, # (1)
auditCheckToActionsMapping: Mapping[str, Sequence[str]],
clientRequestToken: str,TestAuthorizationRequestTypeDef#
# TestAuthorizationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TestAuthorizationRequestTypeDef
def get_value() -> TestAuthorizationRequestTypeDef:
return {
"authInfos": ...,
}
# TestAuthorizationRequestTypeDef definition
class TestAuthorizationRequestTypeDef(TypedDict):
authInfos: Sequence[AuthInfoUnionTypeDef], # (1)
principal: NotRequired[str],
cognitoIdentityPoolId: NotRequired[str],
clientId: NotRequired[str],
policyNamesToAdd: NotRequired[Sequence[str]],
policyNamesToSkip: NotRequired[Sequence[str]],AwsJobExecutionsRolloutConfigTypeDef#
# AwsJobExecutionsRolloutConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AwsJobExecutionsRolloutConfigTypeDef
def get_value() -> AwsJobExecutionsRolloutConfigTypeDef:
return {
"maximumPerMinute": ...,
}
# AwsJobExecutionsRolloutConfigTypeDef definition
class AwsJobExecutionsRolloutConfigTypeDef(TypedDict):
maximumPerMinute: NotRequired[int],
exponentialRate: NotRequired[AwsJobExponentialRolloutRateTypeDef], # (1)BehaviorOutputTypeDef#
# BehaviorOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import BehaviorOutputTypeDef
def get_value() -> BehaviorOutputTypeDef:
return {
"name": ...,
}
# BehaviorOutputTypeDef definition
class BehaviorOutputTypeDef(TypedDict):
name: str,
metric: NotRequired[str],
metricDimension: NotRequired[MetricDimensionTypeDef], # (1)
criteria: NotRequired[BehaviorCriteriaOutputTypeDef], # (2)
suppressAlerts: NotRequired[bool],
exportMetric: NotRequired[bool],TestInvokeAuthorizerRequestTypeDef#
# TestInvokeAuthorizerRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TestInvokeAuthorizerRequestTypeDef
def get_value() -> TestInvokeAuthorizerRequestTypeDef:
return {
"authorizerName": ...,
}
# TestInvokeAuthorizerRequestTypeDef definition
class TestInvokeAuthorizerRequestTypeDef(TypedDict):
authorizerName: str,
token: NotRequired[str],
tokenSignature: NotRequired[str],
httpContext: NotRequired[HttpContextTypeDef], # (1)
mqttContext: NotRequired[MqttContextTypeDef], # (2)
tlsContext: NotRequired[TlsContextTypeDef], # (3)- See HttpContextTypeDef
- See MqttContextTypeDef
- See TlsContextTypeDef
GetBucketsAggregationRequestTypeDef#
# GetBucketsAggregationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetBucketsAggregationRequestTypeDef
def get_value() -> GetBucketsAggregationRequestTypeDef:
return {
"queryString": ...,
}
# GetBucketsAggregationRequestTypeDef definition
class GetBucketsAggregationRequestTypeDef(TypedDict):
queryString: str,
aggregationField: str,
bucketsAggregationType: BucketsAggregationTypeTypeDef, # (1)
indexName: NotRequired[str],
queryVersion: NotRequired[str],DescribeCACertificateResponseTypeDef#
# DescribeCACertificateResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeCACertificateResponseTypeDef
def get_value() -> DescribeCACertificateResponseTypeDef:
return {
"certificateDescription": ...,
}
# DescribeCACertificateResponseTypeDef definition
class DescribeCACertificateResponseTypeDef(TypedDict):
certificateDescription: CACertificateDescriptionTypeDef, # (1)
registrationConfig: RegistrationConfigTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)DescribeCertificateResponseTypeDef#
# DescribeCertificateResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeCertificateResponseTypeDef
def get_value() -> DescribeCertificateResponseTypeDef:
return {
"certificateDescription": ...,
}
# DescribeCertificateResponseTypeDef definition
class DescribeCertificateResponseTypeDef(TypedDict):
certificateDescription: CertificateDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetCommandResponseTypeDef#
# GetCommandResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetCommandResponseTypeDef
def get_value() -> GetCommandResponseTypeDef:
return {
"commandId": ...,
}
# GetCommandResponseTypeDef definition
class GetCommandResponseTypeDef(TypedDict):
commandId: str,
commandArn: str,
namespace: CommandNamespaceType, # (1)
displayName: str,
description: str,
mandatoryParameters: List[CommandParameterOutputTypeDef], # (2)
payload: CommandPayloadOutputTypeDef, # (3)
roleArn: str,
createdAt: datetime,
lastUpdatedAt: datetime,
deprecated: bool,
pendingDeletion: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See CommandNamespaceType
- See CommandParameterOutputTypeDef
- See CommandPayloadOutputTypeDef
- See ResponseMetadataTypeDef
StartSigningJobParameterTypeDef#
# StartSigningJobParameterTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StartSigningJobParameterTypeDef
def get_value() -> StartSigningJobParameterTypeDef:
return {
"signingProfileParameter": ...,
}
# StartSigningJobParameterTypeDef definition
class StartSigningJobParameterTypeDef(TypedDict):
signingProfileParameter: NotRequired[SigningProfileParameterTypeDef], # (1)
signingProfileName: NotRequired[str],
destination: NotRequired[DestinationTypeDef], # (2)JobExecutionsRolloutConfigTypeDef#
# JobExecutionsRolloutConfigTypeDef TypedDict usage example
from types_boto3_iot.type_defs import JobExecutionsRolloutConfigTypeDef
def get_value() -> JobExecutionsRolloutConfigTypeDef:
return {
"maximumPerMinute": ...,
}
# JobExecutionsRolloutConfigTypeDef definition
class JobExecutionsRolloutConfigTypeDef(TypedDict):
maximumPerMinute: NotRequired[int],
exponentialRate: NotRequired[ExponentialRolloutRateTypeDef], # (1)CreatePackageVersionRequestTypeDef#
# CreatePackageVersionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreatePackageVersionRequestTypeDef
def get_value() -> CreatePackageVersionRequestTypeDef:
return {
"packageName": ...,
}
# CreatePackageVersionRequestTypeDef definition
class CreatePackageVersionRequestTypeDef(TypedDict):
packageName: str,
versionName: str,
description: NotRequired[str],
attributes: NotRequired[Mapping[str, str]],
artifact: NotRequired[PackageVersionArtifactTypeDef], # (1)
recipe: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
clientToken: NotRequired[str],UpdatePackageVersionRequestTypeDef#
# UpdatePackageVersionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdatePackageVersionRequestTypeDef
def get_value() -> UpdatePackageVersionRequestTypeDef:
return {
"packageName": ...,
}
# UpdatePackageVersionRequestTypeDef definition
class UpdatePackageVersionRequestTypeDef(TypedDict):
packageName: str,
versionName: str,
description: NotRequired[str],
attributes: NotRequired[Mapping[str, str]],
artifact: NotRequired[PackageVersionArtifactTypeDef], # (1)
action: NotRequired[PackageVersionActionType], # (2)
recipe: NotRequired[str],
clientToken: NotRequired[str],AssociateSbomWithPackageVersionRequestTypeDef#
# AssociateSbomWithPackageVersionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AssociateSbomWithPackageVersionRequestTypeDef
def get_value() -> AssociateSbomWithPackageVersionRequestTypeDef:
return {
"packageName": ...,
}
# AssociateSbomWithPackageVersionRequestTypeDef definition
class AssociateSbomWithPackageVersionRequestTypeDef(TypedDict):
packageName: str,
versionName: str,
sbom: SbomTypeDef, # (1)
clientToken: NotRequired[str],- See SbomTypeDef
AssociateSbomWithPackageVersionResponseTypeDef#
# AssociateSbomWithPackageVersionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AssociateSbomWithPackageVersionResponseTypeDef
def get_value() -> AssociateSbomWithPackageVersionResponseTypeDef:
return {
"packageName": ...,
}
# AssociateSbomWithPackageVersionResponseTypeDef definition
class AssociateSbomWithPackageVersionResponseTypeDef(TypedDict):
packageName: str,
versionName: str,
sbom: SbomTypeDef, # (1)
sbomValidationStatus: SbomValidationStatusType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)GetPackageVersionResponseTypeDef#
# GetPackageVersionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetPackageVersionResponseTypeDef
def get_value() -> GetPackageVersionResponseTypeDef:
return {
"packageVersionArn": ...,
}
# GetPackageVersionResponseTypeDef definition
class GetPackageVersionResponseTypeDef(TypedDict):
packageVersionArn: str,
packageName: str,
versionName: str,
description: str,
attributes: Dict[str, str],
artifact: PackageVersionArtifactTypeDef, # (1)
status: PackageVersionStatusType, # (2)
errorReason: str,
creationDate: datetime,
lastModifiedDate: datetime,
sbom: SbomTypeDef, # (3)
sbomValidationStatus: SbomValidationStatusType, # (4)
recipe: str,
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See PackageVersionArtifactTypeDef
- See PackageVersionStatusType
- See SbomTypeDef
- See SbomValidationStatusType
- See ResponseMetadataTypeDef
CreateStreamRequestTypeDef#
# CreateStreamRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateStreamRequestTypeDef
def get_value() -> CreateStreamRequestTypeDef:
return {
"streamId": ...,
}
# CreateStreamRequestTypeDef definition
class CreateStreamRequestTypeDef(TypedDict):
streamId: str,
files: Sequence[StreamFileTypeDef], # (1)
roleArn: str,
description: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)- See StreamFileTypeDef
- See TagTypeDef
StreamInfoTypeDef#
# StreamInfoTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StreamInfoTypeDef
def get_value() -> StreamInfoTypeDef:
return {
"streamId": ...,
}
# StreamInfoTypeDef definition
class StreamInfoTypeDef(TypedDict):
streamId: NotRequired[str],
streamArn: NotRequired[str],
streamVersion: NotRequired[int],
description: NotRequired[str],
files: NotRequired[List[StreamFileTypeDef]], # (1)
createdAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],
roleArn: NotRequired[str],UpdateStreamRequestTypeDef#
# UpdateStreamRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateStreamRequestTypeDef
def get_value() -> UpdateStreamRequestTypeDef:
return {
"streamId": ...,
}
# UpdateStreamRequestTypeDef definition
class UpdateStreamRequestTypeDef(TypedDict):
streamId: str,
description: NotRequired[str],
files: NotRequired[Sequence[StreamFileTypeDef]], # (1)
roleArn: NotRequired[str],ThingIndexingConfigurationOutputTypeDef#
# ThingIndexingConfigurationOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingIndexingConfigurationOutputTypeDef
def get_value() -> ThingIndexingConfigurationOutputTypeDef:
return {
"thingIndexingMode": ...,
}
# ThingIndexingConfigurationOutputTypeDef definition
class ThingIndexingConfigurationOutputTypeDef(TypedDict):
thingIndexingMode: ThingIndexingModeType, # (1)
thingConnectivityIndexingMode: NotRequired[ThingConnectivityIndexingModeType], # (2)
deviceDefenderIndexingMode: NotRequired[DeviceDefenderIndexingModeType], # (3)
namedShadowIndexingMode: NotRequired[NamedShadowIndexingModeType], # (4)
managedFields: NotRequired[List[FieldTypeDef]], # (5)
customFields: NotRequired[List[FieldTypeDef]], # (5)
filter: NotRequired[IndexingFilterOutputTypeDef], # (7)- See ThingIndexingModeType
- See ThingConnectivityIndexingModeType
- See DeviceDefenderIndexingModeType
- See NamedShadowIndexingModeType
- See FieldTypeDef
- See FieldTypeDef
- See IndexingFilterOutputTypeDef
ThingIndexingConfigurationTypeDef#
# ThingIndexingConfigurationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingIndexingConfigurationTypeDef
def get_value() -> ThingIndexingConfigurationTypeDef:
return {
"thingIndexingMode": ...,
}
# ThingIndexingConfigurationTypeDef definition
class ThingIndexingConfigurationTypeDef(TypedDict):
thingIndexingMode: ThingIndexingModeType, # (1)
thingConnectivityIndexingMode: NotRequired[ThingConnectivityIndexingModeType], # (2)
deviceDefenderIndexingMode: NotRequired[DeviceDefenderIndexingModeType], # (3)
namedShadowIndexingMode: NotRequired[NamedShadowIndexingModeType], # (4)
managedFields: NotRequired[Sequence[FieldTypeDef]], # (5)
customFields: NotRequired[Sequence[FieldTypeDef]], # (5)
filter: NotRequired[IndexingFilterTypeDef], # (7)- See ThingIndexingModeType
- See ThingConnectivityIndexingModeType
- See DeviceDefenderIndexingModeType
- See NamedShadowIndexingModeType
- See FieldTypeDef
- See FieldTypeDef
- See IndexingFilterTypeDef
DescribeThingGroupResponseTypeDef#
# DescribeThingGroupResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeThingGroupResponseTypeDef
def get_value() -> DescribeThingGroupResponseTypeDef:
return {
"thingGroupName": ...,
}
# DescribeThingGroupResponseTypeDef definition
class DescribeThingGroupResponseTypeDef(TypedDict):
thingGroupName: str,
thingGroupId: str,
thingGroupArn: str,
version: int,
thingGroupProperties: ThingGroupPropertiesOutputTypeDef, # (1)
thingGroupMetadata: ThingGroupMetadataTypeDef, # (2)
indexName: str,
queryString: str,
queryVersion: str,
status: DynamicGroupStatusType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See ThingGroupPropertiesOutputTypeDef
- See ThingGroupMetadataTypeDef
- See DynamicGroupStatusType
- See ResponseMetadataTypeDef
HttpActionOutputTypeDef#
# HttpActionOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import HttpActionOutputTypeDef
def get_value() -> HttpActionOutputTypeDef:
return {
"url": ...,
}
# HttpActionOutputTypeDef definition
class HttpActionOutputTypeDef(TypedDict):
url: str,
confirmationUrl: NotRequired[str],
headers: NotRequired[List[HttpActionHeaderTypeDef]], # (1)
auth: NotRequired[HttpAuthorizationTypeDef], # (2)HttpActionTypeDef#
# HttpActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import HttpActionTypeDef
def get_value() -> HttpActionTypeDef:
return {
"url": ...,
}
# HttpActionTypeDef definition
class HttpActionTypeDef(TypedDict):
url: str,
confirmationUrl: NotRequired[str],
headers: NotRequired[Sequence[HttpActionHeaderTypeDef]], # (1)
auth: NotRequired[HttpAuthorizationTypeDef], # (2)DescribeJobExecutionResponseTypeDef#
# DescribeJobExecutionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeJobExecutionResponseTypeDef
def get_value() -> DescribeJobExecutionResponseTypeDef:
return {
"execution": ...,
}
# DescribeJobExecutionResponseTypeDef definition
class DescribeJobExecutionResponseTypeDef(TypedDict):
execution: JobExecutionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListJobExecutionsForJobResponseTypeDef#
# ListJobExecutionsForJobResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListJobExecutionsForJobResponseTypeDef
def get_value() -> ListJobExecutionsForJobResponseTypeDef:
return {
"executionSummaries": ...,
}
# ListJobExecutionsForJobResponseTypeDef definition
class ListJobExecutionsForJobResponseTypeDef(TypedDict):
executionSummaries: List[JobExecutionSummaryForJobTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListJobExecutionsForThingResponseTypeDef#
# ListJobExecutionsForThingResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListJobExecutionsForThingResponseTypeDef
def get_value() -> ListJobExecutionsForThingResponseTypeDef:
return {
"executionSummaries": ...,
}
# ListJobExecutionsForThingResponseTypeDef definition
class ListJobExecutionsForThingResponseTypeDef(TypedDict):
executionSummaries: List[JobExecutionSummaryForThingTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListSecurityProfilesForTargetResponseTypeDef#
# ListSecurityProfilesForTargetResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListSecurityProfilesForTargetResponseTypeDef
def get_value() -> ListSecurityProfilesForTargetResponseTypeDef:
return {
"securityProfileTargetMappings": ...,
}
# ListSecurityProfilesForTargetResponseTypeDef definition
class ListSecurityProfilesForTargetResponseTypeDef(TypedDict):
securityProfileTargetMappings: List[SecurityProfileTargetMappingTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListV2LoggingLevelsResponseTypeDef#
# ListV2LoggingLevelsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListV2LoggingLevelsResponseTypeDef
def get_value() -> ListV2LoggingLevelsResponseTypeDef:
return {
"logTargetConfigurations": ...,
}
# ListV2LoggingLevelsResponseTypeDef definition
class ListV2LoggingLevelsResponseTypeDef(TypedDict):
logTargetConfigurations: List[LogTargetConfigurationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],BehaviorCriteriaTypeDef#
# BehaviorCriteriaTypeDef TypedDict usage example
from types_boto3_iot.type_defs import BehaviorCriteriaTypeDef
def get_value() -> BehaviorCriteriaTypeDef:
return {
"comparisonOperator": ...,
}
# BehaviorCriteriaTypeDef definition
class BehaviorCriteriaTypeDef(TypedDict):
comparisonOperator: NotRequired[ComparisonOperatorType], # (1)
value: NotRequired[MetricValueUnionTypeDef], # (2)
durationSeconds: NotRequired[int],
consecutiveDatapointsToAlarm: NotRequired[int],
consecutiveDatapointsToClear: NotRequired[int],
statisticalThreshold: NotRequired[StatisticalThresholdTypeDef], # (3)
mlDetectionConfig: NotRequired[MachineLearningDetectionConfigTypeDef], # (4)- See ComparisonOperatorType
- See MetricValueTypeDef MetricValueOutputTypeDef
- See StatisticalThresholdTypeDef
- See MachineLearningDetectionConfigTypeDef
DescribeMitigationActionResponseTypeDef#
# DescribeMitigationActionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeMitigationActionResponseTypeDef
def get_value() -> DescribeMitigationActionResponseTypeDef:
return {
"actionName": ...,
}
# DescribeMitigationActionResponseTypeDef definition
class DescribeMitigationActionResponseTypeDef(TypedDict):
actionName: str,
actionType: MitigationActionTypeType, # (1)
actionArn: str,
actionId: str,
roleArn: str,
actionParams: MitigationActionParamsOutputTypeDef, # (2)
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)MitigationActionTypeDef#
# MitigationActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import MitigationActionTypeDef
def get_value() -> MitigationActionTypeDef:
return {
"name": ...,
}
# MitigationActionTypeDef definition
class MitigationActionTypeDef(TypedDict):
name: NotRequired[str],
id: NotRequired[str],
roleArn: NotRequired[str],
actionParams: NotRequired[MitigationActionParamsOutputTypeDef], # (1)ThingTypePropertiesOutputTypeDef#
# ThingTypePropertiesOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingTypePropertiesOutputTypeDef
def get_value() -> ThingTypePropertiesOutputTypeDef:
return {
"thingTypeDescription": ...,
}
# ThingTypePropertiesOutputTypeDef definition
class ThingTypePropertiesOutputTypeDef(TypedDict):
thingTypeDescription: NotRequired[str],
searchableAttributes: NotRequired[List[str]],
mqtt5Configuration: NotRequired[Mqtt5ConfigurationOutputTypeDef], # (1)ThingTypePropertiesTypeDef#
# ThingTypePropertiesTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingTypePropertiesTypeDef
def get_value() -> ThingTypePropertiesTypeDef:
return {
"thingTypeDescription": ...,
}
# ThingTypePropertiesTypeDef definition
class ThingTypePropertiesTypeDef(TypedDict):
thingTypeDescription: NotRequired[str],
searchableAttributes: NotRequired[Sequence[str]],
mqtt5Configuration: NotRequired[Mqtt5ConfigurationTypeDef], # (1)RepublishActionOutputTypeDef#
# RepublishActionOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RepublishActionOutputTypeDef
def get_value() -> RepublishActionOutputTypeDef:
return {
"roleArn": ...,
}
# RepublishActionOutputTypeDef definition
class RepublishActionOutputTypeDef(TypedDict):
roleArn: str,
topic: str,
qos: NotRequired[int],
headers: NotRequired[MqttHeadersOutputTypeDef], # (1)AuditSuppressionTypeDef#
# AuditSuppressionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuditSuppressionTypeDef
def get_value() -> AuditSuppressionTypeDef:
return {
"checkName": ...,
}
# AuditSuppressionTypeDef definition
class AuditSuppressionTypeDef(TypedDict):
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)
expirationDate: NotRequired[datetime],
suppressIndefinitely: NotRequired[bool],
description: NotRequired[str],CreateAuditSuppressionRequestTypeDef#
# CreateAuditSuppressionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateAuditSuppressionRequestTypeDef
def get_value() -> CreateAuditSuppressionRequestTypeDef:
return {
"checkName": ...,
}
# CreateAuditSuppressionRequestTypeDef definition
class CreateAuditSuppressionRequestTypeDef(TypedDict):
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)
clientRequestToken: str,
expirationDate: NotRequired[TimestampTypeDef],
suppressIndefinitely: NotRequired[bool],
description: NotRequired[str],DeleteAuditSuppressionRequestTypeDef#
# DeleteAuditSuppressionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DeleteAuditSuppressionRequestTypeDef
def get_value() -> DeleteAuditSuppressionRequestTypeDef:
return {
"checkName": ...,
}
# DeleteAuditSuppressionRequestTypeDef definition
class DeleteAuditSuppressionRequestTypeDef(TypedDict):
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)DescribeAuditSuppressionRequestTypeDef#
# DescribeAuditSuppressionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeAuditSuppressionRequestTypeDef
def get_value() -> DescribeAuditSuppressionRequestTypeDef:
return {
"checkName": ...,
}
# DescribeAuditSuppressionRequestTypeDef definition
class DescribeAuditSuppressionRequestTypeDef(TypedDict):
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)DescribeAuditSuppressionResponseTypeDef#
# DescribeAuditSuppressionResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeAuditSuppressionResponseTypeDef
def get_value() -> DescribeAuditSuppressionResponseTypeDef:
return {
"checkName": ...,
}
# DescribeAuditSuppressionResponseTypeDef definition
class DescribeAuditSuppressionResponseTypeDef(TypedDict):
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)
expirationDate: datetime,
suppressIndefinitely: bool,
description: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListAuditFindingsRequestPaginateTypeDef#
# ListAuditFindingsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuditFindingsRequestPaginateTypeDef
def get_value() -> ListAuditFindingsRequestPaginateTypeDef:
return {
"taskId": ...,
}
# ListAuditFindingsRequestPaginateTypeDef definition
class ListAuditFindingsRequestPaginateTypeDef(TypedDict):
taskId: NotRequired[str],
checkName: NotRequired[str],
resourceIdentifier: NotRequired[ResourceIdentifierTypeDef], # (1)
startTime: NotRequired[TimestampTypeDef],
endTime: NotRequired[TimestampTypeDef],
listSuppressedFindings: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListAuditFindingsRequestTypeDef#
# ListAuditFindingsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuditFindingsRequestTypeDef
def get_value() -> ListAuditFindingsRequestTypeDef:
return {
"taskId": ...,
}
# ListAuditFindingsRequestTypeDef definition
class ListAuditFindingsRequestTypeDef(TypedDict):
taskId: NotRequired[str],
checkName: NotRequired[str],
resourceIdentifier: NotRequired[ResourceIdentifierTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
startTime: NotRequired[TimestampTypeDef],
endTime: NotRequired[TimestampTypeDef],
listSuppressedFindings: NotRequired[bool],ListAuditSuppressionsRequestPaginateTypeDef#
# ListAuditSuppressionsRequestPaginateTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuditSuppressionsRequestPaginateTypeDef
def get_value() -> ListAuditSuppressionsRequestPaginateTypeDef:
return {
"checkName": ...,
}
# ListAuditSuppressionsRequestPaginateTypeDef definition
class ListAuditSuppressionsRequestPaginateTypeDef(TypedDict):
checkName: NotRequired[str],
resourceIdentifier: NotRequired[ResourceIdentifierTypeDef], # (1)
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListAuditSuppressionsRequestTypeDef#
# ListAuditSuppressionsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuditSuppressionsRequestTypeDef
def get_value() -> ListAuditSuppressionsRequestTypeDef:
return {
"checkName": ...,
}
# ListAuditSuppressionsRequestTypeDef definition
class ListAuditSuppressionsRequestTypeDef(TypedDict):
checkName: NotRequired[str],
resourceIdentifier: NotRequired[ResourceIdentifierTypeDef], # (1)
ascendingOrder: NotRequired[bool],
nextToken: NotRequired[str],
maxResults: NotRequired[int],NonCompliantResourceTypeDef#
# NonCompliantResourceTypeDef TypedDict usage example
from types_boto3_iot.type_defs import NonCompliantResourceTypeDef
def get_value() -> NonCompliantResourceTypeDef:
return {
"resourceType": ...,
}
# NonCompliantResourceTypeDef definition
class NonCompliantResourceTypeDef(TypedDict):
resourceType: NotRequired[ResourceTypeType], # (1)
resourceIdentifier: NotRequired[ResourceIdentifierTypeDef], # (2)
additionalInfo: NotRequired[Dict[str, str]],RelatedResourceTypeDef#
# RelatedResourceTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RelatedResourceTypeDef
def get_value() -> RelatedResourceTypeDef:
return {
"resourceType": ...,
}
# RelatedResourceTypeDef definition
class RelatedResourceTypeDef(TypedDict):
resourceType: NotRequired[ResourceTypeType], # (1)
resourceIdentifier: NotRequired[ResourceIdentifierTypeDef], # (2)
additionalInfo: NotRequired[Dict[str, str]],UpdateAuditSuppressionRequestTypeDef#
# UpdateAuditSuppressionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateAuditSuppressionRequestTypeDef
def get_value() -> UpdateAuditSuppressionRequestTypeDef:
return {
"checkName": ...,
}
# UpdateAuditSuppressionRequestTypeDef definition
class UpdateAuditSuppressionRequestTypeDef(TypedDict):
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)
expirationDate: NotRequired[TimestampTypeDef],
suppressIndefinitely: NotRequired[bool],
description: NotRequired[str],SearchIndexResponseTypeDef#
# SearchIndexResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import SearchIndexResponseTypeDef
def get_value() -> SearchIndexResponseTypeDef:
return {
"nextToken": ...,
}
# SearchIndexResponseTypeDef definition
class SearchIndexResponseTypeDef(TypedDict):
things: List[ThingDocumentTypeDef], # (1)
thingGroups: List[ThingGroupDocumentTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
nextToken: NotRequired[str],CreateTopicRuleDestinationRequestTypeDef#
# CreateTopicRuleDestinationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateTopicRuleDestinationRequestTypeDef
def get_value() -> CreateTopicRuleDestinationRequestTypeDef:
return {
"destinationConfiguration": ...,
}
# CreateTopicRuleDestinationRequestTypeDef definition
class CreateTopicRuleDestinationRequestTypeDef(TypedDict):
destinationConfiguration: TopicRuleDestinationConfigurationTypeDef, # (1)ListTopicRuleDestinationsResponseTypeDef#
# ListTopicRuleDestinationsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListTopicRuleDestinationsResponseTypeDef
def get_value() -> ListTopicRuleDestinationsResponseTypeDef:
return {
"destinationSummaries": ...,
}
# ListTopicRuleDestinationsResponseTypeDef definition
class ListTopicRuleDestinationsResponseTypeDef(TypedDict):
destinationSummaries: List[TopicRuleDestinationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],CreateTopicRuleDestinationResponseTypeDef#
# CreateTopicRuleDestinationResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateTopicRuleDestinationResponseTypeDef
def get_value() -> CreateTopicRuleDestinationResponseTypeDef:
return {
"topicRuleDestination": ...,
}
# CreateTopicRuleDestinationResponseTypeDef definition
class CreateTopicRuleDestinationResponseTypeDef(TypedDict):
topicRuleDestination: TopicRuleDestinationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetTopicRuleDestinationResponseTypeDef#
# GetTopicRuleDestinationResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetTopicRuleDestinationResponseTypeDef
def get_value() -> GetTopicRuleDestinationResponseTypeDef:
return {
"topicRuleDestination": ...,
}
# GetTopicRuleDestinationResponseTypeDef definition
class GetTopicRuleDestinationResponseTypeDef(TypedDict):
topicRuleDestination: TopicRuleDestinationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)AuthResultTypeDef#
# AuthResultTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuthResultTypeDef
def get_value() -> AuthResultTypeDef:
return {
"authInfo": ...,
}
# AuthResultTypeDef definition
class AuthResultTypeDef(TypedDict):
authInfo: NotRequired[AuthInfoOutputTypeDef], # (1)
allowed: NotRequired[AllowedTypeDef], # (2)
denied: NotRequired[DeniedTypeDef], # (3)
authDecision: NotRequired[AuthDecisionType], # (4)
missingContextValues: NotRequired[List[str]],- See AuthInfoOutputTypeDef
- See AllowedTypeDef
- See DeniedTypeDef
- See AuthDecisionType
IotSiteWiseActionOutputTypeDef#
# IotSiteWiseActionOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import IotSiteWiseActionOutputTypeDef
def get_value() -> IotSiteWiseActionOutputTypeDef:
return {
"putAssetPropertyValueEntries": ...,
}
# IotSiteWiseActionOutputTypeDef definition
class IotSiteWiseActionOutputTypeDef(TypedDict):
putAssetPropertyValueEntries: List[PutAssetPropertyValueEntryOutputTypeDef], # (1)
roleArn: str,CreateDynamicThingGroupRequestTypeDef#
# CreateDynamicThingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateDynamicThingGroupRequestTypeDef
def get_value() -> CreateDynamicThingGroupRequestTypeDef:
return {
"thingGroupName": ...,
}
# CreateDynamicThingGroupRequestTypeDef definition
class CreateDynamicThingGroupRequestTypeDef(TypedDict):
thingGroupName: str,
queryString: str,
thingGroupProperties: NotRequired[ThingGroupPropertiesUnionTypeDef], # (1)
indexName: NotRequired[str],
queryVersion: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)CreateThingGroupRequestTypeDef#
# CreateThingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateThingGroupRequestTypeDef
def get_value() -> CreateThingGroupRequestTypeDef:
return {
"thingGroupName": ...,
}
# CreateThingGroupRequestTypeDef definition
class CreateThingGroupRequestTypeDef(TypedDict):
thingGroupName: str,
parentGroupName: NotRequired[str],
thingGroupProperties: NotRequired[ThingGroupPropertiesUnionTypeDef], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)UpdateDynamicThingGroupRequestTypeDef#
# UpdateDynamicThingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateDynamicThingGroupRequestTypeDef
def get_value() -> UpdateDynamicThingGroupRequestTypeDef:
return {
"thingGroupName": ...,
}
# UpdateDynamicThingGroupRequestTypeDef definition
class UpdateDynamicThingGroupRequestTypeDef(TypedDict):
thingGroupName: str,
thingGroupProperties: ThingGroupPropertiesUnionTypeDef, # (1)
expectedVersion: NotRequired[int],
indexName: NotRequired[str],
queryString: NotRequired[str],
queryVersion: NotRequired[str],UpdateThingGroupRequestTypeDef#
# UpdateThingGroupRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateThingGroupRequestTypeDef
def get_value() -> UpdateThingGroupRequestTypeDef:
return {
"thingGroupName": ...,
}
# UpdateThingGroupRequestTypeDef definition
class UpdateThingGroupRequestTypeDef(TypedDict):
thingGroupName: str,
thingGroupProperties: ThingGroupPropertiesUnionTypeDef, # (1)
expectedVersion: NotRequired[int],ActiveViolationTypeDef#
# ActiveViolationTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ActiveViolationTypeDef
def get_value() -> ActiveViolationTypeDef:
return {
"violationId": ...,
}
# ActiveViolationTypeDef definition
class ActiveViolationTypeDef(TypedDict):
violationId: NotRequired[str],
thingName: NotRequired[str],
securityProfileName: NotRequired[str],
behavior: NotRequired[BehaviorOutputTypeDef], # (1)
lastViolationValue: NotRequired[MetricValueOutputTypeDef], # (2)
violationEventAdditionalInfo: NotRequired[ViolationEventAdditionalInfoTypeDef], # (3)
verificationState: NotRequired[VerificationStateType], # (4)
verificationStateDescription: NotRequired[str],
lastViolationTime: NotRequired[datetime],
violationStartTime: NotRequired[datetime],- See BehaviorOutputTypeDef
- See MetricValueOutputTypeDef
- See ViolationEventAdditionalInfoTypeDef
- See VerificationStateType
DescribeSecurityProfileResponseTypeDef#
# DescribeSecurityProfileResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeSecurityProfileResponseTypeDef
def get_value() -> DescribeSecurityProfileResponseTypeDef:
return {
"securityProfileName": ...,
}
# DescribeSecurityProfileResponseTypeDef definition
class DescribeSecurityProfileResponseTypeDef(TypedDict):
securityProfileName: str,
securityProfileArn: str,
securityProfileDescription: str,
behaviors: List[BehaviorOutputTypeDef], # (1)
alertTargets: Dict[AlertTargetTypeType, AlertTargetTypeDef], # (2)
additionalMetricsToRetain: List[str],
additionalMetricsToRetainV2: List[MetricToRetainTypeDef], # (3)
version: int,
creationDate: datetime,
lastModifiedDate: datetime,
metricsExportConfig: MetricsExportConfigTypeDef, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See BehaviorOutputTypeDef
- See AlertTargetTypeType AlertTargetTypeDef
- See MetricToRetainTypeDef
- See MetricsExportConfigTypeDef
- See ResponseMetadataTypeDef
UpdateSecurityProfileResponseTypeDef#
# UpdateSecurityProfileResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateSecurityProfileResponseTypeDef
def get_value() -> UpdateSecurityProfileResponseTypeDef:
return {
"securityProfileName": ...,
}
# UpdateSecurityProfileResponseTypeDef definition
class UpdateSecurityProfileResponseTypeDef(TypedDict):
securityProfileName: str,
securityProfileArn: str,
securityProfileDescription: str,
behaviors: List[BehaviorOutputTypeDef], # (1)
alertTargets: Dict[AlertTargetTypeType, AlertTargetTypeDef], # (2)
additionalMetricsToRetain: List[str],
additionalMetricsToRetainV2: List[MetricToRetainTypeDef], # (3)
version: int,
creationDate: datetime,
lastModifiedDate: datetime,
metricsExportConfig: MetricsExportConfigTypeDef, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See BehaviorOutputTypeDef
- See AlertTargetTypeType AlertTargetTypeDef
- See MetricToRetainTypeDef
- See MetricsExportConfigTypeDef
- See ResponseMetadataTypeDef
ViolationEventTypeDef#
# ViolationEventTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ViolationEventTypeDef
def get_value() -> ViolationEventTypeDef:
return {
"violationId": ...,
}
# ViolationEventTypeDef definition
class ViolationEventTypeDef(TypedDict):
violationId: NotRequired[str],
thingName: NotRequired[str],
securityProfileName: NotRequired[str],
behavior: NotRequired[BehaviorOutputTypeDef], # (1)
metricValue: NotRequired[MetricValueOutputTypeDef], # (2)
violationEventAdditionalInfo: NotRequired[ViolationEventAdditionalInfoTypeDef], # (3)
violationEventType: NotRequired[ViolationEventTypeType], # (4)
verificationState: NotRequired[VerificationStateType], # (5)
verificationStateDescription: NotRequired[str],
violationEventTime: NotRequired[datetime],- See BehaviorOutputTypeDef
- See MetricValueOutputTypeDef
- See ViolationEventAdditionalInfoTypeDef
- See ViolationEventTypeType
- See VerificationStateType
CustomCodeSigningTypeDef#
# CustomCodeSigningTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CustomCodeSigningTypeDef
def get_value() -> CustomCodeSigningTypeDef:
return {
"signature": ...,
}
# CustomCodeSigningTypeDef definition
class CustomCodeSigningTypeDef(TypedDict):
signature: NotRequired[CodeSigningSignatureUnionTypeDef], # (1)
certificateChain: NotRequired[CodeSigningCertificateChainTypeDef], # (2)
hashAlgorithm: NotRequired[str],
signatureAlgorithm: NotRequired[str],- See CodeSigningSignatureTypeDef CodeSigningSignatureOutputTypeDef
- See CodeSigningCertificateChainTypeDef
CommandParameterTypeDef#
# CommandParameterTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CommandParameterTypeDef
def get_value() -> CommandParameterTypeDef:
return {
"name": ...,
}
# CommandParameterTypeDef definition
class CommandParameterTypeDef(TypedDict):
name: str,
value: NotRequired[CommandParameterValueUnionTypeDef], # (1)
defaultValue: NotRequired[CommandParameterValueUnionTypeDef], # (1)
description: NotRequired[str],- See CommandParameterValueTypeDef CommandParameterValueOutputTypeDef
- See CommandParameterValueTypeDef CommandParameterValueOutputTypeDef
StartDetectMitigationActionsTaskRequestTypeDef#
# StartDetectMitigationActionsTaskRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import StartDetectMitigationActionsTaskRequestTypeDef
def get_value() -> StartDetectMitigationActionsTaskRequestTypeDef:
return {
"taskId": ...,
}
# StartDetectMitigationActionsTaskRequestTypeDef definition
class StartDetectMitigationActionsTaskRequestTypeDef(TypedDict):
taskId: str,
target: DetectMitigationActionsTaskTargetUnionTypeDef, # (1)
actions: Sequence[str],
clientRequestToken: str,
violationEventOccurrenceRange: NotRequired[ViolationEventOccurrenceRangeUnionTypeDef], # (2)
includeOnlyActiveViolations: NotRequired[bool],
includeSuppressedAlerts: NotRequired[bool],- See DetectMitigationActionsTaskTargetTypeDef DetectMitigationActionsTaskTargetOutputTypeDef
- See ViolationEventOccurrenceRangeTypeDef ViolationEventOccurrenceRangeOutputTypeDef
CodeSigningOutputTypeDef#
# CodeSigningOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CodeSigningOutputTypeDef
def get_value() -> CodeSigningOutputTypeDef:
return {
"awsSignerJobId": ...,
}
# CodeSigningOutputTypeDef definition
class CodeSigningOutputTypeDef(TypedDict):
awsSignerJobId: NotRequired[str],
startSigningJobParameter: NotRequired[StartSigningJobParameterTypeDef], # (1)
customCodeSigning: NotRequired[CustomCodeSigningOutputTypeDef], # (2)DescribeJobTemplateResponseTypeDef#
# DescribeJobTemplateResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeJobTemplateResponseTypeDef
def get_value() -> DescribeJobTemplateResponseTypeDef:
return {
"jobTemplateArn": ...,
}
# DescribeJobTemplateResponseTypeDef definition
class DescribeJobTemplateResponseTypeDef(TypedDict):
jobTemplateArn: str,
jobTemplateId: str,
description: str,
documentSource: str,
document: str,
createdAt: datetime,
presignedUrlConfig: PresignedUrlConfigTypeDef, # (1)
jobExecutionsRolloutConfig: JobExecutionsRolloutConfigTypeDef, # (2)
abortConfig: AbortConfigOutputTypeDef, # (3)
timeoutConfig: TimeoutConfigTypeDef, # (4)
jobExecutionsRetryConfig: JobExecutionsRetryConfigOutputTypeDef, # (5)
maintenanceWindows: List[MaintenanceWindowTypeDef], # (6)
destinationPackageVersions: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (7)- See PresignedUrlConfigTypeDef
- See JobExecutionsRolloutConfigTypeDef
- See AbortConfigOutputTypeDef
- See TimeoutConfigTypeDef
- See JobExecutionsRetryConfigOutputTypeDef
- See MaintenanceWindowTypeDef
- See ResponseMetadataTypeDef
JobTypeDef#
# JobTypeDef TypedDict usage example
from types_boto3_iot.type_defs import JobTypeDef
def get_value() -> JobTypeDef:
return {
"jobArn": ...,
}
# JobTypeDef definition
class JobTypeDef(TypedDict):
jobArn: NotRequired[str],
jobId: NotRequired[str],
targetSelection: NotRequired[TargetSelectionType], # (1)
status: NotRequired[JobStatusType], # (2)
forceCanceled: NotRequired[bool],
reasonCode: NotRequired[str],
comment: NotRequired[str],
targets: NotRequired[List[str]],
description: NotRequired[str],
presignedUrlConfig: NotRequired[PresignedUrlConfigTypeDef], # (3)
jobExecutionsRolloutConfig: NotRequired[JobExecutionsRolloutConfigTypeDef], # (4)
abortConfig: NotRequired[AbortConfigOutputTypeDef], # (5)
createdAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],
completedAt: NotRequired[datetime],
jobProcessDetails: NotRequired[JobProcessDetailsTypeDef], # (6)
timeoutConfig: NotRequired[TimeoutConfigTypeDef], # (7)
namespaceId: NotRequired[str],
jobTemplateArn: NotRequired[str],
jobExecutionsRetryConfig: NotRequired[JobExecutionsRetryConfigOutputTypeDef], # (8)
documentParameters: NotRequired[Dict[str, str]],
isConcurrent: NotRequired[bool],
schedulingConfig: NotRequired[SchedulingConfigOutputTypeDef], # (9)
scheduledJobRollouts: NotRequired[List[ScheduledJobRolloutTypeDef]], # (10)
destinationPackageVersions: NotRequired[List[str]],- See TargetSelectionType
- See JobStatusType
- See PresignedUrlConfigTypeDef
- See JobExecutionsRolloutConfigTypeDef
- See AbortConfigOutputTypeDef
- See JobProcessDetailsTypeDef
- See TimeoutConfigTypeDef
- See JobExecutionsRetryConfigOutputTypeDef
- See SchedulingConfigOutputTypeDef
- See ScheduledJobRolloutTypeDef
DescribeStreamResponseTypeDef#
# DescribeStreamResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeStreamResponseTypeDef
def get_value() -> DescribeStreamResponseTypeDef:
return {
"streamInfo": ...,
}
# DescribeStreamResponseTypeDef definition
class DescribeStreamResponseTypeDef(TypedDict):
streamInfo: StreamInfoTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetIndexingConfigurationResponseTypeDef#
# GetIndexingConfigurationResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetIndexingConfigurationResponseTypeDef
def get_value() -> GetIndexingConfigurationResponseTypeDef:
return {
"thingIndexingConfiguration": ...,
}
# GetIndexingConfigurationResponseTypeDef definition
class GetIndexingConfigurationResponseTypeDef(TypedDict):
thingIndexingConfiguration: ThingIndexingConfigurationOutputTypeDef, # (1)
thingGroupIndexingConfiguration: ThingGroupIndexingConfigurationOutputTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)- See ThingIndexingConfigurationOutputTypeDef
- See ThingGroupIndexingConfigurationOutputTypeDef
- See ResponseMetadataTypeDef
CreateJobRequestTypeDef#
# CreateJobRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateJobRequestTypeDef
def get_value() -> CreateJobRequestTypeDef:
return {
"jobId": ...,
}
# CreateJobRequestTypeDef definition
class CreateJobRequestTypeDef(TypedDict):
jobId: str,
targets: Sequence[str],
documentSource: NotRequired[str],
document: NotRequired[str],
description: NotRequired[str],
presignedUrlConfig: NotRequired[PresignedUrlConfigTypeDef], # (1)
targetSelection: NotRequired[TargetSelectionType], # (2)
jobExecutionsRolloutConfig: NotRequired[JobExecutionsRolloutConfigTypeDef], # (3)
abortConfig: NotRequired[AbortConfigUnionTypeDef], # (4)
timeoutConfig: NotRequired[TimeoutConfigTypeDef], # (5)
tags: NotRequired[Sequence[TagTypeDef]], # (6)
namespaceId: NotRequired[str],
jobTemplateArn: NotRequired[str],
jobExecutionsRetryConfig: NotRequired[JobExecutionsRetryConfigUnionTypeDef], # (7)
documentParameters: NotRequired[Mapping[str, str]],
schedulingConfig: NotRequired[SchedulingConfigUnionTypeDef], # (8)
destinationPackageVersions: NotRequired[Sequence[str]],- See PresignedUrlConfigTypeDef
- See TargetSelectionType
- See JobExecutionsRolloutConfigTypeDef
- See AbortConfigTypeDef AbortConfigOutputTypeDef
- See TimeoutConfigTypeDef
- See TagTypeDef
- See JobExecutionsRetryConfigTypeDef JobExecutionsRetryConfigOutputTypeDef
- See SchedulingConfigTypeDef SchedulingConfigOutputTypeDef
CreateJobTemplateRequestTypeDef#
# CreateJobTemplateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateJobTemplateRequestTypeDef
def get_value() -> CreateJobTemplateRequestTypeDef:
return {
"jobTemplateId": ...,
}
# CreateJobTemplateRequestTypeDef definition
class CreateJobTemplateRequestTypeDef(TypedDict):
jobTemplateId: str,
description: str,
jobArn: NotRequired[str],
documentSource: NotRequired[str],
document: NotRequired[str],
presignedUrlConfig: NotRequired[PresignedUrlConfigTypeDef], # (1)
jobExecutionsRolloutConfig: NotRequired[JobExecutionsRolloutConfigTypeDef], # (2)
abortConfig: NotRequired[AbortConfigUnionTypeDef], # (3)
timeoutConfig: NotRequired[TimeoutConfigTypeDef], # (4)
tags: NotRequired[Sequence[TagTypeDef]], # (5)
jobExecutionsRetryConfig: NotRequired[JobExecutionsRetryConfigUnionTypeDef], # (6)
maintenanceWindows: NotRequired[Sequence[MaintenanceWindowTypeDef]], # (7)
destinationPackageVersions: NotRequired[Sequence[str]],- See PresignedUrlConfigTypeDef
- See JobExecutionsRolloutConfigTypeDef
- See AbortConfigTypeDef AbortConfigOutputTypeDef
- See TimeoutConfigTypeDef
- See TagTypeDef
- See JobExecutionsRetryConfigTypeDef JobExecutionsRetryConfigOutputTypeDef
- See MaintenanceWindowTypeDef
UpdateJobRequestTypeDef#
# UpdateJobRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateJobRequestTypeDef
def get_value() -> UpdateJobRequestTypeDef:
return {
"jobId": ...,
}
# UpdateJobRequestTypeDef definition
class UpdateJobRequestTypeDef(TypedDict):
jobId: str,
description: NotRequired[str],
presignedUrlConfig: NotRequired[PresignedUrlConfigTypeDef], # (1)
jobExecutionsRolloutConfig: NotRequired[JobExecutionsRolloutConfigTypeDef], # (2)
abortConfig: NotRequired[AbortConfigUnionTypeDef], # (3)
timeoutConfig: NotRequired[TimeoutConfigTypeDef], # (4)
namespaceId: NotRequired[str],
jobExecutionsRetryConfig: NotRequired[JobExecutionsRetryConfigUnionTypeDef], # (5)- See PresignedUrlConfigTypeDef
- See JobExecutionsRolloutConfigTypeDef
- See AbortConfigTypeDef AbortConfigOutputTypeDef
- See TimeoutConfigTypeDef
- See JobExecutionsRetryConfigTypeDef JobExecutionsRetryConfigOutputTypeDef
DescribeAuditMitigationActionsTaskResponseTypeDef#
# DescribeAuditMitigationActionsTaskResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeAuditMitigationActionsTaskResponseTypeDef
def get_value() -> DescribeAuditMitigationActionsTaskResponseTypeDef:
return {
"taskStatus": ...,
}
# DescribeAuditMitigationActionsTaskResponseTypeDef definition
class DescribeAuditMitigationActionsTaskResponseTypeDef(TypedDict):
taskStatus: AuditMitigationActionsTaskStatusType, # (1)
startTime: datetime,
endTime: datetime,
taskStatistics: Dict[str, TaskStatisticsForAuditCheckTypeDef], # (2)
target: AuditMitigationActionsTaskTargetOutputTypeDef, # (3)
auditCheckToActionsMapping: Dict[str, List[str]],
actionsDefinition: List[MitigationActionTypeDef], # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See AuditMitigationActionsTaskStatusType
- See TaskStatisticsForAuditCheckTypeDef
- See AuditMitigationActionsTaskTargetOutputTypeDef
- See MitigationActionTypeDef
- See ResponseMetadataTypeDef
DetectMitigationActionsTaskSummaryTypeDef#
# DetectMitigationActionsTaskSummaryTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DetectMitigationActionsTaskSummaryTypeDef
def get_value() -> DetectMitigationActionsTaskSummaryTypeDef:
return {
"taskId": ...,
}
# DetectMitigationActionsTaskSummaryTypeDef definition
class DetectMitigationActionsTaskSummaryTypeDef(TypedDict):
taskId: NotRequired[str],
taskStatus: NotRequired[DetectMitigationActionsTaskStatusType], # (1)
taskStartTime: NotRequired[datetime],
taskEndTime: NotRequired[datetime],
target: NotRequired[DetectMitigationActionsTaskTargetOutputTypeDef], # (2)
violationEventOccurrenceRange: NotRequired[ViolationEventOccurrenceRangeOutputTypeDef], # (3)
onlyActiveViolationsIncluded: NotRequired[bool],
suppressedAlertsIncluded: NotRequired[bool],
actionsDefinition: NotRequired[List[MitigationActionTypeDef]], # (4)
taskStatistics: NotRequired[DetectMitigationActionsTaskStatisticsTypeDef], # (5)- See DetectMitigationActionsTaskStatusType
- See DetectMitigationActionsTaskTargetOutputTypeDef
- See ViolationEventOccurrenceRangeOutputTypeDef
- See MitigationActionTypeDef
- See DetectMitigationActionsTaskStatisticsTypeDef
CreateMitigationActionRequestTypeDef#
# CreateMitigationActionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateMitigationActionRequestTypeDef
def get_value() -> CreateMitigationActionRequestTypeDef:
return {
"actionName": ...,
}
# CreateMitigationActionRequestTypeDef definition
class CreateMitigationActionRequestTypeDef(TypedDict):
actionName: str,
roleArn: str,
actionParams: MitigationActionParamsUnionTypeDef, # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)UpdateMitigationActionRequestTypeDef#
# UpdateMitigationActionRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateMitigationActionRequestTypeDef
def get_value() -> UpdateMitigationActionRequestTypeDef:
return {
"actionName": ...,
}
# UpdateMitigationActionRequestTypeDef definition
class UpdateMitigationActionRequestTypeDef(TypedDict):
actionName: str,
roleArn: NotRequired[str],
actionParams: NotRequired[MitigationActionParamsUnionTypeDef], # (1)DescribeThingTypeResponseTypeDef#
# DescribeThingTypeResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeThingTypeResponseTypeDef
def get_value() -> DescribeThingTypeResponseTypeDef:
return {
"thingTypeName": ...,
}
# DescribeThingTypeResponseTypeDef definition
class DescribeThingTypeResponseTypeDef(TypedDict):
thingTypeName: str,
thingTypeId: str,
thingTypeArn: str,
thingTypeProperties: ThingTypePropertiesOutputTypeDef, # (1)
thingTypeMetadata: ThingTypeMetadataTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)ThingTypeDefinitionTypeDef#
# ThingTypeDefinitionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ThingTypeDefinitionTypeDef
def get_value() -> ThingTypeDefinitionTypeDef:
return {
"thingTypeName": ...,
}
# ThingTypeDefinitionTypeDef definition
class ThingTypeDefinitionTypeDef(TypedDict):
thingTypeName: NotRequired[str],
thingTypeArn: NotRequired[str],
thingTypeProperties: NotRequired[ThingTypePropertiesOutputTypeDef], # (1)
thingTypeMetadata: NotRequired[ThingTypeMetadataTypeDef], # (2)RepublishActionTypeDef#
# RepublishActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import RepublishActionTypeDef
def get_value() -> RepublishActionTypeDef:
return {
"roleArn": ...,
}
# RepublishActionTypeDef definition
class RepublishActionTypeDef(TypedDict):
roleArn: str,
topic: str,
qos: NotRequired[int],
headers: NotRequired[MqttHeadersUnionTypeDef], # (1)ListAuditSuppressionsResponseTypeDef#
# ListAuditSuppressionsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuditSuppressionsResponseTypeDef
def get_value() -> ListAuditSuppressionsResponseTypeDef:
return {
"suppressions": ...,
}
# ListAuditSuppressionsResponseTypeDef definition
class ListAuditSuppressionsResponseTypeDef(TypedDict):
suppressions: List[AuditSuppressionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],AuditFindingTypeDef#
# AuditFindingTypeDef TypedDict usage example
from types_boto3_iot.type_defs import AuditFindingTypeDef
def get_value() -> AuditFindingTypeDef:
return {
"findingId": ...,
}
# AuditFindingTypeDef definition
class AuditFindingTypeDef(TypedDict):
findingId: NotRequired[str],
taskId: NotRequired[str],
checkName: NotRequired[str],
taskStartTime: NotRequired[datetime],
findingTime: NotRequired[datetime],
severity: NotRequired[AuditFindingSeverityType], # (1)
nonCompliantResource: NotRequired[NonCompliantResourceTypeDef], # (2)
relatedResources: NotRequired[List[RelatedResourceTypeDef]], # (3)
reasonForNonCompliance: NotRequired[str],
reasonForNonComplianceCode: NotRequired[str],
isSuppressed: NotRequired[bool],ListRelatedResourcesForAuditFindingResponseTypeDef#
# ListRelatedResourcesForAuditFindingResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListRelatedResourcesForAuditFindingResponseTypeDef
def get_value() -> ListRelatedResourcesForAuditFindingResponseTypeDef:
return {
"relatedResources": ...,
}
# ListRelatedResourcesForAuditFindingResponseTypeDef definition
class ListRelatedResourcesForAuditFindingResponseTypeDef(TypedDict):
relatedResources: List[RelatedResourceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],TestAuthorizationResponseTypeDef#
# TestAuthorizationResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TestAuthorizationResponseTypeDef
def get_value() -> TestAuthorizationResponseTypeDef:
return {
"authResults": ...,
}
# TestAuthorizationResponseTypeDef definition
class TestAuthorizationResponseTypeDef(TypedDict):
authResults: List[AuthResultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ActionOutputTypeDef#
# ActionOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ActionOutputTypeDef
def get_value() -> ActionOutputTypeDef:
return {
"dynamoDB": ...,
}
# ActionOutputTypeDef definition
class ActionOutputTypeDef(TypedDict):
dynamoDB: NotRequired[DynamoDBActionTypeDef], # (1)
dynamoDBv2: NotRequired[DynamoDBv2ActionTypeDef], # (2)
lambda: NotRequired[LambdaActionTypeDef], # (3)
sns: NotRequired[SnsActionTypeDef], # (4)
sqs: NotRequired[SqsActionTypeDef], # (5)
kinesis: NotRequired[KinesisActionTypeDef], # (6)
republish: NotRequired[RepublishActionOutputTypeDef], # (7)
s3: NotRequired[S3ActionTypeDef], # (8)
firehose: NotRequired[FirehoseActionTypeDef], # (9)
cloudwatchMetric: NotRequired[CloudwatchMetricActionTypeDef], # (10)
cloudwatchAlarm: NotRequired[CloudwatchAlarmActionTypeDef], # (11)
cloudwatchLogs: NotRequired[CloudwatchLogsActionTypeDef], # (12)
elasticsearch: NotRequired[ElasticsearchActionTypeDef], # (13)
salesforce: NotRequired[SalesforceActionTypeDef], # (14)
iotAnalytics: NotRequired[IotAnalyticsActionTypeDef], # (15)
iotEvents: NotRequired[IotEventsActionTypeDef], # (16)
iotSiteWise: NotRequired[IotSiteWiseActionOutputTypeDef], # (17)
stepFunctions: NotRequired[StepFunctionsActionTypeDef], # (18)
timestream: NotRequired[TimestreamActionOutputTypeDef], # (19)
http: NotRequired[HttpActionOutputTypeDef], # (20)
kafka: NotRequired[KafkaActionOutputTypeDef], # (21)
openSearch: NotRequired[OpenSearchActionTypeDef], # (22)
location: NotRequired[LocationActionTypeDef], # (23)- See DynamoDBActionTypeDef
- See DynamoDBv2ActionTypeDef
- See LambdaActionTypeDef
- See SnsActionTypeDef
- See SqsActionTypeDef
- See KinesisActionTypeDef
- See RepublishActionOutputTypeDef
- See S3ActionTypeDef
- See FirehoseActionTypeDef
- See CloudwatchMetricActionTypeDef
- See CloudwatchAlarmActionTypeDef
- See CloudwatchLogsActionTypeDef
- See ElasticsearchActionTypeDef
- See SalesforceActionTypeDef
- See IotAnalyticsActionTypeDef
- See IotEventsActionTypeDef
- See IotSiteWiseActionOutputTypeDef
- See StepFunctionsActionTypeDef
- See TimestreamActionOutputTypeDef
- See HttpActionOutputTypeDef
- See KafkaActionOutputTypeDef
- See OpenSearchActionTypeDef
- See LocationActionTypeDef
IotSiteWiseActionTypeDef#
# IotSiteWiseActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import IotSiteWiseActionTypeDef
def get_value() -> IotSiteWiseActionTypeDef:
return {
"putAssetPropertyValueEntries": ...,
}
# IotSiteWiseActionTypeDef definition
class IotSiteWiseActionTypeDef(TypedDict):
putAssetPropertyValueEntries: Sequence[PutAssetPropertyValueEntryUnionTypeDef], # (1)
roleArn: str,ListActiveViolationsResponseTypeDef#
# ListActiveViolationsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListActiveViolationsResponseTypeDef
def get_value() -> ListActiveViolationsResponseTypeDef:
return {
"activeViolations": ...,
}
# ListActiveViolationsResponseTypeDef definition
class ListActiveViolationsResponseTypeDef(TypedDict):
activeViolations: List[ActiveViolationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListViolationEventsResponseTypeDef#
# ListViolationEventsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListViolationEventsResponseTypeDef
def get_value() -> ListViolationEventsResponseTypeDef:
return {
"violationEvents": ...,
}
# ListViolationEventsResponseTypeDef definition
class ListViolationEventsResponseTypeDef(TypedDict):
violationEvents: List[ViolationEventTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],OTAUpdateFileOutputTypeDef#
# OTAUpdateFileOutputTypeDef TypedDict usage example
from types_boto3_iot.type_defs import OTAUpdateFileOutputTypeDef
def get_value() -> OTAUpdateFileOutputTypeDef:
return {
"fileName": ...,
}
# OTAUpdateFileOutputTypeDef definition
class OTAUpdateFileOutputTypeDef(TypedDict):
fileName: NotRequired[str],
fileType: NotRequired[int],
fileVersion: NotRequired[str],
fileLocation: NotRequired[FileLocationTypeDef], # (1)
codeSigning: NotRequired[CodeSigningOutputTypeDef], # (2)
attributes: NotRequired[Dict[str, str]],DescribeJobResponseTypeDef#
# DescribeJobResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeJobResponseTypeDef
def get_value() -> DescribeJobResponseTypeDef:
return {
"documentSource": ...,
}
# DescribeJobResponseTypeDef definition
class DescribeJobResponseTypeDef(TypedDict):
documentSource: str,
job: JobTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See JobTypeDef
- See ResponseMetadataTypeDef
UpdateIndexingConfigurationRequestTypeDef#
# UpdateIndexingConfigurationRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateIndexingConfigurationRequestTypeDef
def get_value() -> UpdateIndexingConfigurationRequestTypeDef:
return {
"thingIndexingConfiguration": ...,
}
# UpdateIndexingConfigurationRequestTypeDef definition
class UpdateIndexingConfigurationRequestTypeDef(TypedDict):
thingIndexingConfiguration: NotRequired[ThingIndexingConfigurationUnionTypeDef], # (1)
thingGroupIndexingConfiguration: NotRequired[ThingGroupIndexingConfigurationUnionTypeDef], # (2)- See ThingIndexingConfigurationTypeDef ThingIndexingConfigurationOutputTypeDef
- See ThingGroupIndexingConfigurationTypeDef ThingGroupIndexingConfigurationOutputTypeDef
BehaviorTypeDef#
# BehaviorTypeDef TypedDict usage example
from types_boto3_iot.type_defs import BehaviorTypeDef
def get_value() -> BehaviorTypeDef:
return {
"name": ...,
}
# BehaviorTypeDef definition
class BehaviorTypeDef(TypedDict):
name: str,
metric: NotRequired[str],
metricDimension: NotRequired[MetricDimensionTypeDef], # (1)
criteria: NotRequired[BehaviorCriteriaUnionTypeDef], # (2)
suppressAlerts: NotRequired[bool],
exportMetric: NotRequired[bool],DescribeDetectMitigationActionsTaskResponseTypeDef#
# DescribeDetectMitigationActionsTaskResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeDetectMitigationActionsTaskResponseTypeDef
def get_value() -> DescribeDetectMitigationActionsTaskResponseTypeDef:
return {
"taskSummary": ...,
}
# DescribeDetectMitigationActionsTaskResponseTypeDef definition
class DescribeDetectMitigationActionsTaskResponseTypeDef(TypedDict):
taskSummary: DetectMitigationActionsTaskSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListDetectMitigationActionsTasksResponseTypeDef#
# ListDetectMitigationActionsTasksResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListDetectMitigationActionsTasksResponseTypeDef
def get_value() -> ListDetectMitigationActionsTasksResponseTypeDef:
return {
"tasks": ...,
}
# ListDetectMitigationActionsTasksResponseTypeDef definition
class ListDetectMitigationActionsTasksResponseTypeDef(TypedDict):
tasks: List[DetectMitigationActionsTaskSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListThingTypesResponseTypeDef#
# ListThingTypesResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListThingTypesResponseTypeDef
def get_value() -> ListThingTypesResponseTypeDef:
return {
"thingTypes": ...,
}
# ListThingTypesResponseTypeDef definition
class ListThingTypesResponseTypeDef(TypedDict):
thingTypes: List[ThingTypeDefinitionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],CreateThingTypeRequestTypeDef#
# CreateThingTypeRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateThingTypeRequestTypeDef
def get_value() -> CreateThingTypeRequestTypeDef:
return {
"thingTypeName": ...,
}
# CreateThingTypeRequestTypeDef definition
class CreateThingTypeRequestTypeDef(TypedDict):
thingTypeName: str,
thingTypeProperties: NotRequired[ThingTypePropertiesUnionTypeDef], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)UpdateThingTypeRequestTypeDef#
# UpdateThingTypeRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateThingTypeRequestTypeDef
def get_value() -> UpdateThingTypeRequestTypeDef:
return {
"thingTypeName": ...,
}
# UpdateThingTypeRequestTypeDef definition
class UpdateThingTypeRequestTypeDef(TypedDict):
thingTypeName: str,
thingTypeProperties: NotRequired[ThingTypePropertiesUnionTypeDef], # (1)DescribeAuditFindingResponseTypeDef#
# DescribeAuditFindingResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import DescribeAuditFindingResponseTypeDef
def get_value() -> DescribeAuditFindingResponseTypeDef:
return {
"finding": ...,
}
# DescribeAuditFindingResponseTypeDef definition
class DescribeAuditFindingResponseTypeDef(TypedDict):
finding: AuditFindingTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ListAuditFindingsResponseTypeDef#
# ListAuditFindingsResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ListAuditFindingsResponseTypeDef
def get_value() -> ListAuditFindingsResponseTypeDef:
return {
"findings": ...,
}
# ListAuditFindingsResponseTypeDef definition
class ListAuditFindingsResponseTypeDef(TypedDict):
findings: List[AuditFindingTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],TopicRuleTypeDef#
# TopicRuleTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TopicRuleTypeDef
def get_value() -> TopicRuleTypeDef:
return {
"ruleName": ...,
}
# TopicRuleTypeDef definition
class TopicRuleTypeDef(TypedDict):
ruleName: NotRequired[str],
sql: NotRequired[str],
description: NotRequired[str],
createdAt: NotRequired[datetime],
actions: NotRequired[List[ActionOutputTypeDef]], # (1)
ruleDisabled: NotRequired[bool],
awsIotSqlVersion: NotRequired[str],
errorAction: NotRequired[ActionOutputTypeDef], # (2)CodeSigningTypeDef#
# CodeSigningTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CodeSigningTypeDef
def get_value() -> CodeSigningTypeDef:
return {
"awsSignerJobId": ...,
}
# CodeSigningTypeDef definition
class CodeSigningTypeDef(TypedDict):
awsSignerJobId: NotRequired[str],
startSigningJobParameter: NotRequired[StartSigningJobParameterTypeDef], # (1)
customCodeSigning: NotRequired[CustomCodeSigningUnionTypeDef], # (2)CreateCommandRequestTypeDef#
# CreateCommandRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateCommandRequestTypeDef
def get_value() -> CreateCommandRequestTypeDef:
return {
"commandId": ...,
}
# CreateCommandRequestTypeDef definition
class CreateCommandRequestTypeDef(TypedDict):
commandId: str,
namespace: NotRequired[CommandNamespaceType], # (1)
displayName: NotRequired[str],
description: NotRequired[str],
payload: NotRequired[CommandPayloadUnionTypeDef], # (2)
mandatoryParameters: NotRequired[Sequence[CommandParameterUnionTypeDef]], # (3)
roleArn: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (4)- See CommandNamespaceType
- See CommandPayloadTypeDef CommandPayloadOutputTypeDef
- See CommandParameterTypeDef CommandParameterOutputTypeDef
- See TagTypeDef
OTAUpdateInfoTypeDef#
# OTAUpdateInfoTypeDef TypedDict usage example
from types_boto3_iot.type_defs import OTAUpdateInfoTypeDef
def get_value() -> OTAUpdateInfoTypeDef:
return {
"otaUpdateId": ...,
}
# OTAUpdateInfoTypeDef definition
class OTAUpdateInfoTypeDef(TypedDict):
otaUpdateId: NotRequired[str],
otaUpdateArn: NotRequired[str],
creationDate: NotRequired[datetime],
lastModifiedDate: NotRequired[datetime],
description: NotRequired[str],
targets: NotRequired[List[str]],
protocols: NotRequired[List[ProtocolType]], # (1)
awsJobExecutionsRolloutConfig: NotRequired[AwsJobExecutionsRolloutConfigTypeDef], # (2)
awsJobPresignedUrlConfig: NotRequired[AwsJobPresignedUrlConfigTypeDef], # (3)
targetSelection: NotRequired[TargetSelectionType], # (4)
otaUpdateFiles: NotRequired[List[OTAUpdateFileOutputTypeDef]], # (5)
otaUpdateStatus: NotRequired[OTAUpdateStatusType], # (6)
awsIotJobId: NotRequired[str],
awsIotJobArn: NotRequired[str],
errorInfo: NotRequired[ErrorInfoTypeDef], # (7)
additionalParameters: NotRequired[Dict[str, str]],- See ProtocolType
- See AwsJobExecutionsRolloutConfigTypeDef
- See AwsJobPresignedUrlConfigTypeDef
- See TargetSelectionType
- See OTAUpdateFileOutputTypeDef
- See OTAUpdateStatusType
- See ErrorInfoTypeDef
GetTopicRuleResponseTypeDef#
# GetTopicRuleResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetTopicRuleResponseTypeDef
def get_value() -> GetTopicRuleResponseTypeDef:
return {
"ruleArn": ...,
}
# GetTopicRuleResponseTypeDef definition
class GetTopicRuleResponseTypeDef(TypedDict):
ruleArn: str,
rule: TopicRuleTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)ActionTypeDef#
# ActionTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ActionTypeDef
def get_value() -> ActionTypeDef:
return {
"dynamoDB": ...,
}
# ActionTypeDef definition
class ActionTypeDef(TypedDict):
dynamoDB: NotRequired[DynamoDBActionTypeDef], # (1)
dynamoDBv2: NotRequired[DynamoDBv2ActionTypeDef], # (2)
lambda: NotRequired[LambdaActionTypeDef], # (3)
sns: NotRequired[SnsActionTypeDef], # (4)
sqs: NotRequired[SqsActionTypeDef], # (5)
kinesis: NotRequired[KinesisActionTypeDef], # (6)
republish: NotRequired[RepublishActionUnionTypeDef], # (7)
s3: NotRequired[S3ActionTypeDef], # (8)
firehose: NotRequired[FirehoseActionTypeDef], # (9)
cloudwatchMetric: NotRequired[CloudwatchMetricActionTypeDef], # (10)
cloudwatchAlarm: NotRequired[CloudwatchAlarmActionTypeDef], # (11)
cloudwatchLogs: NotRequired[CloudwatchLogsActionTypeDef], # (12)
elasticsearch: NotRequired[ElasticsearchActionTypeDef], # (13)
salesforce: NotRequired[SalesforceActionTypeDef], # (14)
iotAnalytics: NotRequired[IotAnalyticsActionTypeDef], # (15)
iotEvents: NotRequired[IotEventsActionTypeDef], # (16)
iotSiteWise: NotRequired[IotSiteWiseActionUnionTypeDef], # (17)
stepFunctions: NotRequired[StepFunctionsActionTypeDef], # (18)
timestream: NotRequired[TimestreamActionUnionTypeDef], # (19)
http: NotRequired[HttpActionUnionTypeDef], # (20)
kafka: NotRequired[KafkaActionUnionTypeDef], # (21)
openSearch: NotRequired[OpenSearchActionTypeDef], # (22)
location: NotRequired[LocationActionTypeDef], # (23)- See DynamoDBActionTypeDef
- See DynamoDBv2ActionTypeDef
- See LambdaActionTypeDef
- See SnsActionTypeDef
- See SqsActionTypeDef
- See KinesisActionTypeDef
- See RepublishActionTypeDef RepublishActionOutputTypeDef
- See S3ActionTypeDef
- See FirehoseActionTypeDef
- See CloudwatchMetricActionTypeDef
- See CloudwatchAlarmActionTypeDef
- See CloudwatchLogsActionTypeDef
- See ElasticsearchActionTypeDef
- See SalesforceActionTypeDef
- See IotAnalyticsActionTypeDef
- See IotEventsActionTypeDef
- See IotSiteWiseActionTypeDef IotSiteWiseActionOutputTypeDef
- See StepFunctionsActionTypeDef
- See TimestreamActionTypeDef TimestreamActionOutputTypeDef
- See HttpActionTypeDef HttpActionOutputTypeDef
- See KafkaActionTypeDef KafkaActionOutputTypeDef
- See OpenSearchActionTypeDef
- See LocationActionTypeDef
GetOTAUpdateResponseTypeDef#
# GetOTAUpdateResponseTypeDef TypedDict usage example
from types_boto3_iot.type_defs import GetOTAUpdateResponseTypeDef
def get_value() -> GetOTAUpdateResponseTypeDef:
return {
"otaUpdateInfo": ...,
}
# GetOTAUpdateResponseTypeDef definition
class GetOTAUpdateResponseTypeDef(TypedDict):
otaUpdateInfo: OTAUpdateInfoTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateSecurityProfileRequestTypeDef#
# CreateSecurityProfileRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateSecurityProfileRequestTypeDef
def get_value() -> CreateSecurityProfileRequestTypeDef:
return {
"securityProfileName": ...,
}
# CreateSecurityProfileRequestTypeDef definition
class CreateSecurityProfileRequestTypeDef(TypedDict):
securityProfileName: str,
securityProfileDescription: NotRequired[str],
behaviors: NotRequired[Sequence[BehaviorUnionTypeDef]], # (1)
alertTargets: NotRequired[Mapping[AlertTargetTypeType, AlertTargetTypeDef]], # (2)
additionalMetricsToRetain: NotRequired[Sequence[str]],
additionalMetricsToRetainV2: NotRequired[Sequence[MetricToRetainTypeDef]], # (3)
tags: NotRequired[Sequence[TagTypeDef]], # (4)
metricsExportConfig: NotRequired[MetricsExportConfigTypeDef], # (5)- See BehaviorTypeDef BehaviorOutputTypeDef
- See AlertTargetTypeType AlertTargetTypeDef
- See MetricToRetainTypeDef
- See TagTypeDef
- See MetricsExportConfigTypeDef
UpdateSecurityProfileRequestTypeDef#
# UpdateSecurityProfileRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import UpdateSecurityProfileRequestTypeDef
def get_value() -> UpdateSecurityProfileRequestTypeDef:
return {
"securityProfileName": ...,
}
# UpdateSecurityProfileRequestTypeDef definition
class UpdateSecurityProfileRequestTypeDef(TypedDict):
securityProfileName: str,
securityProfileDescription: NotRequired[str],
behaviors: NotRequired[Sequence[BehaviorUnionTypeDef]], # (1)
alertTargets: NotRequired[Mapping[AlertTargetTypeType, AlertTargetTypeDef]], # (2)
additionalMetricsToRetain: NotRequired[Sequence[str]],
additionalMetricsToRetainV2: NotRequired[Sequence[MetricToRetainTypeDef]], # (3)
deleteBehaviors: NotRequired[bool],
deleteAlertTargets: NotRequired[bool],
deleteAdditionalMetricsToRetain: NotRequired[bool],
expectedVersion: NotRequired[int],
metricsExportConfig: NotRequired[MetricsExportConfigTypeDef], # (4)
deleteMetricsExportConfig: NotRequired[bool],- See BehaviorTypeDef BehaviorOutputTypeDef
- See AlertTargetTypeType AlertTargetTypeDef
- See MetricToRetainTypeDef
- See MetricsExportConfigTypeDef
ValidateSecurityProfileBehaviorsRequestTypeDef#
# ValidateSecurityProfileBehaviorsRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ValidateSecurityProfileBehaviorsRequestTypeDef
def get_value() -> ValidateSecurityProfileBehaviorsRequestTypeDef:
return {
"behaviors": ...,
}
# ValidateSecurityProfileBehaviorsRequestTypeDef definition
class ValidateSecurityProfileBehaviorsRequestTypeDef(TypedDict):
behaviors: Sequence[BehaviorUnionTypeDef], # (1)OTAUpdateFileTypeDef#
# OTAUpdateFileTypeDef TypedDict usage example
from types_boto3_iot.type_defs import OTAUpdateFileTypeDef
def get_value() -> OTAUpdateFileTypeDef:
return {
"fileName": ...,
}
# OTAUpdateFileTypeDef definition
class OTAUpdateFileTypeDef(TypedDict):
fileName: NotRequired[str],
fileType: NotRequired[int],
fileVersion: NotRequired[str],
fileLocation: NotRequired[FileLocationTypeDef], # (1)
codeSigning: NotRequired[CodeSigningUnionTypeDef], # (2)
attributes: NotRequired[Mapping[str, str]],TopicRulePayloadTypeDef#
# TopicRulePayloadTypeDef TypedDict usage example
from types_boto3_iot.type_defs import TopicRulePayloadTypeDef
def get_value() -> TopicRulePayloadTypeDef:
return {
"sql": ...,
}
# TopicRulePayloadTypeDef definition
class TopicRulePayloadTypeDef(TypedDict):
sql: str,
actions: Sequence[ActionUnionTypeDef], # (1)
description: NotRequired[str],
ruleDisabled: NotRequired[bool],
awsIotSqlVersion: NotRequired[str],
errorAction: NotRequired[ActionUnionTypeDef], # (2)CreateTopicRuleRequestTypeDef#
# CreateTopicRuleRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateTopicRuleRequestTypeDef
def get_value() -> CreateTopicRuleRequestTypeDef:
return {
"ruleName": ...,
}
# CreateTopicRuleRequestTypeDef definition
class CreateTopicRuleRequestTypeDef(TypedDict):
ruleName: str,
topicRulePayload: TopicRulePayloadTypeDef, # (1)
tags: NotRequired[str],ReplaceTopicRuleRequestTypeDef#
# ReplaceTopicRuleRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import ReplaceTopicRuleRequestTypeDef
def get_value() -> ReplaceTopicRuleRequestTypeDef:
return {
"ruleName": ...,
}
# ReplaceTopicRuleRequestTypeDef definition
class ReplaceTopicRuleRequestTypeDef(TypedDict):
ruleName: str,
topicRulePayload: TopicRulePayloadTypeDef, # (1)CreateOTAUpdateRequestTypeDef#
# CreateOTAUpdateRequestTypeDef TypedDict usage example
from types_boto3_iot.type_defs import CreateOTAUpdateRequestTypeDef
def get_value() -> CreateOTAUpdateRequestTypeDef:
return {
"otaUpdateId": ...,
}
# CreateOTAUpdateRequestTypeDef definition
class CreateOTAUpdateRequestTypeDef(TypedDict):
otaUpdateId: str,
targets: Sequence[str],
files: Sequence[OTAUpdateFileUnionTypeDef], # (1)
roleArn: str,
description: NotRequired[str],
protocols: NotRequired[Sequence[ProtocolType]], # (2)
targetSelection: NotRequired[TargetSelectionType], # (3)
awsJobExecutionsRolloutConfig: NotRequired[AwsJobExecutionsRolloutConfigTypeDef], # (4)
awsJobPresignedUrlConfig: NotRequired[AwsJobPresignedUrlConfigTypeDef], # (5)
awsJobAbortConfig: NotRequired[AwsJobAbortConfigTypeDef], # (6)
awsJobTimeoutConfig: NotRequired[AwsJobTimeoutConfigTypeDef], # (7)
additionalParameters: NotRequired[Mapping[str, str]],
tags: NotRequired[Sequence[TagTypeDef]], # (8)