Typed dictionaries#
Auto-generated documentation for IoT type annotations stubs module mypy-boto3-iot.
AbortCriteriaTypeDef#
# AbortCriteriaTypeDef usage example
from mypy_boto3_iot.type_defs import AbortCriteriaTypeDef
def get_value() -> AbortCriteriaTypeDef:
return {
"failureType": ...,
"action": ...,
"thresholdPercentage": ...,
"minNumberOfExecutedThings": ...,
}
# AbortCriteriaTypeDef definition
class AbortCriteriaTypeDef(TypedDict):
failureType: JobExecutionFailureTypeType, # (1)
action: AbortActionType, # (2)
thresholdPercentage: float,
minNumberOfExecutedThings: int,
AcceptCertificateTransferRequestRequestTypeDef#
# AcceptCertificateTransferRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import AcceptCertificateTransferRequestRequestTypeDef
def get_value() -> AcceptCertificateTransferRequestRequestTypeDef:
return {
"certificateId": ...,
}
# AcceptCertificateTransferRequestRequestTypeDef definition
class AcceptCertificateTransferRequestRequestTypeDef(TypedDict):
certificateId: str,
setAsActive: NotRequired[bool],
CloudwatchAlarmActionTypeDef#
# CloudwatchAlarmActionTypeDef usage example
from mypy_boto3_iot.type_defs import CloudwatchAlarmActionTypeDef
def get_value() -> CloudwatchAlarmActionTypeDef:
return {
"roleArn": ...,
"alarmName": ...,
"stateReason": ...,
"stateValue": ...,
}
# CloudwatchAlarmActionTypeDef definition
class CloudwatchAlarmActionTypeDef(TypedDict):
roleArn: str,
alarmName: str,
stateReason: str,
stateValue: str,
CloudwatchLogsActionTypeDef#
# CloudwatchLogsActionTypeDef usage example
from mypy_boto3_iot.type_defs import CloudwatchLogsActionTypeDef
def get_value() -> CloudwatchLogsActionTypeDef:
return {
"roleArn": ...,
"logGroupName": ...,
}
# CloudwatchLogsActionTypeDef definition
class CloudwatchLogsActionTypeDef(TypedDict):
roleArn: str,
logGroupName: str,
batchMode: NotRequired[bool],
CloudwatchMetricActionTypeDef#
# CloudwatchMetricActionTypeDef usage example
from mypy_boto3_iot.type_defs import CloudwatchMetricActionTypeDef
def get_value() -> CloudwatchMetricActionTypeDef:
return {
"roleArn": ...,
"metricNamespace": ...,
"metricName": ...,
"metricValue": ...,
"metricUnit": ...,
}
# CloudwatchMetricActionTypeDef definition
class CloudwatchMetricActionTypeDef(TypedDict):
roleArn: str,
metricNamespace: str,
metricName: str,
metricValue: str,
metricUnit: str,
metricTimestamp: NotRequired[str],
DynamoDBActionTypeDef#
# DynamoDBActionTypeDef usage example
from mypy_boto3_iot.type_defs import DynamoDBActionTypeDef
def get_value() -> DynamoDBActionTypeDef:
return {
"tableName": ...,
"roleArn": ...,
"hashKeyField": ...,
"hashKeyValue": ...,
}
# 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 usage example
from mypy_boto3_iot.type_defs import ElasticsearchActionTypeDef
def get_value() -> ElasticsearchActionTypeDef:
return {
"roleArn": ...,
"endpoint": ...,
"index": ...,
"type": ...,
"id": ...,
}
# ElasticsearchActionTypeDef definition
class ElasticsearchActionTypeDef(TypedDict):
roleArn: str,
endpoint: str,
index: str,
type: str,
id: str,
FirehoseActionTypeDef#
# FirehoseActionTypeDef usage example
from mypy_boto3_iot.type_defs import FirehoseActionTypeDef
def get_value() -> FirehoseActionTypeDef:
return {
"roleArn": ...,
"deliveryStreamName": ...,
}
# FirehoseActionTypeDef definition
class FirehoseActionTypeDef(TypedDict):
roleArn: str,
deliveryStreamName: str,
separator: NotRequired[str],
batchMode: NotRequired[bool],
IotAnalyticsActionTypeDef#
# IotAnalyticsActionTypeDef usage example
from mypy_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 usage example
from mypy_boto3_iot.type_defs import IotEventsActionTypeDef
def get_value() -> IotEventsActionTypeDef:
return {
"inputName": ...,
"roleArn": ...,
}
# IotEventsActionTypeDef definition
class IotEventsActionTypeDef(TypedDict):
inputName: str,
roleArn: str,
messageId: NotRequired[str],
batchMode: NotRequired[bool],
KafkaActionTypeDef#
# KafkaActionTypeDef usage example
from mypy_boto3_iot.type_defs import KafkaActionTypeDef
def get_value() -> KafkaActionTypeDef:
return {
"destinationArn": ...,
"topic": ...,
"clientProperties": ...,
}
# KafkaActionTypeDef definition
class KafkaActionTypeDef(TypedDict):
destinationArn: str,
topic: str,
clientProperties: Mapping[str, str],
key: NotRequired[str],
partition: NotRequired[str],
KinesisActionTypeDef#
# KinesisActionTypeDef usage example
from mypy_boto3_iot.type_defs import KinesisActionTypeDef
def get_value() -> KinesisActionTypeDef:
return {
"roleArn": ...,
"streamName": ...,
}
# KinesisActionTypeDef definition
class KinesisActionTypeDef(TypedDict):
roleArn: str,
streamName: str,
partitionKey: NotRequired[str],
LambdaActionTypeDef#
# LambdaActionTypeDef usage example
from mypy_boto3_iot.type_defs import LambdaActionTypeDef
def get_value() -> LambdaActionTypeDef:
return {
"functionArn": ...,
}
# LambdaActionTypeDef definition
class LambdaActionTypeDef(TypedDict):
functionArn: str,
OpenSearchActionTypeDef#
# OpenSearchActionTypeDef usage example
from mypy_boto3_iot.type_defs import OpenSearchActionTypeDef
def get_value() -> OpenSearchActionTypeDef:
return {
"roleArn": ...,
"endpoint": ...,
"index": ...,
"type": ...,
"id": ...,
}
# OpenSearchActionTypeDef definition
class OpenSearchActionTypeDef(TypedDict):
roleArn: str,
endpoint: str,
index: str,
type: str,
id: str,
S3ActionTypeDef#
# S3ActionTypeDef usage example
from mypy_boto3_iot.type_defs import S3ActionTypeDef
def get_value() -> S3ActionTypeDef:
return {
"roleArn": ...,
"bucketName": ...,
"key": ...,
}
# S3ActionTypeDef definition
class S3ActionTypeDef(TypedDict):
roleArn: str,
bucketName: str,
key: str,
cannedAcl: NotRequired[CannedAccessControlListType], # (1)
SalesforceActionTypeDef#
# SalesforceActionTypeDef usage example
from mypy_boto3_iot.type_defs import SalesforceActionTypeDef
def get_value() -> SalesforceActionTypeDef:
return {
"token": ...,
"url": ...,
}
# SalesforceActionTypeDef definition
class SalesforceActionTypeDef(TypedDict):
token: str,
url: str,
SnsActionTypeDef#
# SnsActionTypeDef usage example
from mypy_boto3_iot.type_defs import SnsActionTypeDef
def get_value() -> SnsActionTypeDef:
return {
"targetArn": ...,
"roleArn": ...,
}
# SnsActionTypeDef definition
class SnsActionTypeDef(TypedDict):
targetArn: str,
roleArn: str,
messageFormat: NotRequired[MessageFormatType], # (1)
SqsActionTypeDef#
# SqsActionTypeDef usage example
from mypy_boto3_iot.type_defs import SqsActionTypeDef
def get_value() -> SqsActionTypeDef:
return {
"roleArn": ...,
"queueUrl": ...,
}
# SqsActionTypeDef definition
class SqsActionTypeDef(TypedDict):
roleArn: str,
queueUrl: str,
useBase64: NotRequired[bool],
StepFunctionsActionTypeDef#
# StepFunctionsActionTypeDef usage example
from mypy_boto3_iot.type_defs import StepFunctionsActionTypeDef
def get_value() -> StepFunctionsActionTypeDef:
return {
"stateMachineName": ...,
"roleArn": ...,
}
# StepFunctionsActionTypeDef definition
class StepFunctionsActionTypeDef(TypedDict):
stateMachineName: str,
roleArn: str,
executionNamePrefix: NotRequired[str],
MetricValueTypeDef#
# MetricValueTypeDef usage example
from mypy_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]],
ViolationEventAdditionalInfoTypeDef#
# ViolationEventAdditionalInfoTypeDef usage example
from mypy_boto3_iot.type_defs import ViolationEventAdditionalInfoTypeDef
def get_value() -> ViolationEventAdditionalInfoTypeDef:
return {
"confidenceLevel": ...,
}
# ViolationEventAdditionalInfoTypeDef definition
class ViolationEventAdditionalInfoTypeDef(TypedDict):
confidenceLevel: NotRequired[ConfidenceLevelType], # (1)
AddThingToBillingGroupRequestRequestTypeDef#
# AddThingToBillingGroupRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import AddThingToBillingGroupRequestRequestTypeDef
def get_value() -> AddThingToBillingGroupRequestRequestTypeDef:
return {
"billingGroupName": ...,
}
# AddThingToBillingGroupRequestRequestTypeDef definition
class AddThingToBillingGroupRequestRequestTypeDef(TypedDict):
billingGroupName: NotRequired[str],
billingGroupArn: NotRequired[str],
thingName: NotRequired[str],
thingArn: NotRequired[str],
AddThingToThingGroupRequestRequestTypeDef#
# AddThingToThingGroupRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import AddThingToThingGroupRequestRequestTypeDef
def get_value() -> AddThingToThingGroupRequestRequestTypeDef:
return {
"thingGroupName": ...,
}
# AddThingToThingGroupRequestRequestTypeDef definition
class AddThingToThingGroupRequestRequestTypeDef(TypedDict):
thingGroupName: NotRequired[str],
thingGroupArn: NotRequired[str],
thingName: NotRequired[str],
thingArn: NotRequired[str],
overrideDynamicGroups: NotRequired[bool],
AddThingsToThingGroupParamsTypeDef#
# AddThingsToThingGroupParamsTypeDef usage example
from mypy_boto3_iot.type_defs import AddThingsToThingGroupParamsTypeDef
def get_value() -> AddThingsToThingGroupParamsTypeDef:
return {
"thingGroupNames": ...,
}
# AddThingsToThingGroupParamsTypeDef definition
class AddThingsToThingGroupParamsTypeDef(TypedDict):
thingGroupNames: Sequence[str],
overrideDynamicGroups: NotRequired[bool],
AggregationTypeTypeDef#
# AggregationTypeTypeDef usage example
from mypy_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 usage example
from mypy_boto3_iot.type_defs import AlertTargetTypeDef
def get_value() -> AlertTargetTypeDef:
return {
"alertTargetArn": ...,
"roleArn": ...,
}
# AlertTargetTypeDef definition
class AlertTargetTypeDef(TypedDict):
alertTargetArn: str,
roleArn: str,
PolicyTypeDef#
# PolicyTypeDef usage example
from mypy_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 usage example
from mypy_boto3_iot.type_defs import AssetPropertyTimestampTypeDef
def get_value() -> AssetPropertyTimestampTypeDef:
return {
"timeInSeconds": ...,
}
# AssetPropertyTimestampTypeDef definition
class AssetPropertyTimestampTypeDef(TypedDict):
timeInSeconds: str,
offsetInNanos: NotRequired[str],
AssetPropertyVariantTypeDef#
# AssetPropertyVariantTypeDef usage example
from mypy_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],
AssociateTargetsWithJobRequestRequestTypeDef#
# AssociateTargetsWithJobRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import AssociateTargetsWithJobRequestRequestTypeDef
def get_value() -> AssociateTargetsWithJobRequestRequestTypeDef:
return {
"targets": ...,
"jobId": ...,
}
# AssociateTargetsWithJobRequestRequestTypeDef definition
class AssociateTargetsWithJobRequestRequestTypeDef(TypedDict):
targets: Sequence[str],
jobId: str,
comment: NotRequired[str],
namespaceId: NotRequired[str],
AssociateTargetsWithJobResponseTypeDef#
# AssociateTargetsWithJobResponseTypeDef usage example
from mypy_boto3_iot.type_defs import AssociateTargetsWithJobResponseTypeDef
def get_value() -> AssociateTargetsWithJobResponseTypeDef:
return {
"jobArn": ...,
"jobId": ...,
"description": ...,
"ResponseMetadata": ...,
}
# AssociateTargetsWithJobResponseTypeDef definition
class AssociateTargetsWithJobResponseTypeDef(TypedDict):
jobArn: str,
jobId: str,
description: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AttachPolicyRequestRequestTypeDef#
# AttachPolicyRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import AttachPolicyRequestRequestTypeDef
def get_value() -> AttachPolicyRequestRequestTypeDef:
return {
"policyName": ...,
"target": ...,
}
# AttachPolicyRequestRequestTypeDef definition
class AttachPolicyRequestRequestTypeDef(TypedDict):
policyName: str,
target: str,
AttachPrincipalPolicyRequestRequestTypeDef#
# AttachPrincipalPolicyRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import AttachPrincipalPolicyRequestRequestTypeDef
def get_value() -> AttachPrincipalPolicyRequestRequestTypeDef:
return {
"policyName": ...,
"principal": ...,
}
# AttachPrincipalPolicyRequestRequestTypeDef definition
class AttachPrincipalPolicyRequestRequestTypeDef(TypedDict):
policyName: str,
principal: str,
AttachSecurityProfileRequestRequestTypeDef#
# AttachSecurityProfileRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import AttachSecurityProfileRequestRequestTypeDef
def get_value() -> AttachSecurityProfileRequestRequestTypeDef:
return {
"securityProfileName": ...,
"securityProfileTargetArn": ...,
}
# AttachSecurityProfileRequestRequestTypeDef definition
class AttachSecurityProfileRequestRequestTypeDef(TypedDict):
securityProfileName: str,
securityProfileTargetArn: str,
AttachThingPrincipalRequestRequestTypeDef#
# AttachThingPrincipalRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import AttachThingPrincipalRequestRequestTypeDef
def get_value() -> AttachThingPrincipalRequestRequestTypeDef:
return {
"thingName": ...,
"principal": ...,
}
# AttachThingPrincipalRequestRequestTypeDef definition
class AttachThingPrincipalRequestRequestTypeDef(TypedDict):
thingName: str,
principal: str,
AttributePayloadTypeDef#
# AttributePayloadTypeDef usage example
from mypy_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 usage example
from mypy_boto3_iot.type_defs import AuditCheckConfigurationTypeDef
def get_value() -> AuditCheckConfigurationTypeDef:
return {
"enabled": ...,
}
# AuditCheckConfigurationTypeDef definition
class AuditCheckConfigurationTypeDef(TypedDict):
enabled: NotRequired[bool],
AuditCheckDetailsTypeDef#
# AuditCheckDetailsTypeDef usage example
from mypy_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 usage example
from mypy_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 usage example
from mypy_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)
AuditMitigationActionsTaskTargetTypeDef#
# AuditMitigationActionsTaskTargetTypeDef usage example
from mypy_boto3_iot.type_defs import AuditMitigationActionsTaskTargetTypeDef
def get_value() -> AuditMitigationActionsTaskTargetTypeDef:
return {
"auditTaskId": ...,
}
# AuditMitigationActionsTaskTargetTypeDef definition
class AuditMitigationActionsTaskTargetTypeDef(TypedDict):
auditTaskId: NotRequired[str],
findingIds: NotRequired[List[str]],
auditCheckToReasonCodeFilter: NotRequired[Dict[str, List[str]]],
AuditNotificationTargetTypeDef#
# AuditNotificationTargetTypeDef usage example
from mypy_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 usage example
from mypy_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
AuthInfoTypeDef#
# AuthInfoTypeDef usage example
from mypy_boto3_iot.type_defs import AuthInfoTypeDef
def get_value() -> AuthInfoTypeDef:
return {
"resources": ...,
}
# AuthInfoTypeDef definition
class AuthInfoTypeDef(TypedDict):
resources: Sequence[str],
actionType: NotRequired[ActionTypeType], # (1)
- See ActionTypeType
AuthorizerConfigTypeDef#
# AuthorizerConfigTypeDef usage example
from mypy_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 usage example
from mypy_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 usage example
from mypy_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 usage example
from mypy_boto3_iot.type_defs import AwsJobAbortCriteriaTypeDef
def get_value() -> AwsJobAbortCriteriaTypeDef:
return {
"failureType": ...,
"action": ...,
"thresholdPercentage": ...,
"minNumberOfExecutedThings": ...,
}
# AwsJobAbortCriteriaTypeDef definition
class AwsJobAbortCriteriaTypeDef(TypedDict):
failureType: AwsJobAbortCriteriaFailureTypeType, # (1)
action: AwsJobAbortCriteriaAbortActionType, # (2)
thresholdPercentage: float,
minNumberOfExecutedThings: int,
AwsJobRateIncreaseCriteriaTypeDef#
# AwsJobRateIncreaseCriteriaTypeDef usage example
from mypy_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 usage example
from mypy_boto3_iot.type_defs import AwsJobPresignedUrlConfigTypeDef
def get_value() -> AwsJobPresignedUrlConfigTypeDef:
return {
"expiresInSec": ...,
}
# AwsJobPresignedUrlConfigTypeDef definition
class AwsJobPresignedUrlConfigTypeDef(TypedDict):
expiresInSec: NotRequired[int],
AwsJobTimeoutConfigTypeDef#
# AwsJobTimeoutConfigTypeDef usage example
from mypy_boto3_iot.type_defs import AwsJobTimeoutConfigTypeDef
def get_value() -> AwsJobTimeoutConfigTypeDef:
return {
"inProgressTimeoutInMinutes": ...,
}
# AwsJobTimeoutConfigTypeDef definition
class AwsJobTimeoutConfigTypeDef(TypedDict):
inProgressTimeoutInMinutes: NotRequired[int],
MachineLearningDetectionConfigTypeDef#
# MachineLearningDetectionConfigTypeDef usage example
from mypy_boto3_iot.type_defs import MachineLearningDetectionConfigTypeDef
def get_value() -> MachineLearningDetectionConfigTypeDef:
return {
"confidenceLevel": ...,
}
# MachineLearningDetectionConfigTypeDef definition
class MachineLearningDetectionConfigTypeDef(TypedDict):
confidenceLevel: ConfidenceLevelType, # (1)
StatisticalThresholdTypeDef#
# StatisticalThresholdTypeDef usage example
from mypy_boto3_iot.type_defs import StatisticalThresholdTypeDef
def get_value() -> StatisticalThresholdTypeDef:
return {
"statistic": ...,
}
# StatisticalThresholdTypeDef definition
class StatisticalThresholdTypeDef(TypedDict):
statistic: NotRequired[str],
BehaviorModelTrainingSummaryTypeDef#
# BehaviorModelTrainingSummaryTypeDef usage example
from mypy_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 usage example
from mypy_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 usage example
from mypy_boto3_iot.type_defs import BillingGroupMetadataTypeDef
def get_value() -> BillingGroupMetadataTypeDef:
return {
"creationDate": ...,
}
# BillingGroupMetadataTypeDef definition
class BillingGroupMetadataTypeDef(TypedDict):
creationDate: NotRequired[datetime],
BillingGroupPropertiesTypeDef#
# BillingGroupPropertiesTypeDef usage example
from mypy_boto3_iot.type_defs import BillingGroupPropertiesTypeDef
def get_value() -> BillingGroupPropertiesTypeDef:
return {
"billingGroupDescription": ...,
}
# BillingGroupPropertiesTypeDef definition
class BillingGroupPropertiesTypeDef(TypedDict):
billingGroupDescription: NotRequired[str],
BucketTypeDef#
# BucketTypeDef usage example
from mypy_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 usage example
from mypy_boto3_iot.type_defs import TermsAggregationTypeDef
def get_value() -> TermsAggregationTypeDef:
return {
"maxBuckets": ...,
}
# TermsAggregationTypeDef definition
class TermsAggregationTypeDef(TypedDict):
maxBuckets: NotRequired[int],
CertificateValidityTypeDef#
# CertificateValidityTypeDef usage example
from mypy_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 usage example
from mypy_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],
CancelAuditMitigationActionsTaskRequestRequestTypeDef#
# CancelAuditMitigationActionsTaskRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import CancelAuditMitigationActionsTaskRequestRequestTypeDef
def get_value() -> CancelAuditMitigationActionsTaskRequestRequestTypeDef:
return {
"taskId": ...,
}
# CancelAuditMitigationActionsTaskRequestRequestTypeDef definition
class CancelAuditMitigationActionsTaskRequestRequestTypeDef(TypedDict):
taskId: str,
CancelAuditTaskRequestRequestTypeDef#
# CancelAuditTaskRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import CancelAuditTaskRequestRequestTypeDef
def get_value() -> CancelAuditTaskRequestRequestTypeDef:
return {
"taskId": ...,
}
# CancelAuditTaskRequestRequestTypeDef definition
class CancelAuditTaskRequestRequestTypeDef(TypedDict):
taskId: str,
CancelCertificateTransferRequestRequestTypeDef#
# CancelCertificateTransferRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import CancelCertificateTransferRequestRequestTypeDef
def get_value() -> CancelCertificateTransferRequestRequestTypeDef:
return {
"certificateId": ...,
}
# CancelCertificateTransferRequestRequestTypeDef definition
class CancelCertificateTransferRequestRequestTypeDef(TypedDict):
certificateId: str,
CancelDetectMitigationActionsTaskRequestRequestTypeDef#
# CancelDetectMitigationActionsTaskRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import CancelDetectMitigationActionsTaskRequestRequestTypeDef
def get_value() -> CancelDetectMitigationActionsTaskRequestRequestTypeDef:
return {
"taskId": ...,
}
# CancelDetectMitigationActionsTaskRequestRequestTypeDef definition
class CancelDetectMitigationActionsTaskRequestRequestTypeDef(TypedDict):
taskId: str,
CancelJobExecutionRequestRequestTypeDef#
# CancelJobExecutionRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import CancelJobExecutionRequestRequestTypeDef
def get_value() -> CancelJobExecutionRequestRequestTypeDef:
return {
"jobId": ...,
"thingName": ...,
}
# CancelJobExecutionRequestRequestTypeDef definition
class CancelJobExecutionRequestRequestTypeDef(TypedDict):
jobId: str,
thingName: str,
force: NotRequired[bool],
expectedVersion: NotRequired[int],
statusDetails: NotRequired[Mapping[str, str]],
CancelJobRequestRequestTypeDef#
# CancelJobRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import CancelJobRequestRequestTypeDef
def get_value() -> CancelJobRequestRequestTypeDef:
return {
"jobId": ...,
}
# CancelJobRequestRequestTypeDef definition
class CancelJobRequestRequestTypeDef(TypedDict):
jobId: str,
reasonCode: NotRequired[str],
comment: NotRequired[str],
force: NotRequired[bool],
CancelJobResponseTypeDef#
# CancelJobResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CancelJobResponseTypeDef
def get_value() -> CancelJobResponseTypeDef:
return {
"jobArn": ...,
"jobId": ...,
"description": ...,
"ResponseMetadata": ...,
}
# CancelJobResponseTypeDef definition
class CancelJobResponseTypeDef(TypedDict):
jobArn: str,
jobId: str,
description: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TransferDataTypeDef#
# TransferDataTypeDef usage example
from mypy_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],
CertificateTypeDef#
# CertificateTypeDef usage example
from mypy_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],
CodeSigningCertificateChainTypeDef#
# CodeSigningCertificateChainTypeDef usage example
from mypy_boto3_iot.type_defs import CodeSigningCertificateChainTypeDef
def get_value() -> CodeSigningCertificateChainTypeDef:
return {
"certificateName": ...,
}
# CodeSigningCertificateChainTypeDef definition
class CodeSigningCertificateChainTypeDef(TypedDict):
certificateName: NotRequired[str],
inlineDocument: NotRequired[str],
CodeSigningSignatureTypeDef#
# CodeSigningSignatureTypeDef usage example
from mypy_boto3_iot.type_defs import CodeSigningSignatureTypeDef
def get_value() -> CodeSigningSignatureTypeDef:
return {
"inlineDocument": ...,
}
# CodeSigningSignatureTypeDef definition
class CodeSigningSignatureTypeDef(TypedDict):
inlineDocument: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
ConfigurationTypeDef#
# ConfigurationTypeDef usage example
from mypy_boto3_iot.type_defs import ConfigurationTypeDef
def get_value() -> ConfigurationTypeDef:
return {
"Enabled": ...,
}
# ConfigurationTypeDef definition
class ConfigurationTypeDef(TypedDict):
Enabled: NotRequired[bool],
ConfirmTopicRuleDestinationRequestRequestTypeDef#
# ConfirmTopicRuleDestinationRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import ConfirmTopicRuleDestinationRequestRequestTypeDef
def get_value() -> ConfirmTopicRuleDestinationRequestRequestTypeDef:
return {
"confirmationToken": ...,
}
# ConfirmTopicRuleDestinationRequestRequestTypeDef definition
class ConfirmTopicRuleDestinationRequestRequestTypeDef(TypedDict):
confirmationToken: str,
TagTypeDef#
# TagTypeDef usage example
from mypy_boto3_iot.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: NotRequired[str],
CreateAuthorizerResponseTypeDef#
# CreateAuthorizerResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateAuthorizerResponseTypeDef
def get_value() -> CreateAuthorizerResponseTypeDef:
return {
"authorizerName": ...,
"authorizerArn": ...,
"ResponseMetadata": ...,
}
# CreateAuthorizerResponseTypeDef definition
class CreateAuthorizerResponseTypeDef(TypedDict):
authorizerName: str,
authorizerArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBillingGroupResponseTypeDef#
# CreateBillingGroupResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateBillingGroupResponseTypeDef
def get_value() -> CreateBillingGroupResponseTypeDef:
return {
"billingGroupName": ...,
"billingGroupArn": ...,
"billingGroupId": ...,
"ResponseMetadata": ...,
}
# CreateBillingGroupResponseTypeDef definition
class CreateBillingGroupResponseTypeDef(TypedDict):
billingGroupName: str,
billingGroupArn: str,
billingGroupId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateCertificateFromCsrRequestRequestTypeDef#
# CreateCertificateFromCsrRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import CreateCertificateFromCsrRequestRequestTypeDef
def get_value() -> CreateCertificateFromCsrRequestRequestTypeDef:
return {
"certificateSigningRequest": ...,
}
# CreateCertificateFromCsrRequestRequestTypeDef definition
class CreateCertificateFromCsrRequestRequestTypeDef(TypedDict):
certificateSigningRequest: str,
setAsActive: NotRequired[bool],
CreateCertificateFromCsrResponseTypeDef#
# CreateCertificateFromCsrResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateCertificateFromCsrResponseTypeDef
def get_value() -> CreateCertificateFromCsrResponseTypeDef:
return {
"certificateArn": ...,
"certificateId": ...,
"certificatePem": ...,
"ResponseMetadata": ...,
}
# CreateCertificateFromCsrResponseTypeDef definition
class CreateCertificateFromCsrResponseTypeDef(TypedDict):
certificateArn: str,
certificateId: str,
certificatePem: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateCustomMetricResponseTypeDef#
# CreateCustomMetricResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateCustomMetricResponseTypeDef
def get_value() -> CreateCustomMetricResponseTypeDef:
return {
"metricName": ...,
"metricArn": ...,
"ResponseMetadata": ...,
}
# CreateCustomMetricResponseTypeDef definition
class CreateCustomMetricResponseTypeDef(TypedDict):
metricName: str,
metricArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDimensionResponseTypeDef#
# CreateDimensionResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateDimensionResponseTypeDef
def get_value() -> CreateDimensionResponseTypeDef:
return {
"name": ...,
"arn": ...,
"ResponseMetadata": ...,
}
# CreateDimensionResponseTypeDef definition
class CreateDimensionResponseTypeDef(TypedDict):
name: str,
arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TlsConfigTypeDef#
# TlsConfigTypeDef usage example
from mypy_boto3_iot.type_defs import TlsConfigTypeDef
def get_value() -> TlsConfigTypeDef:
return {
"securityPolicy": ...,
}
# TlsConfigTypeDef definition
class TlsConfigTypeDef(TypedDict):
securityPolicy: NotRequired[str],
CreateDomainConfigurationResponseTypeDef#
# CreateDomainConfigurationResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateDomainConfigurationResponseTypeDef
def get_value() -> CreateDomainConfigurationResponseTypeDef:
return {
"domainConfigurationName": ...,
"domainConfigurationArn": ...,
"ResponseMetadata": ...,
}
# CreateDomainConfigurationResponseTypeDef definition
class CreateDomainConfigurationResponseTypeDef(TypedDict):
domainConfigurationName: str,
domainConfigurationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDynamicThingGroupResponseTypeDef#
# CreateDynamicThingGroupResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateDynamicThingGroupResponseTypeDef
def get_value() -> CreateDynamicThingGroupResponseTypeDef:
return {
"thingGroupName": ...,
"thingGroupArn": ...,
"thingGroupId": ...,
"indexName": ...,
"queryString": ...,
"queryVersion": ...,
"ResponseMetadata": ...,
}
# CreateDynamicThingGroupResponseTypeDef definition
class CreateDynamicThingGroupResponseTypeDef(TypedDict):
thingGroupName: str,
thingGroupArn: str,
thingGroupId: str,
indexName: str,
queryString: str,
queryVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateFleetMetricResponseTypeDef#
# CreateFleetMetricResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateFleetMetricResponseTypeDef
def get_value() -> CreateFleetMetricResponseTypeDef:
return {
"metricName": ...,
"metricArn": ...,
"ResponseMetadata": ...,
}
# CreateFleetMetricResponseTypeDef definition
class CreateFleetMetricResponseTypeDef(TypedDict):
metricName: str,
metricArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PresignedUrlConfigTypeDef#
# PresignedUrlConfigTypeDef usage example
from mypy_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 usage example
from mypy_boto3_iot.type_defs import TimeoutConfigTypeDef
def get_value() -> TimeoutConfigTypeDef:
return {
"inProgressTimeoutInMinutes": ...,
}
# TimeoutConfigTypeDef definition
class TimeoutConfigTypeDef(TypedDict):
inProgressTimeoutInMinutes: NotRequired[int],
CreateJobResponseTypeDef#
# CreateJobResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateJobResponseTypeDef
def get_value() -> CreateJobResponseTypeDef:
return {
"jobArn": ...,
"jobId": ...,
"description": ...,
"ResponseMetadata": ...,
}
# CreateJobResponseTypeDef definition
class CreateJobResponseTypeDef(TypedDict):
jobArn: str,
jobId: str,
description: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
MaintenanceWindowTypeDef#
# MaintenanceWindowTypeDef usage example
from mypy_boto3_iot.type_defs import MaintenanceWindowTypeDef
def get_value() -> MaintenanceWindowTypeDef:
return {
"startTime": ...,
"durationInMinutes": ...,
}
# MaintenanceWindowTypeDef definition
class MaintenanceWindowTypeDef(TypedDict):
startTime: str,
durationInMinutes: int,
CreateJobTemplateResponseTypeDef#
# CreateJobTemplateResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateJobTemplateResponseTypeDef
def get_value() -> CreateJobTemplateResponseTypeDef:
return {
"jobTemplateArn": ...,
"jobTemplateId": ...,
"ResponseMetadata": ...,
}
# CreateJobTemplateResponseTypeDef definition
class CreateJobTemplateResponseTypeDef(TypedDict):
jobTemplateArn: str,
jobTemplateId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateKeysAndCertificateRequestRequestTypeDef#
# CreateKeysAndCertificateRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import CreateKeysAndCertificateRequestRequestTypeDef
def get_value() -> CreateKeysAndCertificateRequestRequestTypeDef:
return {
"setAsActive": ...,
}
# CreateKeysAndCertificateRequestRequestTypeDef definition
class CreateKeysAndCertificateRequestRequestTypeDef(TypedDict):
setAsActive: NotRequired[bool],
KeyPairTypeDef#
# KeyPairTypeDef usage example
from mypy_boto3_iot.type_defs import KeyPairTypeDef
def get_value() -> KeyPairTypeDef:
return {
"PublicKey": ...,
}
# KeyPairTypeDef definition
class KeyPairTypeDef(TypedDict):
PublicKey: NotRequired[str],
PrivateKey: NotRequired[str],
CreateMitigationActionResponseTypeDef#
# CreateMitigationActionResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateMitigationActionResponseTypeDef
def get_value() -> CreateMitigationActionResponseTypeDef:
return {
"actionArn": ...,
"actionId": ...,
"ResponseMetadata": ...,
}
# CreateMitigationActionResponseTypeDef definition
class CreateMitigationActionResponseTypeDef(TypedDict):
actionArn: str,
actionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateOTAUpdateResponseTypeDef#
# CreateOTAUpdateResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateOTAUpdateResponseTypeDef
def get_value() -> CreateOTAUpdateResponseTypeDef:
return {
"otaUpdateId": ...,
"awsIotJobId": ...,
"otaUpdateArn": ...,
"awsIotJobArn": ...,
"otaUpdateStatus": ...,
"ResponseMetadata": ...,
}
# CreateOTAUpdateResponseTypeDef definition
class CreateOTAUpdateResponseTypeDef(TypedDict):
otaUpdateId: str,
awsIotJobId: str,
otaUpdateArn: str,
awsIotJobArn: str,
otaUpdateStatus: OTAUpdateStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreatePolicyResponseTypeDef#
# CreatePolicyResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreatePolicyResponseTypeDef
def get_value() -> CreatePolicyResponseTypeDef:
return {
"policyName": ...,
"policyArn": ...,
"policyDocument": ...,
"policyVersionId": ...,
"ResponseMetadata": ...,
}
# CreatePolicyResponseTypeDef definition
class CreatePolicyResponseTypeDef(TypedDict):
policyName: str,
policyArn: str,
policyDocument: str,
policyVersionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreatePolicyVersionRequestRequestTypeDef#
# CreatePolicyVersionRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import CreatePolicyVersionRequestRequestTypeDef
def get_value() -> CreatePolicyVersionRequestRequestTypeDef:
return {
"policyName": ...,
"policyDocument": ...,
}
# CreatePolicyVersionRequestRequestTypeDef definition
class CreatePolicyVersionRequestRequestTypeDef(TypedDict):
policyName: str,
policyDocument: str,
setAsDefault: NotRequired[bool],
CreatePolicyVersionResponseTypeDef#
# CreatePolicyVersionResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreatePolicyVersionResponseTypeDef
def get_value() -> CreatePolicyVersionResponseTypeDef:
return {
"policyArn": ...,
"policyDocument": ...,
"policyVersionId": ...,
"isDefaultVersion": ...,
"ResponseMetadata": ...,
}
# CreatePolicyVersionResponseTypeDef definition
class CreatePolicyVersionResponseTypeDef(TypedDict):
policyArn: str,
policyDocument: str,
policyVersionId: str,
isDefaultVersion: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProvisioningClaimRequestRequestTypeDef#
# CreateProvisioningClaimRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import CreateProvisioningClaimRequestRequestTypeDef
def get_value() -> CreateProvisioningClaimRequestRequestTypeDef:
return {
"templateName": ...,
}
# CreateProvisioningClaimRequestRequestTypeDef definition
class CreateProvisioningClaimRequestRequestTypeDef(TypedDict):
templateName: str,
ProvisioningHookTypeDef#
# ProvisioningHookTypeDef usage example
from mypy_boto3_iot.type_defs import ProvisioningHookTypeDef
def get_value() -> ProvisioningHookTypeDef:
return {
"targetArn": ...,
}
# ProvisioningHookTypeDef definition
class ProvisioningHookTypeDef(TypedDict):
targetArn: str,
payloadVersion: NotRequired[str],
CreateProvisioningTemplateResponseTypeDef#
# CreateProvisioningTemplateResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateProvisioningTemplateResponseTypeDef
def get_value() -> CreateProvisioningTemplateResponseTypeDef:
return {
"templateArn": ...,
"templateName": ...,
"defaultVersionId": ...,
"ResponseMetadata": ...,
}
# CreateProvisioningTemplateResponseTypeDef definition
class CreateProvisioningTemplateResponseTypeDef(TypedDict):
templateArn: str,
templateName: str,
defaultVersionId: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProvisioningTemplateVersionRequestRequestTypeDef#
# CreateProvisioningTemplateVersionRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import CreateProvisioningTemplateVersionRequestRequestTypeDef
def get_value() -> CreateProvisioningTemplateVersionRequestRequestTypeDef:
return {
"templateName": ...,
"templateBody": ...,
}
# CreateProvisioningTemplateVersionRequestRequestTypeDef definition
class CreateProvisioningTemplateVersionRequestRequestTypeDef(TypedDict):
templateName: str,
templateBody: str,
setAsDefault: NotRequired[bool],
CreateProvisioningTemplateVersionResponseTypeDef#
# CreateProvisioningTemplateVersionResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateProvisioningTemplateVersionResponseTypeDef
def get_value() -> CreateProvisioningTemplateVersionResponseTypeDef:
return {
"templateArn": ...,
"templateName": ...,
"versionId": ...,
"isDefaultVersion": ...,
"ResponseMetadata": ...,
}
# CreateProvisioningTemplateVersionResponseTypeDef definition
class CreateProvisioningTemplateVersionResponseTypeDef(TypedDict):
templateArn: str,
templateName: str,
versionId: int,
isDefaultVersion: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateRoleAliasResponseTypeDef#
# CreateRoleAliasResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateRoleAliasResponseTypeDef
def get_value() -> CreateRoleAliasResponseTypeDef:
return {
"roleAlias": ...,
"roleAliasArn": ...,
"ResponseMetadata": ...,
}
# CreateRoleAliasResponseTypeDef definition
class CreateRoleAliasResponseTypeDef(TypedDict):
roleAlias: str,
roleAliasArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateScheduledAuditResponseTypeDef#
# CreateScheduledAuditResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateScheduledAuditResponseTypeDef
def get_value() -> CreateScheduledAuditResponseTypeDef:
return {
"scheduledAuditArn": ...,
"ResponseMetadata": ...,
}
# CreateScheduledAuditResponseTypeDef definition
class CreateScheduledAuditResponseTypeDef(TypedDict):
scheduledAuditArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateSecurityProfileResponseTypeDef#
# CreateSecurityProfileResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateSecurityProfileResponseTypeDef
def get_value() -> CreateSecurityProfileResponseTypeDef:
return {
"securityProfileName": ...,
"securityProfileArn": ...,
"ResponseMetadata": ...,
}
# CreateSecurityProfileResponseTypeDef definition
class CreateSecurityProfileResponseTypeDef(TypedDict):
securityProfileName: str,
securityProfileArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateStreamResponseTypeDef#
# CreateStreamResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateStreamResponseTypeDef
def get_value() -> CreateStreamResponseTypeDef:
return {
"streamId": ...,
"streamArn": ...,
"description": ...,
"streamVersion": ...,
"ResponseMetadata": ...,
}
# CreateStreamResponseTypeDef definition
class CreateStreamResponseTypeDef(TypedDict):
streamId: str,
streamArn: str,
description: str,
streamVersion: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateThingGroupResponseTypeDef#
# CreateThingGroupResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateThingGroupResponseTypeDef
def get_value() -> CreateThingGroupResponseTypeDef:
return {
"thingGroupName": ...,
"thingGroupArn": ...,
"thingGroupId": ...,
"ResponseMetadata": ...,
}
# CreateThingGroupResponseTypeDef definition
class CreateThingGroupResponseTypeDef(TypedDict):
thingGroupName: str,
thingGroupArn: str,
thingGroupId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateThingResponseTypeDef#
# CreateThingResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateThingResponseTypeDef
def get_value() -> CreateThingResponseTypeDef:
return {
"thingName": ...,
"thingArn": ...,
"thingId": ...,
"ResponseMetadata": ...,
}
# CreateThingResponseTypeDef definition
class CreateThingResponseTypeDef(TypedDict):
thingName: str,
thingArn: str,
thingId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ThingTypePropertiesTypeDef#
# ThingTypePropertiesTypeDef usage example
from mypy_boto3_iot.type_defs import ThingTypePropertiesTypeDef
def get_value() -> ThingTypePropertiesTypeDef:
return {
"thingTypeDescription": ...,
}
# ThingTypePropertiesTypeDef definition
class ThingTypePropertiesTypeDef(TypedDict):
thingTypeDescription: NotRequired[str],
searchableAttributes: NotRequired[Sequence[str]],
CreateThingTypeResponseTypeDef#
# CreateThingTypeResponseTypeDef usage example
from mypy_boto3_iot.type_defs import CreateThingTypeResponseTypeDef
def get_value() -> CreateThingTypeResponseTypeDef:
return {
"thingTypeName": ...,
"thingTypeArn": ...,
"thingTypeId": ...,
"ResponseMetadata": ...,
}
# CreateThingTypeResponseTypeDef definition
class CreateThingTypeResponseTypeDef(TypedDict):
thingTypeName: str,
thingTypeArn: str,
thingTypeId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteAccountAuditConfigurationRequestRequestTypeDef#
# DeleteAccountAuditConfigurationRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import DeleteAccountAuditConfigurationRequestRequestTypeDef
def get_value() -> DeleteAccountAuditConfigurationRequestRequestTypeDef:
return {
"deleteScheduledAudits": ...,
}
# DeleteAccountAuditConfigurationRequestRequestTypeDef definition
class DeleteAccountAuditConfigurationRequestRequestTypeDef(TypedDict):
deleteScheduledAudits: NotRequired[bool],
DeleteAuthorizerRequestRequestTypeDef#
# DeleteAuthorizerRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import DeleteAuthorizerRequestRequestTypeDef
def get_value() -> DeleteAuthorizerRequestRequestTypeDef:
return {
"authorizerName": ...,
}
# DeleteAuthorizerRequestRequestTypeDef definition
class DeleteAuthorizerRequestRequestTypeDef(TypedDict):
authorizerName: str,
DeleteBillingGroupRequestRequestTypeDef#
# DeleteBillingGroupRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import DeleteBillingGroupRequestRequestTypeDef
def get_value() -> DeleteBillingGroupRequestRequestTypeDef:
return {
"billingGroupName": ...,
}
# DeleteBillingGroupRequestRequestTypeDef definition
class DeleteBillingGroupRequestRequestTypeDef(TypedDict):
billingGroupName: str,
expectedVersion: NotRequired[int],
DeleteCACertificateRequestRequestTypeDef#
# DeleteCACertificateRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import DeleteCACertificateRequestRequestTypeDef
def get_value() -> DeleteCACertificateRequestRequestTypeDef:
return {
"certificateId": ...,
}
# DeleteCACertificateRequestRequestTypeDef definition
class DeleteCACertificateRequestRequestTypeDef(TypedDict):
certificateId: str,
DeleteCertificateRequestRequestTypeDef#
# DeleteCertificateRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import DeleteCertificateRequestRequestTypeDef
def get_value() -> DeleteCertificateRequestRequestTypeDef:
return {
"certificateId": ...,
}
# DeleteCertificateRequestRequestTypeDef definition
class DeleteCertificateRequestRequestTypeDef(TypedDict):
certificateId: str,
forceDelete: NotRequired[bool],
DeleteCustomMetricRequestRequestTypeDef#
# DeleteCustomMetricRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import DeleteCustomMetricRequestRequestTypeDef
def get_value() -> DeleteCustomMetricRequestRequestTypeDef:
return {
"metricName": ...,
}
# DeleteCustomMetricRequestRequestTypeDef definition
class DeleteCustomMetricRequestRequestTypeDef(TypedDict):
metricName: str,
DeleteDimensionRequestRequestTypeDef#
# DeleteDimensionRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import DeleteDimensionRequestRequestTypeDef
def get_value() -> DeleteDimensionRequestRequestTypeDef:
return {
"name": ...,
}
# DeleteDimensionRequestRequestTypeDef definition
class DeleteDimensionRequestRequestTypeDef(TypedDict):
name: str,
DeleteDomainConfigurationRequestRequestTypeDef#
# DeleteDomainConfigurationRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import DeleteDomainConfigurationRequestRequestTypeDef
def get_value() -> DeleteDomainConfigurationRequestRequestTypeDef:
return {
"domainConfigurationName": ...,
}
# DeleteDomainConfigurationRequestRequestTypeDef definition
class DeleteDomainConfigurationRequestRequestTypeDef(TypedDict):
domainConfigurationName: str,
DeleteDynamicThingGroupRequestRequestTypeDef#
# DeleteDynamicThingGroupRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import DeleteDynamicThingGroupRequestRequestTypeDef
def get_value() -> DeleteDynamicThingGroupRequestRequestTypeDef:
return {
"thingGroupName": ...,
}
# DeleteDynamicThingGroupRequestRequestTypeDef definition
class DeleteDynamicThingGroupRequestRequestTypeDef(TypedDict):
thingGroupName: str,
expectedVersion: NotRequired[int],
DeleteFleetMetricRequestRequestTypeDef#
# DeleteFleetMetricRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import DeleteFleetMetricRequestRequestTypeDef
def get_value() -> DeleteFleetMetricRequestRequestTypeDef:
return {
"metricName": ...,
}
# DeleteFleetMetricRequestRequestTypeDef definition
class DeleteFleetMetricRequestRequestTypeDef(TypedDict):
metricName: str,
expectedVersion: NotRequired[int],
DeleteJobExecutionRequestRequestTypeDef#
# DeleteJobExecutionRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs import DeleteJobExecutionRequestRequestTypeDef
def get_value() -> DeleteJobExecutionRequestRequestTypeDef:
return {
"jobId": ...,
"thingName": ...,
"executionNumber": ...,
}
# DeleteJobExecutionRequestRequestTypeDef definition
class DeleteJobExecutionRequestRequestTypeDef(TypedDict):
jobId: str,
thingName: str,
executionNumber: int,
force: NotRequired[bool],
namespaceId: NotRequired[str],
DeleteJobRequestRequestTypeDef#
# DeleteJobRequestRequestTypeDef usage example
from mypy_boto3_iot.type_defs impor