Skip to content

Typed dictionaries

Index > IoT > Typed dictionaries

Auto-generated documentation for IoT type annotations stubs module mypy-boto3-iot.

AbortCriteriaTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AbortCriteriaTypeDef

def get_value() -> AbortCriteriaTypeDef:
    return {
        "failureType": ...,
        "action": ...,
        "thresholdPercentage": ...,
        "minNumberOfExecutedThings": ...,
    }
Definition
class AbortCriteriaTypeDef(TypedDict):
    failureType: JobExecutionFailureTypeType,  # (1)
    action: AbortActionType,  # (2)
    thresholdPercentage: float,
    minNumberOfExecutedThings: int,
  1. See JobExecutionFailureTypeType
  2. See AbortActionType

AcceptCertificateTransferRequestRequestTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AcceptCertificateTransferRequestRequestTypeDef

def get_value() -> AcceptCertificateTransferRequestRequestTypeDef:
    return {
        "certificateId": ...,
    }
Definition
class AcceptCertificateTransferRequestRequestTypeDef(TypedDict):
    certificateId: str,
    setAsActive: NotRequired[bool],

CloudwatchAlarmActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import CloudwatchAlarmActionTypeDef

def get_value() -> CloudwatchAlarmActionTypeDef:
    return {
        "roleArn": ...,
        "alarmName": ...,
        "stateReason": ...,
        "stateValue": ...,
    }
Definition
class CloudwatchAlarmActionTypeDef(TypedDict):
    roleArn: str,
    alarmName: str,
    stateReason: str,
    stateValue: str,

CloudwatchLogsActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import CloudwatchLogsActionTypeDef

def get_value() -> CloudwatchLogsActionTypeDef:
    return {
        "roleArn": ...,
        "logGroupName": ...,
    }
Definition
class CloudwatchLogsActionTypeDef(TypedDict):
    roleArn: str,
    logGroupName: str,
    batchMode: NotRequired[bool],

CloudwatchMetricActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import CloudwatchMetricActionTypeDef

def get_value() -> CloudwatchMetricActionTypeDef:
    return {
        "roleArn": ...,
        "metricNamespace": ...,
        "metricName": ...,
        "metricValue": ...,
        "metricUnit": ...,
    }
Definition
class CloudwatchMetricActionTypeDef(TypedDict):
    roleArn: str,
    metricNamespace: str,
    metricName: str,
    metricValue: str,
    metricUnit: str,
    metricTimestamp: NotRequired[str],

DynamoDBActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import DynamoDBActionTypeDef

def get_value() -> DynamoDBActionTypeDef:
    return {
        "tableName": ...,
        "roleArn": ...,
        "hashKeyField": ...,
        "hashKeyValue": ...,
    }
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],
  1. See DynamoKeyTypeType
  2. See DynamoKeyTypeType

ElasticsearchActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import ElasticsearchActionTypeDef

def get_value() -> ElasticsearchActionTypeDef:
    return {
        "roleArn": ...,
        "endpoint": ...,
        "index": ...,
        "type": ...,
        "id": ...,
    }
Definition
class ElasticsearchActionTypeDef(TypedDict):
    roleArn: str,
    endpoint: str,
    index: str,
    type: str,
    id: str,

FirehoseActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import FirehoseActionTypeDef

def get_value() -> FirehoseActionTypeDef:
    return {
        "roleArn": ...,
        "deliveryStreamName": ...,
    }
Definition
class FirehoseActionTypeDef(TypedDict):
    roleArn: str,
    deliveryStreamName: str,
    separator: NotRequired[str],
    batchMode: NotRequired[bool],

IotAnalyticsActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import IotAnalyticsActionTypeDef

def get_value() -> IotAnalyticsActionTypeDef:
    return {
        "channelArn": ...,
    }
Definition
class IotAnalyticsActionTypeDef(TypedDict):
    channelArn: NotRequired[str],
    channelName: NotRequired[str],
    batchMode: NotRequired[bool],
    roleArn: NotRequired[str],

IotEventsActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import IotEventsActionTypeDef

def get_value() -> IotEventsActionTypeDef:
    return {
        "inputName": ...,
        "roleArn": ...,
    }
Definition
class IotEventsActionTypeDef(TypedDict):
    inputName: str,
    roleArn: str,
    messageId: NotRequired[str],
    batchMode: NotRequired[bool],

KafkaActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import KafkaActionTypeDef

def get_value() -> KafkaActionTypeDef:
    return {
        "destinationArn": ...,
        "topic": ...,
        "clientProperties": ...,
    }
Definition
class KafkaActionTypeDef(TypedDict):
    destinationArn: str,
    topic: str,
    clientProperties: Mapping[str, str],
    key: NotRequired[str],
    partition: NotRequired[str],

KinesisActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import KinesisActionTypeDef

def get_value() -> KinesisActionTypeDef:
    return {
        "roleArn": ...,
        "streamName": ...,
    }
Definition
class KinesisActionTypeDef(TypedDict):
    roleArn: str,
    streamName: str,
    partitionKey: NotRequired[str],

LambdaActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import LambdaActionTypeDef

def get_value() -> LambdaActionTypeDef:
    return {
        "functionArn": ...,
    }
Definition
class LambdaActionTypeDef(TypedDict):
    functionArn: str,

OpenSearchActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import OpenSearchActionTypeDef

def get_value() -> OpenSearchActionTypeDef:
    return {
        "roleArn": ...,
        "endpoint": ...,
        "index": ...,
        "type": ...,
        "id": ...,
    }
Definition
class OpenSearchActionTypeDef(TypedDict):
    roleArn: str,
    endpoint: str,
    index: str,
    type: str,
    id: str,

S3ActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import S3ActionTypeDef

def get_value() -> S3ActionTypeDef:
    return {
        "roleArn": ...,
        "bucketName": ...,
        "key": ...,
    }
Definition
class S3ActionTypeDef(TypedDict):
    roleArn: str,
    bucketName: str,
    key: str,
    cannedAcl: NotRequired[CannedAccessControlListType],  # (1)
  1. See CannedAccessControlListType

SalesforceActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import SalesforceActionTypeDef

def get_value() -> SalesforceActionTypeDef:
    return {
        "token": ...,
        "url": ...,
    }
Definition
class SalesforceActionTypeDef(TypedDict):
    token: str,
    url: str,

SnsActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import SnsActionTypeDef

def get_value() -> SnsActionTypeDef:
    return {
        "targetArn": ...,
        "roleArn": ...,
    }
Definition
class SnsActionTypeDef(TypedDict):
    targetArn: str,
    roleArn: str,
    messageFormat: NotRequired[MessageFormatType],  # (1)
  1. See MessageFormatType

SqsActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import SqsActionTypeDef

def get_value() -> SqsActionTypeDef:
    return {
        "roleArn": ...,
        "queueUrl": ...,
    }
Definition
class SqsActionTypeDef(TypedDict):
    roleArn: str,
    queueUrl: str,
    useBase64: NotRequired[bool],

StepFunctionsActionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import StepFunctionsActionTypeDef

def get_value() -> StepFunctionsActionTypeDef:
    return {
        "stateMachineName": ...,
        "roleArn": ...,
    }
Definition
class StepFunctionsActionTypeDef(TypedDict):
    stateMachineName: str,
    roleArn: str,
    executionNamePrefix: NotRequired[str],

MetricValueTypeDef

Usage Example
from mypy_boto3_iot.type_defs import MetricValueTypeDef

def get_value() -> MetricValueTypeDef:
    return {
        "count": ...,
    }
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]],

ViolationEventAdditionalInfoTypeDef

Usage Example
from mypy_boto3_iot.type_defs import ViolationEventAdditionalInfoTypeDef

def get_value() -> ViolationEventAdditionalInfoTypeDef:
    return {
        "confidenceLevel": ...,
    }
Definition
class ViolationEventAdditionalInfoTypeDef(TypedDict):
    confidenceLevel: NotRequired[ConfidenceLevelType],  # (1)
  1. See ConfidenceLevelType

AddThingToBillingGroupRequestRequestTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AddThingToBillingGroupRequestRequestTypeDef

def get_value() -> AddThingToBillingGroupRequestRequestTypeDef:
    return {
        "billingGroupName": ...,
    }
Definition
class AddThingToBillingGroupRequestRequestTypeDef(TypedDict):
    billingGroupName: NotRequired[str],
    billingGroupArn: NotRequired[str],
    thingName: NotRequired[str],
    thingArn: NotRequired[str],

AddThingToThingGroupRequestRequestTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AddThingToThingGroupRequestRequestTypeDef

def get_value() -> AddThingToThingGroupRequestRequestTypeDef:
    return {
        "thingGroupName": ...,
    }
Definition
class AddThingToThingGroupRequestRequestTypeDef(TypedDict):
    thingGroupName: NotRequired[str],
    thingGroupArn: NotRequired[str],
    thingName: NotRequired[str],
    thingArn: NotRequired[str],
    overrideDynamicGroups: NotRequired[bool],

AddThingsToThingGroupParamsTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AddThingsToThingGroupParamsTypeDef

def get_value() -> AddThingsToThingGroupParamsTypeDef:
    return {
        "thingGroupNames": ...,
    }
Definition
class AddThingsToThingGroupParamsTypeDef(TypedDict):
    thingGroupNames: Sequence[str],
    overrideDynamicGroups: NotRequired[bool],

AggregationTypeTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AggregationTypeTypeDef

def get_value() -> AggregationTypeTypeDef:
    return {
        "name": ...,
    }
Definition
class AggregationTypeTypeDef(TypedDict):
    name: AggregationTypeNameType,  # (1)
    values: NotRequired[Sequence[str]],
  1. See AggregationTypeNameType

AlertTargetTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AlertTargetTypeDef

def get_value() -> AlertTargetTypeDef:
    return {
        "alertTargetArn": ...,
        "roleArn": ...,
    }
Definition
class AlertTargetTypeDef(TypedDict):
    alertTargetArn: str,
    roleArn: str,

PolicyTypeDef

Usage Example
from mypy_boto3_iot.type_defs import PolicyTypeDef

def get_value() -> PolicyTypeDef:
    return {
        "policyName": ...,
    }
Definition
class PolicyTypeDef(TypedDict):
    policyName: NotRequired[str],
    policyArn: NotRequired[str],

AssetPropertyTimestampTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AssetPropertyTimestampTypeDef

def get_value() -> AssetPropertyTimestampTypeDef:
    return {
        "timeInSeconds": ...,
    }
Definition
class AssetPropertyTimestampTypeDef(TypedDict):
    timeInSeconds: str,
    offsetInNanos: NotRequired[str],

AssetPropertyVariantTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AssetPropertyVariantTypeDef

def get_value() -> AssetPropertyVariantTypeDef:
    return {
        "stringValue": ...,
    }
Definition
class AssetPropertyVariantTypeDef(TypedDict):
    stringValue: NotRequired[str],
    integerValue: NotRequired[str],
    doubleValue: NotRequired[str],
    booleanValue: NotRequired[str],

AssociateTargetsWithJobRequestRequestTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AssociateTargetsWithJobRequestRequestTypeDef

def get_value() -> AssociateTargetsWithJobRequestRequestTypeDef:
    return {
        "targets": ...,
        "jobId": ...,
    }
Definition
class AssociateTargetsWithJobRequestRequestTypeDef(TypedDict):
    targets: Sequence[str],
    jobId: str,
    comment: NotRequired[str],
    namespaceId: NotRequired[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_iot.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

AttachPolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AttachPolicyRequestRequestTypeDef

def get_value() -> AttachPolicyRequestRequestTypeDef:
    return {
        "policyName": ...,
        "target": ...,
    }
Definition
class AttachPolicyRequestRequestTypeDef(TypedDict):
    policyName: str,
    target: str,

AttachPrincipalPolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AttachPrincipalPolicyRequestRequestTypeDef

def get_value() -> AttachPrincipalPolicyRequestRequestTypeDef:
    return {
        "policyName": ...,
        "principal": ...,
    }
Definition
class AttachPrincipalPolicyRequestRequestTypeDef(TypedDict):
    policyName: str,
    principal: str,

AttachSecurityProfileRequestRequestTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AttachSecurityProfileRequestRequestTypeDef

def get_value() -> AttachSecurityProfileRequestRequestTypeDef:
    return {
        "securityProfileName": ...,
        "securityProfileTargetArn": ...,
    }
Definition
class AttachSecurityProfileRequestRequestTypeDef(TypedDict):
    securityProfileName: str,
    securityProfileTargetArn: str,

AttachThingPrincipalRequestRequestTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AttachThingPrincipalRequestRequestTypeDef

def get_value() -> AttachThingPrincipalRequestRequestTypeDef:
    return {
        "thingName": ...,
        "principal": ...,
    }
Definition
class AttachThingPrincipalRequestRequestTypeDef(TypedDict):
    thingName: str,
    principal: str,

AttributePayloadTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AttributePayloadTypeDef

def get_value() -> AttributePayloadTypeDef:
    return {
        "attributes": ...,
    }
Definition
class AttributePayloadTypeDef(TypedDict):
    attributes: NotRequired[Mapping[str, str]],
    merge: NotRequired[bool],

AuditCheckConfigurationTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AuditCheckConfigurationTypeDef

def get_value() -> AuditCheckConfigurationTypeDef:
    return {
        "enabled": ...,
    }
Definition
class AuditCheckConfigurationTypeDef(TypedDict):
    enabled: NotRequired[bool],

AuditCheckDetailsTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AuditCheckDetailsTypeDef

def get_value() -> AuditCheckDetailsTypeDef:
    return {
        "checkRunStatus": ...,
    }
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],
  1. See AuditCheckRunStatusType

AuditMitigationActionExecutionMetadataTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AuditMitigationActionExecutionMetadataTypeDef

def get_value() -> AuditMitigationActionExecutionMetadataTypeDef:
    return {
        "taskId": ...,
    }
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],
  1. See AuditMitigationActionsExecutionStatusType

AuditMitigationActionsTaskMetadataTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AuditMitigationActionsTaskMetadataTypeDef

def get_value() -> AuditMitigationActionsTaskMetadataTypeDef:
    return {
        "taskId": ...,
    }
Definition
class AuditMitigationActionsTaskMetadataTypeDef(TypedDict):
    taskId: NotRequired[str],
    startTime: NotRequired[datetime],
    taskStatus: NotRequired[AuditMitigationActionsTaskStatusType],  # (1)
  1. See AuditMitigationActionsTaskStatusType

AuditMitigationActionsTaskTargetTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AuditMitigationActionsTaskTargetTypeDef

def get_value() -> AuditMitigationActionsTaskTargetTypeDef:
    return {
        "auditTaskId": ...,
    }
Definition
class AuditMitigationActionsTaskTargetTypeDef(TypedDict):
    auditTaskId: NotRequired[str],
    findingIds: NotRequired[List[str]],
    auditCheckToReasonCodeFilter: NotRequired[Dict[str, List[str]]],

AuditNotificationTargetTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AuditNotificationTargetTypeDef

def get_value() -> AuditNotificationTargetTypeDef:
    return {
        "targetArn": ...,
    }
Definition
class AuditNotificationTargetTypeDef(TypedDict):
    targetArn: NotRequired[str],
    roleArn: NotRequired[str],
    enabled: NotRequired[bool],

AuditTaskMetadataTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AuditTaskMetadataTypeDef

def get_value() -> AuditTaskMetadataTypeDef:
    return {
        "taskId": ...,
    }
Definition
class AuditTaskMetadataTypeDef(TypedDict):
    taskId: NotRequired[str],
    taskStatus: NotRequired[AuditTaskStatusType],  # (1)
    taskType: NotRequired[AuditTaskTypeType],  # (2)
  1. See AuditTaskStatusType
  2. See AuditTaskTypeType

AuthInfoTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AuthInfoTypeDef

def get_value() -> AuthInfoTypeDef:
    return {
        "resources": ...,
    }
Definition
class AuthInfoTypeDef(TypedDict):
    resources: Sequence[str],
    actionType: NotRequired[ActionTypeType],  # (1)
  1. See ActionTypeType

AuthorizerConfigTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AuthorizerConfigTypeDef

def get_value() -> AuthorizerConfigTypeDef:
    return {
        "defaultAuthorizerName": ...,
    }
Definition
class AuthorizerConfigTypeDef(TypedDict):
    defaultAuthorizerName: NotRequired[str],
    allowAuthorizerOverride: NotRequired[bool],

AuthorizerDescriptionTypeDef

Usage Example
from mypy_boto3_iot.type_defs import AuthorizerDescriptionTypeDef