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,
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],
- See DynamoKeyTypeType
- 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": ...,
}
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)
SalesforceActionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import SalesforceActionTypeDef
def get_value() -> SalesforceActionTypeDef:
return {
"token": ...,
"url": ...,
}
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)
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)
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]],
AlertTargetTypeDef
Usage Example
from mypy_boto3_iot.type_defs import AlertTargetTypeDef
def get_value() -> AlertTargetTypeDef:
return {
"alertTargetArn": ...,
"roleArn": ...,
}
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": ...,
}
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": ...,
}
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],
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],
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)
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)
- See AuditTaskStatusType
- 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)
- 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
def get_value() -> AuthorizerDescriptionTypeDef:
return {
"authorizerName": ...,
}
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
Usage Example
from mypy_boto3_iot.type_defs import AuthorizerSummaryTypeDef
def get_value() -> AuthorizerSummaryTypeDef:
return {
"authorizerName": ...,
}
Definition
class AuthorizerSummaryTypeDef(TypedDict):
authorizerName: NotRequired[str],
authorizerArn: NotRequired[str],
AwsJobAbortCriteriaTypeDef
Usage Example
from mypy_boto3_iot.type_defs import AwsJobAbortCriteriaTypeDef
def get_value() -> AwsJobAbortCriteriaTypeDef:
return {
"failureType": ...,
"action": ...,
"thresholdPercentage": ...,
"minNumberOfExecutedThings": ...,
}
Definition
class AwsJobAbortCriteriaTypeDef(TypedDict):
failureType: AwsJobAbortCriteriaFailureTypeType, # (1)
action: AwsJobAbortCriteriaAbortActionType, # (2)
thresholdPercentage: float,
minNumberOfExecutedThings: int,
AwsJobRateIncreaseCriteriaTypeDef
Usage Example
from mypy_boto3_iot.type_defs import AwsJobRateIncreaseCriteriaTypeDef
def get_value() -> AwsJobRateIncreaseCriteriaTypeDef:
return {
"numberOfNotifiedThings": ...,
}
Definition
class AwsJobRateIncreaseCriteriaTypeDef(TypedDict):
numberOfNotifiedThings: NotRequired[int],
numberOfSucceededThings: NotRequired[int],
AwsJobPresignedUrlConfigTypeDef
Usage Example
from mypy_boto3_iot.type_defs import AwsJobPresignedUrlConfigTypeDef
def get_value() -> AwsJobPresignedUrlConfigTypeDef:
return {
"expiresInSec": ...,
}
AwsJobTimeoutConfigTypeDef
Usage Example
from mypy_boto3_iot.type_defs import AwsJobTimeoutConfigTypeDef
def get_value() -> AwsJobTimeoutConfigTypeDef:
return {
"inProgressTimeoutInMinutes": ...,
}
Definition
class AwsJobTimeoutConfigTypeDef(TypedDict):
inProgressTimeoutInMinutes: NotRequired[int],
MachineLearningDetectionConfigTypeDef
Usage Example
from mypy_boto3_iot.type_defs import MachineLearningDetectionConfigTypeDef
def get_value() -> MachineLearningDetectionConfigTypeDef:
return {
"confidenceLevel": ...,
}
Definition
class MachineLearningDetectionConfigTypeDef(TypedDict):
confidenceLevel: ConfidenceLevelType, # (1)
StatisticalThresholdTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StatisticalThresholdTypeDef
def get_value() -> StatisticalThresholdTypeDef:
return {
"statistic": ...,
}
BehaviorModelTrainingSummaryTypeDef
Usage Example
from mypy_boto3_iot.type_defs import BehaviorModelTrainingSummaryTypeDef
def get_value() -> BehaviorModelTrainingSummaryTypeDef:
return {
"securityProfileName": ...,
}
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
Usage Example
from mypy_boto3_iot.type_defs import MetricDimensionTypeDef
def get_value() -> MetricDimensionTypeDef:
return {
"dimensionName": ...,
}
Definition
class MetricDimensionTypeDef(TypedDict):
dimensionName: str,
operator: NotRequired[DimensionValueOperatorType], # (1)
BillingGroupMetadataTypeDef
Usage Example
from mypy_boto3_iot.type_defs import BillingGroupMetadataTypeDef
def get_value() -> BillingGroupMetadataTypeDef:
return {
"creationDate": ...,
}
BillingGroupPropertiesTypeDef
Usage Example
from mypy_boto3_iot.type_defs import BillingGroupPropertiesTypeDef
def get_value() -> BillingGroupPropertiesTypeDef:
return {
"billingGroupDescription": ...,
}
Definition
class BillingGroupPropertiesTypeDef(TypedDict):
billingGroupDescription: NotRequired[str],
BucketTypeDef
Usage Example
from mypy_boto3_iot.type_defs import BucketTypeDef
def get_value() -> BucketTypeDef:
return {
"keyValue": ...,
}
TermsAggregationTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TermsAggregationTypeDef
def get_value() -> TermsAggregationTypeDef:
return {
"maxBuckets": ...,
}
CertificateValidityTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CertificateValidityTypeDef
def get_value() -> CertificateValidityTypeDef:
return {
"notBefore": ...,
}
Definition
class CertificateValidityTypeDef(TypedDict):
notBefore: NotRequired[datetime],
notAfter: NotRequired[datetime],
CACertificateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CACertificateTypeDef
def get_value() -> CACertificateTypeDef:
return {
"certificateArn": ...,
}
Definition
class CACertificateTypeDef(TypedDict):
certificateArn: NotRequired[str],
certificateId: NotRequired[str],
status: NotRequired[CACertificateStatusType], # (1)
creationDate: NotRequired[datetime],
CancelAuditMitigationActionsTaskRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CancelAuditMitigationActionsTaskRequestRequestTypeDef
def get_value() -> CancelAuditMitigationActionsTaskRequestRequestTypeDef:
return {
"taskId": ...,
}
CancelAuditTaskRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CancelAuditTaskRequestRequestTypeDef
def get_value() -> CancelAuditTaskRequestRequestTypeDef:
return {
"taskId": ...,
}
CancelCertificateTransferRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CancelCertificateTransferRequestRequestTypeDef
def get_value() -> CancelCertificateTransferRequestRequestTypeDef:
return {
"certificateId": ...,
}
CancelDetectMitigationActionsTaskRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CancelDetectMitigationActionsTaskRequestRequestTypeDef
def get_value() -> CancelDetectMitigationActionsTaskRequestRequestTypeDef:
return {
"taskId": ...,
}
CancelJobExecutionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CancelJobExecutionRequestRequestTypeDef
def get_value() -> CancelJobExecutionRequestRequestTypeDef:
return {
"jobId": ...,
"thingName": ...,
}
Definition
class CancelJobExecutionRequestRequestTypeDef(TypedDict):
jobId: str,
thingName: str,
force: NotRequired[bool],
expectedVersion: NotRequired[int],
statusDetails: NotRequired[Mapping[str, str]],
CancelJobRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CancelJobRequestRequestTypeDef
def get_value() -> CancelJobRequestRequestTypeDef:
return {
"jobId": ...,
}
Definition
class CancelJobRequestRequestTypeDef(TypedDict):
jobId: str,
reasonCode: NotRequired[str],
comment: NotRequired[str],
force: NotRequired[bool],
TransferDataTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TransferDataTypeDef
def get_value() -> TransferDataTypeDef:
return {
"transferMessage": ...,
}
Definition
class TransferDataTypeDef(TypedDict):
transferMessage: NotRequired[str],
rejectReason: NotRequired[str],
transferDate: NotRequired[datetime],
acceptDate: NotRequired[datetime],
rejectDate: NotRequired[datetime],
CertificateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CertificateTypeDef
def get_value() -> CertificateTypeDef:
return {
"certificateArn": ...,
}
Definition
class CertificateTypeDef(TypedDict):
certificateArn: NotRequired[str],
certificateId: NotRequired[str],
status: NotRequired[CertificateStatusType], # (1)
certificateMode: NotRequired[CertificateModeType], # (2)
creationDate: NotRequired[datetime],
CodeSigningCertificateChainTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CodeSigningCertificateChainTypeDef
def get_value() -> CodeSigningCertificateChainTypeDef:
return {
"certificateName": ...,
}
Definition
class CodeSigningCertificateChainTypeDef(TypedDict):
certificateName: NotRequired[str],
inlineDocument: NotRequired[str],
CodeSigningSignatureTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CodeSigningSignatureTypeDef
def get_value() -> CodeSigningSignatureTypeDef:
return {
"inlineDocument": ...,
}
Definition
class CodeSigningSignatureTypeDef(TypedDict):
inlineDocument: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
ConfigurationTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ConfigurationTypeDef
def get_value() -> ConfigurationTypeDef:
return {
"Enabled": ...,
}
ConfirmTopicRuleDestinationRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ConfirmTopicRuleDestinationRequestRequestTypeDef
def get_value() -> ConfirmTopicRuleDestinationRequestRequestTypeDef:
return {
"confirmationToken": ...,
}
Definition
class ConfirmTopicRuleDestinationRequestRequestTypeDef(TypedDict):
confirmationToken: str,
TagTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
CreateCertificateFromCsrRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateCertificateFromCsrRequestRequestTypeDef
def get_value() -> CreateCertificateFromCsrRequestRequestTypeDef:
return {
"certificateSigningRequest": ...,
}
Definition
class CreateCertificateFromCsrRequestRequestTypeDef(TypedDict):
certificateSigningRequest: str,
setAsActive: NotRequired[bool],
PresignedUrlConfigTypeDef
Usage Example
from mypy_boto3_iot.type_defs import PresignedUrlConfigTypeDef
def get_value() -> PresignedUrlConfigTypeDef:
return {
"roleArn": ...,
}
Definition
class PresignedUrlConfigTypeDef(TypedDict):
roleArn: NotRequired[str],
expiresInSec: NotRequired[int],
TimeoutConfigTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TimeoutConfigTypeDef
def get_value() -> TimeoutConfigTypeDef:
return {
"inProgressTimeoutInMinutes": ...,
}
MaintenanceWindowTypeDef
Usage Example
from mypy_boto3_iot.type_defs import MaintenanceWindowTypeDef
def get_value() -> MaintenanceWindowTypeDef:
return {
"startTime": ...,
"durationInMinutes": ...,
}
CreateKeysAndCertificateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateKeysAndCertificateRequestRequestTypeDef
def get_value() -> CreateKeysAndCertificateRequestRequestTypeDef:
return {
"setAsActive": ...,
}
Definition
class CreateKeysAndCertificateRequestRequestTypeDef(TypedDict):
setAsActive: NotRequired[bool],
KeyPairTypeDef
Usage Example
from mypy_boto3_iot.type_defs import KeyPairTypeDef
def get_value() -> KeyPairTypeDef:
return {
"PublicKey": ...,
}
Definition
class KeyPairTypeDef(TypedDict):
PublicKey: NotRequired[str],
PrivateKey: NotRequired[str],
CreatePolicyVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreatePolicyVersionRequestRequestTypeDef
def get_value() -> CreatePolicyVersionRequestRequestTypeDef:
return {
"policyName": ...,
"policyDocument": ...,
}
Definition
class CreatePolicyVersionRequestRequestTypeDef(TypedDict):
policyName: str,
policyDocument: str,
setAsDefault: NotRequired[bool],
CreateProvisioningClaimRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateProvisioningClaimRequestRequestTypeDef
def get_value() -> CreateProvisioningClaimRequestRequestTypeDef:
return {
"templateName": ...,
}
ProvisioningHookTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ProvisioningHookTypeDef
def get_value() -> ProvisioningHookTypeDef:
return {
"targetArn": ...,
}
Definition
class ProvisioningHookTypeDef(TypedDict):
targetArn: str,
payloadVersion: NotRequired[str],
CreateProvisioningTemplateVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateProvisioningTemplateVersionRequestRequestTypeDef
def get_value() -> CreateProvisioningTemplateVersionRequestRequestTypeDef:
return {
"templateName": ...,
"templateBody": ...,
}
Definition
class CreateProvisioningTemplateVersionRequestRequestTypeDef(TypedDict):
templateName: str,
templateBody: str,
setAsDefault: NotRequired[bool],
ThingTypePropertiesTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ThingTypePropertiesTypeDef
def get_value() -> ThingTypePropertiesTypeDef:
return {
"thingTypeDescription": ...,
}
Definition
class ThingTypePropertiesTypeDef(TypedDict):
thingTypeDescription: NotRequired[str],
searchableAttributes: NotRequired[Sequence[str]],
DeleteAccountAuditConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteAccountAuditConfigurationRequestRequestTypeDef
def get_value() -> DeleteAccountAuditConfigurationRequestRequestTypeDef:
return {
"deleteScheduledAudits": ...,
}
Definition
class DeleteAccountAuditConfigurationRequestRequestTypeDef(TypedDict):
deleteScheduledAudits: NotRequired[bool],
DeleteAuthorizerRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteAuthorizerRequestRequestTypeDef
def get_value() -> DeleteAuthorizerRequestRequestTypeDef:
return {
"authorizerName": ...,
}
DeleteBillingGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteBillingGroupRequestRequestTypeDef
def get_value() -> DeleteBillingGroupRequestRequestTypeDef:
return {
"billingGroupName": ...,
}
Definition
class DeleteBillingGroupRequestRequestTypeDef(TypedDict):
billingGroupName: str,
expectedVersion: NotRequired[int],
DeleteCACertificateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteCACertificateRequestRequestTypeDef
def get_value() -> DeleteCACertificateRequestRequestTypeDef:
return {
"certificateId": ...,
}
DeleteCertificateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteCertificateRequestRequestTypeDef
def get_value() -> DeleteCertificateRequestRequestTypeDef:
return {
"certificateId": ...,
}
Definition
class DeleteCertificateRequestRequestTypeDef(TypedDict):
certificateId: str,
forceDelete: NotRequired[bool],
DeleteCustomMetricRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteCustomMetricRequestRequestTypeDef
def get_value() -> DeleteCustomMetricRequestRequestTypeDef:
return {
"metricName": ...,
}
DeleteDimensionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteDimensionRequestRequestTypeDef
def get_value() -> DeleteDimensionRequestRequestTypeDef:
return {
"name": ...,
}
DeleteDomainConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteDomainConfigurationRequestRequestTypeDef
def get_value() -> DeleteDomainConfigurationRequestRequestTypeDef:
return {
"domainConfigurationName": ...,
}
Definition
class DeleteDomainConfigurationRequestRequestTypeDef(TypedDict):
domainConfigurationName: str,
DeleteDynamicThingGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteDynamicThingGroupRequestRequestTypeDef
def get_value() -> DeleteDynamicThingGroupRequestRequestTypeDef:
return {
"thingGroupName": ...,
}
Definition
class DeleteDynamicThingGroupRequestRequestTypeDef(TypedDict):
thingGroupName: str,
expectedVersion: NotRequired[int],
DeleteFleetMetricRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteFleetMetricRequestRequestTypeDef
def get_value() -> DeleteFleetMetricRequestRequestTypeDef:
return {
"metricName": ...,
}
Definition
class DeleteFleetMetricRequestRequestTypeDef(TypedDict):
metricName: str,
expectedVersion: NotRequired[int],
DeleteJobExecutionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteJobExecutionRequestRequestTypeDef
def get_value() -> DeleteJobExecutionRequestRequestTypeDef:
return {
"jobId": ...,
"thingName": ...,
"executionNumber": ...,
}
Definition
class DeleteJobExecutionRequestRequestTypeDef(TypedDict):
jobId: str,
thingName: str,
executionNumber: int,
force: NotRequired[bool],
namespaceId: NotRequired[str],
DeleteJobRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteJobRequestRequestTypeDef
def get_value() -> DeleteJobRequestRequestTypeDef:
return {
"jobId": ...,
}
Definition
class DeleteJobRequestRequestTypeDef(TypedDict):
jobId: str,
force: NotRequired[bool],
namespaceId: NotRequired[str],
DeleteJobTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteJobTemplateRequestRequestTypeDef
def get_value() -> DeleteJobTemplateRequestRequestTypeDef:
return {
"jobTemplateId": ...,
}
DeleteMitigationActionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteMitigationActionRequestRequestTypeDef
def get_value() -> DeleteMitigationActionRequestRequestTypeDef:
return {
"actionName": ...,
}
DeleteOTAUpdateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteOTAUpdateRequestRequestTypeDef
def get_value() -> DeleteOTAUpdateRequestRequestTypeDef:
return {
"otaUpdateId": ...,
}
Definition
class DeleteOTAUpdateRequestRequestTypeDef(TypedDict):
otaUpdateId: str,
deleteStream: NotRequired[bool],
forceDeleteAWSJob: NotRequired[bool],
DeletePolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeletePolicyRequestRequestTypeDef
def get_value() -> DeletePolicyRequestRequestTypeDef:
return {
"policyName": ...,
}
DeletePolicyVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeletePolicyVersionRequestRequestTypeDef
def get_value() -> DeletePolicyVersionRequestRequestTypeDef:
return {
"policyName": ...,
"policyVersionId": ...,
}
Definition
class DeletePolicyVersionRequestRequestTypeDef(TypedDict):
policyName: str,
policyVersionId: str,
DeleteProvisioningTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteProvisioningTemplateRequestRequestTypeDef
def get_value() -> DeleteProvisioningTemplateRequestRequestTypeDef:
return {
"templateName": ...,
}
DeleteProvisioningTemplateVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteProvisioningTemplateVersionRequestRequestTypeDef
def get_value() -> DeleteProvisioningTemplateVersionRequestRequestTypeDef:
return {
"templateName": ...,
"versionId": ...,
}
Definition
class DeleteProvisioningTemplateVersionRequestRequestTypeDef(TypedDict):
templateName: str,
versionId: int,
DeleteRoleAliasRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteRoleAliasRequestRequestTypeDef
def get_value() -> DeleteRoleAliasRequestRequestTypeDef:
return {
"roleAlias": ...,
}
DeleteScheduledAuditRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteScheduledAuditRequestRequestTypeDef
def get_value() -> DeleteScheduledAuditRequestRequestTypeDef:
return {
"scheduledAuditName": ...,
}
DeleteSecurityProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteSecurityProfileRequestRequestTypeDef
def get_value() -> DeleteSecurityProfileRequestRequestTypeDef:
return {
"securityProfileName": ...,
}
Definition
class DeleteSecurityProfileRequestRequestTypeDef(TypedDict):
securityProfileName: str,
expectedVersion: NotRequired[int],
DeleteStreamRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteStreamRequestRequestTypeDef
def get_value() -> DeleteStreamRequestRequestTypeDef:
return {
"streamId": ...,
}
DeleteThingGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteThingGroupRequestRequestTypeDef
def get_value() -> DeleteThingGroupRequestRequestTypeDef:
return {
"thingGroupName": ...,
}
Definition
class DeleteThingGroupRequestRequestTypeDef(TypedDict):
thingGroupName: str,
expectedVersion: NotRequired[int],
DeleteThingRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteThingRequestRequestTypeDef
def get_value() -> DeleteThingRequestRequestTypeDef:
return {
"thingName": ...,
}
Definition
class DeleteThingRequestRequestTypeDef(TypedDict):
thingName: str,
expectedVersion: NotRequired[int],
DeleteThingTypeRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteThingTypeRequestRequestTypeDef
def get_value() -> DeleteThingTypeRequestRequestTypeDef:
return {
"thingTypeName": ...,
}
DeleteTopicRuleDestinationRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteTopicRuleDestinationRequestRequestTypeDef
def get_value() -> DeleteTopicRuleDestinationRequestRequestTypeDef:
return {
"arn": ...,
}
DeleteTopicRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteTopicRuleRequestRequestTypeDef
def get_value() -> DeleteTopicRuleRequestRequestTypeDef:
return {
"ruleName": ...,
}
DeleteV2LoggingLevelRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteV2LoggingLevelRequestRequestTypeDef
def get_value() -> DeleteV2LoggingLevelRequestRequestTypeDef:
return {
"targetType": ...,
"targetName": ...,
}
Definition
class DeleteV2LoggingLevelRequestRequestTypeDef(TypedDict):
targetType: LogTargetTypeType, # (1)
targetName: str,
DeprecateThingTypeRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeprecateThingTypeRequestRequestTypeDef
def get_value() -> DeprecateThingTypeRequestRequestTypeDef:
return {
"thingTypeName": ...,
}
Definition
class DeprecateThingTypeRequestRequestTypeDef(TypedDict):
thingTypeName: str,
undoDeprecate: NotRequired[bool],
DescribeAuditFindingRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeAuditFindingRequestRequestTypeDef
def get_value() -> DescribeAuditFindingRequestRequestTypeDef:
return {
"findingId": ...,
}
DescribeAuditMitigationActionsTaskRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeAuditMitigationActionsTaskRequestRequestTypeDef
def get_value() -> DescribeAuditMitigationActionsTaskRequestRequestTypeDef:
return {
"taskId": ...,
}
TaskStatisticsForAuditCheckTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TaskStatisticsForAuditCheckTypeDef
def get_value() -> TaskStatisticsForAuditCheckTypeDef:
return {
"totalFindingsCount": ...,
}
Definition
class TaskStatisticsForAuditCheckTypeDef(TypedDict):
totalFindingsCount: NotRequired[int],
failedFindingsCount: NotRequired[int],
succeededFindingsCount: NotRequired[int],
skippedFindingsCount: NotRequired[int],
canceledFindingsCount: NotRequired[int],
DescribeAuditTaskRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeAuditTaskRequestRequestTypeDef
def get_value() -> DescribeAuditTaskRequestRequestTypeDef:
return {
"taskId": ...,
}
TaskStatisticsTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TaskStatisticsTypeDef
def get_value() -> TaskStatisticsTypeDef:
return {
"totalChecks": ...,
}
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],
DescribeAuthorizerRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeAuthorizerRequestRequestTypeDef
def get_value() -> DescribeAuthorizerRequestRequestTypeDef:
return {
"authorizerName": ...,
}
DescribeBillingGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeBillingGroupRequestRequestTypeDef
def get_value() -> DescribeBillingGroupRequestRequestTypeDef:
return {
"billingGroupName": ...,
}
DescribeCACertificateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeCACertificateRequestRequestTypeDef
def get_value() -> DescribeCACertificateRequestRequestTypeDef:
return {
"certificateId": ...,
}
RegistrationConfigTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RegistrationConfigTypeDef
def get_value() -> RegistrationConfigTypeDef:
return {
"templateBody": ...,
}
Definition
class RegistrationConfigTypeDef(TypedDict):
templateBody: NotRequired[str],
roleArn: NotRequired[str],
templateName: NotRequired[str],
DescribeCertificateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeCertificateRequestRequestTypeDef
def get_value() -> DescribeCertificateRequestRequestTypeDef:
return {
"certificateId": ...,
}
DescribeCustomMetricRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeCustomMetricRequestRequestTypeDef
def get_value() -> DescribeCustomMetricRequestRequestTypeDef:
return {
"metricName": ...,
}
DescribeDetectMitigationActionsTaskRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeDetectMitigationActionsTaskRequestRequestTypeDef
def get_value() -> DescribeDetectMitigationActionsTaskRequestRequestTypeDef:
return {
"taskId": ...,
}
DescribeDimensionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeDimensionRequestRequestTypeDef
def get_value() -> DescribeDimensionRequestRequestTypeDef:
return {
"name": ...,
}
DescribeDomainConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeDomainConfigurationRequestRequestTypeDef
def get_value() -> DescribeDomainConfigurationRequestRequestTypeDef:
return {
"domainConfigurationName": ...,
}
Definition
class DescribeDomainConfigurationRequestRequestTypeDef(TypedDict):
domainConfigurationName: str,
ServerCertificateSummaryTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ServerCertificateSummaryTypeDef
def get_value() -> ServerCertificateSummaryTypeDef:
return {
"serverCertificateArn": ...,
}
Definition
class ServerCertificateSummaryTypeDef(TypedDict):
serverCertificateArn: NotRequired[str],
serverCertificateStatus: NotRequired[ServerCertificateStatusType], # (1)
serverCertificateStatusDetail: NotRequired[str],
DescribeEndpointRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeEndpointRequestRequestTypeDef
def get_value() -> DescribeEndpointRequestRequestTypeDef:
return {
"endpointType": ...,
}
DescribeFleetMetricRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeFleetMetricRequestRequestTypeDef
def get_value() -> DescribeFleetMetricRequestRequestTypeDef:
return {
"metricName": ...,
}
DescribeIndexRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeIndexRequestRequestTypeDef
def get_value() -> DescribeIndexRequestRequestTypeDef:
return {
"indexName": ...,
}
DescribeJobExecutionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeJobExecutionRequestRequestTypeDef
def get_value() -> DescribeJobExecutionRequestRequestTypeDef:
return {
"jobId": ...,
"thingName": ...,
}
Definition
class DescribeJobExecutionRequestRequestTypeDef(TypedDict):
jobId: str,
thingName: str,
executionNumber: NotRequired[int],
DescribeJobRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeJobRequestRequestTypeDef
def get_value() -> DescribeJobRequestRequestTypeDef:
return {
"jobId": ...,
}
DescribeJobTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeJobTemplateRequestRequestTypeDef
def get_value() -> DescribeJobTemplateRequestRequestTypeDef:
return {
"jobTemplateId": ...,
}
DescribeManagedJobTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeManagedJobTemplateRequestRequestTypeDef
def get_value() -> DescribeManagedJobTemplateRequestRequestTypeDef:
return {
"templateName": ...,
}
Definition
class DescribeManagedJobTemplateRequestRequestTypeDef(TypedDict):
templateName: str,
templateVersion: NotRequired[str],
DocumentParameterTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DocumentParameterTypeDef
def get_value() -> DocumentParameterTypeDef:
return {
"key": ...,
}
Definition
class DocumentParameterTypeDef(TypedDict):
key: NotRequired[str],
description: NotRequired[str],
regex: NotRequired[str],
example: NotRequired[str],
optional: NotRequired[bool],
DescribeMitigationActionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeMitigationActionRequestRequestTypeDef
def get_value() -> DescribeMitigationActionRequestRequestTypeDef:
return {
"actionName": ...,
}
DescribeProvisioningTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeProvisioningTemplateRequestRequestTypeDef
def get_value() -> DescribeProvisioningTemplateRequestRequestTypeDef:
return {
"templateName": ...,
}
DescribeProvisioningTemplateVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeProvisioningTemplateVersionRequestRequestTypeDef
def get_value() -> DescribeProvisioningTemplateVersionRequestRequestTypeDef:
return {
"templateName": ...,
"versionId": ...,
}
Definition
class DescribeProvisioningTemplateVersionRequestRequestTypeDef(TypedDict):
templateName: str,
versionId: int,
DescribeRoleAliasRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeRoleAliasRequestRequestTypeDef
def get_value() -> DescribeRoleAliasRequestRequestTypeDef:
return {
"roleAlias": ...,
}
RoleAliasDescriptionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RoleAliasDescriptionTypeDef
def get_value() -> RoleAliasDescriptionTypeDef:
return {
"roleAlias": ...,
}
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],
DescribeScheduledAuditRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeScheduledAuditRequestRequestTypeDef
def get_value() -> DescribeScheduledAuditRequestRequestTypeDef:
return {
"scheduledAuditName": ...,
}
DescribeSecurityProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeSecurityProfileRequestRequestTypeDef
def get_value() -> DescribeSecurityProfileRequestRequestTypeDef:
return {
"securityProfileName": ...,
}
DescribeStreamRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeStreamRequestRequestTypeDef
def get_value() -> DescribeStreamRequestRequestTypeDef:
return {
"streamId": ...,
}
DescribeThingGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeThingGroupRequestRequestTypeDef
def get_value() -> DescribeThingGroupRequestRequestTypeDef:
return {
"thingGroupName": ...,
}
DescribeThingRegistrationTaskRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeThingRegistrationTaskRequestRequestTypeDef
def get_value() -> DescribeThingRegistrationTaskRequestRequestTypeDef:
return {
"taskId": ...,
}
DescribeThingRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeThingRequestRequestTypeDef
def get_value() -> DescribeThingRequestRequestTypeDef:
return {
"thingName": ...,
}
DescribeThingTypeRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeThingTypeRequestRequestTypeDef
def get_value() -> DescribeThingTypeRequestRequestTypeDef:
return {
"thingTypeName": ...,
}
ThingTypeMetadataTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ThingTypeMetadataTypeDef
def get_value() -> ThingTypeMetadataTypeDef:
return {
"deprecated": ...,
}
Definition
class ThingTypeMetadataTypeDef(TypedDict):
deprecated: NotRequired[bool],
deprecationDate: NotRequired[datetime],
creationDate: NotRequired[datetime],
S3DestinationTypeDef
Usage Example
from mypy_boto3_iot.type_defs import S3DestinationTypeDef
def get_value() -> S3DestinationTypeDef:
return {
"bucket": ...,
}
Definition
class S3DestinationTypeDef(TypedDict):
bucket: NotRequired[str],
prefix: NotRequired[str],
DetachPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DetachPolicyRequestRequestTypeDef
def get_value() -> DetachPolicyRequestRequestTypeDef:
return {
"policyName": ...,
"target": ...,
}
DetachPrincipalPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DetachPrincipalPolicyRequestRequestTypeDef
def get_value() -> DetachPrincipalPolicyRequestRequestTypeDef:
return {
"policyName": ...,
"principal": ...,
}
Definition
class DetachPrincipalPolicyRequestRequestTypeDef(TypedDict):
policyName: str,
principal: str,
DetachSecurityProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DetachSecurityProfileRequestRequestTypeDef
def get_value() -> DetachSecurityProfileRequestRequestTypeDef:
return {
"securityProfileName": ...,
"securityProfileTargetArn": ...,
}
Definition
class DetachSecurityProfileRequestRequestTypeDef(TypedDict):
securityProfileName: str,
securityProfileTargetArn: str,
DetachThingPrincipalRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DetachThingPrincipalRequestRequestTypeDef
def get_value() -> DetachThingPrincipalRequestRequestTypeDef:
return {
"thingName": ...,
"principal": ...,
}
Definition
class DetachThingPrincipalRequestRequestTypeDef(TypedDict):
thingName: str,
principal: str,
DetectMitigationActionExecutionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DetectMitigationActionExecutionTypeDef
def get_value() -> DetectMitigationActionExecutionTypeDef:
return {
"taskId": ...,
}
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
Usage Example
from mypy_boto3_iot.type_defs import DetectMitigationActionsTaskStatisticsTypeDef
def get_value() -> DetectMitigationActionsTaskStatisticsTypeDef:
return {
"actionsExecuted": ...,
}
Definition
class DetectMitigationActionsTaskStatisticsTypeDef(TypedDict):
actionsExecuted: NotRequired[int],
actionsSkipped: NotRequired[int],
actionsFailed: NotRequired[int],
DetectMitigationActionsTaskTargetTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DetectMitigationActionsTaskTargetTypeDef
def get_value() -> DetectMitigationActionsTaskTargetTypeDef:
return {
"violationIds": ...,
}
Definition
class DetectMitigationActionsTaskTargetTypeDef(TypedDict):
violationIds: NotRequired[List[str]],
securityProfileName: NotRequired[str],
behaviorName: NotRequired[str],
ViolationEventOccurrenceRangeTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ViolationEventOccurrenceRangeTypeDef
def get_value() -> ViolationEventOccurrenceRangeTypeDef:
return {
"startTime": ...,
"endTime": ...,
}
Definition
class ViolationEventOccurrenceRangeTypeDef(TypedDict):
startTime: datetime,
endTime: datetime,
DisableTopicRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DisableTopicRuleRequestRequestTypeDef
def get_value() -> DisableTopicRuleRequestRequestTypeDef:
return {
"ruleName": ...,
}
DomainConfigurationSummaryTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DomainConfigurationSummaryTypeDef
def get_value() -> DomainConfigurationSummaryTypeDef:
return {
"domainConfigurationName": ...,
}
Definition
class DomainConfigurationSummaryTypeDef(TypedDict):
domainConfigurationName: NotRequired[str],
domainConfigurationArn: NotRequired[str],
serviceType: NotRequired[ServiceTypeType], # (1)
- See ServiceTypeType
PutItemInputTypeDef
Usage Example
from mypy_boto3_iot.type_defs import PutItemInputTypeDef
def get_value() -> PutItemInputTypeDef:
return {
"tableName": ...,
}
EffectivePolicyTypeDef
Usage Example
from mypy_boto3_iot.type_defs import EffectivePolicyTypeDef
def get_value() -> EffectivePolicyTypeDef:
return {
"policyName": ...,
}
Definition
class EffectivePolicyTypeDef(TypedDict):
policyName: NotRequired[str],
policyArn: NotRequired[str],
policyDocument: NotRequired[str],
EnableIoTLoggingParamsTypeDef
Usage Example
from mypy_boto3_iot.type_defs import EnableIoTLoggingParamsTypeDef
def get_value() -> EnableIoTLoggingParamsTypeDef:
return {
"roleArnForLogging": ...,
"logLevel": ...,
}
Definition
class EnableIoTLoggingParamsTypeDef(TypedDict):
roleArnForLogging: str,
logLevel: LogLevelType, # (1)
- See LogLevelType
EnableTopicRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import EnableTopicRuleRequestRequestTypeDef
def get_value() -> EnableTopicRuleRequestRequestTypeDef:
return {
"ruleName": ...,
}
ErrorInfoTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ErrorInfoTypeDef
def get_value() -> ErrorInfoTypeDef:
return {
"code": ...,
}
RateIncreaseCriteriaTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RateIncreaseCriteriaTypeDef
def get_value() -> RateIncreaseCriteriaTypeDef:
return {
"numberOfNotifiedThings": ...,
}
Definition
class RateIncreaseCriteriaTypeDef(TypedDict):
numberOfNotifiedThings: NotRequired[int],
numberOfSucceededThings: NotRequired[int],
FieldTypeDef
Usage Example
from mypy_boto3_iot.type_defs import FieldTypeDef
def get_value() -> FieldTypeDef:
return {
"name": ...,
}
Definition
class FieldTypeDef(TypedDict):
name: NotRequired[str],
type: NotRequired[FieldTypeType], # (1)
- See FieldTypeType
S3LocationTypeDef
Usage Example
from mypy_boto3_iot.type_defs import S3LocationTypeDef
def get_value() -> S3LocationTypeDef:
return {
"bucket": ...,
}
Definition
class S3LocationTypeDef(TypedDict):
bucket: NotRequired[str],
key: NotRequired[str],
version: NotRequired[str],
StreamTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StreamTypeDef
def get_value() -> StreamTypeDef:
return {
"streamId": ...,
}
FleetMetricNameAndArnTypeDef
Usage Example
from mypy_boto3_iot.type_defs import FleetMetricNameAndArnTypeDef
def get_value() -> FleetMetricNameAndArnTypeDef:
return {
"metricName": ...,
}
Definition
class FleetMetricNameAndArnTypeDef(TypedDict):
metricName: NotRequired[str],
metricArn: NotRequired[str],
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_iot.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
GetBehaviorModelTrainingSummariesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetBehaviorModelTrainingSummariesRequestRequestTypeDef
def get_value() -> GetBehaviorModelTrainingSummariesRequestRequestTypeDef:
return {
"securityProfileName": ...,
}
Definition
class GetBehaviorModelTrainingSummariesRequestRequestTypeDef(TypedDict):
securityProfileName: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
GetCardinalityRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetCardinalityRequestRequestTypeDef
def get_value() -> GetCardinalityRequestRequestTypeDef:
return {
"queryString": ...,
}
Definition
class GetCardinalityRequestRequestTypeDef(TypedDict):
queryString: str,
indexName: NotRequired[str],
aggregationField: NotRequired[str],
queryVersion: NotRequired[str],
GetEffectivePoliciesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetEffectivePoliciesRequestRequestTypeDef
def get_value() -> GetEffectivePoliciesRequestRequestTypeDef:
return {
"principal": ...,
}
Definition
class GetEffectivePoliciesRequestRequestTypeDef(TypedDict):
principal: NotRequired[str],
cognitoIdentityPoolId: NotRequired[str],
thingName: NotRequired[str],
GetJobDocumentRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetJobDocumentRequestRequestTypeDef
def get_value() -> GetJobDocumentRequestRequestTypeDef:
return {
"jobId": ...,
}
GetOTAUpdateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetOTAUpdateRequestRequestTypeDef
def get_value() -> GetOTAUpdateRequestRequestTypeDef:
return {
"otaUpdateId": ...,
}
GetPercentilesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetPercentilesRequestRequestTypeDef
def get_value() -> GetPercentilesRequestRequestTypeDef:
return {
"queryString": ...,
}
Definition
class GetPercentilesRequestRequestTypeDef(TypedDict):
queryString: str,
indexName: NotRequired[str],
aggregationField: NotRequired[str],
queryVersion: NotRequired[str],
percents: NotRequired[Sequence[float]],
PercentPairTypeDef
Usage Example
from mypy_boto3_iot.type_defs import PercentPairTypeDef
def get_value() -> PercentPairTypeDef:
return {
"percent": ...,
}
Definition
class PercentPairTypeDef(TypedDict):
percent: NotRequired[float],
value: NotRequired[float],
GetPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetPolicyRequestRequestTypeDef
def get_value() -> GetPolicyRequestRequestTypeDef:
return {
"policyName": ...,
}
GetPolicyVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetPolicyVersionRequestRequestTypeDef
def get_value() -> GetPolicyVersionRequestRequestTypeDef:
return {
"policyName": ...,
"policyVersionId": ...,
}
Definition
class GetPolicyVersionRequestRequestTypeDef(TypedDict):
policyName: str,
policyVersionId: str,
GetStatisticsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetStatisticsRequestRequestTypeDef
def get_value() -> GetStatisticsRequestRequestTypeDef:
return {
"queryString": ...,
}
Definition
class GetStatisticsRequestRequestTypeDef(TypedDict):
queryString: str,
indexName: NotRequired[str],
aggregationField: NotRequired[str],
queryVersion: NotRequired[str],
StatisticsTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StatisticsTypeDef
def get_value() -> StatisticsTypeDef:
return {
"count": ...,
}
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],
GetTopicRuleDestinationRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetTopicRuleDestinationRequestRequestTypeDef
def get_value() -> GetTopicRuleDestinationRequestRequestTypeDef:
return {
"arn": ...,
}
GetTopicRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetTopicRuleRequestRequestTypeDef
def get_value() -> GetTopicRuleRequestRequestTypeDef:
return {
"ruleName": ...,
}
GroupNameAndArnTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GroupNameAndArnTypeDef
def get_value() -> GroupNameAndArnTypeDef:
return {
"groupName": ...,
}
Definition
class GroupNameAndArnTypeDef(TypedDict):
groupName: NotRequired[str],
groupArn: NotRequired[str],
HttpActionHeaderTypeDef
Usage Example
from mypy_boto3_iot.type_defs import HttpActionHeaderTypeDef
def get_value() -> HttpActionHeaderTypeDef:
return {
"key": ...,
"value": ...,
}
SigV4AuthorizationTypeDef
Usage Example
from mypy_boto3_iot.type_defs import SigV4AuthorizationTypeDef
def get_value() -> SigV4AuthorizationTypeDef:
return {
"signingRegion": ...,
"serviceName": ...,
"roleArn": ...,
}
Definition
class SigV4AuthorizationTypeDef(TypedDict):
signingRegion: str,
serviceName: str,
roleArn: str,
HttpContextTypeDef
Usage Example
from mypy_boto3_iot.type_defs import HttpContextTypeDef
def get_value() -> HttpContextTypeDef:
return {
"headers": ...,
}
Definition
class HttpContextTypeDef(TypedDict):
headers: NotRequired[Mapping[str, str]],
queryString: NotRequired[str],
HttpUrlDestinationConfigurationTypeDef
Usage Example
from mypy_boto3_iot.type_defs import HttpUrlDestinationConfigurationTypeDef
def get_value() -> HttpUrlDestinationConfigurationTypeDef:
return {
"confirmationUrl": ...,
}
HttpUrlDestinationPropertiesTypeDef
Usage Example
from mypy_boto3_iot.type_defs import HttpUrlDestinationPropertiesTypeDef
def get_value() -> HttpUrlDestinationPropertiesTypeDef:
return {
"confirmationUrl": ...,
}
HttpUrlDestinationSummaryTypeDef
Usage Example
from mypy_boto3_iot.type_defs import HttpUrlDestinationSummaryTypeDef
def get_value() -> HttpUrlDestinationSummaryTypeDef:
return {
"confirmationUrl": ...,
}
IndexingFilterTypeDef
Usage Example
from mypy_boto3_iot.type_defs import IndexingFilterTypeDef
def get_value() -> IndexingFilterTypeDef:
return {
"namedShadowNames": ...,
}
IssuerCertificateIdentifierTypeDef
Usage Example
from mypy_boto3_iot.type_defs import IssuerCertificateIdentifierTypeDef
def get_value() -> IssuerCertificateIdentifierTypeDef:
return {
"issuerCertificateSubject": ...,
}
Definition
class IssuerCertificateIdentifierTypeDef(TypedDict):
issuerCertificateSubject: NotRequired[str],
issuerId: NotRequired[str],
issuerCertificateSerialNumber: NotRequired[str],
JobExecutionStatusDetailsTypeDef
Usage Example
from mypy_boto3_iot.type_defs import JobExecutionStatusDetailsTypeDef
def get_value() -> JobExecutionStatusDetailsTypeDef:
return {
"detailsMap": ...,
}
Definition
class JobExecutionStatusDetailsTypeDef(TypedDict):
detailsMap: NotRequired[Dict[str, str]],
JobExecutionSummaryTypeDef
Usage Example
from mypy_boto3_iot.type_defs import JobExecutionSummaryTypeDef
def get_value() -> JobExecutionSummaryTypeDef:
return {
"status": ...,
}
Definition
class JobExecutionSummaryTypeDef(TypedDict):
status: NotRequired[JobExecutionStatusType], # (1)
queuedAt: NotRequired[datetime],
startedAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],
executionNumber: NotRequired[int],
retryAttempt: NotRequired[int],
RetryCriteriaTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RetryCriteriaTypeDef
def get_value() -> RetryCriteriaTypeDef:
return {
"failureType": ...,
"numberOfRetries": ...,
}
Definition
class RetryCriteriaTypeDef(TypedDict):
failureType: RetryableFailureTypeType, # (1)
numberOfRetries: int,
JobProcessDetailsTypeDef
Usage Example
from mypy_boto3_iot.type_defs import JobProcessDetailsTypeDef
def get_value() -> JobProcessDetailsTypeDef:
return {
"processingTargets": ...,
}
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
Usage Example
from mypy_boto3_iot.type_defs import JobSummaryTypeDef
def get_value() -> JobSummaryTypeDef:
return {
"jobArn": ...,
}
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
Usage Example
from mypy_boto3_iot.type_defs import JobTemplateSummaryTypeDef
def get_value() -> JobTemplateSummaryTypeDef:
return {
"jobTemplateArn": ...,
}
Definition
class JobTemplateSummaryTypeDef(TypedDict):
jobTemplateArn: NotRequired[str],
jobTemplateId: NotRequired[str],
description: NotRequired[str],
createdAt: NotRequired[datetime],
ScheduledJobRolloutTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ScheduledJobRolloutTypeDef
def get_value() -> ScheduledJobRolloutTypeDef:
return {
"startTime": ...,
}
ListActiveViolationsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListActiveViolationsRequestRequestTypeDef
def get_value() -> ListActiveViolationsRequestRequestTypeDef:
return {
"thingName": ...,
}
Definition
class ListActiveViolationsRequestRequestTypeDef(TypedDict):
thingName: NotRequired[str],
securityProfileName: NotRequired[str],
behaviorCriteriaType: NotRequired[BehaviorCriteriaTypeType], # (1)
listSuppressedAlerts: NotRequired[bool],
verificationState: NotRequired[VerificationStateType], # (2)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListAttachedPoliciesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAttachedPoliciesRequestRequestTypeDef
def get_value() -> ListAttachedPoliciesRequestRequestTypeDef:
return {
"target": ...,
}
Definition
class ListAttachedPoliciesRequestRequestTypeDef(TypedDict):
target: str,
recursive: NotRequired[bool],
marker: NotRequired[str],
pageSize: NotRequired[int],
ListAuditMitigationActionsExecutionsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuditMitigationActionsExecutionsRequestRequestTypeDef
def get_value() -> ListAuditMitigationActionsExecutionsRequestRequestTypeDef:
return {
"taskId": ...,
"findingId": ...,
}
Definition
class ListAuditMitigationActionsExecutionsRequestRequestTypeDef(TypedDict):
taskId: str,
findingId: str,
actionStatus: NotRequired[AuditMitigationActionsExecutionStatusType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListAuditMitigationActionsTasksRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuditMitigationActionsTasksRequestRequestTypeDef
def get_value() -> ListAuditMitigationActionsTasksRequestRequestTypeDef:
return {
"startTime": ...,
"endTime": ...,
}
Definition
class ListAuditMitigationActionsTasksRequestRequestTypeDef(TypedDict):
startTime: Union[datetime, str],
endTime: Union[datetime, str],
auditTaskId: NotRequired[str],
findingId: NotRequired[str],
taskStatus: NotRequired[AuditMitigationActionsTaskStatusType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListAuditTasksRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuditTasksRequestRequestTypeDef
def get_value() -> ListAuditTasksRequestRequestTypeDef:
return {
"startTime": ...,
"endTime": ...,
}
Definition
class ListAuditTasksRequestRequestTypeDef(TypedDict):
startTime: Union[datetime, str],
endTime: Union[datetime, str],
taskType: NotRequired[AuditTaskTypeType], # (1)
taskStatus: NotRequired[AuditTaskStatusType], # (2)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
- See AuditTaskTypeType
- See AuditTaskStatusType
ListAuthorizersRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuthorizersRequestRequestTypeDef
def get_value() -> ListAuthorizersRequestRequestTypeDef:
return {
"pageSize": ...,
}
Definition
class ListAuthorizersRequestRequestTypeDef(TypedDict):
pageSize: NotRequired[int],
marker: NotRequired[str],
ascendingOrder: NotRequired[bool],
status: NotRequired[AuthorizerStatusType], # (1)
ListBillingGroupsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListBillingGroupsRequestRequestTypeDef
def get_value() -> ListBillingGroupsRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListBillingGroupsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
namePrefixFilter: NotRequired[str],
ListCACertificatesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListCACertificatesRequestRequestTypeDef
def get_value() -> ListCACertificatesRequestRequestTypeDef:
return {
"pageSize": ...,
}
Definition
class ListCACertificatesRequestRequestTypeDef(TypedDict):
pageSize: NotRequired[int],
marker: NotRequired[str],
ascendingOrder: NotRequired[bool],
templateName: NotRequired[str],
ListCertificatesByCARequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListCertificatesByCARequestRequestTypeDef
def get_value() -> ListCertificatesByCARequestRequestTypeDef:
return {
"caCertificateId": ...,
}
Definition
class ListCertificatesByCARequestRequestTypeDef(TypedDict):
caCertificateId: str,
pageSize: NotRequired[int],
marker: NotRequired[str],
ascendingOrder: NotRequired[bool],
ListCertificatesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListCertificatesRequestRequestTypeDef
def get_value() -> ListCertificatesRequestRequestTypeDef:
return {
"pageSize": ...,
}
Definition
class ListCertificatesRequestRequestTypeDef(TypedDict):
pageSize: NotRequired[int],
marker: NotRequired[str],
ascendingOrder: NotRequired[bool],
ListCustomMetricsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListCustomMetricsRequestRequestTypeDef
def get_value() -> ListCustomMetricsRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListCustomMetricsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListDetectMitigationActionsExecutionsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListDetectMitigationActionsExecutionsRequestRequestTypeDef
def get_value() -> ListDetectMitigationActionsExecutionsRequestRequestTypeDef:
return {
"taskId": ...,
}
Definition
class ListDetectMitigationActionsExecutionsRequestRequestTypeDef(TypedDict):
taskId: NotRequired[str],
violationId: NotRequired[str],
thingName: NotRequired[str],
startTime: NotRequired[Union[datetime, str]],
endTime: NotRequired[Union[datetime, str]],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListDetectMitigationActionsTasksRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListDetectMitigationActionsTasksRequestRequestTypeDef
def get_value() -> ListDetectMitigationActionsTasksRequestRequestTypeDef:
return {
"startTime": ...,
"endTime": ...,
}
Definition
class ListDetectMitigationActionsTasksRequestRequestTypeDef(TypedDict):
startTime: Union[datetime, str],
endTime: Union[datetime, str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListDimensionsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListDimensionsRequestRequestTypeDef
def get_value() -> ListDimensionsRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListDimensionsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListDomainConfigurationsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListDomainConfigurationsRequestRequestTypeDef
def get_value() -> ListDomainConfigurationsRequestRequestTypeDef:
return {
"marker": ...,
}
Definition
class ListDomainConfigurationsRequestRequestTypeDef(TypedDict):
marker: NotRequired[str],
pageSize: NotRequired[int],
serviceType: NotRequired[ServiceTypeType], # (1)
- See ServiceTypeType
ListFleetMetricsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListFleetMetricsRequestRequestTypeDef
def get_value() -> ListFleetMetricsRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListFleetMetricsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListIndicesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListIndicesRequestRequestTypeDef
def get_value() -> ListIndicesRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListIndicesRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListJobExecutionsForJobRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListJobExecutionsForJobRequestRequestTypeDef
def get_value() -> ListJobExecutionsForJobRequestRequestTypeDef:
return {
"jobId": ...,
}
Definition
class ListJobExecutionsForJobRequestRequestTypeDef(TypedDict):
jobId: str,
status: NotRequired[JobExecutionStatusType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListJobExecutionsForThingRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListJobExecutionsForThingRequestRequestTypeDef
def get_value() -> ListJobExecutionsForThingRequestRequestTypeDef:
return {
"thingName": ...,
}
Definition
class ListJobExecutionsForThingRequestRequestTypeDef(TypedDict):
thingName: str,
status: NotRequired[JobExecutionStatusType], # (1)
namespaceId: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
jobId: NotRequired[str],
ListJobTemplatesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListJobTemplatesRequestRequestTypeDef
def get_value() -> ListJobTemplatesRequestRequestTypeDef:
return {
"maxResults": ...,
}
Definition
class ListJobTemplatesRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListJobsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListJobsRequestRequestTypeDef
def get_value() -> ListJobsRequestRequestTypeDef:
return {
"status": ...,
}
Definition
class ListJobsRequestRequestTypeDef(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
ListManagedJobTemplatesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListManagedJobTemplatesRequestRequestTypeDef
def get_value() -> ListManagedJobTemplatesRequestRequestTypeDef:
return {
"templateName": ...,
}
Definition
class ListManagedJobTemplatesRequestRequestTypeDef(TypedDict):
templateName: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ManagedJobTemplateSummaryTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ManagedJobTemplateSummaryTypeDef
def get_value() -> ManagedJobTemplateSummaryTypeDef:
return {
"templateArn": ...,
}
Definition
class ManagedJobTemplateSummaryTypeDef(TypedDict):
templateArn: NotRequired[str],
templateName: NotRequired[str],
description: NotRequired[str],
environments: NotRequired[List[str]],
templateVersion: NotRequired[str],
ListMetricValuesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListMetricValuesRequestRequestTypeDef
def get_value() -> ListMetricValuesRequestRequestTypeDef:
return {
"thingName": ...,
"metricName": ...,
"startTime": ...,
"endTime": ...,
}
Definition
class ListMetricValuesRequestRequestTypeDef(TypedDict):
thingName: str,
metricName: str,
startTime: Union[datetime, str],
endTime: Union[datetime, str],
dimensionName: NotRequired[str],
dimensionValueOperator: NotRequired[DimensionValueOperatorType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListMitigationActionsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListMitigationActionsRequestRequestTypeDef
def get_value() -> ListMitigationActionsRequestRequestTypeDef:
return {
"actionType": ...,
}
Definition
class ListMitigationActionsRequestRequestTypeDef(TypedDict):
actionType: NotRequired[MitigationActionTypeType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
MitigationActionIdentifierTypeDef
Usage Example
from mypy_boto3_iot.type_defs import MitigationActionIdentifierTypeDef
def get_value() -> MitigationActionIdentifierTypeDef:
return {
"actionName": ...,
}
Definition
class MitigationActionIdentifierTypeDef(TypedDict):
actionName: NotRequired[str],
actionArn: NotRequired[str],
creationDate: NotRequired[datetime],
ListOTAUpdatesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListOTAUpdatesRequestRequestTypeDef
def get_value() -> ListOTAUpdatesRequestRequestTypeDef:
return {
"maxResults": ...,
}
Definition
class ListOTAUpdatesRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
otaUpdateStatus: NotRequired[OTAUpdateStatusType], # (1)
OTAUpdateSummaryTypeDef
Usage Example
from mypy_boto3_iot.type_defs import OTAUpdateSummaryTypeDef
def get_value() -> OTAUpdateSummaryTypeDef:
return {
"otaUpdateId": ...,
}
Definition
class OTAUpdateSummaryTypeDef(TypedDict):
otaUpdateId: NotRequired[str],
otaUpdateArn: NotRequired[str],
creationDate: NotRequired[datetime],
ListOutgoingCertificatesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListOutgoingCertificatesRequestRequestTypeDef
def get_value() -> ListOutgoingCertificatesRequestRequestTypeDef:
return {
"pageSize": ...,
}
Definition
class ListOutgoingCertificatesRequestRequestTypeDef(TypedDict):
pageSize: NotRequired[int],
marker: NotRequired[str],
ascendingOrder: NotRequired[bool],
OutgoingCertificateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import OutgoingCertificateTypeDef
def get_value() -> OutgoingCertificateTypeDef:
return {
"certificateArn": ...,
}
Definition
class OutgoingCertificateTypeDef(TypedDict):
certificateArn: NotRequired[str],
certificateId: NotRequired[str],
transferredTo: NotRequired[str],
transferDate: NotRequired[datetime],
transferMessage: NotRequired[str],
creationDate: NotRequired[datetime],
ListPoliciesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListPoliciesRequestRequestTypeDef
def get_value() -> ListPoliciesRequestRequestTypeDef:
return {
"marker": ...,
}
Definition
class ListPoliciesRequestRequestTypeDef(TypedDict):
marker: NotRequired[str],
pageSize: NotRequired[int],
ascendingOrder: NotRequired[bool],
ListPolicyPrincipalsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListPolicyPrincipalsRequestRequestTypeDef
def get_value() -> ListPolicyPrincipalsRequestRequestTypeDef:
return {
"policyName": ...,
}
Definition
class ListPolicyPrincipalsRequestRequestTypeDef(TypedDict):
policyName: str,
marker: NotRequired[str],
pageSize: NotRequired[int],
ascendingOrder: NotRequired[bool],
ListPolicyVersionsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListPolicyVersionsRequestRequestTypeDef
def get_value() -> ListPolicyVersionsRequestRequestTypeDef:
return {
"policyName": ...,
}
PolicyVersionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import PolicyVersionTypeDef
def get_value() -> PolicyVersionTypeDef:
return {
"versionId": ...,
}
Definition
class PolicyVersionTypeDef(TypedDict):
versionId: NotRequired[str],
isDefaultVersion: NotRequired[bool],
createDate: NotRequired[datetime],
ListPrincipalPoliciesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListPrincipalPoliciesRequestRequestTypeDef
def get_value() -> ListPrincipalPoliciesRequestRequestTypeDef:
return {
"principal": ...,
}
Definition
class ListPrincipalPoliciesRequestRequestTypeDef(TypedDict):
principal: str,
marker: NotRequired[str],
pageSize: NotRequired[int],
ascendingOrder: NotRequired[bool],
ListPrincipalThingsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListPrincipalThingsRequestRequestTypeDef
def get_value() -> ListPrincipalThingsRequestRequestTypeDef:
return {
"principal": ...,
}
Definition
class ListPrincipalThingsRequestRequestTypeDef(TypedDict):
principal: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListProvisioningTemplateVersionsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListProvisioningTemplateVersionsRequestRequestTypeDef
def get_value() -> ListProvisioningTemplateVersionsRequestRequestTypeDef:
return {
"templateName": ...,
}
Definition
class ListProvisioningTemplateVersionsRequestRequestTypeDef(TypedDict):
templateName: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ProvisioningTemplateVersionSummaryTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ProvisioningTemplateVersionSummaryTypeDef
def get_value() -> ProvisioningTemplateVersionSummaryTypeDef:
return {
"versionId": ...,
}
Definition
class ProvisioningTemplateVersionSummaryTypeDef(TypedDict):
versionId: NotRequired[int],
creationDate: NotRequired[datetime],
isDefaultVersion: NotRequired[bool],
ListProvisioningTemplatesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListProvisioningTemplatesRequestRequestTypeDef
def get_value() -> ListProvisioningTemplatesRequestRequestTypeDef:
return {
"maxResults": ...,
}
Definition
class ListProvisioningTemplatesRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ProvisioningTemplateSummaryTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ProvisioningTemplateSummaryTypeDef
def get_value() -> ProvisioningTemplateSummaryTypeDef:
return {
"templateArn": ...,
}
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
ListRelatedResourcesForAuditFindingRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListRelatedResourcesForAuditFindingRequestRequestTypeDef
def get_value() -> ListRelatedResourcesForAuditFindingRequestRequestTypeDef:
return {
"findingId": ...,
}
Definition
class ListRelatedResourcesForAuditFindingRequestRequestTypeDef(TypedDict):
findingId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListRoleAliasesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListRoleAliasesRequestRequestTypeDef
def get_value() -> ListRoleAliasesRequestRequestTypeDef:
return {
"pageSize": ...,
}
Definition
class ListRoleAliasesRequestRequestTypeDef(TypedDict):
pageSize: NotRequired[int],
marker: NotRequired[str],
ascendingOrder: NotRequired[bool],
ListScheduledAuditsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListScheduledAuditsRequestRequestTypeDef
def get_value() -> ListScheduledAuditsRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListScheduledAuditsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ScheduledAuditMetadataTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ScheduledAuditMetadataTypeDef
def get_value() -> ScheduledAuditMetadataTypeDef:
return {
"scheduledAuditName": ...,
}
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
ListSecurityProfilesForTargetRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListSecurityProfilesForTargetRequestRequestTypeDef
def get_value() -> ListSecurityProfilesForTargetRequestRequestTypeDef:
return {
"securityProfileTargetArn": ...,
}
Definition
class ListSecurityProfilesForTargetRequestRequestTypeDef(TypedDict):
securityProfileTargetArn: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
recursive: NotRequired[bool],
ListSecurityProfilesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListSecurityProfilesRequestRequestTypeDef
def get_value() -> ListSecurityProfilesRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListSecurityProfilesRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
dimensionName: NotRequired[str],
metricName: NotRequired[str],
SecurityProfileIdentifierTypeDef
Usage Example
from mypy_boto3_iot.type_defs import SecurityProfileIdentifierTypeDef
def get_value() -> SecurityProfileIdentifierTypeDef:
return {
"name": ...,
"arn": ...,
}
ListStreamsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListStreamsRequestRequestTypeDef
def get_value() -> ListStreamsRequestRequestTypeDef:
return {
"maxResults": ...,
}
Definition
class ListStreamsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ascendingOrder: NotRequired[bool],
StreamSummaryTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StreamSummaryTypeDef
def get_value() -> StreamSummaryTypeDef:
return {
"streamId": ...,
}
Definition
class StreamSummaryTypeDef(TypedDict):
streamId: NotRequired[str],
streamArn: NotRequired[str],
streamVersion: NotRequired[int],
description: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
nextToken: NotRequired[str],
ListTargetsForPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListTargetsForPolicyRequestRequestTypeDef
def get_value() -> ListTargetsForPolicyRequestRequestTypeDef:
return {
"policyName": ...,
}
Definition
class ListTargetsForPolicyRequestRequestTypeDef(TypedDict):
policyName: str,
marker: NotRequired[str],
pageSize: NotRequired[int],
ListTargetsForSecurityProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListTargetsForSecurityProfileRequestRequestTypeDef
def get_value() -> ListTargetsForSecurityProfileRequestRequestTypeDef:
return {
"securityProfileName": ...,
}
Definition
class ListTargetsForSecurityProfileRequestRequestTypeDef(TypedDict):
securityProfileName: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
SecurityProfileTargetTypeDef
Usage Example
from mypy_boto3_iot.type_defs import SecurityProfileTargetTypeDef
def get_value() -> SecurityProfileTargetTypeDef:
return {
"arn": ...,
}
ListThingGroupsForThingRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingGroupsForThingRequestRequestTypeDef
def get_value() -> ListThingGroupsForThingRequestRequestTypeDef:
return {
"thingName": ...,
}
Definition
class ListThingGroupsForThingRequestRequestTypeDef(TypedDict):
thingName: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListThingGroupsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingGroupsRequestRequestTypeDef
def get_value() -> ListThingGroupsRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListThingGroupsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
parentGroup: NotRequired[str],
namePrefixFilter: NotRequired[str],
recursive: NotRequired[bool],
ListThingPrincipalsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingPrincipalsRequestRequestTypeDef
def get_value() -> ListThingPrincipalsRequestRequestTypeDef:
return {
"thingName": ...,
}
Definition
class ListThingPrincipalsRequestRequestTypeDef(TypedDict):
thingName: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListThingRegistrationTaskReportsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingRegistrationTaskReportsRequestRequestTypeDef
def get_value() -> ListThingRegistrationTaskReportsRequestRequestTypeDef:
return {
"taskId": ...,
"reportType": ...,
}
Definition
class ListThingRegistrationTaskReportsRequestRequestTypeDef(TypedDict):
taskId: str,
reportType: ReportTypeType, # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
- See ReportTypeType
ListThingRegistrationTasksRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingRegistrationTasksRequestRequestTypeDef
def get_value() -> ListThingRegistrationTasksRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListThingRegistrationTasksRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
status: NotRequired[StatusType], # (1)
- See StatusType
ListThingTypesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingTypesRequestRequestTypeDef
def get_value() -> ListThingTypesRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListThingTypesRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
thingTypeName: NotRequired[str],
ListThingsInBillingGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingsInBillingGroupRequestRequestTypeDef
def get_value() -> ListThingsInBillingGroupRequestRequestTypeDef:
return {
"billingGroupName": ...,
}
Definition
class ListThingsInBillingGroupRequestRequestTypeDef(TypedDict):
billingGroupName: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListThingsInThingGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingsInThingGroupRequestRequestTypeDef
def get_value() -> ListThingsInThingGroupRequestRequestTypeDef:
return {
"thingGroupName": ...,
}
Definition
class ListThingsInThingGroupRequestRequestTypeDef(TypedDict):
thingGroupName: str,
recursive: NotRequired[bool],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListThingsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingsRequestRequestTypeDef
def get_value() -> ListThingsRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListThingsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
attributeName: NotRequired[str],
attributeValue: NotRequired[str],
thingTypeName: NotRequired[str],
usePrefixAttributeValue: NotRequired[bool],
ThingAttributeTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ThingAttributeTypeDef
def get_value() -> ThingAttributeTypeDef:
return {
"thingName": ...,
}
Definition
class ThingAttributeTypeDef(TypedDict):
thingName: NotRequired[str],
thingTypeName: NotRequired[str],
thingArn: NotRequired[str],
attributes: NotRequired[Dict[str, str]],
version: NotRequired[int],
ListTopicRuleDestinationsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListTopicRuleDestinationsRequestRequestTypeDef
def get_value() -> ListTopicRuleDestinationsRequestRequestTypeDef:
return {
"maxResults": ...,
}
Definition
class ListTopicRuleDestinationsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListTopicRulesRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListTopicRulesRequestRequestTypeDef
def get_value() -> ListTopicRulesRequestRequestTypeDef:
return {
"topic": ...,
}
Definition
class ListTopicRulesRequestRequestTypeDef(TypedDict):
topic: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ruleDisabled: NotRequired[bool],
TopicRuleListItemTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TopicRuleListItemTypeDef
def get_value() -> TopicRuleListItemTypeDef:
return {
"ruleArn": ...,
}
Definition
class TopicRuleListItemTypeDef(TypedDict):
ruleArn: NotRequired[str],
ruleName: NotRequired[str],
topicPattern: NotRequired[str],
createdAt: NotRequired[datetime],
ruleDisabled: NotRequired[bool],
ListV2LoggingLevelsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListV2LoggingLevelsRequestRequestTypeDef
def get_value() -> ListV2LoggingLevelsRequestRequestTypeDef:
return {
"targetType": ...,
}
Definition
class ListV2LoggingLevelsRequestRequestTypeDef(TypedDict):
targetType: NotRequired[LogTargetTypeType], # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListViolationEventsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListViolationEventsRequestRequestTypeDef
def get_value() -> ListViolationEventsRequestRequestTypeDef:
return {
"startTime": ...,
"endTime": ...,
}
Definition
class ListViolationEventsRequestRequestTypeDef(TypedDict):
startTime: Union[datetime, str],
endTime: Union[datetime, str],
thingName: NotRequired[str],
securityProfileName: NotRequired[str],
behaviorCriteriaType: NotRequired[BehaviorCriteriaTypeType], # (1)
listSuppressedAlerts: NotRequired[bool],
verificationState: NotRequired[VerificationStateType], # (2)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
LocationTimestampTypeDef
Usage Example
from mypy_boto3_iot.type_defs import LocationTimestampTypeDef
def get_value() -> LocationTimestampTypeDef:
return {
"value": ...,
}
LogTargetTypeDef
Usage Example
from mypy_boto3_iot.type_defs import LogTargetTypeDef
def get_value() -> LogTargetTypeDef:
return {
"targetType": ...,
}
Definition
class LogTargetTypeDef(TypedDict):
targetType: LogTargetTypeType, # (1)
targetName: NotRequired[str],
LoggingOptionsPayloadTypeDef
Usage Example
from mypy_boto3_iot.type_defs import LoggingOptionsPayloadTypeDef
def get_value() -> LoggingOptionsPayloadTypeDef:
return {
"roleArn": ...,
}
Definition
class LoggingOptionsPayloadTypeDef(TypedDict):
roleArn: str,
logLevel: NotRequired[LogLevelType], # (1)
- See LogLevelType
PublishFindingToSnsParamsTypeDef
Usage Example
from mypy_boto3_iot.type_defs import PublishFindingToSnsParamsTypeDef
def get_value() -> PublishFindingToSnsParamsTypeDef:
return {
"topicArn": ...,
}
ReplaceDefaultPolicyVersionParamsTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ReplaceDefaultPolicyVersionParamsTypeDef
def get_value() -> ReplaceDefaultPolicyVersionParamsTypeDef:
return {
"templateName": ...,
}
Definition
class ReplaceDefaultPolicyVersionParamsTypeDef(TypedDict):
templateName: PolicyTemplateNameType, # (1)
UpdateCACertificateParamsTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateCACertificateParamsTypeDef
def get_value() -> UpdateCACertificateParamsTypeDef:
return {
"action": ...,
}
Definition
class UpdateCACertificateParamsTypeDef(TypedDict):
action: CACertificateUpdateActionType, # (1)
UpdateDeviceCertificateParamsTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateDeviceCertificateParamsTypeDef
def get_value() -> UpdateDeviceCertificateParamsTypeDef:
return {
"action": ...,
}
Definition
class UpdateDeviceCertificateParamsTypeDef(TypedDict):
action: DeviceCertificateUpdateActionType, # (1)
MqttContextTypeDef
Usage Example
from mypy_boto3_iot.type_defs import MqttContextTypeDef
def get_value() -> MqttContextTypeDef:
return {
"username": ...,
}
Definition
class MqttContextTypeDef(TypedDict):
username: NotRequired[str],
password: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
clientId: NotRequired[str],
UserPropertyTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UserPropertyTypeDef
def get_value() -> UserPropertyTypeDef:
return {
"key": ...,
"value": ...,
}
PolicyVersionIdentifierTypeDef
Usage Example
from mypy_boto3_iot.type_defs import PolicyVersionIdentifierTypeDef
def get_value() -> PolicyVersionIdentifierTypeDef:
return {
"policyName": ...,
}
Definition
class PolicyVersionIdentifierTypeDef(TypedDict):
policyName: NotRequired[str],
policyVersionId: NotRequired[str],
PutVerificationStateOnViolationRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import PutVerificationStateOnViolationRequestRequestTypeDef
def get_value() -> PutVerificationStateOnViolationRequestRequestTypeDef:
return {
"violationId": ...,
"verificationState": ...,
}
Definition
class PutVerificationStateOnViolationRequestRequestTypeDef(TypedDict):
violationId: str,
verificationState: VerificationStateType, # (1)
verificationStateDescription: NotRequired[str],
RegisterCertificateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RegisterCertificateRequestRequestTypeDef
def get_value() -> RegisterCertificateRequestRequestTypeDef:
return {
"certificatePem": ...,
}
Definition
class RegisterCertificateRequestRequestTypeDef(TypedDict):
certificatePem: str,
caCertificatePem: NotRequired[str],
setAsActive: NotRequired[bool],
status: NotRequired[CertificateStatusType], # (1)
RegisterCertificateWithoutCARequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RegisterCertificateWithoutCARequestRequestTypeDef
def get_value() -> RegisterCertificateWithoutCARequestRequestTypeDef:
return {
"certificatePem": ...,
}
Definition
class RegisterCertificateWithoutCARequestRequestTypeDef(TypedDict):
certificatePem: str,
status: NotRequired[CertificateStatusType], # (1)
RegisterThingRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RegisterThingRequestRequestTypeDef
def get_value() -> RegisterThingRequestRequestTypeDef:
return {
"templateBody": ...,
}
Definition
class RegisterThingRequestRequestTypeDef(TypedDict):
templateBody: str,
parameters: NotRequired[Mapping[str, str]],
RejectCertificateTransferRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RejectCertificateTransferRequestRequestTypeDef
def get_value() -> RejectCertificateTransferRequestRequestTypeDef:
return {
"certificateId": ...,
}
Definition
class RejectCertificateTransferRequestRequestTypeDef(TypedDict):
certificateId: str,
rejectReason: NotRequired[str],
RemoveThingFromBillingGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RemoveThingFromBillingGroupRequestRequestTypeDef
def get_value() -> RemoveThingFromBillingGroupRequestRequestTypeDef:
return {
"billingGroupName": ...,
}
Definition
class RemoveThingFromBillingGroupRequestRequestTypeDef(TypedDict):
billingGroupName: NotRequired[str],
billingGroupArn: NotRequired[str],
thingName: NotRequired[str],
thingArn: NotRequired[str],
RemoveThingFromThingGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RemoveThingFromThingGroupRequestRequestTypeDef
def get_value() -> RemoveThingFromThingGroupRequestRequestTypeDef:
return {
"thingGroupName": ...,
}
Definition
class RemoveThingFromThingGroupRequestRequestTypeDef(TypedDict):
thingGroupName: NotRequired[str],
thingGroupArn: NotRequired[str],
thingName: NotRequired[str],
thingArn: NotRequired[str],
SearchIndexRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import SearchIndexRequestRequestTypeDef
def get_value() -> SearchIndexRequestRequestTypeDef:
return {
"queryString": ...,
}
Definition
class SearchIndexRequestRequestTypeDef(TypedDict):
queryString: str,
indexName: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
queryVersion: NotRequired[str],
ThingGroupDocumentTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ThingGroupDocumentTypeDef
def get_value() -> ThingGroupDocumentTypeDef:
return {
"thingGroupName": ...,
}
Definition
class ThingGroupDocumentTypeDef(TypedDict):
thingGroupName: NotRequired[str],
thingGroupId: NotRequired[str],
thingGroupDescription: NotRequired[str],
attributes: NotRequired[Dict[str, str]],
parentGroupNames: NotRequired[List[str]],
SetDefaultAuthorizerRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import SetDefaultAuthorizerRequestRequestTypeDef
def get_value() -> SetDefaultAuthorizerRequestRequestTypeDef:
return {
"authorizerName": ...,
}
SetDefaultPolicyVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import SetDefaultPolicyVersionRequestRequestTypeDef
def get_value() -> SetDefaultPolicyVersionRequestRequestTypeDef:
return {
"policyName": ...,
"policyVersionId": ...,
}
Definition
class SetDefaultPolicyVersionRequestRequestTypeDef(TypedDict):
policyName: str,
policyVersionId: str,
SetV2LoggingOptionsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import SetV2LoggingOptionsRequestRequestTypeDef
def get_value() -> SetV2LoggingOptionsRequestRequestTypeDef:
return {
"roleArn": ...,
}
Definition
class SetV2LoggingOptionsRequestRequestTypeDef(TypedDict):
roleArn: NotRequired[str],
defaultLogLevel: NotRequired[LogLevelType], # (1)
disableAllLogs: NotRequired[bool],
- See LogLevelType
SigningProfileParameterTypeDef
Usage Example
from mypy_boto3_iot.type_defs import SigningProfileParameterTypeDef
def get_value() -> SigningProfileParameterTypeDef:
return {
"certificateArn": ...,
}
Definition
class SigningProfileParameterTypeDef(TypedDict):
certificateArn: NotRequired[str],
platform: NotRequired[str],
certificatePathOnDevice: NotRequired[str],
StartOnDemandAuditTaskRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StartOnDemandAuditTaskRequestRequestTypeDef
def get_value() -> StartOnDemandAuditTaskRequestRequestTypeDef:
return {
"targetCheckNames": ...,
}
Definition
class StartOnDemandAuditTaskRequestRequestTypeDef(TypedDict):
targetCheckNames: Sequence[str],
StartThingRegistrationTaskRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StartThingRegistrationTaskRequestRequestTypeDef
def get_value() -> StartThingRegistrationTaskRequestRequestTypeDef:
return {
"templateBody": ...,
"inputFileBucket": ...,
"inputFileKey": ...,
"roleArn": ...,
}
Definition
class StartThingRegistrationTaskRequestRequestTypeDef(TypedDict):
templateBody: str,
inputFileBucket: str,
inputFileKey: str,
roleArn: str,
StopThingRegistrationTaskRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StopThingRegistrationTaskRequestRequestTypeDef
def get_value() -> StopThingRegistrationTaskRequestRequestTypeDef:
return {
"taskId": ...,
}
TlsContextTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TlsContextTypeDef
def get_value() -> TlsContextTypeDef:
return {
"serverName": ...,
}
ThingConnectivityTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ThingConnectivityTypeDef
def get_value() -> ThingConnectivityTypeDef:
return {
"connected": ...,
}
Definition
class ThingConnectivityTypeDef(TypedDict):
connected: NotRequired[bool],
timestamp: NotRequired[int],
disconnectReason: NotRequired[str],
TimestreamDimensionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TimestreamDimensionTypeDef
def get_value() -> TimestreamDimensionTypeDef:
return {
"name": ...,
"value": ...,
}
TimestreamTimestampTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TimestreamTimestampTypeDef
def get_value() -> TimestreamTimestampTypeDef:
return {
"value": ...,
"unit": ...,
}
VpcDestinationConfigurationTypeDef
Usage Example
from mypy_boto3_iot.type_defs import VpcDestinationConfigurationTypeDef
def get_value() -> VpcDestinationConfigurationTypeDef:
return {
"subnetIds": ...,
"vpcId": ...,
"roleArn": ...,
}
Definition
class VpcDestinationConfigurationTypeDef(TypedDict):
subnetIds: Sequence[str],
vpcId: str,
roleArn: str,
securityGroups: NotRequired[Sequence[str]],
VpcDestinationSummaryTypeDef
Usage Example
from mypy_boto3_iot.type_defs import VpcDestinationSummaryTypeDef
def get_value() -> VpcDestinationSummaryTypeDef:
return {
"subnetIds": ...,
}
Definition
class VpcDestinationSummaryTypeDef(TypedDict):
subnetIds: NotRequired[List[str]],
securityGroups: NotRequired[List[str]],
vpcId: NotRequired[str],
roleArn: NotRequired[str],
VpcDestinationPropertiesTypeDef
Usage Example
from mypy_boto3_iot.type_defs import VpcDestinationPropertiesTypeDef
def get_value() -> VpcDestinationPropertiesTypeDef:
return {
"subnetIds": ...,
}
Definition
class VpcDestinationPropertiesTypeDef(TypedDict):
subnetIds: NotRequired[List[str]],
securityGroups: NotRequired[List[str]],
vpcId: NotRequired[str],
roleArn: NotRequired[str],
TransferCertificateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TransferCertificateRequestRequestTypeDef
def get_value() -> TransferCertificateRequestRequestTypeDef:
return {
"certificateId": ...,
"targetAwsAccount": ...,
}
Definition
class TransferCertificateRequestRequestTypeDef(TypedDict):
certificateId: str,
targetAwsAccount: str,
transferMessage: NotRequired[str],
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateAuthorizerRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateAuthorizerRequestRequestTypeDef
def get_value() -> UpdateAuthorizerRequestRequestTypeDef:
return {
"authorizerName": ...,
}
Definition
class UpdateAuthorizerRequestRequestTypeDef(TypedDict):
authorizerName: str,
authorizerFunctionArn: NotRequired[str],
tokenKeyName: NotRequired[str],
tokenSigningPublicKeys: NotRequired[Mapping[str, str]],
status: NotRequired[AuthorizerStatusType], # (1)
enableCachingForHttp: NotRequired[bool],
UpdateCertificateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateCertificateRequestRequestTypeDef
def get_value() -> UpdateCertificateRequestRequestTypeDef:
return {
"certificateId": ...,
"newStatus": ...,
}
Definition
class UpdateCertificateRequestRequestTypeDef(TypedDict):
certificateId: str,
newStatus: CertificateStatusType, # (1)
UpdateCustomMetricRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateCustomMetricRequestRequestTypeDef
def get_value() -> UpdateCustomMetricRequestRequestTypeDef:
return {
"metricName": ...,
"displayName": ...,
}
Definition
class UpdateCustomMetricRequestRequestTypeDef(TypedDict):
metricName: str,
displayName: str,
UpdateDimensionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateDimensionRequestRequestTypeDef
def get_value() -> UpdateDimensionRequestRequestTypeDef:
return {
"name": ...,
"stringValues": ...,
}
Definition
class UpdateDimensionRequestRequestTypeDef(TypedDict):
name: str,
stringValues: Sequence[str],
UpdateRoleAliasRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateRoleAliasRequestRequestTypeDef
def get_value() -> UpdateRoleAliasRequestRequestTypeDef:
return {
"roleAlias": ...,
}
Definition
class UpdateRoleAliasRequestRequestTypeDef(TypedDict):
roleAlias: str,
roleArn: NotRequired[str],
credentialDurationSeconds: NotRequired[int],
UpdateScheduledAuditRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateScheduledAuditRequestRequestTypeDef
def get_value() -> UpdateScheduledAuditRequestRequestTypeDef:
return {
"scheduledAuditName": ...,
}
Definition
class UpdateScheduledAuditRequestRequestTypeDef(TypedDict):
scheduledAuditName: str,
frequency: NotRequired[AuditFrequencyType], # (1)
dayOfMonth: NotRequired[str],
dayOfWeek: NotRequired[DayOfWeekType], # (2)
targetCheckNames: NotRequired[Sequence[str]],
- See AuditFrequencyType
- See DayOfWeekType
UpdateThingGroupsForThingRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateThingGroupsForThingRequestRequestTypeDef
def get_value() -> UpdateThingGroupsForThingRequestRequestTypeDef:
return {
"thingName": ...,
}
Definition
class UpdateThingGroupsForThingRequestRequestTypeDef(TypedDict):
thingName: NotRequired[str],
thingGroupsToAdd: NotRequired[Sequence[str]],
thingGroupsToRemove: NotRequired[Sequence[str]],
overrideDynamicGroups: NotRequired[bool],
UpdateTopicRuleDestinationRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateTopicRuleDestinationRequestRequestTypeDef
def get_value() -> UpdateTopicRuleDestinationRequestRequestTypeDef:
return {
"arn": ...,
"status": ...,
}
Definition
class UpdateTopicRuleDestinationRequestRequestTypeDef(TypedDict):
arn: str,
status: TopicRuleDestinationStatusType, # (1)
ValidationErrorTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ValidationErrorTypeDef
def get_value() -> ValidationErrorTypeDef:
return {
"errorMessage": ...,
}
AbortConfigTypeDef
Usage Example
from mypy_boto3_iot.type_defs import AbortConfigTypeDef
def get_value() -> AbortConfigTypeDef:
return {
"criteriaList": ...,
}
MetricDatumTypeDef
Usage Example
from mypy_boto3_iot.type_defs import MetricDatumTypeDef
def get_value() -> MetricDatumTypeDef:
return {
"timestamp": ...,
}
Definition
class MetricDatumTypeDef(TypedDict):
timestamp: NotRequired[datetime],
value: NotRequired[MetricValueTypeDef], # (1)
UpdateFleetMetricRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateFleetMetricRequestRequestTypeDef
def get_value() -> UpdateFleetMetricRequestRequestTypeDef:
return {
"metricName": ...,
"indexName": ...,
}
Definition
class UpdateFleetMetricRequestRequestTypeDef(TypedDict):
metricName: str,
indexName: str,
queryString: NotRequired[str],
aggregationType: NotRequired[AggregationTypeTypeDef], # (1)
period: NotRequired[int],
aggregationField: NotRequired[str],
description: NotRequired[str],
queryVersion: NotRequired[str],
unit: NotRequired[FleetMetricUnitType], # (2)
expectedVersion: NotRequired[int],
AllowedTypeDef
Usage Example
from mypy_boto3_iot.type_defs import AllowedTypeDef
def get_value() -> AllowedTypeDef:
return {
"policies": ...,
}
- See PolicyTypeDef
ExplicitDenyTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ExplicitDenyTypeDef
def get_value() -> ExplicitDenyTypeDef:
return {
"policies": ...,
}
- See PolicyTypeDef
ImplicitDenyTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ImplicitDenyTypeDef
def get_value() -> ImplicitDenyTypeDef:
return {
"policies": ...,
}
- See PolicyTypeDef
AssetPropertyValueTypeDef
Usage Example
from mypy_boto3_iot.type_defs import AssetPropertyValueTypeDef
def get_value() -> AssetPropertyValueTypeDef:
return {
"value": ...,
"timestamp": ...,
}
Definition
class AssetPropertyValueTypeDef(TypedDict):
value: AssetPropertyVariantTypeDef, # (1)
timestamp: AssetPropertyTimestampTypeDef, # (2)
quality: NotRequired[str],
AssociateTargetsWithJobResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import AssociateTargetsWithJobResponseTypeDef
def get_value() -> AssociateTargetsWithJobResponseTypeDef:
return {
"jobArn": ...,
"jobId": ...,
"description": ...,
"ResponseMetadata": ...,
}
Definition
class AssociateTargetsWithJobResponseTypeDef(TypedDict):
jobArn: str,
jobId: str,
description: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CancelJobResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CancelJobResponseTypeDef
def get_value() -> CancelJobResponseTypeDef:
return {
"jobArn": ...,
"jobId": ...,
"description": ...,
"ResponseMetadata": ...,
}
Definition
class CancelJobResponseTypeDef(TypedDict):
jobArn: str,
jobId: str,
description: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateAuthorizerResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateAuthorizerResponseTypeDef
def get_value() -> CreateAuthorizerResponseTypeDef:
return {
"authorizerName": ...,
"authorizerArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateAuthorizerResponseTypeDef(TypedDict):
authorizerName: str,
authorizerArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBillingGroupResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateBillingGroupResponseTypeDef
def get_value() -> CreateBillingGroupResponseTypeDef:
return {
"billingGroupName": ...,
"billingGroupArn": ...,
"billingGroupId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateBillingGroupResponseTypeDef(TypedDict):
billingGroupName: str,
billingGroupArn: str,
billingGroupId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateCertificateFromCsrResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateCertificateFromCsrResponseTypeDef
def get_value() -> CreateCertificateFromCsrResponseTypeDef:
return {
"certificateArn": ...,
"certificateId": ...,
"certificatePem": ...,
"ResponseMetadata": ...,
}
Definition
class CreateCertificateFromCsrResponseTypeDef(TypedDict):
certificateArn: str,
certificateId: str,
certificatePem: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateCustomMetricResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateCustomMetricResponseTypeDef
def get_value() -> CreateCustomMetricResponseTypeDef:
return {
"metricName": ...,
"metricArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateCustomMetricResponseTypeDef(TypedDict):
metricName: str,
metricArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDimensionResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateDimensionResponseTypeDef
def get_value() -> CreateDimensionResponseTypeDef:
return {
"name": ...,
"arn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateDimensionResponseTypeDef(TypedDict):
name: str,
arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDomainConfigurationResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateDomainConfigurationResponseTypeDef
def get_value() -> CreateDomainConfigurationResponseTypeDef:
return {
"domainConfigurationName": ...,
"domainConfigurationArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateDomainConfigurationResponseTypeDef(TypedDict):
domainConfigurationName: str,
domainConfigurationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDynamicThingGroupResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateDynamicThingGroupResponseTypeDef
def get_value() -> CreateDynamicThingGroupResponseTypeDef:
return {
"thingGroupName": ...,
"thingGroupArn": ...,
"thingGroupId": ...,
"indexName": ...,
"queryString": ...,
"queryVersion": ...,
"ResponseMetadata": ...,
}
Definition
class CreateDynamicThingGroupResponseTypeDef(TypedDict):
thingGroupName: str,
thingGroupArn: str,
thingGroupId: str,
indexName: str,
queryString: str,
queryVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateFleetMetricResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateFleetMetricResponseTypeDef
def get_value() -> CreateFleetMetricResponseTypeDef:
return {
"metricName": ...,
"metricArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateFleetMetricResponseTypeDef(TypedDict):
metricName: str,
metricArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateJobResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateJobResponseTypeDef
def get_value() -> CreateJobResponseTypeDef:
return {
"jobArn": ...,
"jobId": ...,
"description": ...,
"ResponseMetadata": ...,
}
Definition
class CreateJobResponseTypeDef(TypedDict):
jobArn: str,
jobId: str,
description: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateJobTemplateResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateJobTemplateResponseTypeDef
def get_value() -> CreateJobTemplateResponseTypeDef:
return {
"jobTemplateArn": ...,
"jobTemplateId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateJobTemplateResponseTypeDef(TypedDict):
jobTemplateArn: str,
jobTemplateId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateMitigationActionResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateMitigationActionResponseTypeDef
def get_value() -> CreateMitigationActionResponseTypeDef:
return {
"actionArn": ...,
"actionId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateMitigationActionResponseTypeDef(TypedDict):
actionArn: str,
actionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateOTAUpdateResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateOTAUpdateResponseTypeDef
def get_value() -> CreateOTAUpdateResponseTypeDef:
return {
"otaUpdateId": ...,
"awsIotJobId": ...,
"otaUpdateArn": ...,
"awsIotJobArn": ...,
"otaUpdateStatus": ...,
"ResponseMetadata": ...,
}
Definition
class CreateOTAUpdateResponseTypeDef(TypedDict):
otaUpdateId: str,
awsIotJobId: str,
otaUpdateArn: str,
awsIotJobArn: str,
otaUpdateStatus: OTAUpdateStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreatePolicyResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreatePolicyResponseTypeDef
def get_value() -> CreatePolicyResponseTypeDef:
return {
"policyName": ...,
"policyArn": ...,
"policyDocument": ...,
"policyVersionId": ...,
"ResponseMetadata": ...,
}
Definition
class CreatePolicyResponseTypeDef(TypedDict):
policyName: str,
policyArn: str,
policyDocument: str,
policyVersionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreatePolicyVersionResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreatePolicyVersionResponseTypeDef
def get_value() -> CreatePolicyVersionResponseTypeDef:
return {
"policyArn": ...,
"policyDocument": ...,
"policyVersionId": ...,
"isDefaultVersion": ...,
"ResponseMetadata": ...,
}
Definition
class CreatePolicyVersionResponseTypeDef(TypedDict):
policyArn: str,
policyDocument: str,
policyVersionId: str,
isDefaultVersion: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProvisioningTemplateResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateProvisioningTemplateResponseTypeDef
def get_value() -> CreateProvisioningTemplateResponseTypeDef:
return {
"templateArn": ...,
"templateName": ...,
"defaultVersionId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateProvisioningTemplateResponseTypeDef(TypedDict):
templateArn: str,
templateName: str,
defaultVersionId: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProvisioningTemplateVersionResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateProvisioningTemplateVersionResponseTypeDef
def get_value() -> CreateProvisioningTemplateVersionResponseTypeDef:
return {
"templateArn": ...,
"templateName": ...,
"versionId": ...,
"isDefaultVersion": ...,
"ResponseMetadata": ...,
}
Definition
class CreateProvisioningTemplateVersionResponseTypeDef(TypedDict):
templateArn: str,
templateName: str,
versionId: int,
isDefaultVersion: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateRoleAliasResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateRoleAliasResponseTypeDef
def get_value() -> CreateRoleAliasResponseTypeDef:
return {
"roleAlias": ...,
"roleAliasArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateRoleAliasResponseTypeDef(TypedDict):
roleAlias: str,
roleAliasArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateScheduledAuditResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateScheduledAuditResponseTypeDef
def get_value() -> CreateScheduledAuditResponseTypeDef:
return {
"scheduledAuditArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateScheduledAuditResponseTypeDef(TypedDict):
scheduledAuditArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateSecurityProfileResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateSecurityProfileResponseTypeDef
def get_value() -> CreateSecurityProfileResponseTypeDef:
return {
"securityProfileName": ...,
"securityProfileArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateSecurityProfileResponseTypeDef(TypedDict):
securityProfileName: str,
securityProfileArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateStreamResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateStreamResponseTypeDef
def get_value() -> CreateStreamResponseTypeDef:
return {
"streamId": ...,
"streamArn": ...,
"description": ...,
"streamVersion": ...,
"ResponseMetadata": ...,
}
Definition
class CreateStreamResponseTypeDef(TypedDict):
streamId: str,
streamArn: str,
description: str,
streamVersion: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateThingGroupResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateThingGroupResponseTypeDef
def get_value() -> CreateThingGroupResponseTypeDef:
return {
"thingGroupName": ...,
"thingGroupArn": ...,
"thingGroupId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateThingGroupResponseTypeDef(TypedDict):
thingGroupName: str,
thingGroupArn: str,
thingGroupId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateThingResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateThingResponseTypeDef
def get_value() -> CreateThingResponseTypeDef:
return {
"thingName": ...,
"thingArn": ...,
"thingId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateThingResponseTypeDef(TypedDict):
thingName: str,
thingArn: str,
thingId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateThingTypeResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateThingTypeResponseTypeDef
def get_value() -> CreateThingTypeResponseTypeDef:
return {
"thingTypeName": ...,
"thingTypeArn": ...,
"thingTypeId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateThingTypeResponseTypeDef(TypedDict):
thingTypeName: str,
thingTypeArn: str,
thingTypeId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeCustomMetricResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeCustomMetricResponseTypeDef
def get_value() -> DescribeCustomMetricResponseTypeDef:
return {
"metricName": ...,
"metricArn": ...,
"metricType": ...,
"displayName": ...,
"creationDate": ...,
"lastModifiedDate": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeCustomMetricResponseTypeDef(TypedDict):
metricName: str,
metricArn: str,
metricType: CustomMetricTypeType, # (1)
displayName: str,
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeDimensionResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeDimensionResponseTypeDef
def get_value() -> DescribeDimensionResponseTypeDef:
return {
"name": ...,
"arn": ...,
"type": ...,
"stringValues": ...,
"creationDate": ...,
"lastModifiedDate": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeDimensionResponseTypeDef(TypedDict):
name: str,
arn: str,
type: DimensionTypeType, # (1)
stringValues: List[str],
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeEndpointResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeEndpointResponseTypeDef
def get_value() -> DescribeEndpointResponseTypeDef:
return {
"endpointAddress": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeEndpointResponseTypeDef(TypedDict):
endpointAddress: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeFleetMetricResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeFleetMetricResponseTypeDef
def get_value() -> DescribeFleetMetricResponseTypeDef:
return {
"metricName": ...,
"queryString": ...,
"aggregationType": ...,
"period": ...,
"aggregationField": ...,
"description": ...,
"queryVersion": ...,
"indexName": ...,
"creationDate": ...,
"lastModifiedDate": ...,
"unit": ...,
"version": ...,
"metricArn": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeFleetMetricResponseTypeDef(TypedDict):
metricName: str,
queryString: str,
aggregationType: AggregationTypeTypeDef, # (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
Usage Example
from mypy_boto3_iot.type_defs import DescribeIndexResponseTypeDef
def get_value() -> DescribeIndexResponseTypeDef:
return {
"indexName": ...,
"indexStatus": ...,
"schema": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeIndexResponseTypeDef(TypedDict):
indexName: str,
indexStatus: IndexStatusType, # (1)
schema: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeProvisioningTemplateVersionResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeProvisioningTemplateVersionResponseTypeDef
def get_value() -> DescribeProvisioningTemplateVersionResponseTypeDef:
return {
"versionId": ...,
"creationDate": ...,
"templateBody": ...,
"isDefaultVersion": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeProvisioningTemplateVersionResponseTypeDef(TypedDict):
versionId: int,
creationDate: datetime,
templateBody: str,
isDefaultVersion: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeScheduledAuditResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeScheduledAuditResponseTypeDef
def get_value() -> DescribeScheduledAuditResponseTypeDef:
return {
"frequency": ...,
"dayOfMonth": ...,
"dayOfWeek": ...,
"targetCheckNames": ...,
"scheduledAuditName": ...,
"scheduledAuditArn": ...,
"ResponseMetadata": ...,
}
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
Usage Example
from mypy_boto3_iot.type_defs import DescribeThingRegistrationTaskResponseTypeDef
def get_value() -> DescribeThingRegistrationTaskResponseTypeDef:
return {
"taskId": ...,
"creationDate": ...,
"lastModifiedDate": ...,
"templateBody": ...,
"inputFileBucket": ...,
"inputFileKey": ...,
"roleArn": ...,
"status": ...,
"message": ...,
"successCount": ...,
"failureCount": ...,
"percentageProgress": ...,
"ResponseMetadata": ...,
}
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
Usage Example
from mypy_boto3_iot.type_defs import DescribeThingResponseTypeDef
def get_value() -> DescribeThingResponseTypeDef:
return {
"defaultClientId": ...,
"thingName": ...,
"thingId": ...,
"thingArn": ...,
"thingTypeName": ...,
"attributes": ...,
"version": ...,
"billingGroupName": ...,
"ResponseMetadata": ...,
}
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
Usage Example
from mypy_boto3_iot.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetCardinalityResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetCardinalityResponseTypeDef
def get_value() -> GetCardinalityResponseTypeDef:
return {
"cardinality": ...,
"ResponseMetadata": ...,
}
Definition
class GetCardinalityResponseTypeDef(TypedDict):
cardinality: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetJobDocumentResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetJobDocumentResponseTypeDef
def get_value() -> GetJobDocumentResponseTypeDef:
return {
"document": ...,
"ResponseMetadata": ...,
}
Definition
class GetJobDocumentResponseTypeDef(TypedDict):
document: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetLoggingOptionsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetLoggingOptionsResponseTypeDef
def get_value() -> GetLoggingOptionsResponseTypeDef:
return {
"roleArn": ...,
"logLevel": ...,
"ResponseMetadata": ...,
}
Definition
class GetLoggingOptionsResponseTypeDef(TypedDict):
roleArn: str,
logLevel: LogLevelType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See LogLevelType
- See ResponseMetadataTypeDef
GetPolicyResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetPolicyResponseTypeDef
def get_value() -> GetPolicyResponseTypeDef:
return {
"policyName": ...,
"policyArn": ...,
"policyDocument": ...,
"defaultVersionId": ...,
"creationDate": ...,
"lastModifiedDate": ...,
"generationId": ...,
"ResponseMetadata": ...,
}
Definition
class GetPolicyResponseTypeDef(TypedDict):
policyName: str,
policyArn: str,
policyDocument: str,
defaultVersionId: str,
creationDate: datetime,
lastModifiedDate: datetime,
generationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetPolicyVersionResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetPolicyVersionResponseTypeDef
def get_value() -> GetPolicyVersionResponseTypeDef:
return {
"policyArn": ...,
"policyName": ...,
"policyDocument": ...,
"policyVersionId": ...,
"isDefaultVersion": ...,
"creationDate": ...,
"lastModifiedDate": ...,
"generationId": ...,
"ResponseMetadata": ...,
}
Definition
class GetPolicyVersionResponseTypeDef(TypedDict):
policyArn: str,
policyName: str,
policyDocument: str,
policyVersionId: str,
isDefaultVersion: bool,
creationDate: datetime,
lastModifiedDate: datetime,
generationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetRegistrationCodeResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetRegistrationCodeResponseTypeDef
def get_value() -> GetRegistrationCodeResponseTypeDef:
return {
"registrationCode": ...,
"ResponseMetadata": ...,
}
Definition
class GetRegistrationCodeResponseTypeDef(TypedDict):
registrationCode: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetV2LoggingOptionsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetV2LoggingOptionsResponseTypeDef
def get_value() -> GetV2LoggingOptionsResponseTypeDef:
return {
"roleArn": ...,
"defaultLogLevel": ...,
"disableAllLogs": ...,
"ResponseMetadata": ...,
}
Definition
class GetV2LoggingOptionsResponseTypeDef(TypedDict):
roleArn: str,
defaultLogLevel: LogLevelType, # (1)
disableAllLogs: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See LogLevelType
- See ResponseMetadataTypeDef
ListAttachedPoliciesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAttachedPoliciesResponseTypeDef
def get_value() -> ListAttachedPoliciesResponseTypeDef:
return {
"policies": ...,
"nextMarker": ...,
"ResponseMetadata": ...,
}
Definition
class ListAttachedPoliciesResponseTypeDef(TypedDict):
policies: List[PolicyTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See PolicyTypeDef
- See ResponseMetadataTypeDef
ListCustomMetricsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListCustomMetricsResponseTypeDef
def get_value() -> ListCustomMetricsResponseTypeDef:
return {
"metricNames": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListCustomMetricsResponseTypeDef(TypedDict):
metricNames: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListDimensionsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListDimensionsResponseTypeDef
def get_value() -> ListDimensionsResponseTypeDef:
return {
"dimensionNames": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListDimensionsResponseTypeDef(TypedDict):
dimensionNames: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListIndicesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListIndicesResponseTypeDef
def get_value() -> ListIndicesResponseTypeDef:
return {
"indexNames": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListIndicesResponseTypeDef(TypedDict):
indexNames: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListPoliciesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListPoliciesResponseTypeDef
def get_value() -> ListPoliciesResponseTypeDef:
return {
"policies": ...,
"nextMarker": ...,
"ResponseMetadata": ...,
}
Definition
class ListPoliciesResponseTypeDef(TypedDict):
policies: List[PolicyTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See PolicyTypeDef
- See ResponseMetadataTypeDef
ListPolicyPrincipalsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListPolicyPrincipalsResponseTypeDef
def get_value() -> ListPolicyPrincipalsResponseTypeDef:
return {
"principals": ...,
"nextMarker": ...,
"ResponseMetadata": ...,
}
Definition
class ListPolicyPrincipalsResponseTypeDef(TypedDict):
principals: List[str],
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListPrincipalPoliciesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListPrincipalPoliciesResponseTypeDef
def get_value() -> ListPrincipalPoliciesResponseTypeDef:
return {
"policies": ...,
"nextMarker": ...,
"ResponseMetadata": ...,
}
Definition
class ListPrincipalPoliciesResponseTypeDef(TypedDict):
policies: List[PolicyTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See PolicyTypeDef
- See ResponseMetadataTypeDef
ListPrincipalThingsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListPrincipalThingsResponseTypeDef
def get_value() -> ListPrincipalThingsResponseTypeDef:
return {
"things": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListPrincipalThingsResponseTypeDef(TypedDict):
things: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListRoleAliasesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListRoleAliasesResponseTypeDef
def get_value() -> ListRoleAliasesResponseTypeDef:
return {
"roleAliases": ...,
"nextMarker": ...,
"ResponseMetadata": ...,
}
Definition
class ListRoleAliasesResponseTypeDef(TypedDict):
roleAliases: List[str],
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTargetsForPolicyResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListTargetsForPolicyResponseTypeDef
def get_value() -> ListTargetsForPolicyResponseTypeDef:
return {
"targets": ...,
"nextMarker": ...,
"ResponseMetadata": ...,
}
Definition
class ListTargetsForPolicyResponseTypeDef(TypedDict):
targets: List[str],
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListThingPrincipalsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingPrincipalsResponseTypeDef
def get_value() -> ListThingPrincipalsResponseTypeDef:
return {
"principals": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListThingPrincipalsResponseTypeDef(TypedDict):
principals: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListThingRegistrationTaskReportsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingRegistrationTaskReportsResponseTypeDef
def get_value() -> ListThingRegistrationTaskReportsResponseTypeDef:
return {
"resourceLinks": ...,
"reportType": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListThingRegistrationTaskReportsResponseTypeDef(TypedDict):
resourceLinks: List[str],
reportType: ReportTypeType, # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListThingRegistrationTasksResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingRegistrationTasksResponseTypeDef
def get_value() -> ListThingRegistrationTasksResponseTypeDef:
return {
"taskIds": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListThingRegistrationTasksResponseTypeDef(TypedDict):
taskIds: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListThingsInBillingGroupResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingsInBillingGroupResponseTypeDef
def get_value() -> ListThingsInBillingGroupResponseTypeDef:
return {
"things": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListThingsInBillingGroupResponseTypeDef(TypedDict):
things: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListThingsInThingGroupResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingsInThingGroupResponseTypeDef
def get_value() -> ListThingsInThingGroupResponseTypeDef:
return {
"things": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListThingsInThingGroupResponseTypeDef(TypedDict):
things: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RegisterCACertificateResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RegisterCACertificateResponseTypeDef
def get_value() -> RegisterCACertificateResponseTypeDef:
return {
"certificateArn": ...,
"certificateId": ...,
"ResponseMetadata": ...,
}
Definition
class RegisterCACertificateResponseTypeDef(TypedDict):
certificateArn: str,
certificateId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RegisterCertificateResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RegisterCertificateResponseTypeDef
def get_value() -> RegisterCertificateResponseTypeDef:
return {
"certificateArn": ...,
"certificateId": ...,
"ResponseMetadata": ...,
}
Definition
class RegisterCertificateResponseTypeDef(TypedDict):
certificateArn: str,
certificateId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RegisterCertificateWithoutCAResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RegisterCertificateWithoutCAResponseTypeDef
def get_value() -> RegisterCertificateWithoutCAResponseTypeDef:
return {
"certificateArn": ...,
"certificateId": ...,
"ResponseMetadata": ...,
}
Definition
class RegisterCertificateWithoutCAResponseTypeDef(TypedDict):
certificateArn: str,
certificateId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RegisterThingResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RegisterThingResponseTypeDef
def get_value() -> RegisterThingResponseTypeDef:
return {
"certificatePem": ...,
"resourceArns": ...,
"ResponseMetadata": ...,
}
Definition
class RegisterThingResponseTypeDef(TypedDict):
certificatePem: str,
resourceArns: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SetDefaultAuthorizerResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import SetDefaultAuthorizerResponseTypeDef
def get_value() -> SetDefaultAuthorizerResponseTypeDef:
return {
"authorizerName": ...,
"authorizerArn": ...,
"ResponseMetadata": ...,
}
Definition
class SetDefaultAuthorizerResponseTypeDef(TypedDict):
authorizerName: str,
authorizerArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartAuditMitigationActionsTaskResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StartAuditMitigationActionsTaskResponseTypeDef
def get_value() -> StartAuditMitigationActionsTaskResponseTypeDef:
return {
"taskId": ...,
"ResponseMetadata": ...,
}
Definition
class StartAuditMitigationActionsTaskResponseTypeDef(TypedDict):
taskId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartDetectMitigationActionsTaskResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StartDetectMitigationActionsTaskResponseTypeDef
def get_value() -> StartDetectMitigationActionsTaskResponseTypeDef:
return {
"taskId": ...,
"ResponseMetadata": ...,
}
Definition
class StartDetectMitigationActionsTaskResponseTypeDef(TypedDict):
taskId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartOnDemandAuditTaskResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StartOnDemandAuditTaskResponseTypeDef
def get_value() -> StartOnDemandAuditTaskResponseTypeDef:
return {
"taskId": ...,
"ResponseMetadata": ...,
}
Definition
class StartOnDemandAuditTaskResponseTypeDef(TypedDict):
taskId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartThingRegistrationTaskResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StartThingRegistrationTaskResponseTypeDef
def get_value() -> StartThingRegistrationTaskResponseTypeDef:
return {
"taskId": ...,
"ResponseMetadata": ...,
}
Definition
class StartThingRegistrationTaskResponseTypeDef(TypedDict):
taskId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TestInvokeAuthorizerResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TestInvokeAuthorizerResponseTypeDef
def get_value() -> TestInvokeAuthorizerResponseTypeDef:
return {
"isAuthenticated": ...,
"principalId": ...,
"policyDocuments": ...,
"refreshAfterInSeconds": ...,
"disconnectAfterInSeconds": ...,
"ResponseMetadata": ...,
}
Definition
class TestInvokeAuthorizerResponseTypeDef(TypedDict):
isAuthenticated: bool,
principalId: str,
policyDocuments: List[str],
refreshAfterInSeconds: int,
disconnectAfterInSeconds: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TransferCertificateResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TransferCertificateResponseTypeDef
def get_value() -> TransferCertificateResponseTypeDef:
return {
"transferredCertificateArn": ...,
"ResponseMetadata": ...,
}
Definition
class TransferCertificateResponseTypeDef(TypedDict):
transferredCertificateArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateAuthorizerResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateAuthorizerResponseTypeDef
def get_value() -> UpdateAuthorizerResponseTypeDef:
return {
"authorizerName": ...,
"authorizerArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateAuthorizerResponseTypeDef(TypedDict):
authorizerName: str,
authorizerArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateBillingGroupResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateBillingGroupResponseTypeDef
def get_value() -> UpdateBillingGroupResponseTypeDef:
return {
"version": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateBillingGroupResponseTypeDef(TypedDict):
version: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateCustomMetricResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateCustomMetricResponseTypeDef
def get_value() -> UpdateCustomMetricResponseTypeDef:
return {
"metricName": ...,
"metricArn": ...,
"metricType": ...,
"displayName": ...,
"creationDate": ...,
"lastModifiedDate": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateCustomMetricResponseTypeDef(TypedDict):
metricName: str,
metricArn: str,
metricType: CustomMetricTypeType, # (1)
displayName: str,
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateDimensionResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateDimensionResponseTypeDef
def get_value() -> UpdateDimensionResponseTypeDef:
return {
"name": ...,
"arn": ...,
"type": ...,
"stringValues": ...,
"creationDate": ...,
"lastModifiedDate": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateDimensionResponseTypeDef(TypedDict):
name: str,
arn: str,
type: DimensionTypeType, # (1)
stringValues: List[str],
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateDomainConfigurationResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateDomainConfigurationResponseTypeDef
def get_value() -> UpdateDomainConfigurationResponseTypeDef:
return {
"domainConfigurationName": ...,
"domainConfigurationArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateDomainConfigurationResponseTypeDef(TypedDict):
domainConfigurationName: str,
domainConfigurationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateDynamicThingGroupResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateDynamicThingGroupResponseTypeDef
def get_value() -> UpdateDynamicThingGroupResponseTypeDef:
return {
"version": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateDynamicThingGroupResponseTypeDef(TypedDict):
version: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateMitigationActionResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateMitigationActionResponseTypeDef
def get_value() -> UpdateMitigationActionResponseTypeDef:
return {
"actionArn": ...,
"actionId": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateMitigationActionResponseTypeDef(TypedDict):
actionArn: str,
actionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateRoleAliasResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateRoleAliasResponseTypeDef
def get_value() -> UpdateRoleAliasResponseTypeDef:
return {
"roleAlias": ...,
"roleAliasArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateRoleAliasResponseTypeDef(TypedDict):
roleAlias: str,
roleAliasArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateScheduledAuditResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateScheduledAuditResponseTypeDef
def get_value() -> UpdateScheduledAuditResponseTypeDef:
return {
"scheduledAuditArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateScheduledAuditResponseTypeDef(TypedDict):
scheduledAuditArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateStreamResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateStreamResponseTypeDef
def get_value() -> UpdateStreamResponseTypeDef:
return {
"streamId": ...,
"streamArn": ...,
"description": ...,
"streamVersion": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateStreamResponseTypeDef(TypedDict):
streamId: str,
streamArn: str,
description: str,
streamVersion: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateThingGroupResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateThingGroupResponseTypeDef
def get_value() -> UpdateThingGroupResponseTypeDef:
return {
"version": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateThingGroupResponseTypeDef(TypedDict):
version: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateThingRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateThingRequestRequestTypeDef
def get_value() -> CreateThingRequestRequestTypeDef:
return {
"thingName": ...,
}
Definition
class CreateThingRequestRequestTypeDef(TypedDict):
thingName: str,
thingTypeName: NotRequired[str],
attributePayload: NotRequired[AttributePayloadTypeDef], # (1)
billingGroupName: NotRequired[str],
ThingGroupPropertiesTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ThingGroupPropertiesTypeDef
def get_value() -> ThingGroupPropertiesTypeDef:
return {
"thingGroupDescription": ...,
}
Definition
class ThingGroupPropertiesTypeDef(TypedDict):
thingGroupDescription: NotRequired[str],
attributePayload: NotRequired[AttributePayloadTypeDef], # (1)
UpdateThingRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateThingRequestRequestTypeDef
def get_value() -> UpdateThingRequestRequestTypeDef:
return {
"thingName": ...,
}
Definition
class UpdateThingRequestRequestTypeDef(TypedDict):
thingName: str,
thingTypeName: NotRequired[str],
attributePayload: NotRequired[AttributePayloadTypeDef], # (1)
expectedVersion: NotRequired[int],
removeThingType: NotRequired[bool],
ListAuditMitigationActionsExecutionsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuditMitigationActionsExecutionsResponseTypeDef
def get_value() -> ListAuditMitigationActionsExecutionsResponseTypeDef:
return {
"actionsExecutions": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListAuditMitigationActionsExecutionsResponseTypeDef(TypedDict):
actionsExecutions: List[AuditMitigationActionExecutionMetadataTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAuditMitigationActionsTasksResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuditMitigationActionsTasksResponseTypeDef
def get_value() -> ListAuditMitigationActionsTasksResponseTypeDef:
return {
"tasks": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListAuditMitigationActionsTasksResponseTypeDef(TypedDict):
tasks: List[AuditMitigationActionsTaskMetadataTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartAuditMitigationActionsTaskRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StartAuditMitigationActionsTaskRequestRequestTypeDef
def get_value() -> StartAuditMitigationActionsTaskRequestRequestTypeDef:
return {
"taskId": ...,
"target": ...,
"auditCheckToActionsMapping": ...,
"clientRequestToken": ...,
}
Definition
class StartAuditMitigationActionsTaskRequestRequestTypeDef(TypedDict):
taskId: str,
target: AuditMitigationActionsTaskTargetTypeDef, # (1)
auditCheckToActionsMapping: Mapping[str, Sequence[str]],
clientRequestToken: str,
DescribeAccountAuditConfigurationResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeAccountAuditConfigurationResponseTypeDef
def get_value() -> DescribeAccountAuditConfigurationResponseTypeDef:
return {
"roleArn": ...,
"auditNotificationTargetConfigurations": ...,
"auditCheckConfigurations": ...,
"ResponseMetadata": ...,
}
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
UpdateAccountAuditConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateAccountAuditConfigurationRequestRequestTypeDef
def get_value() -> UpdateAccountAuditConfigurationRequestRequestTypeDef:
return {
"roleArn": ...,
}
Definition
class UpdateAccountAuditConfigurationRequestRequestTypeDef(TypedDict):
roleArn: NotRequired[str],
auditNotificationTargetConfigurations: NotRequired[Mapping[AuditNotificationTypeType, AuditNotificationTargetTypeDef]], # (1)
auditCheckConfigurations: NotRequired[Mapping[str, AuditCheckConfigurationTypeDef]], # (2)
ListAuditTasksResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuditTasksResponseTypeDef
def get_value() -> ListAuditTasksResponseTypeDef:
return {
"tasks": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListAuditTasksResponseTypeDef(TypedDict):
tasks: List[AuditTaskMetadataTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TestAuthorizationRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TestAuthorizationRequestRequestTypeDef
def get_value() -> TestAuthorizationRequestRequestTypeDef:
return {
"authInfos": ...,
}
Definition
class TestAuthorizationRequestRequestTypeDef(TypedDict):
authInfos: Sequence[AuthInfoTypeDef], # (1)
principal: NotRequired[str],
cognitoIdentityPoolId: NotRequired[str],
clientId: NotRequired[str],
policyNamesToAdd: NotRequired[Sequence[str]],
policyNamesToSkip: NotRequired[Sequence[str]],
- See AuthInfoTypeDef
UpdateDomainConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateDomainConfigurationRequestRequestTypeDef
def get_value() -> UpdateDomainConfigurationRequestRequestTypeDef:
return {
"domainConfigurationName": ...,
}
Definition
class UpdateDomainConfigurationRequestRequestTypeDef(TypedDict):
domainConfigurationName: str,
authorizerConfig: NotRequired[AuthorizerConfigTypeDef], # (1)
domainConfigurationStatus: NotRequired[DomainConfigurationStatusType], # (2)
removeAuthorizerConfig: NotRequired[bool],
DescribeAuthorizerResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeAuthorizerResponseTypeDef
def get_value() -> DescribeAuthorizerResponseTypeDef:
return {
"authorizerDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeAuthorizerResponseTypeDef(TypedDict):
authorizerDescription: AuthorizerDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeDefaultAuthorizerResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeDefaultAuthorizerResponseTypeDef
def get_value() -> DescribeDefaultAuthorizerResponseTypeDef:
return {
"authorizerDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeDefaultAuthorizerResponseTypeDef(TypedDict):
authorizerDescription: AuthorizerDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAuthorizersResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuthorizersResponseTypeDef
def get_value() -> ListAuthorizersResponseTypeDef:
return {
"authorizers": ...,
"nextMarker": ...,
"ResponseMetadata": ...,
}
Definition
class ListAuthorizersResponseTypeDef(TypedDict):
authorizers: List[AuthorizerSummaryTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AwsJobAbortConfigTypeDef
Usage Example
from mypy_boto3_iot.type_defs import AwsJobAbortConfigTypeDef
def get_value() -> AwsJobAbortConfigTypeDef:
return {
"abortCriteriaList": ...,
}
Definition
class AwsJobAbortConfigTypeDef(TypedDict):
abortCriteriaList: Sequence[AwsJobAbortCriteriaTypeDef], # (1)
AwsJobExponentialRolloutRateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import AwsJobExponentialRolloutRateTypeDef
def get_value() -> AwsJobExponentialRolloutRateTypeDef:
return {
"baseRatePerMinute": ...,
"incrementFactor": ...,
"rateIncreaseCriteria": ...,
}
Definition
class AwsJobExponentialRolloutRateTypeDef(TypedDict):
baseRatePerMinute: int,
incrementFactor: float,
rateIncreaseCriteria: AwsJobRateIncreaseCriteriaTypeDef, # (1)
BehaviorCriteriaTypeDef
Usage Example
from mypy_boto3_iot.type_defs import BehaviorCriteriaTypeDef
def get_value() -> BehaviorCriteriaTypeDef:
return {
"comparisonOperator": ...,
}
Definition
class BehaviorCriteriaTypeDef(TypedDict):
comparisonOperator: NotRequired[ComparisonOperatorType], # (1)
value: NotRequired[MetricValueTypeDef], # (2)
durationSeconds: NotRequired[int],
consecutiveDatapointsToAlarm: NotRequired[int],
consecutiveDatapointsToClear: NotRequired[int],
statisticalThreshold: NotRequired[StatisticalThresholdTypeDef], # (3)
mlDetectionConfig: NotRequired[MachineLearningDetectionConfigTypeDef], # (4)
- See ComparisonOperatorType
- See MetricValueTypeDef
- See StatisticalThresholdTypeDef
- See MachineLearningDetectionConfigTypeDef
GetBehaviorModelTrainingSummariesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetBehaviorModelTrainingSummariesResponseTypeDef
def get_value() -> GetBehaviorModelTrainingSummariesResponseTypeDef:
return {
"summaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class GetBehaviorModelTrainingSummariesResponseTypeDef(TypedDict):
summaries: List[BehaviorModelTrainingSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
MetricToRetainTypeDef
Usage Example
from mypy_boto3_iot.type_defs import MetricToRetainTypeDef
def get_value() -> MetricToRetainTypeDef:
return {
"metric": ...,
}
Definition
class MetricToRetainTypeDef(TypedDict):
metric: str,
metricDimension: NotRequired[MetricDimensionTypeDef], # (1)
DescribeBillingGroupResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeBillingGroupResponseTypeDef
def get_value() -> DescribeBillingGroupResponseTypeDef:
return {
"billingGroupName": ...,
"billingGroupId": ...,
"billingGroupArn": ...,
"version": ...,
"billingGroupProperties": ...,
"billingGroupMetadata": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeBillingGroupResponseTypeDef(TypedDict):
billingGroupName: str,
billingGroupId: str,
billingGroupArn: str,
version: int,
billingGroupProperties: BillingGroupPropertiesTypeDef, # (1)
billingGroupMetadata: BillingGroupMetadataTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
UpdateBillingGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateBillingGroupRequestRequestTypeDef
def get_value() -> UpdateBillingGroupRequestRequestTypeDef:
return {
"billingGroupName": ...,
"billingGroupProperties": ...,
}
Definition
class UpdateBillingGroupRequestRequestTypeDef(TypedDict):
billingGroupName: str,
billingGroupProperties: BillingGroupPropertiesTypeDef, # (1)
expectedVersion: NotRequired[int],
GetBucketsAggregationResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetBucketsAggregationResponseTypeDef
def get_value() -> GetBucketsAggregationResponseTypeDef:
return {
"totalCount": ...,
"buckets": ...,
"ResponseMetadata": ...,
}
Definition
class GetBucketsAggregationResponseTypeDef(TypedDict):
totalCount: int,
buckets: List[BucketTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See BucketTypeDef
- See ResponseMetadataTypeDef
BucketsAggregationTypeTypeDef
Usage Example
from mypy_boto3_iot.type_defs import BucketsAggregationTypeTypeDef
def get_value() -> BucketsAggregationTypeTypeDef:
return {
"termsAggregation": ...,
}
Definition
class BucketsAggregationTypeTypeDef(TypedDict):
termsAggregation: NotRequired[TermsAggregationTypeDef], # (1)
CACertificateDescriptionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CACertificateDescriptionTypeDef
def get_value() -> CACertificateDescriptionTypeDef:
return {
"certificateArn": ...,
}
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
Usage Example
from mypy_boto3_iot.type_defs import ListCACertificatesResponseTypeDef
def get_value() -> ListCACertificatesResponseTypeDef:
return {
"certificates": ...,
"nextMarker": ...,
"ResponseMetadata": ...,
}
Definition
class ListCACertificatesResponseTypeDef(TypedDict):
certificates: List[CACertificateTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CertificateDescriptionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CertificateDescriptionTypeDef
def get_value() -> CertificateDescriptionTypeDef:
return {
"certificateArn": ...,
}
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
ListCertificatesByCAResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListCertificatesByCAResponseTypeDef
def get_value() -> ListCertificatesByCAResponseTypeDef:
return {
"certificates": ...,
"nextMarker": ...,
"ResponseMetadata": ...,
}
Definition
class ListCertificatesByCAResponseTypeDef(TypedDict):
certificates: List[CertificateTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListCertificatesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListCertificatesResponseTypeDef
def get_value() -> ListCertificatesResponseTypeDef:
return {
"certificates": ...,
"nextMarker": ...,
"ResponseMetadata": ...,
}
Definition
class ListCertificatesResponseTypeDef(TypedDict):
certificates: List[CertificateTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CustomCodeSigningTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CustomCodeSigningTypeDef
def get_value() -> CustomCodeSigningTypeDef:
return {
"signature": ...,
}
Definition
class CustomCodeSigningTypeDef(TypedDict):
signature: NotRequired[CodeSigningSignatureTypeDef], # (1)
certificateChain: NotRequired[CodeSigningCertificateChainTypeDef], # (2)
hashAlgorithm: NotRequired[str],
signatureAlgorithm: NotRequired[str],
DescribeEventConfigurationsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeEventConfigurationsResponseTypeDef
def get_value() -> DescribeEventConfigurationsResponseTypeDef:
return {
"eventConfigurations": ...,
"creationDate": ...,
"lastModifiedDate": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeEventConfigurationsResponseTypeDef(TypedDict):
eventConfigurations: Dict[EventTypeType, ConfigurationTypeDef], # (1)
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateEventConfigurationsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateEventConfigurationsRequestRequestTypeDef
def get_value() -> UpdateEventConfigurationsRequestRequestTypeDef:
return {
"eventConfigurations": ...,
}
Definition
class UpdateEventConfigurationsRequestRequestTypeDef(TypedDict):
eventConfigurations: NotRequired[Mapping[EventTypeType, ConfigurationTypeDef]], # (1)
CreateAuthorizerRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateAuthorizerRequestRequestTypeDef
def get_value() -> CreateAuthorizerRequestRequestTypeDef:
return {
"authorizerName": ...,
"authorizerFunctionArn": ...,
}
Definition
class CreateAuthorizerRequestRequestTypeDef(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
CreateBillingGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateBillingGroupRequestRequestTypeDef
def get_value() -> CreateBillingGroupRequestRequestTypeDef:
return {
"billingGroupName": ...,
}
Definition
class CreateBillingGroupRequestRequestTypeDef(TypedDict):
billingGroupName: str,
billingGroupProperties: NotRequired[BillingGroupPropertiesTypeDef], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)
CreateCustomMetricRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateCustomMetricRequestRequestTypeDef
def get_value() -> CreateCustomMetricRequestRequestTypeDef:
return {
"metricName": ...,
"metricType": ...,
"clientRequestToken": ...,
}
Definition
class CreateCustomMetricRequestRequestTypeDef(TypedDict):
metricName: str,
metricType: CustomMetricTypeType, # (1)
clientRequestToken: str,
displayName: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See CustomMetricTypeType
- See TagTypeDef
CreateDimensionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateDimensionRequestRequestTypeDef
def get_value() -> CreateDimensionRequestRequestTypeDef:
return {
"name": ...,
"type": ...,
"stringValues": ...,
"clientRequestToken": ...,
}
Definition
class CreateDimensionRequestRequestTypeDef(TypedDict):
name: str,
type: DimensionTypeType, # (1)
stringValues: Sequence[str],
clientRequestToken: str,
tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See DimensionTypeType
- See TagTypeDef
CreateDomainConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateDomainConfigurationRequestRequestTypeDef
def get_value() -> CreateDomainConfigurationRequestRequestTypeDef:
return {
"domainConfigurationName": ...,
}
Definition
class CreateDomainConfigurationRequestRequestTypeDef(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)
- See AuthorizerConfigTypeDef
- See ServiceTypeType
- See TagTypeDef
CreateFleetMetricRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateFleetMetricRequestRequestTypeDef
def get_value() -> CreateFleetMetricRequestRequestTypeDef:
return {
"metricName": ...,
"queryString": ...,
"aggregationType": ...,
"period": ...,
"aggregationField": ...,
}
Definition
class CreateFleetMetricRequestRequestTypeDef(TypedDict):
metricName: str,
queryString: str,
aggregationType: AggregationTypeTypeDef, # (1)
period: int,
aggregationField: str,
description: NotRequired[str],
queryVersion: NotRequired[str],
indexName: NotRequired[str],
unit: NotRequired[FleetMetricUnitType], # (2)
tags: NotRequired[Sequence[TagTypeDef]], # (3)
- See AggregationTypeTypeDef
- See FleetMetricUnitType
- See TagTypeDef
CreatePolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreatePolicyRequestRequestTypeDef
def get_value() -> CreatePolicyRequestRequestTypeDef:
return {
"policyName": ...,
"policyDocument": ...,
}
Definition
class CreatePolicyRequestRequestTypeDef(TypedDict):
policyName: str,
policyDocument: str,
tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateRoleAliasRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateRoleAliasRequestRequestTypeDef
def get_value() -> CreateRoleAliasRequestRequestTypeDef:
return {
"roleAlias": ...,
"roleArn": ...,
}
Definition
class CreateRoleAliasRequestRequestTypeDef(TypedDict):
roleAlias: str,
roleArn: str,
credentialDurationSeconds: NotRequired[int],
tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateScheduledAuditRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateScheduledAuditRequestRequestTypeDef
def get_value() -> CreateScheduledAuditRequestRequestTypeDef:
return {
"frequency": ...,
"targetCheckNames": ...,
"scheduledAuditName": ...,
}
Definition
class CreateScheduledAuditRequestRequestTypeDef(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
Usage Example
from mypy_boto3_iot.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: List[TagTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
SchedulingConfigTypeDef
Usage Example
from mypy_boto3_iot.type_defs import SchedulingConfigTypeDef
def get_value() -> SchedulingConfigTypeDef:
return {
"startTime": ...,
}
Definition
class SchedulingConfigTypeDef(TypedDict):
startTime: NotRequired[str],
endTime: NotRequired[str],
endBehavior: NotRequired[JobEndBehaviorType], # (1)
maintenanceWindows: NotRequired[Sequence[MaintenanceWindowTypeDef]], # (2)
CreateKeysAndCertificateResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateKeysAndCertificateResponseTypeDef
def get_value() -> CreateKeysAndCertificateResponseTypeDef:
return {
"certificateArn": ...,
"certificateId": ...,
"certificatePem": ...,
"keyPair": ...,
"ResponseMetadata": ...,
}
Definition
class CreateKeysAndCertificateResponseTypeDef(TypedDict):
certificateArn: str,
certificateId: str,
certificatePem: str,
keyPair: KeyPairTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateProvisioningClaimResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateProvisioningClaimResponseTypeDef
def get_value() -> CreateProvisioningClaimResponseTypeDef:
return {
"certificateId": ...,
"certificatePem": ...,
"keyPair": ...,
"expiration": ...,
"ResponseMetadata": ...,
}
Definition
class CreateProvisioningClaimResponseTypeDef(TypedDict):
certificateId: str,
certificatePem: str,
keyPair: KeyPairTypeDef, # (1)
expiration: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateProvisioningTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateProvisioningTemplateRequestRequestTypeDef
def get_value() -> CreateProvisioningTemplateRequestRequestTypeDef:
return {
"templateName": ...,
"templateBody": ...,
"provisioningRoleArn": ...,
}
Definition
class CreateProvisioningTemplateRequestRequestTypeDef(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
Usage Example
from mypy_boto3_iot.type_defs import DescribeProvisioningTemplateResponseTypeDef
def get_value() -> DescribeProvisioningTemplateResponseTypeDef:
return {
"templateArn": ...,
"templateName": ...,
"description": ...,
"creationDate": ...,
"lastModifiedDate": ...,
"defaultVersionId": ...,
"templateBody": ...,
"enabled": ...,
"provisioningRoleArn": ...,
"preProvisioningHook": ...,
"type": ...,
"ResponseMetadata": ...,
}
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)
UpdateProvisioningTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateProvisioningTemplateRequestRequestTypeDef
def get_value() -> UpdateProvisioningTemplateRequestRequestTypeDef:
return {
"templateName": ...,
}
Definition
class UpdateProvisioningTemplateRequestRequestTypeDef(TypedDict):
templateName: str,
description: NotRequired[str],
enabled: NotRequired[bool],
defaultVersionId: NotRequired[int],
provisioningRoleArn: NotRequired[str],
preProvisioningHook: NotRequired[ProvisioningHookTypeDef], # (1)
removePreProvisioningHook: NotRequired[bool],
CreateThingTypeRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateThingTypeRequestRequestTypeDef
def get_value() -> CreateThingTypeRequestRequestTypeDef:
return {
"thingTypeName": ...,
}
Definition
class CreateThingTypeRequestRequestTypeDef(TypedDict):
thingTypeName: str,
thingTypeProperties: NotRequired[ThingTypePropertiesTypeDef], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See ThingTypePropertiesTypeDef
- See TagTypeDef
DescribeAuditTaskResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeAuditTaskResponseTypeDef
def get_value() -> DescribeAuditTaskResponseTypeDef:
return {
"taskStatus": ...,
"taskType": ...,
"taskStartTime": ...,
"taskStatistics": ...,
"scheduledAuditName": ...,
"auditDetails": ...,
"ResponseMetadata": ...,
}
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
RegisterCACertificateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RegisterCACertificateRequestRequestTypeDef
def get_value() -> RegisterCACertificateRequestRequestTypeDef:
return {
"caCertificate": ...,
}
Definition
class RegisterCACertificateRequestRequestTypeDef(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
UpdateCACertificateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateCACertificateRequestRequestTypeDef
def get_value() -> UpdateCACertificateRequestRequestTypeDef:
return {
"certificateId": ...,
}
Definition
class UpdateCACertificateRequestRequestTypeDef(TypedDict):
certificateId: str,
newStatus: NotRequired[CACertificateStatusType], # (1)
newAutoRegistrationStatus: NotRequired[AutoRegistrationStatusType], # (2)
registrationConfig: NotRequired[RegistrationConfigTypeDef], # (3)
removeAutoRegistration: NotRequired[bool],
DescribeDomainConfigurationResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeDomainConfigurationResponseTypeDef
def get_value() -> DescribeDomainConfigurationResponseTypeDef:
return {
"domainConfigurationName": ...,
"domainConfigurationArn": ...,
"domainName": ...,
"serverCertificates": ...,
"authorizerConfig": ...,
"domainConfigurationStatus": ...,
"serviceType": ...,
"domainType": ...,
"lastStatusChangeDate": ...,
"ResponseMetadata": ...,
}
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,
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See ServerCertificateSummaryTypeDef
- See AuthorizerConfigTypeDef
- See DomainConfigurationStatusType
- See ServiceTypeType
- See DomainTypeType
- See ResponseMetadataTypeDef
DescribeManagedJobTemplateResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeManagedJobTemplateResponseTypeDef
def get_value() -> DescribeManagedJobTemplateResponseTypeDef:
return {
"templateName": ...,
"templateArn": ...,
"description": ...,
"templateVersion": ...,
"environments": ...,
"documentParameters": ...,
"document": ...,
"ResponseMetadata": ...,
}
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
Usage Example
from mypy_boto3_iot.type_defs import DescribeRoleAliasResponseTypeDef
def get_value() -> DescribeRoleAliasResponseTypeDef:
return {
"roleAliasDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeRoleAliasResponseTypeDef(TypedDict):
roleAliasDescription: RoleAliasDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeThingTypeResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeThingTypeResponseTypeDef
def get_value() -> DescribeThingTypeResponseTypeDef:
return {
"thingTypeName": ...,
"thingTypeId": ...,
"thingTypeArn": ...,
"thingTypeProperties": ...,
"thingTypeMetadata": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeThingTypeResponseTypeDef(TypedDict):
thingTypeName: str,
thingTypeId: str,
thingTypeArn: str,
thingTypeProperties: ThingTypePropertiesTypeDef, # (1)
thingTypeMetadata: ThingTypeMetadataTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ThingTypeDefinitionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ThingTypeDefinitionTypeDef
def get_value() -> ThingTypeDefinitionTypeDef:
return {
"thingTypeName": ...,
}
Definition
class ThingTypeDefinitionTypeDef(TypedDict):
thingTypeName: NotRequired[str],
thingTypeArn: NotRequired[str],
thingTypeProperties: NotRequired[ThingTypePropertiesTypeDef], # (1)
thingTypeMetadata: NotRequired[ThingTypeMetadataTypeDef], # (2)
DestinationTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DestinationTypeDef
def get_value() -> DestinationTypeDef:
return {
"s3Destination": ...,
}
Definition
class DestinationTypeDef(TypedDict):
s3Destination: NotRequired[S3DestinationTypeDef], # (1)
ListDetectMitigationActionsExecutionsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListDetectMitigationActionsExecutionsResponseTypeDef
def get_value() -> ListDetectMitigationActionsExecutionsResponseTypeDef:
return {
"actionsExecutions": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListDetectMitigationActionsExecutionsResponseTypeDef(TypedDict):
actionsExecutions: List[DetectMitigationActionExecutionTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartDetectMitigationActionsTaskRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StartDetectMitigationActionsTaskRequestRequestTypeDef
def get_value() -> StartDetectMitigationActionsTaskRequestRequestTypeDef:
return {
"taskId": ...,
"target": ...,
"actions": ...,
"clientRequestToken": ...,
}
Definition
class StartDetectMitigationActionsTaskRequestRequestTypeDef(TypedDict):
taskId: str,
target: DetectMitigationActionsTaskTargetTypeDef, # (1)
actions: Sequence[str],
clientRequestToken: str,
violationEventOccurrenceRange: NotRequired[ViolationEventOccurrenceRangeTypeDef], # (2)
includeOnlyActiveViolations: NotRequired[bool],
includeSuppressedAlerts: NotRequired[bool],
ListDomainConfigurationsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListDomainConfigurationsResponseTypeDef
def get_value() -> ListDomainConfigurationsResponseTypeDef:
return {
"domainConfigurations": ...,
"nextMarker": ...,
"ResponseMetadata": ...,
}
Definition
class ListDomainConfigurationsResponseTypeDef(TypedDict):
domainConfigurations: List[DomainConfigurationSummaryTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DynamoDBv2ActionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DynamoDBv2ActionTypeDef
def get_value() -> DynamoDBv2ActionTypeDef:
return {
"roleArn": ...,
"putItem": ...,
}
Definition
class DynamoDBv2ActionTypeDef(TypedDict):
roleArn: str,
putItem: PutItemInputTypeDef, # (1)
GetEffectivePoliciesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetEffectivePoliciesResponseTypeDef
def get_value() -> GetEffectivePoliciesResponseTypeDef:
return {
"effectivePolicies": ...,
"ResponseMetadata": ...,
}
Definition
class GetEffectivePoliciesResponseTypeDef(TypedDict):
effectivePolicies: List[EffectivePolicyTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ExponentialRolloutRateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ExponentialRolloutRateTypeDef
def get_value() -> ExponentialRolloutRateTypeDef:
return {
"baseRatePerMinute": ...,
"incrementFactor": ...,
"rateIncreaseCriteria": ...,
}
Definition
class ExponentialRolloutRateTypeDef(TypedDict):
baseRatePerMinute: int,
incrementFactor: float,
rateIncreaseCriteria: RateIncreaseCriteriaTypeDef, # (1)
ThingGroupIndexingConfigurationTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ThingGroupIndexingConfigurationTypeDef
def get_value() -> ThingGroupIndexingConfigurationTypeDef:
return {
"thingGroupIndexingMode": ...,
}
Definition
class ThingGroupIndexingConfigurationTypeDef(TypedDict):
thingGroupIndexingMode: ThingGroupIndexingModeType, # (1)
managedFields: NotRequired[List[FieldTypeDef]], # (2)
customFields: NotRequired[List[FieldTypeDef]], # (2)
- See ThingGroupIndexingModeType
- See FieldTypeDef
- See FieldTypeDef
StreamFileTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StreamFileTypeDef
def get_value() -> StreamFileTypeDef:
return {
"fileId": ...,
}
Definition
class StreamFileTypeDef(TypedDict):
fileId: NotRequired[int],
s3Location: NotRequired[S3LocationTypeDef], # (1)
FileLocationTypeDef
Usage Example
from mypy_boto3_iot.type_defs import FileLocationTypeDef
def get_value() -> FileLocationTypeDef:
return {
"stream": ...,
}
Definition
class FileLocationTypeDef(TypedDict):
stream: NotRequired[StreamTypeDef], # (1)
s3Location: NotRequired[S3LocationTypeDef], # (2)
- See StreamTypeDef
- See S3LocationTypeDef
ListFleetMetricsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListFleetMetricsResponseTypeDef
def get_value() -> ListFleetMetricsResponseTypeDef:
return {
"fleetMetrics": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListFleetMetricsResponseTypeDef(TypedDict):
fleetMetrics: List[FleetMetricNameAndArnTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetBehaviorModelTrainingSummariesRequestGetBehaviorModelTrainingSummariesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetBehaviorModelTrainingSummariesRequestGetBehaviorModelTrainingSummariesPaginateTypeDef
def get_value() -> GetBehaviorModelTrainingSummariesRequestGetBehaviorModelTrainingSummariesPaginateTypeDef:
return {
"securityProfileName": ...,
}
Definition
class GetBehaviorModelTrainingSummariesRequestGetBehaviorModelTrainingSummariesPaginateTypeDef(TypedDict):
securityProfileName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListActiveViolationsRequestListActiveViolationsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListActiveViolationsRequestListActiveViolationsPaginateTypeDef
def get_value() -> ListActiveViolationsRequestListActiveViolationsPaginateTypeDef:
return {
"thingName": ...,
}
Definition
class ListActiveViolationsRequestListActiveViolationsPaginateTypeDef(TypedDict):
thingName: NotRequired[str],
securityProfileName: NotRequired[str],
behaviorCriteriaType: NotRequired[BehaviorCriteriaTypeType], # (1)
listSuppressedAlerts: NotRequired[bool],
verificationState: NotRequired[VerificationStateType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
ListAttachedPoliciesRequestListAttachedPoliciesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAttachedPoliciesRequestListAttachedPoliciesPaginateTypeDef
def get_value() -> ListAttachedPoliciesRequestListAttachedPoliciesPaginateTypeDef:
return {
"target": ...,
}
Definition
class ListAttachedPoliciesRequestListAttachedPoliciesPaginateTypeDef(TypedDict):
target: str,
recursive: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAuditMitigationActionsExecutionsRequestListAuditMitigationActionsExecutionsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuditMitigationActionsExecutionsRequestListAuditMitigationActionsExecutionsPaginateTypeDef
def get_value() -> ListAuditMitigationActionsExecutionsRequestListAuditMitigationActionsExecutionsPaginateTypeDef:
return {
"taskId": ...,
"findingId": ...,
}
Definition
class ListAuditMitigationActionsExecutionsRequestListAuditMitigationActionsExecutionsPaginateTypeDef(TypedDict):
taskId: str,
findingId: str,
actionStatus: NotRequired[AuditMitigationActionsExecutionStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListAuditMitigationActionsTasksRequestListAuditMitigationActionsTasksPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuditMitigationActionsTasksRequestListAuditMitigationActionsTasksPaginateTypeDef
def get_value() -> ListAuditMitigationActionsTasksRequestListAuditMitigationActionsTasksPaginateTypeDef:
return {
"startTime": ...,
"endTime": ...,
}
Definition
class ListAuditMitigationActionsTasksRequestListAuditMitigationActionsTasksPaginateTypeDef(TypedDict):
startTime: Union[datetime, str],
endTime: Union[datetime, str],
auditTaskId: NotRequired[str],
findingId: NotRequired[str],
taskStatus: NotRequired[AuditMitigationActionsTaskStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListAuditTasksRequestListAuditTasksPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuditTasksRequestListAuditTasksPaginateTypeDef
def get_value() -> ListAuditTasksRequestListAuditTasksPaginateTypeDef:
return {
"startTime": ...,
"endTime": ...,
}
Definition
class ListAuditTasksRequestListAuditTasksPaginateTypeDef(TypedDict):
startTime: Union[datetime, str],
endTime: Union[datetime, str],
taskType: NotRequired[AuditTaskTypeType], # (1)
taskStatus: NotRequired[AuditTaskStatusType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
ListAuthorizersRequestListAuthorizersPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuthorizersRequestListAuthorizersPaginateTypeDef
def get_value() -> ListAuthorizersRequestListAuthorizersPaginateTypeDef:
return {
"ascendingOrder": ...,
}
Definition
class ListAuthorizersRequestListAuthorizersPaginateTypeDef(TypedDict):
ascendingOrder: NotRequired[bool],
status: NotRequired[AuthorizerStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListBillingGroupsRequestListBillingGroupsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListBillingGroupsRequestListBillingGroupsPaginateTypeDef
def get_value() -> ListBillingGroupsRequestListBillingGroupsPaginateTypeDef:
return {
"namePrefixFilter": ...,
}
Definition
class ListBillingGroupsRequestListBillingGroupsPaginateTypeDef(TypedDict):
namePrefixFilter: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListCACertificatesRequestListCACertificatesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListCACertificatesRequestListCACertificatesPaginateTypeDef
def get_value() -> ListCACertificatesRequestListCACertificatesPaginateTypeDef:
return {
"ascendingOrder": ...,
}
Definition
class ListCACertificatesRequestListCACertificatesPaginateTypeDef(TypedDict):
ascendingOrder: NotRequired[bool],
templateName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListCertificatesByCARequestListCertificatesByCAPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListCertificatesByCARequestListCertificatesByCAPaginateTypeDef
def get_value() -> ListCertificatesByCARequestListCertificatesByCAPaginateTypeDef:
return {
"caCertificateId": ...,
}
Definition
class ListCertificatesByCARequestListCertificatesByCAPaginateTypeDef(TypedDict):
caCertificateId: str,
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListCertificatesRequestListCertificatesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListCertificatesRequestListCertificatesPaginateTypeDef
def get_value() -> ListCertificatesRequestListCertificatesPaginateTypeDef:
return {
"ascendingOrder": ...,
}
Definition
class ListCertificatesRequestListCertificatesPaginateTypeDef(TypedDict):
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListCustomMetricsRequestListCustomMetricsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListCustomMetricsRequestListCustomMetricsPaginateTypeDef
def get_value() -> ListCustomMetricsRequestListCustomMetricsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListCustomMetricsRequestListCustomMetricsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDetectMitigationActionsExecutionsRequestListDetectMitigationActionsExecutionsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListDetectMitigationActionsExecutionsRequestListDetectMitigationActionsExecutionsPaginateTypeDef
def get_value() -> ListDetectMitigationActionsExecutionsRequestListDetectMitigationActionsExecutionsPaginateTypeDef:
return {
"taskId": ...,
}
Definition
class ListDetectMitigationActionsExecutionsRequestListDetectMitigationActionsExecutionsPaginateTypeDef(TypedDict):
taskId: NotRequired[str],
violationId: NotRequired[str],
thingName: NotRequired[str],
startTime: NotRequired[Union[datetime, str]],
endTime: NotRequired[Union[datetime, str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDetectMitigationActionsTasksRequestListDetectMitigationActionsTasksPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListDetectMitigationActionsTasksRequestListDetectMitigationActionsTasksPaginateTypeDef
def get_value() -> ListDetectMitigationActionsTasksRequestListDetectMitigationActionsTasksPaginateTypeDef:
return {
"startTime": ...,
"endTime": ...,
}
Definition
class ListDetectMitigationActionsTasksRequestListDetectMitigationActionsTasksPaginateTypeDef(TypedDict):
startTime: Union[datetime, str],
endTime: Union[datetime, str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDimensionsRequestListDimensionsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListDimensionsRequestListDimensionsPaginateTypeDef
def get_value() -> ListDimensionsRequestListDimensionsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListDimensionsRequestListDimensionsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDomainConfigurationsRequestListDomainConfigurationsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListDomainConfigurationsRequestListDomainConfigurationsPaginateTypeDef
def get_value() -> ListDomainConfigurationsRequestListDomainConfigurationsPaginateTypeDef:
return {
"serviceType": ...,
}
Definition
class ListDomainConfigurationsRequestListDomainConfigurationsPaginateTypeDef(TypedDict):
serviceType: NotRequired[ServiceTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListFleetMetricsRequestListFleetMetricsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListFleetMetricsRequestListFleetMetricsPaginateTypeDef
def get_value() -> ListFleetMetricsRequestListFleetMetricsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListFleetMetricsRequestListFleetMetricsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListIndicesRequestListIndicesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListIndicesRequestListIndicesPaginateTypeDef
def get_value() -> ListIndicesRequestListIndicesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListIndicesRequestListIndicesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListJobExecutionsForJobRequestListJobExecutionsForJobPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListJobExecutionsForJobRequestListJobExecutionsForJobPaginateTypeDef
def get_value() -> ListJobExecutionsForJobRequestListJobExecutionsForJobPaginateTypeDef:
return {
"jobId": ...,
}
Definition
class ListJobExecutionsForJobRequestListJobExecutionsForJobPaginateTypeDef(TypedDict):
jobId: str,
status: NotRequired[JobExecutionStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListJobExecutionsForThingRequestListJobExecutionsForThingPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListJobExecutionsForThingRequestListJobExecutionsForThingPaginateTypeDef
def get_value() -> ListJobExecutionsForThingRequestListJobExecutionsForThingPaginateTypeDef:
return {
"thingName": ...,
}
Definition
class ListJobExecutionsForThingRequestListJobExecutionsForThingPaginateTypeDef(TypedDict):
thingName: str,
status: NotRequired[JobExecutionStatusType], # (1)
namespaceId: NotRequired[str],
jobId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListJobTemplatesRequestListJobTemplatesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListJobTemplatesRequestListJobTemplatesPaginateTypeDef
def get_value() -> ListJobTemplatesRequestListJobTemplatesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListJobTemplatesRequestListJobTemplatesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListJobsRequestListJobsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListJobsRequestListJobsPaginateTypeDef
def get_value() -> ListJobsRequestListJobsPaginateTypeDef:
return {
"status": ...,
}
Definition
class ListJobsRequestListJobsPaginateTypeDef(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
ListMetricValuesRequestListMetricValuesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListMetricValuesRequestListMetricValuesPaginateTypeDef
def get_value() -> ListMetricValuesRequestListMetricValuesPaginateTypeDef:
return {
"thingName": ...,
"metricName": ...,
"startTime": ...,
"endTime": ...,
}
Definition
class ListMetricValuesRequestListMetricValuesPaginateTypeDef(TypedDict):
thingName: str,
metricName: str,
startTime: Union[datetime, str],
endTime: Union[datetime, str],
dimensionName: NotRequired[str],
dimensionValueOperator: NotRequired[DimensionValueOperatorType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListMitigationActionsRequestListMitigationActionsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListMitigationActionsRequestListMitigationActionsPaginateTypeDef
def get_value() -> ListMitigationActionsRequestListMitigationActionsPaginateTypeDef:
return {
"actionType": ...,
}
Definition
class ListMitigationActionsRequestListMitigationActionsPaginateTypeDef(TypedDict):
actionType: NotRequired[MitigationActionTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListOTAUpdatesRequestListOTAUpdatesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListOTAUpdatesRequestListOTAUpdatesPaginateTypeDef
def get_value() -> ListOTAUpdatesRequestListOTAUpdatesPaginateTypeDef:
return {
"otaUpdateStatus": ...,
}
Definition
class ListOTAUpdatesRequestListOTAUpdatesPaginateTypeDef(TypedDict):
otaUpdateStatus: NotRequired[OTAUpdateStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListOutgoingCertificatesRequestListOutgoingCertificatesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListOutgoingCertificatesRequestListOutgoingCertificatesPaginateTypeDef
def get_value() -> ListOutgoingCertificatesRequestListOutgoingCertificatesPaginateTypeDef:
return {
"ascendingOrder": ...,
}
Definition
class ListOutgoingCertificatesRequestListOutgoingCertificatesPaginateTypeDef(TypedDict):
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPoliciesRequestListPoliciesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListPoliciesRequestListPoliciesPaginateTypeDef
def get_value() -> ListPoliciesRequestListPoliciesPaginateTypeDef:
return {
"ascendingOrder": ...,
}
Definition
class ListPoliciesRequestListPoliciesPaginateTypeDef(TypedDict):
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPolicyPrincipalsRequestListPolicyPrincipalsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListPolicyPrincipalsRequestListPolicyPrincipalsPaginateTypeDef
def get_value() -> ListPolicyPrincipalsRequestListPolicyPrincipalsPaginateTypeDef:
return {
"policyName": ...,
}
Definition
class ListPolicyPrincipalsRequestListPolicyPrincipalsPaginateTypeDef(TypedDict):
policyName: str,
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPrincipalPoliciesRequestListPrincipalPoliciesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListPrincipalPoliciesRequestListPrincipalPoliciesPaginateTypeDef
def get_value() -> ListPrincipalPoliciesRequestListPrincipalPoliciesPaginateTypeDef:
return {
"principal": ...,
}
Definition
class ListPrincipalPoliciesRequestListPrincipalPoliciesPaginateTypeDef(TypedDict):
principal: str,
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPrincipalThingsRequestListPrincipalThingsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListPrincipalThingsRequestListPrincipalThingsPaginateTypeDef
def get_value() -> ListPrincipalThingsRequestListPrincipalThingsPaginateTypeDef:
return {
"principal": ...,
}
Definition
class ListPrincipalThingsRequestListPrincipalThingsPaginateTypeDef(TypedDict):
principal: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListProvisioningTemplateVersionsRequestListProvisioningTemplateVersionsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListProvisioningTemplateVersionsRequestListProvisioningTemplateVersionsPaginateTypeDef
def get_value() -> ListProvisioningTemplateVersionsRequestListProvisioningTemplateVersionsPaginateTypeDef:
return {
"templateName": ...,
}
Definition
class ListProvisioningTemplateVersionsRequestListProvisioningTemplateVersionsPaginateTypeDef(TypedDict):
templateName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListProvisioningTemplatesRequestListProvisioningTemplatesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListProvisioningTemplatesRequestListProvisioningTemplatesPaginateTypeDef
def get_value() -> ListProvisioningTemplatesRequestListProvisioningTemplatesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListProvisioningTemplatesRequestListProvisioningTemplatesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRoleAliasesRequestListRoleAliasesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListRoleAliasesRequestListRoleAliasesPaginateTypeDef
def get_value() -> ListRoleAliasesRequestListRoleAliasesPaginateTypeDef:
return {
"ascendingOrder": ...,
}
Definition
class ListRoleAliasesRequestListRoleAliasesPaginateTypeDef(TypedDict):
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListScheduledAuditsRequestListScheduledAuditsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListScheduledAuditsRequestListScheduledAuditsPaginateTypeDef
def get_value() -> ListScheduledAuditsRequestListScheduledAuditsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListScheduledAuditsRequestListScheduledAuditsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListSecurityProfilesForTargetRequestListSecurityProfilesForTargetPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListSecurityProfilesForTargetRequestListSecurityProfilesForTargetPaginateTypeDef
def get_value() -> ListSecurityProfilesForTargetRequestListSecurityProfilesForTargetPaginateTypeDef:
return {
"securityProfileTargetArn": ...,
}
Definition
class ListSecurityProfilesForTargetRequestListSecurityProfilesForTargetPaginateTypeDef(TypedDict):
securityProfileTargetArn: str,
recursive: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListSecurityProfilesRequestListSecurityProfilesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListSecurityProfilesRequestListSecurityProfilesPaginateTypeDef
def get_value() -> ListSecurityProfilesRequestListSecurityProfilesPaginateTypeDef:
return {
"dimensionName": ...,
}
Definition
class ListSecurityProfilesRequestListSecurityProfilesPaginateTypeDef(TypedDict):
dimensionName: NotRequired[str],
metricName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListStreamsRequestListStreamsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListStreamsRequestListStreamsPaginateTypeDef
def get_value() -> ListStreamsRequestListStreamsPaginateTypeDef:
return {
"ascendingOrder": ...,
}
Definition
class ListStreamsRequestListStreamsPaginateTypeDef(TypedDict):
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
def get_value() -> ListTagsForResourceRequestListTagsForResourcePaginateTypeDef:
return {
"resourceArn": ...,
}
Definition
class ListTagsForResourceRequestListTagsForResourcePaginateTypeDef(TypedDict):
resourceArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTargetsForPolicyRequestListTargetsForPolicyPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListTargetsForPolicyRequestListTargetsForPolicyPaginateTypeDef
def get_value() -> ListTargetsForPolicyRequestListTargetsForPolicyPaginateTypeDef:
return {
"policyName": ...,
}
Definition
class ListTargetsForPolicyRequestListTargetsForPolicyPaginateTypeDef(TypedDict):
policyName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTargetsForSecurityProfileRequestListTargetsForSecurityProfilePaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListTargetsForSecurityProfileRequestListTargetsForSecurityProfilePaginateTypeDef
def get_value() -> ListTargetsForSecurityProfileRequestListTargetsForSecurityProfilePaginateTypeDef:
return {
"securityProfileName": ...,
}
Definition
class ListTargetsForSecurityProfileRequestListTargetsForSecurityProfilePaginateTypeDef(TypedDict):
securityProfileName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListThingGroupsForThingRequestListThingGroupsForThingPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingGroupsForThingRequestListThingGroupsForThingPaginateTypeDef
def get_value() -> ListThingGroupsForThingRequestListThingGroupsForThingPaginateTypeDef:
return {
"thingName": ...,
}
Definition
class ListThingGroupsForThingRequestListThingGroupsForThingPaginateTypeDef(TypedDict):
thingName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListThingGroupsRequestListThingGroupsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingGroupsRequestListThingGroupsPaginateTypeDef
def get_value() -> ListThingGroupsRequestListThingGroupsPaginateTypeDef:
return {
"parentGroup": ...,
}
Definition
class ListThingGroupsRequestListThingGroupsPaginateTypeDef(TypedDict):
parentGroup: NotRequired[str],
namePrefixFilter: NotRequired[str],
recursive: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListThingPrincipalsRequestListThingPrincipalsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingPrincipalsRequestListThingPrincipalsPaginateTypeDef
def get_value() -> ListThingPrincipalsRequestListThingPrincipalsPaginateTypeDef:
return {
"thingName": ...,
}
Definition
class ListThingPrincipalsRequestListThingPrincipalsPaginateTypeDef(TypedDict):
thingName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListThingRegistrationTaskReportsRequestListThingRegistrationTaskReportsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingRegistrationTaskReportsRequestListThingRegistrationTaskReportsPaginateTypeDef
def get_value() -> ListThingRegistrationTaskReportsRequestListThingRegistrationTaskReportsPaginateTypeDef:
return {
"taskId": ...,
"reportType": ...,
}
Definition
class ListThingRegistrationTaskReportsRequestListThingRegistrationTaskReportsPaginateTypeDef(TypedDict):
taskId: str,
reportType: ReportTypeType, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See ReportTypeType
- See PaginatorConfigTypeDef
ListThingRegistrationTasksRequestListThingRegistrationTasksPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingRegistrationTasksRequestListThingRegistrationTasksPaginateTypeDef
def get_value() -> ListThingRegistrationTasksRequestListThingRegistrationTasksPaginateTypeDef:
return {
"status": ...,
}
Definition
class ListThingRegistrationTasksRequestListThingRegistrationTasksPaginateTypeDef(TypedDict):
status: NotRequired[StatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See StatusType
- See PaginatorConfigTypeDef
ListThingTypesRequestListThingTypesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingTypesRequestListThingTypesPaginateTypeDef
def get_value() -> ListThingTypesRequestListThingTypesPaginateTypeDef:
return {
"thingTypeName": ...,
}
Definition
class ListThingTypesRequestListThingTypesPaginateTypeDef(TypedDict):
thingTypeName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListThingsInBillingGroupRequestListThingsInBillingGroupPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingsInBillingGroupRequestListThingsInBillingGroupPaginateTypeDef
def get_value() -> ListThingsInBillingGroupRequestListThingsInBillingGroupPaginateTypeDef:
return {
"billingGroupName": ...,
}
Definition
class ListThingsInBillingGroupRequestListThingsInBillingGroupPaginateTypeDef(TypedDict):
billingGroupName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListThingsInThingGroupRequestListThingsInThingGroupPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingsInThingGroupRequestListThingsInThingGroupPaginateTypeDef
def get_value() -> ListThingsInThingGroupRequestListThingsInThingGroupPaginateTypeDef:
return {
"thingGroupName": ...,
}
Definition
class ListThingsInThingGroupRequestListThingsInThingGroupPaginateTypeDef(TypedDict):
thingGroupName: str,
recursive: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListThingsRequestListThingsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingsRequestListThingsPaginateTypeDef
def get_value() -> ListThingsRequestListThingsPaginateTypeDef:
return {
"attributeName": ...,
}
Definition
class ListThingsRequestListThingsPaginateTypeDef(TypedDict):
attributeName: NotRequired[str],
attributeValue: NotRequired[str],
thingTypeName: NotRequired[str],
usePrefixAttributeValue: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTopicRuleDestinationsRequestListTopicRuleDestinationsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListTopicRuleDestinationsRequestListTopicRuleDestinationsPaginateTypeDef
def get_value() -> ListTopicRuleDestinationsRequestListTopicRuleDestinationsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListTopicRuleDestinationsRequestListTopicRuleDestinationsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTopicRulesRequestListTopicRulesPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListTopicRulesRequestListTopicRulesPaginateTypeDef
def get_value() -> ListTopicRulesRequestListTopicRulesPaginateTypeDef:
return {
"topic": ...,
}
Definition
class ListTopicRulesRequestListTopicRulesPaginateTypeDef(TypedDict):
topic: NotRequired[str],
ruleDisabled: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListV2LoggingLevelsRequestListV2LoggingLevelsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListV2LoggingLevelsRequestListV2LoggingLevelsPaginateTypeDef
def get_value() -> ListV2LoggingLevelsRequestListV2LoggingLevelsPaginateTypeDef:
return {
"targetType": ...,
}
Definition
class ListV2LoggingLevelsRequestListV2LoggingLevelsPaginateTypeDef(TypedDict):
targetType: NotRequired[LogTargetTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListViolationEventsRequestListViolationEventsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListViolationEventsRequestListViolationEventsPaginateTypeDef
def get_value() -> ListViolationEventsRequestListViolationEventsPaginateTypeDef:
return {
"startTime": ...,
"endTime": ...,
}
Definition
class ListViolationEventsRequestListViolationEventsPaginateTypeDef(TypedDict):
startTime: Union[datetime, str],
endTime: Union[datetime, str],
thingName: NotRequired[str],
securityProfileName: NotRequired[str],
behaviorCriteriaType: NotRequired[BehaviorCriteriaTypeType], # (1)
listSuppressedAlerts: NotRequired[bool],
verificationState: NotRequired[VerificationStateType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
GetPercentilesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetPercentilesResponseTypeDef
def get_value() -> GetPercentilesResponseTypeDef:
return {
"percentiles": ...,
"ResponseMetadata": ...,
}
Definition
class GetPercentilesResponseTypeDef(TypedDict):
percentiles: List[PercentPairTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetStatisticsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetStatisticsResponseTypeDef
def get_value() -> GetStatisticsResponseTypeDef:
return {
"statistics": ...,
"ResponseMetadata": ...,
}
Definition
class GetStatisticsResponseTypeDef(TypedDict):
statistics: StatisticsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListBillingGroupsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListBillingGroupsResponseTypeDef
def get_value() -> ListBillingGroupsResponseTypeDef:
return {
"billingGroups": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListBillingGroupsResponseTypeDef(TypedDict):
billingGroups: List[GroupNameAndArnTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListThingGroupsForThingResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingGroupsForThingResponseTypeDef
def get_value() -> ListThingGroupsForThingResponseTypeDef:
return {
"thingGroups": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListThingGroupsForThingResponseTypeDef(TypedDict):
thingGroups: List[GroupNameAndArnTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListThingGroupsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingGroupsResponseTypeDef
def get_value() -> ListThingGroupsResponseTypeDef:
return {
"thingGroups": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListThingGroupsResponseTypeDef(TypedDict):
thingGroups: List[GroupNameAndArnTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ThingGroupMetadataTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ThingGroupMetadataTypeDef
def get_value() -> ThingGroupMetadataTypeDef:
return {
"parentGroupName": ...,
}
Definition
class ThingGroupMetadataTypeDef(TypedDict):
parentGroupName: NotRequired[str],
rootToParentThingGroups: NotRequired[List[GroupNameAndArnTypeDef]], # (1)
creationDate: NotRequired[datetime],
HttpAuthorizationTypeDef
Usage Example
from mypy_boto3_iot.type_defs import HttpAuthorizationTypeDef
def get_value() -> HttpAuthorizationTypeDef:
return {
"sigv4": ...,
}
Definition
class HttpAuthorizationTypeDef(TypedDict):
sigv4: NotRequired[SigV4AuthorizationTypeDef], # (1)
ThingIndexingConfigurationTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ThingIndexingConfigurationTypeDef
def get_value() -> ThingIndexingConfigurationTypeDef:
return {
"thingIndexingMode": ...,
}
Definition
class ThingIndexingConfigurationTypeDef(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[IndexingFilterTypeDef], # (7)
- See ThingIndexingModeType
- See ThingConnectivityIndexingModeType
- See DeviceDefenderIndexingModeType
- See NamedShadowIndexingModeType
- See FieldTypeDef
- See FieldTypeDef
- See IndexingFilterTypeDef
JobExecutionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import JobExecutionTypeDef
def get_value() -> JobExecutionTypeDef:
return {
"jobId": ...,
}
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
Usage Example
from mypy_boto3_iot.type_defs import JobExecutionSummaryForJobTypeDef
def get_value() -> JobExecutionSummaryForJobTypeDef:
return {
"thingArn": ...,
}
Definition
class JobExecutionSummaryForJobTypeDef(TypedDict):
thingArn: NotRequired[str],
jobExecutionSummary: NotRequired[JobExecutionSummaryTypeDef], # (1)
JobExecutionSummaryForThingTypeDef
Usage Example
from mypy_boto3_iot.type_defs import JobExecutionSummaryForThingTypeDef
def get_value() -> JobExecutionSummaryForThingTypeDef:
return {
"jobId": ...,
}
Definition
class JobExecutionSummaryForThingTypeDef(TypedDict):
jobId: NotRequired[str],
jobExecutionSummary: NotRequired[JobExecutionSummaryTypeDef], # (1)
JobExecutionsRetryConfigTypeDef
Usage Example
from mypy_boto3_iot.type_defs import JobExecutionsRetryConfigTypeDef
def get_value() -> JobExecutionsRetryConfigTypeDef:
return {
"criteriaList": ...,
}
Definition
class JobExecutionsRetryConfigTypeDef(TypedDict):
criteriaList: Sequence[RetryCriteriaTypeDef], # (1)
ListJobsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListJobsResponseTypeDef
def get_value() -> ListJobsResponseTypeDef:
return {
"jobs": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListJobsResponseTypeDef(TypedDict):
jobs: List[JobSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListJobTemplatesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListJobTemplatesResponseTypeDef
def get_value() -> ListJobTemplatesResponseTypeDef:
return {
"jobTemplates": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListJobTemplatesResponseTypeDef(TypedDict):
jobTemplates: List[JobTemplateSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListManagedJobTemplatesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListManagedJobTemplatesResponseTypeDef
def get_value() -> ListManagedJobTemplatesResponseTypeDef:
return {
"managedJobTemplates": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListManagedJobTemplatesResponseTypeDef(TypedDict):
managedJobTemplates: List[ManagedJobTemplateSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListMitigationActionsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListMitigationActionsResponseTypeDef
def get_value() -> ListMitigationActionsResponseTypeDef:
return {
"actionIdentifiers": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListMitigationActionsResponseTypeDef(TypedDict):
actionIdentifiers: List[MitigationActionIdentifierTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListOTAUpdatesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListOTAUpdatesResponseTypeDef
def get_value() -> ListOTAUpdatesResponseTypeDef:
return {
"otaUpdates": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListOTAUpdatesResponseTypeDef(TypedDict):
otaUpdates: List[OTAUpdateSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListOutgoingCertificatesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListOutgoingCertificatesResponseTypeDef
def get_value() -> ListOutgoingCertificatesResponseTypeDef:
return {
"outgoingCertificates": ...,
"nextMarker": ...,
"ResponseMetadata": ...,
}
Definition
class ListOutgoingCertificatesResponseTypeDef(TypedDict):
outgoingCertificates: List[OutgoingCertificateTypeDef], # (1)
nextMarker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListPolicyVersionsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListPolicyVersionsResponseTypeDef
def get_value() -> ListPolicyVersionsResponseTypeDef:
return {
"policyVersions": ...,
"ResponseMetadata": ...,
}
Definition
class ListPolicyVersionsResponseTypeDef(TypedDict):
policyVersions: List[PolicyVersionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListProvisioningTemplateVersionsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListProvisioningTemplateVersionsResponseTypeDef
def get_value() -> ListProvisioningTemplateVersionsResponseTypeDef:
return {
"versions": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListProvisioningTemplateVersionsResponseTypeDef(TypedDict):
versions: List[ProvisioningTemplateVersionSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListProvisioningTemplatesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListProvisioningTemplatesResponseTypeDef
def get_value() -> ListProvisioningTemplatesResponseTypeDef:
return {
"templates": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListProvisioningTemplatesResponseTypeDef(TypedDict):
templates: List[ProvisioningTemplateSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListScheduledAuditsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListScheduledAuditsResponseTypeDef
def get_value() -> ListScheduledAuditsResponseTypeDef:
return {
"scheduledAudits": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListScheduledAuditsResponseTypeDef(TypedDict):
scheduledAudits: List[ScheduledAuditMetadataTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSecurityProfilesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListSecurityProfilesResponseTypeDef
def get_value() -> ListSecurityProfilesResponseTypeDef:
return {
"securityProfileIdentifiers": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListSecurityProfilesResponseTypeDef(TypedDict):
securityProfileIdentifiers: List[SecurityProfileIdentifierTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListStreamsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListStreamsResponseTypeDef
def get_value() -> ListStreamsResponseTypeDef:
return {
"streams": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListStreamsResponseTypeDef(TypedDict):
streams: List[StreamSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTargetsForSecurityProfileResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListTargetsForSecurityProfileResponseTypeDef
def get_value() -> ListTargetsForSecurityProfileResponseTypeDef:
return {
"securityProfileTargets": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListTargetsForSecurityProfileResponseTypeDef(TypedDict):
securityProfileTargets: List[SecurityProfileTargetTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SecurityProfileTargetMappingTypeDef
Usage Example
from mypy_boto3_iot.type_defs import SecurityProfileTargetMappingTypeDef
def get_value() -> SecurityProfileTargetMappingTypeDef:
return {
"securityProfileIdentifier": ...,
}
Definition
class SecurityProfileTargetMappingTypeDef(TypedDict):
securityProfileIdentifier: NotRequired[SecurityProfileIdentifierTypeDef], # (1)
target: NotRequired[SecurityProfileTargetTypeDef], # (2)
ListThingsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingsResponseTypeDef
def get_value() -> ListThingsResponseTypeDef:
return {
"things": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListThingsResponseTypeDef(TypedDict):
things: List[ThingAttributeTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTopicRulesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListTopicRulesResponseTypeDef
def get_value() -> ListTopicRulesResponseTypeDef:
return {
"rules": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListTopicRulesResponseTypeDef(TypedDict):
rules: List[TopicRuleListItemTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
LocationActionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import LocationActionTypeDef
def get_value() -> LocationActionTypeDef:
return {
"roleArn": ...,
"trackerName": ...,
"deviceId": ...,
"latitude": ...,
"longitude": ...,
}
Definition
class LocationActionTypeDef(TypedDict):
roleArn: str,
trackerName: str,
deviceId: str,
latitude: str,
longitude: str,
timestamp: NotRequired[LocationTimestampTypeDef], # (1)
LogTargetConfigurationTypeDef
Usage Example
from mypy_boto3_iot.type_defs import LogTargetConfigurationTypeDef
def get_value() -> LogTargetConfigurationTypeDef:
return {
"logTarget": ...,
}
Definition
class LogTargetConfigurationTypeDef(TypedDict):
logTarget: NotRequired[LogTargetTypeDef], # (1)
logLevel: NotRequired[LogLevelType], # (2)
- See LogTargetTypeDef
- See LogLevelType
SetV2LoggingLevelRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import SetV2LoggingLevelRequestRequestTypeDef
def get_value() -> SetV2LoggingLevelRequestRequestTypeDef:
return {
"logTarget": ...,
"logLevel": ...,
}
Definition
class SetV2LoggingLevelRequestRequestTypeDef(TypedDict):
logTarget: LogTargetTypeDef, # (1)
logLevel: LogLevelType, # (2)
- See LogTargetTypeDef
- See LogLevelType
SetLoggingOptionsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import SetLoggingOptionsRequestRequestTypeDef
def get_value() -> SetLoggingOptionsRequestRequestTypeDef:
return {
"loggingOptionsPayload": ...,
}
Definition
class SetLoggingOptionsRequestRequestTypeDef(TypedDict):
loggingOptionsPayload: LoggingOptionsPayloadTypeDef, # (1)
MitigationActionParamsTypeDef
Usage Example
from mypy_boto3_iot.type_defs import MitigationActionParamsTypeDef
def get_value() -> MitigationActionParamsTypeDef:
return {
"updateDeviceCertificateParams": ...,
}
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
MqttHeadersTypeDef
Usage Example
from mypy_boto3_iot.type_defs import MqttHeadersTypeDef
def get_value() -> MqttHeadersTypeDef:
return {
"payloadFormatIndicator": ...,
}
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
Usage Example
from mypy_boto3_iot.type_defs import ResourceIdentifierTypeDef
def get_value() -> ResourceIdentifierTypeDef:
return {
"deviceCertificateId": ...,
}
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],
TestInvokeAuthorizerRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TestInvokeAuthorizerRequestRequestTypeDef
def get_value() -> TestInvokeAuthorizerRequestRequestTypeDef:
return {
"authorizerName": ...,
}
Definition
class TestInvokeAuthorizerRequestRequestTypeDef(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
ThingDocumentTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ThingDocumentTypeDef
def get_value() -> ThingDocumentTypeDef:
return {
"thingName": ...,
}
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)
TimestreamActionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TimestreamActionTypeDef
def get_value() -> TimestreamActionTypeDef:
return {
"roleArn": ...,
"databaseName": ...,
"tableName": ...,
"dimensions": ...,
}
Definition
class TimestreamActionTypeDef(TypedDict):
roleArn: str,
databaseName: str,
tableName: str,
dimensions: Sequence[TimestreamDimensionTypeDef], # (1)
timestamp: NotRequired[TimestreamTimestampTypeDef], # (2)
TopicRuleDestinationConfigurationTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TopicRuleDestinationConfigurationTypeDef
def get_value() -> TopicRuleDestinationConfigurationTypeDef:
return {
"httpUrlConfiguration": ...,
}
Definition
class TopicRuleDestinationConfigurationTypeDef(TypedDict):
httpUrlConfiguration: NotRequired[HttpUrlDestinationConfigurationTypeDef], # (1)
vpcConfiguration: NotRequired[VpcDestinationConfigurationTypeDef], # (2)
TopicRuleDestinationSummaryTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TopicRuleDestinationSummaryTypeDef
def get_value() -> TopicRuleDestinationSummaryTypeDef:
return {
"arn": ...,
}
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
Usage Example
from mypy_boto3_iot.type_defs import TopicRuleDestinationTypeDef
def get_value() -> TopicRuleDestinationTypeDef:
return {
"arn": ...,
}
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
Usage Example
from mypy_boto3_iot.type_defs import ValidateSecurityProfileBehaviorsResponseTypeDef
def get_value() -> ValidateSecurityProfileBehaviorsResponseTypeDef:
return {
"valid": ...,
"validationErrors": ...,
"ResponseMetadata": ...,
}
Definition
class ValidateSecurityProfileBehaviorsResponseTypeDef(TypedDict):
valid: bool,
validationErrors: List[ValidationErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListMetricValuesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListMetricValuesResponseTypeDef
def get_value() -> ListMetricValuesResponseTypeDef:
return {
"metricDatumList": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListMetricValuesResponseTypeDef(TypedDict):
metricDatumList: List[MetricDatumTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeniedTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeniedTypeDef
def get_value() -> DeniedTypeDef:
return {
"implicitDeny": ...,
}
Definition
class DeniedTypeDef(TypedDict):
implicitDeny: NotRequired[ImplicitDenyTypeDef], # (1)
explicitDeny: NotRequired[ExplicitDenyTypeDef], # (2)
PutAssetPropertyValueEntryTypeDef
Usage Example
from mypy_boto3_iot.type_defs import PutAssetPropertyValueEntryTypeDef
def get_value() -> PutAssetPropertyValueEntryTypeDef:
return {
"propertyValues": ...,
}
Definition
class PutAssetPropertyValueEntryTypeDef(TypedDict):
propertyValues: Sequence[AssetPropertyValueTypeDef], # (1)
entryId: NotRequired[str],
assetId: NotRequired[str],
propertyId: NotRequired[str],
propertyAlias: NotRequired[str],
CreateDynamicThingGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateDynamicThingGroupRequestRequestTypeDef
def get_value() -> CreateDynamicThingGroupRequestRequestTypeDef:
return {
"thingGroupName": ...,
"queryString": ...,
}
Definition
class CreateDynamicThingGroupRequestRequestTypeDef(TypedDict):
thingGroupName: str,
queryString: str,
thingGroupProperties: NotRequired[ThingGroupPropertiesTypeDef], # (1)
indexName: NotRequired[str],
queryVersion: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)
CreateThingGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateThingGroupRequestRequestTypeDef
def get_value() -> CreateThingGroupRequestRequestTypeDef:
return {
"thingGroupName": ...,
}
Definition
class CreateThingGroupRequestRequestTypeDef(TypedDict):
thingGroupName: str,
parentGroupName: NotRequired[str],
thingGroupProperties: NotRequired[ThingGroupPropertiesTypeDef], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)
UpdateDynamicThingGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateDynamicThingGroupRequestRequestTypeDef
def get_value() -> UpdateDynamicThingGroupRequestRequestTypeDef:
return {
"thingGroupName": ...,
"thingGroupProperties": ...,
}
Definition
class UpdateDynamicThingGroupRequestRequestTypeDef(TypedDict):
thingGroupName: str,
thingGroupProperties: ThingGroupPropertiesTypeDef, # (1)
expectedVersion: NotRequired[int],
indexName: NotRequired[str],
queryString: NotRequired[str],
queryVersion: NotRequired[str],
UpdateThingGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateThingGroupRequestRequestTypeDef
def get_value() -> UpdateThingGroupRequestRequestTypeDef:
return {
"thingGroupName": ...,
"thingGroupProperties": ...,
}
Definition
class UpdateThingGroupRequestRequestTypeDef(TypedDict):
thingGroupName: str,
thingGroupProperties: ThingGroupPropertiesTypeDef, # (1)
expectedVersion: NotRequired[int],
AwsJobExecutionsRolloutConfigTypeDef
Usage Example
from mypy_boto3_iot.type_defs import AwsJobExecutionsRolloutConfigTypeDef
def get_value() -> AwsJobExecutionsRolloutConfigTypeDef:
return {
"maximumPerMinute": ...,
}
Definition
class AwsJobExecutionsRolloutConfigTypeDef(TypedDict):
maximumPerMinute: NotRequired[int],
exponentialRate: NotRequired[AwsJobExponentialRolloutRateTypeDef], # (1)
BehaviorTypeDef
Usage Example
from mypy_boto3_iot.type_defs import BehaviorTypeDef
def get_value() -> BehaviorTypeDef:
return {
"name": ...,
}
Definition
class BehaviorTypeDef(TypedDict):
name: str,
metric: NotRequired[str],
metricDimension: NotRequired[MetricDimensionTypeDef], # (1)
criteria: NotRequired[BehaviorCriteriaTypeDef], # (2)
suppressAlerts: NotRequired[bool],
GetBucketsAggregationRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetBucketsAggregationRequestRequestTypeDef
def get_value() -> GetBucketsAggregationRequestRequestTypeDef:
return {
"queryString": ...,
"aggregationField": ...,
"bucketsAggregationType": ...,
}
Definition
class GetBucketsAggregationRequestRequestTypeDef(TypedDict):
queryString: str,
aggregationField: str,
bucketsAggregationType: BucketsAggregationTypeTypeDef, # (1)
indexName: NotRequired[str],
queryVersion: NotRequired[str],
DescribeCACertificateResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeCACertificateResponseTypeDef
def get_value() -> DescribeCACertificateResponseTypeDef:
return {
"certificateDescription": ...,
"registrationConfig": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeCACertificateResponseTypeDef(TypedDict):
certificateDescription: CACertificateDescriptionTypeDef, # (1)
registrationConfig: RegistrationConfigTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DescribeCertificateResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeCertificateResponseTypeDef
def get_value() -> DescribeCertificateResponseTypeDef:
return {
"certificateDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeCertificateResponseTypeDef(TypedDict):
certificateDescription: CertificateDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListThingTypesResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListThingTypesResponseTypeDef
def get_value() -> ListThingTypesResponseTypeDef:
return {
"thingTypes": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListThingTypesResponseTypeDef(TypedDict):
thingTypes: List[ThingTypeDefinitionTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartSigningJobParameterTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StartSigningJobParameterTypeDef
def get_value() -> StartSigningJobParameterTypeDef:
return {
"signingProfileParameter": ...,
}
Definition
class StartSigningJobParameterTypeDef(TypedDict):
signingProfileParameter: NotRequired[SigningProfileParameterTypeDef], # (1)
signingProfileName: NotRequired[str],
destination: NotRequired[DestinationTypeDef], # (2)
JobExecutionsRolloutConfigTypeDef
Usage Example
from mypy_boto3_iot.type_defs import JobExecutionsRolloutConfigTypeDef
def get_value() -> JobExecutionsRolloutConfigTypeDef:
return {
"maximumPerMinute": ...,
}
Definition
class JobExecutionsRolloutConfigTypeDef(TypedDict):
maximumPerMinute: NotRequired[int],
exponentialRate: NotRequired[ExponentialRolloutRateTypeDef], # (1)
CreateStreamRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateStreamRequestRequestTypeDef
def get_value() -> CreateStreamRequestRequestTypeDef:
return {
"streamId": ...,
"files": ...,
"roleArn": ...,
}
Definition
class CreateStreamRequestRequestTypeDef(TypedDict):
streamId: str,
files: Sequence[StreamFileTypeDef], # (1)
roleArn: str,
description: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See StreamFileTypeDef
- See TagTypeDef
StreamInfoTypeDef
Usage Example
from mypy_boto3_iot.type_defs import StreamInfoTypeDef
def get_value() -> StreamInfoTypeDef:
return {
"streamId": ...,
}
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],
UpdateStreamRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateStreamRequestRequestTypeDef
def get_value() -> UpdateStreamRequestRequestTypeDef:
return {
"streamId": ...,
}
Definition
class UpdateStreamRequestRequestTypeDef(TypedDict):
streamId: str,
description: NotRequired[str],
files: NotRequired[Sequence[StreamFileTypeDef]], # (1)
roleArn: NotRequired[str],
DescribeThingGroupResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeThingGroupResponseTypeDef
def get_value() -> DescribeThingGroupResponseTypeDef:
return {
"thingGroupName": ...,
"thingGroupId": ...,
"thingGroupArn": ...,
"version": ...,
"thingGroupProperties": ...,
"thingGroupMetadata": ...,
"indexName": ...,
"queryString": ...,
"queryVersion": ...,
"status": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeThingGroupResponseTypeDef(TypedDict):
thingGroupName: str,
thingGroupId: str,
thingGroupArn: str,
version: int,
thingGroupProperties: ThingGroupPropertiesTypeDef, # (1)
thingGroupMetadata: ThingGroupMetadataTypeDef, # (2)
indexName: str,
queryString: str,
queryVersion: str,
status: DynamicGroupStatusType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ThingGroupPropertiesTypeDef
- See ThingGroupMetadataTypeDef
- See DynamicGroupStatusType
- See ResponseMetadataTypeDef
HttpActionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import HttpActionTypeDef
def get_value() -> HttpActionTypeDef:
return {
"url": ...,
}
Definition
class HttpActionTypeDef(TypedDict):
url: str,
confirmationUrl: NotRequired[str],
headers: NotRequired[Sequence[HttpActionHeaderTypeDef]], # (1)
auth: NotRequired[HttpAuthorizationTypeDef], # (2)
GetIndexingConfigurationResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetIndexingConfigurationResponseTypeDef
def get_value() -> GetIndexingConfigurationResponseTypeDef:
return {
"thingIndexingConfiguration": ...,
"thingGroupIndexingConfiguration": ...,
"ResponseMetadata": ...,
}
Definition
class GetIndexingConfigurationResponseTypeDef(TypedDict):
thingIndexingConfiguration: ThingIndexingConfigurationTypeDef, # (1)
thingGroupIndexingConfiguration: ThingGroupIndexingConfigurationTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See ThingIndexingConfigurationTypeDef
- See ThingGroupIndexingConfigurationTypeDef
- See ResponseMetadataTypeDef
UpdateIndexingConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateIndexingConfigurationRequestRequestTypeDef
def get_value() -> UpdateIndexingConfigurationRequestRequestTypeDef:
return {
"thingIndexingConfiguration": ...,
}
Definition
class UpdateIndexingConfigurationRequestRequestTypeDef(TypedDict):
thingIndexingConfiguration: NotRequired[ThingIndexingConfigurationTypeDef], # (1)
thingGroupIndexingConfiguration: NotRequired[ThingGroupIndexingConfigurationTypeDef], # (2)
DescribeJobExecutionResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeJobExecutionResponseTypeDef
def get_value() -> DescribeJobExecutionResponseTypeDef:
return {
"execution": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeJobExecutionResponseTypeDef(TypedDict):
execution: JobExecutionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListJobExecutionsForJobResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListJobExecutionsForJobResponseTypeDef
def get_value() -> ListJobExecutionsForJobResponseTypeDef:
return {
"executionSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListJobExecutionsForJobResponseTypeDef(TypedDict):
executionSummaries: List[JobExecutionSummaryForJobTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListJobExecutionsForThingResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListJobExecutionsForThingResponseTypeDef
def get_value() -> ListJobExecutionsForThingResponseTypeDef:
return {
"executionSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListJobExecutionsForThingResponseTypeDef(TypedDict):
executionSummaries: List[JobExecutionSummaryForThingTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSecurityProfilesForTargetResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListSecurityProfilesForTargetResponseTypeDef
def get_value() -> ListSecurityProfilesForTargetResponseTypeDef:
return {
"securityProfileTargetMappings": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListSecurityProfilesForTargetResponseTypeDef(TypedDict):
securityProfileTargetMappings: List[SecurityProfileTargetMappingTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListV2LoggingLevelsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListV2LoggingLevelsResponseTypeDef
def get_value() -> ListV2LoggingLevelsResponseTypeDef:
return {
"logTargetConfigurations": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListV2LoggingLevelsResponseTypeDef(TypedDict):
logTargetConfigurations: List[LogTargetConfigurationTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateMitigationActionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateMitigationActionRequestRequestTypeDef
def get_value() -> CreateMitigationActionRequestRequestTypeDef:
return {
"actionName": ...,
"roleArn": ...,
"actionParams": ...,
}
Definition
class CreateMitigationActionRequestRequestTypeDef(TypedDict):
actionName: str,
roleArn: str,
actionParams: MitigationActionParamsTypeDef, # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)
DescribeMitigationActionResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeMitigationActionResponseTypeDef
def get_value() -> DescribeMitigationActionResponseTypeDef:
return {
"actionName": ...,
"actionType": ...,
"actionArn": ...,
"actionId": ...,
"roleArn": ...,
"actionParams": ...,
"creationDate": ...,
"lastModifiedDate": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeMitigationActionResponseTypeDef(TypedDict):
actionName: str,
actionType: MitigationActionTypeType, # (1)
actionArn: str,
actionId: str,
roleArn: str,
actionParams: MitigationActionParamsTypeDef, # (2)
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
MitigationActionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import MitigationActionTypeDef
def get_value() -> MitigationActionTypeDef:
return {
"name": ...,
}
Definition
class MitigationActionTypeDef(TypedDict):
name: NotRequired[str],
id: NotRequired[str],
roleArn: NotRequired[str],
actionParams: NotRequired[MitigationActionParamsTypeDef], # (1)
UpdateMitigationActionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateMitigationActionRequestRequestTypeDef
def get_value() -> UpdateMitigationActionRequestRequestTypeDef:
return {
"actionName": ...,
}
Definition
class UpdateMitigationActionRequestRequestTypeDef(TypedDict):
actionName: str,
roleArn: NotRequired[str],
actionParams: NotRequired[MitigationActionParamsTypeDef], # (1)
RepublishActionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RepublishActionTypeDef
def get_value() -> RepublishActionTypeDef:
return {
"roleArn": ...,
"topic": ...,
}
Definition
class RepublishActionTypeDef(TypedDict):
roleArn: str,
topic: str,
qos: NotRequired[int],
headers: NotRequired[MqttHeadersTypeDef], # (1)
AuditSuppressionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import AuditSuppressionTypeDef
def get_value() -> AuditSuppressionTypeDef:
return {
"checkName": ...,
"resourceIdentifier": ...,
}
Definition
class AuditSuppressionTypeDef(TypedDict):
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)
expirationDate: NotRequired[datetime],
suppressIndefinitely: NotRequired[bool],
description: NotRequired[str],
CreateAuditSuppressionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateAuditSuppressionRequestRequestTypeDef
def get_value() -> CreateAuditSuppressionRequestRequestTypeDef:
return {
"checkName": ...,
"resourceIdentifier": ...,
"clientRequestToken": ...,
}
Definition
class CreateAuditSuppressionRequestRequestTypeDef(TypedDict):
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)
clientRequestToken: str,
expirationDate: NotRequired[Union[datetime, str]],
suppressIndefinitely: NotRequired[bool],
description: NotRequired[str],
DeleteAuditSuppressionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DeleteAuditSuppressionRequestRequestTypeDef
def get_value() -> DeleteAuditSuppressionRequestRequestTypeDef:
return {
"checkName": ...,
"resourceIdentifier": ...,
}
Definition
class DeleteAuditSuppressionRequestRequestTypeDef(TypedDict):
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)
DescribeAuditSuppressionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeAuditSuppressionRequestRequestTypeDef
def get_value() -> DescribeAuditSuppressionRequestRequestTypeDef:
return {
"checkName": ...,
"resourceIdentifier": ...,
}
Definition
class DescribeAuditSuppressionRequestRequestTypeDef(TypedDict):
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)
DescribeAuditSuppressionResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeAuditSuppressionResponseTypeDef
def get_value() -> DescribeAuditSuppressionResponseTypeDef:
return {
"checkName": ...,
"resourceIdentifier": ...,
"expirationDate": ...,
"suppressIndefinitely": ...,
"description": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeAuditSuppressionResponseTypeDef(TypedDict):
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)
expirationDate: datetime,
suppressIndefinitely: bool,
description: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAuditFindingsRequestListAuditFindingsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuditFindingsRequestListAuditFindingsPaginateTypeDef
def get_value() -> ListAuditFindingsRequestListAuditFindingsPaginateTypeDef:
return {
"taskId": ...,
}
Definition
class ListAuditFindingsRequestListAuditFindingsPaginateTypeDef(TypedDict):
taskId: NotRequired[str],
checkName: NotRequired[str],
resourceIdentifier: NotRequired[ResourceIdentifierTypeDef], # (1)
startTime: NotRequired[Union[datetime, str]],
endTime: NotRequired[Union[datetime, str]],
listSuppressedFindings: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListAuditFindingsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuditFindingsRequestRequestTypeDef
def get_value() -> ListAuditFindingsRequestRequestTypeDef:
return {
"taskId": ...,
}
Definition
class ListAuditFindingsRequestRequestTypeDef(TypedDict):
taskId: NotRequired[str],
checkName: NotRequired[str],
resourceIdentifier: NotRequired[ResourceIdentifierTypeDef], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
startTime: NotRequired[Union[datetime, str]],
endTime: NotRequired[Union[datetime, str]],
listSuppressedFindings: NotRequired[bool],
ListAuditSuppressionsRequestListAuditSuppressionsPaginateTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuditSuppressionsRequestListAuditSuppressionsPaginateTypeDef
def get_value() -> ListAuditSuppressionsRequestListAuditSuppressionsPaginateTypeDef:
return {
"checkName": ...,
}
Definition
class ListAuditSuppressionsRequestListAuditSuppressionsPaginateTypeDef(TypedDict):
checkName: NotRequired[str],
resourceIdentifier: NotRequired[ResourceIdentifierTypeDef], # (1)
ascendingOrder: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListAuditSuppressionsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuditSuppressionsRequestRequestTypeDef
def get_value() -> ListAuditSuppressionsRequestRequestTypeDef:
return {
"checkName": ...,
}
Definition
class ListAuditSuppressionsRequestRequestTypeDef(TypedDict):
checkName: NotRequired[str],
resourceIdentifier: NotRequired[ResourceIdentifierTypeDef], # (1)
ascendingOrder: NotRequired[bool],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
NonCompliantResourceTypeDef
Usage Example
from mypy_boto3_iot.type_defs import NonCompliantResourceTypeDef
def get_value() -> NonCompliantResourceTypeDef:
return {
"resourceType": ...,
}
Definition
class NonCompliantResourceTypeDef(TypedDict):
resourceType: NotRequired[ResourceTypeType], # (1)
resourceIdentifier: NotRequired[ResourceIdentifierTypeDef], # (2)
additionalInfo: NotRequired[Dict[str, str]],
RelatedResourceTypeDef
Usage Example
from mypy_boto3_iot.type_defs import RelatedResourceTypeDef
def get_value() -> RelatedResourceTypeDef:
return {
"resourceType": ...,
}
Definition
class RelatedResourceTypeDef(TypedDict):
resourceType: NotRequired[ResourceTypeType], # (1)
resourceIdentifier: NotRequired[ResourceIdentifierTypeDef], # (2)
additionalInfo: NotRequired[Dict[str, str]],
UpdateAuditSuppressionRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateAuditSuppressionRequestRequestTypeDef
def get_value() -> UpdateAuditSuppressionRequestRequestTypeDef:
return {
"checkName": ...,
"resourceIdentifier": ...,
}
Definition
class UpdateAuditSuppressionRequestRequestTypeDef(TypedDict):
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)
expirationDate: NotRequired[Union[datetime, str]],
suppressIndefinitely: NotRequired[bool],
description: NotRequired[str],
SearchIndexResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import SearchIndexResponseTypeDef
def get_value() -> SearchIndexResponseTypeDef:
return {
"nextToken": ...,
"things": ...,
"thingGroups": ...,
"ResponseMetadata": ...,
}
Definition
class SearchIndexResponseTypeDef(TypedDict):
nextToken: str,
things: List[ThingDocumentTypeDef], # (1)
thingGroups: List[ThingGroupDocumentTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
CreateTopicRuleDestinationRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateTopicRuleDestinationRequestRequestTypeDef
def get_value() -> CreateTopicRuleDestinationRequestRequestTypeDef:
return {
"destinationConfiguration": ...,
}
Definition
class CreateTopicRuleDestinationRequestRequestTypeDef(TypedDict):
destinationConfiguration: TopicRuleDestinationConfigurationTypeDef, # (1)
ListTopicRuleDestinationsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListTopicRuleDestinationsResponseTypeDef
def get_value() -> ListTopicRuleDestinationsResponseTypeDef:
return {
"destinationSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListTopicRuleDestinationsResponseTypeDef(TypedDict):
destinationSummaries: List[TopicRuleDestinationSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateTopicRuleDestinationResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateTopicRuleDestinationResponseTypeDef
def get_value() -> CreateTopicRuleDestinationResponseTypeDef:
return {
"topicRuleDestination": ...,
"ResponseMetadata": ...,
}
Definition
class CreateTopicRuleDestinationResponseTypeDef(TypedDict):
topicRuleDestination: TopicRuleDestinationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetTopicRuleDestinationResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetTopicRuleDestinationResponseTypeDef
def get_value() -> GetTopicRuleDestinationResponseTypeDef:
return {
"topicRuleDestination": ...,
"ResponseMetadata": ...,
}
Definition
class GetTopicRuleDestinationResponseTypeDef(TypedDict):
topicRuleDestination: TopicRuleDestinationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AuthResultTypeDef
Usage Example
from mypy_boto3_iot.type_defs import AuthResultTypeDef
def get_value() -> AuthResultTypeDef:
return {
"authInfo": ...,
}
Definition
class AuthResultTypeDef(TypedDict):
authInfo: NotRequired[AuthInfoTypeDef], # (1)
allowed: NotRequired[AllowedTypeDef], # (2)
denied: NotRequired[DeniedTypeDef], # (3)
authDecision: NotRequired[AuthDecisionType], # (4)
missingContextValues: NotRequired[List[str]],
- See AuthInfoTypeDef
- See AllowedTypeDef
- See DeniedTypeDef
- See AuthDecisionType
IotSiteWiseActionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import IotSiteWiseActionTypeDef
def get_value() -> IotSiteWiseActionTypeDef:
return {
"putAssetPropertyValueEntries": ...,
"roleArn": ...,
}
Definition
class IotSiteWiseActionTypeDef(TypedDict):
putAssetPropertyValueEntries: Sequence[PutAssetPropertyValueEntryTypeDef], # (1)
roleArn: str,
ActiveViolationTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ActiveViolationTypeDef
def get_value() -> ActiveViolationTypeDef:
return {
"violationId": ...,
}
Definition
class ActiveViolationTypeDef(TypedDict):
violationId: NotRequired[str],
thingName: NotRequired[str],
securityProfileName: NotRequired[str],
behavior: NotRequired[BehaviorTypeDef], # (1)
lastViolationValue: NotRequired[MetricValueTypeDef], # (2)
violationEventAdditionalInfo: NotRequired[ViolationEventAdditionalInfoTypeDef], # (3)
verificationState: NotRequired[VerificationStateType], # (4)
verificationStateDescription: NotRequired[str],
lastViolationTime: NotRequired[datetime],
violationStartTime: NotRequired[datetime],
- See BehaviorTypeDef
- See MetricValueTypeDef
- See ViolationEventAdditionalInfoTypeDef
- See VerificationStateType
CreateSecurityProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateSecurityProfileRequestRequestTypeDef
def get_value() -> CreateSecurityProfileRequestRequestTypeDef:
return {
"securityProfileName": ...,
}
Definition
class CreateSecurityProfileRequestRequestTypeDef(TypedDict):
securityProfileName: str,
securityProfileDescription: NotRequired[str],
behaviors: NotRequired[Sequence[BehaviorTypeDef]], # (1)
alertTargets: NotRequired[Mapping[AlertTargetTypeType, AlertTargetTypeDef]], # (2)
additionalMetricsToRetain: NotRequired[Sequence[str]],
additionalMetricsToRetainV2: NotRequired[Sequence[MetricToRetainTypeDef]], # (3)
tags: NotRequired[Sequence[TagTypeDef]], # (4)
- See BehaviorTypeDef
- See AlertTargetTypeType AlertTargetTypeDef
- See MetricToRetainTypeDef
- See TagTypeDef
DescribeSecurityProfileResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeSecurityProfileResponseTypeDef
def get_value() -> DescribeSecurityProfileResponseTypeDef:
return {
"securityProfileName": ...,
"securityProfileArn": ...,
"securityProfileDescription": ...,
"behaviors": ...,
"alertTargets": ...,
"additionalMetricsToRetain": ...,
"additionalMetricsToRetainV2": ...,
"version": ...,
"creationDate": ...,
"lastModifiedDate": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeSecurityProfileResponseTypeDef(TypedDict):
securityProfileName: str,
securityProfileArn: str,
securityProfileDescription: str,
behaviors: List[BehaviorTypeDef], # (1)
alertTargets: Dict[AlertTargetTypeType, AlertTargetTypeDef], # (2)
additionalMetricsToRetain: List[str],
additionalMetricsToRetainV2: List[MetricToRetainTypeDef], # (3)
version: int,
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See BehaviorTypeDef
- See AlertTargetTypeType AlertTargetTypeDef
- See MetricToRetainTypeDef
- See ResponseMetadataTypeDef
UpdateSecurityProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateSecurityProfileRequestRequestTypeDef
def get_value() -> UpdateSecurityProfileRequestRequestTypeDef:
return {
"securityProfileName": ...,
}
Definition
class UpdateSecurityProfileRequestRequestTypeDef(TypedDict):
securityProfileName: str,
securityProfileDescription: NotRequired[str],
behaviors: NotRequired[Sequence[BehaviorTypeDef]], # (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],
UpdateSecurityProfileResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateSecurityProfileResponseTypeDef
def get_value() -> UpdateSecurityProfileResponseTypeDef:
return {
"securityProfileName": ...,
"securityProfileArn": ...,
"securityProfileDescription": ...,
"behaviors": ...,
"alertTargets": ...,
"additionalMetricsToRetain": ...,
"additionalMetricsToRetainV2": ...,
"version": ...,
"creationDate": ...,
"lastModifiedDate": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateSecurityProfileResponseTypeDef(TypedDict):
securityProfileName: str,
securityProfileArn: str,
securityProfileDescription: str,
behaviors: List[BehaviorTypeDef], # (1)
alertTargets: Dict[AlertTargetTypeType, AlertTargetTypeDef], # (2)
additionalMetricsToRetain: List[str],
additionalMetricsToRetainV2: List[MetricToRetainTypeDef], # (3)
version: int,
creationDate: datetime,
lastModifiedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See BehaviorTypeDef
- See AlertTargetTypeType AlertTargetTypeDef
- See MetricToRetainTypeDef
- See ResponseMetadataTypeDef
ValidateSecurityProfileBehaviorsRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ValidateSecurityProfileBehaviorsRequestRequestTypeDef
def get_value() -> ValidateSecurityProfileBehaviorsRequestRequestTypeDef:
return {
"behaviors": ...,
}
Definition
class ValidateSecurityProfileBehaviorsRequestRequestTypeDef(TypedDict):
behaviors: Sequence[BehaviorTypeDef], # (1)
- See BehaviorTypeDef
ViolationEventTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ViolationEventTypeDef
def get_value() -> ViolationEventTypeDef:
return {
"violationId": ...,
}
Definition
class ViolationEventTypeDef(TypedDict):
violationId: NotRequired[str],
thingName: NotRequired[str],
securityProfileName: NotRequired[str],
behavior: NotRequired[BehaviorTypeDef], # (1)
metricValue: NotRequired[MetricValueTypeDef], # (2)
violationEventAdditionalInfo: NotRequired[ViolationEventAdditionalInfoTypeDef], # (3)
violationEventType: NotRequired[ViolationEventTypeType], # (4)
verificationState: NotRequired[VerificationStateType], # (5)
verificationStateDescription: NotRequired[str],
violationEventTime: NotRequired[datetime],
- See BehaviorTypeDef
- See MetricValueTypeDef
- See ViolationEventAdditionalInfoTypeDef
- See ViolationEventTypeType
- See VerificationStateType
CodeSigningTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CodeSigningTypeDef
def get_value() -> CodeSigningTypeDef:
return {
"awsSignerJobId": ...,
}
Definition
class CodeSigningTypeDef(TypedDict):
awsSignerJobId: NotRequired[str],
startSigningJobParameter: NotRequired[StartSigningJobParameterTypeDef], # (1)
customCodeSigning: NotRequired[CustomCodeSigningTypeDef], # (2)
CreateJobRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateJobRequestRequestTypeDef
def get_value() -> CreateJobRequestRequestTypeDef:
return {
"jobId": ...,
"targets": ...,
}
Definition
class CreateJobRequestRequestTypeDef(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[AbortConfigTypeDef], # (4)
timeoutConfig: NotRequired[TimeoutConfigTypeDef], # (5)
tags: NotRequired[Sequence[TagTypeDef]], # (6)
namespaceId: NotRequired[str],
jobTemplateArn: NotRequired[str],
jobExecutionsRetryConfig: NotRequired[JobExecutionsRetryConfigTypeDef], # (7)
documentParameters: NotRequired[Mapping[str, str]],
schedulingConfig: NotRequired[SchedulingConfigTypeDef], # (8)
- See PresignedUrlConfigTypeDef
- See TargetSelectionType
- See JobExecutionsRolloutConfigTypeDef
- See AbortConfigTypeDef
- See TimeoutConfigTypeDef
- See TagTypeDef
- See JobExecutionsRetryConfigTypeDef
- See SchedulingConfigTypeDef
CreateJobTemplateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateJobTemplateRequestRequestTypeDef
def get_value() -> CreateJobTemplateRequestRequestTypeDef:
return {
"jobTemplateId": ...,
"description": ...,
}
Definition
class CreateJobTemplateRequestRequestTypeDef(TypedDict):
jobTemplateId: str,
description: str,
jobArn: NotRequired[str],
documentSource: NotRequired[str],
document: NotRequired[str],
presignedUrlConfig: NotRequired[PresignedUrlConfigTypeDef], # (1)
jobExecutionsRolloutConfig: NotRequired[JobExecutionsRolloutConfigTypeDef], # (2)
abortConfig: NotRequired[AbortConfigTypeDef], # (3)
timeoutConfig: NotRequired[TimeoutConfigTypeDef], # (4)
tags: NotRequired[Sequence[TagTypeDef]], # (5)
jobExecutionsRetryConfig: NotRequired[JobExecutionsRetryConfigTypeDef], # (6)
maintenanceWindows: NotRequired[Sequence[MaintenanceWindowTypeDef]], # (7)
- See PresignedUrlConfigTypeDef
- See JobExecutionsRolloutConfigTypeDef
- See AbortConfigTypeDef
- See TimeoutConfigTypeDef
- See TagTypeDef
- See JobExecutionsRetryConfigTypeDef
- See MaintenanceWindowTypeDef
DescribeJobTemplateResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeJobTemplateResponseTypeDef
def get_value() -> DescribeJobTemplateResponseTypeDef:
return {
"jobTemplateArn": ...,
"jobTemplateId": ...,
"description": ...,
"documentSource": ...,
"document": ...,
"createdAt": ...,
"presignedUrlConfig": ...,
"jobExecutionsRolloutConfig": ...,
"abortConfig": ...,
"timeoutConfig": ...,
"jobExecutionsRetryConfig": ...,
"maintenanceWindows": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeJobTemplateResponseTypeDef(TypedDict):
jobTemplateArn: str,
jobTemplateId: str,
description: str,
documentSource: str,
document: str,
createdAt: datetime,
presignedUrlConfig: PresignedUrlConfigTypeDef, # (1)
jobExecutionsRolloutConfig: JobExecutionsRolloutConfigTypeDef, # (2)
abortConfig: AbortConfigTypeDef, # (3)
timeoutConfig: TimeoutConfigTypeDef, # (4)
jobExecutionsRetryConfig: JobExecutionsRetryConfigTypeDef, # (5)
maintenanceWindows: List[MaintenanceWindowTypeDef], # (6)
ResponseMetadata: ResponseMetadataTypeDef, # (7)
- See PresignedUrlConfigTypeDef
- See JobExecutionsRolloutConfigTypeDef
- See AbortConfigTypeDef
- See TimeoutConfigTypeDef
- See JobExecutionsRetryConfigTypeDef
- See MaintenanceWindowTypeDef
- See ResponseMetadataTypeDef
JobTypeDef
Usage Example
from mypy_boto3_iot.type_defs import JobTypeDef
def get_value() -> JobTypeDef:
return {
"jobArn": ...,
}
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[AbortConfigTypeDef], # (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[JobExecutionsRetryConfigTypeDef], # (8)
documentParameters: NotRequired[Dict[str, str]],
isConcurrent: NotRequired[bool],
schedulingConfig: NotRequired[SchedulingConfigTypeDef], # (9)
scheduledJobRollouts: NotRequired[List[ScheduledJobRolloutTypeDef]], # (10)
- See TargetSelectionType
- See JobStatusType
- See PresignedUrlConfigTypeDef
- See JobExecutionsRolloutConfigTypeDef
- See AbortConfigTypeDef
- See JobProcessDetailsTypeDef
- See TimeoutConfigTypeDef
- See JobExecutionsRetryConfigTypeDef
- See SchedulingConfigTypeDef
- See ScheduledJobRolloutTypeDef
UpdateJobRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import UpdateJobRequestRequestTypeDef
def get_value() -> UpdateJobRequestRequestTypeDef:
return {
"jobId": ...,
}
Definition
class UpdateJobRequestRequestTypeDef(TypedDict):
jobId: str,
description: NotRequired[str],
presignedUrlConfig: NotRequired[PresignedUrlConfigTypeDef], # (1)
jobExecutionsRolloutConfig: NotRequired[JobExecutionsRolloutConfigTypeDef], # (2)
abortConfig: NotRequired[AbortConfigTypeDef], # (3)
timeoutConfig: NotRequired[TimeoutConfigTypeDef], # (4)
namespaceId: NotRequired[str],
jobExecutionsRetryConfig: NotRequired[JobExecutionsRetryConfigTypeDef], # (5)
- See PresignedUrlConfigTypeDef
- See JobExecutionsRolloutConfigTypeDef
- See AbortConfigTypeDef
- See TimeoutConfigTypeDef
- See JobExecutionsRetryConfigTypeDef
DescribeStreamResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeStreamResponseTypeDef
def get_value() -> DescribeStreamResponseTypeDef:
return {
"streamInfo": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeStreamResponseTypeDef(TypedDict):
streamInfo: StreamInfoTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAuditMitigationActionsTaskResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeAuditMitigationActionsTaskResponseTypeDef
def get_value() -> DescribeAuditMitigationActionsTaskResponseTypeDef:
return {
"taskStatus": ...,
"startTime": ...,
"endTime": ...,
"taskStatistics": ...,
"target": ...,
"auditCheckToActionsMapping": ...,
"actionsDefinition": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeAuditMitigationActionsTaskResponseTypeDef(TypedDict):
taskStatus: AuditMitigationActionsTaskStatusType, # (1)
startTime: datetime,
endTime: datetime,
taskStatistics: Dict[str, TaskStatisticsForAuditCheckTypeDef], # (2)
target: AuditMitigationActionsTaskTargetTypeDef, # (3)
auditCheckToActionsMapping: Dict[str, List[str]],
actionsDefinition: List[MitigationActionTypeDef], # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See AuditMitigationActionsTaskStatusType
- See TaskStatisticsForAuditCheckTypeDef
- See AuditMitigationActionsTaskTargetTypeDef
- See MitigationActionTypeDef
- See ResponseMetadataTypeDef
DetectMitigationActionsTaskSummaryTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DetectMitigationActionsTaskSummaryTypeDef
def get_value() -> DetectMitigationActionsTaskSummaryTypeDef:
return {
"taskId": ...,
}
Definition
class DetectMitigationActionsTaskSummaryTypeDef(TypedDict):
taskId: NotRequired[str],
taskStatus: NotRequired[DetectMitigationActionsTaskStatusType], # (1)
taskStartTime: NotRequired[datetime],
taskEndTime: NotRequired[datetime],
target: NotRequired[DetectMitigationActionsTaskTargetTypeDef], # (2)
violationEventOccurrenceRange: NotRequired[ViolationEventOccurrenceRangeTypeDef], # (3)
onlyActiveViolationsIncluded: NotRequired[bool],
suppressedAlertsIncluded: NotRequired[bool],
actionsDefinition: NotRequired[List[MitigationActionTypeDef]], # (4)
taskStatistics: NotRequired[DetectMitigationActionsTaskStatisticsTypeDef], # (5)
- See DetectMitigationActionsTaskStatusType
- See DetectMitigationActionsTaskTargetTypeDef
- See ViolationEventOccurrenceRangeTypeDef
- See MitigationActionTypeDef
- See DetectMitigationActionsTaskStatisticsTypeDef
ListAuditSuppressionsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuditSuppressionsResponseTypeDef
def get_value() -> ListAuditSuppressionsResponseTypeDef:
return {
"suppressions": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListAuditSuppressionsResponseTypeDef(TypedDict):
suppressions: List[AuditSuppressionTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AuditFindingTypeDef
Usage Example
from mypy_boto3_iot.type_defs import AuditFindingTypeDef
def get_value() -> AuditFindingTypeDef:
return {
"findingId": ...,
}
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
Usage Example
from mypy_boto3_iot.type_defs import ListRelatedResourcesForAuditFindingResponseTypeDef
def get_value() -> ListRelatedResourcesForAuditFindingResponseTypeDef:
return {
"relatedResources": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListRelatedResourcesForAuditFindingResponseTypeDef(TypedDict):
relatedResources: List[RelatedResourceTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TestAuthorizationResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TestAuthorizationResponseTypeDef
def get_value() -> TestAuthorizationResponseTypeDef:
return {
"authResults": ...,
"ResponseMetadata": ...,
}
Definition
class TestAuthorizationResponseTypeDef(TypedDict):
authResults: List[AuthResultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ActionTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ActionTypeDef
def get_value() -> ActionTypeDef:
return {
"dynamoDB": ...,
}
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[RepublishActionTypeDef], # (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[IotSiteWiseActionTypeDef], # (17)
stepFunctions: NotRequired[StepFunctionsActionTypeDef], # (18)
timestream: NotRequired[TimestreamActionTypeDef], # (19)
http: NotRequired[HttpActionTypeDef], # (20)
kafka: NotRequired[KafkaActionTypeDef], # (21)
openSearch: NotRequired[OpenSearchActionTypeDef], # (22)
location: NotRequired[LocationActionTypeDef], # (23)
- See DynamoDBActionTypeDef
- See DynamoDBv2ActionTypeDef
- See LambdaActionTypeDef
- See SnsActionTypeDef
- See SqsActionTypeDef
- See KinesisActionTypeDef
- See RepublishActionTypeDef
- See S3ActionTypeDef
- See FirehoseActionTypeDef
- See CloudwatchMetricActionTypeDef
- See CloudwatchAlarmActionTypeDef
- See CloudwatchLogsActionTypeDef
- See ElasticsearchActionTypeDef
- See SalesforceActionTypeDef
- See IotAnalyticsActionTypeDef
- See IotEventsActionTypeDef
- See IotSiteWiseActionTypeDef
- See StepFunctionsActionTypeDef
- See TimestreamActionTypeDef
- See HttpActionTypeDef
- See KafkaActionTypeDef
- See OpenSearchActionTypeDef
- See LocationActionTypeDef
ListActiveViolationsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListActiveViolationsResponseTypeDef
def get_value() -> ListActiveViolationsResponseTypeDef:
return {
"activeViolations": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListActiveViolationsResponseTypeDef(TypedDict):
activeViolations: List[ActiveViolationTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListViolationEventsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListViolationEventsResponseTypeDef
def get_value() -> ListViolationEventsResponseTypeDef:
return {
"violationEvents": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListViolationEventsResponseTypeDef(TypedDict):
violationEvents: List[ViolationEventTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
OTAUpdateFileTypeDef
Usage Example
from mypy_boto3_iot.type_defs import OTAUpdateFileTypeDef
def get_value() -> OTAUpdateFileTypeDef:
return {
"fileName": ...,
}
Definition
class OTAUpdateFileTypeDef(TypedDict):
fileName: NotRequired[str],
fileType: NotRequired[int],
fileVersion: NotRequired[str],
fileLocation: NotRequired[FileLocationTypeDef], # (1)
codeSigning: NotRequired[CodeSigningTypeDef], # (2)
attributes: NotRequired[Mapping[str, str]],
DescribeJobResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeJobResponseTypeDef
def get_value() -> DescribeJobResponseTypeDef:
return {
"documentSource": ...,
"job": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeJobResponseTypeDef(TypedDict):
documentSource: str,
job: JobTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See JobTypeDef
- See ResponseMetadataTypeDef
DescribeDetectMitigationActionsTaskResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeDetectMitigationActionsTaskResponseTypeDef
def get_value() -> DescribeDetectMitigationActionsTaskResponseTypeDef:
return {
"taskSummary": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeDetectMitigationActionsTaskResponseTypeDef(TypedDict):
taskSummary: DetectMitigationActionsTaskSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDetectMitigationActionsTasksResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListDetectMitigationActionsTasksResponseTypeDef
def get_value() -> ListDetectMitigationActionsTasksResponseTypeDef:
return {
"tasks": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListDetectMitigationActionsTasksResponseTypeDef(TypedDict):
tasks: List[DetectMitigationActionsTaskSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAuditFindingResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import DescribeAuditFindingResponseTypeDef
def get_value() -> DescribeAuditFindingResponseTypeDef:
return {
"finding": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeAuditFindingResponseTypeDef(TypedDict):
finding: AuditFindingTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAuditFindingsResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ListAuditFindingsResponseTypeDef
def get_value() -> ListAuditFindingsResponseTypeDef:
return {
"findings": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListAuditFindingsResponseTypeDef(TypedDict):
findings: List[AuditFindingTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TopicRulePayloadTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TopicRulePayloadTypeDef
def get_value() -> TopicRulePayloadTypeDef:
return {
"sql": ...,
"actions": ...,
}
Definition
class TopicRulePayloadTypeDef(TypedDict):
sql: str,
actions: Sequence[ActionTypeDef], # (1)
description: NotRequired[str],
ruleDisabled: NotRequired[bool],
awsIotSqlVersion: NotRequired[str],
errorAction: NotRequired[ActionTypeDef], # (2)
- See ActionTypeDef
- See ActionTypeDef
TopicRuleTypeDef
Usage Example
from mypy_boto3_iot.type_defs import TopicRuleTypeDef
def get_value() -> TopicRuleTypeDef:
return {
"ruleName": ...,
}
Definition
class TopicRuleTypeDef(TypedDict):
ruleName: NotRequired[str],
sql: NotRequired[str],
description: NotRequired[str],
createdAt: NotRequired[datetime],
actions: NotRequired[List[ActionTypeDef]], # (1)
ruleDisabled: NotRequired[bool],
awsIotSqlVersion: NotRequired[str],
errorAction: NotRequired[ActionTypeDef], # (2)
- See ActionTypeDef
- See ActionTypeDef
CreateOTAUpdateRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateOTAUpdateRequestRequestTypeDef
def get_value() -> CreateOTAUpdateRequestRequestTypeDef:
return {
"otaUpdateId": ...,
"targets": ...,
"files": ...,
"roleArn": ...,
}
Definition
class CreateOTAUpdateRequestRequestTypeDef(TypedDict):
otaUpdateId: str,
targets: Sequence[str],
files: Sequence[OTAUpdateFileTypeDef], # (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)
- See OTAUpdateFileTypeDef
- See ProtocolType
- See TargetSelectionType
- See AwsJobExecutionsRolloutConfigTypeDef
- See AwsJobPresignedUrlConfigTypeDef
- See AwsJobAbortConfigTypeDef
- See AwsJobTimeoutConfigTypeDef
- See TagTypeDef
OTAUpdateInfoTypeDef
Usage Example
from mypy_boto3_iot.type_defs import OTAUpdateInfoTypeDef
def get_value() -> OTAUpdateInfoTypeDef:
return {
"otaUpdateId": ...,
}
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[OTAUpdateFileTypeDef]], # (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 OTAUpdateFileTypeDef
- See OTAUpdateStatusType
- See ErrorInfoTypeDef
CreateTopicRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import CreateTopicRuleRequestRequestTypeDef
def get_value() -> CreateTopicRuleRequestRequestTypeDef:
return {
"ruleName": ...,
"topicRulePayload": ...,
}
Definition
class CreateTopicRuleRequestRequestTypeDef(TypedDict):
ruleName: str,
topicRulePayload: TopicRulePayloadTypeDef, # (1)
tags: NotRequired[str],
ReplaceTopicRuleRequestRequestTypeDef
Usage Example
from mypy_boto3_iot.type_defs import ReplaceTopicRuleRequestRequestTypeDef
def get_value() -> ReplaceTopicRuleRequestRequestTypeDef:
return {
"ruleName": ...,
"topicRulePayload": ...,
}
Definition
class ReplaceTopicRuleRequestRequestTypeDef(TypedDict):
ruleName: str,
topicRulePayload: TopicRulePayloadTypeDef, # (1)
GetTopicRuleResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetTopicRuleResponseTypeDef
def get_value() -> GetTopicRuleResponseTypeDef:
return {
"ruleArn": ...,
"rule": ...,
"ResponseMetadata": ...,
}
Definition
class GetTopicRuleResponseTypeDef(TypedDict):
ruleArn: str,
rule: TopicRuleTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetOTAUpdateResponseTypeDef
Usage Example
from mypy_boto3_iot.type_defs import GetOTAUpdateResponseTypeDef
def get_value() -> GetOTAUpdateResponseTypeDef:
return {
"otaUpdateInfo": ...,
"ResponseMetadata": ...,
}