Typed dictionaries#
Index > IoT1ClickDevicesService > Typed dictionaries
Auto-generated documentation for IoT1ClickDevicesService type annotations stubs module mypy-boto3-iot1click-devices.
ClaimDevicesByClaimCodeRequestRequestTypeDef#
# ClaimDevicesByClaimCodeRequestRequestTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import ClaimDevicesByClaimCodeRequestRequestTypeDef
def get_value() -> ClaimDevicesByClaimCodeRequestRequestTypeDef:
return {
"ClaimCode": ...,
}
# ClaimDevicesByClaimCodeRequestRequestTypeDef definition
class ClaimDevicesByClaimCodeRequestRequestTypeDef(TypedDict):
ClaimCode: str,
ClaimDevicesByClaimCodeResponseTypeDef#
# ClaimDevicesByClaimCodeResponseTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import ClaimDevicesByClaimCodeResponseTypeDef
def get_value() -> ClaimDevicesByClaimCodeResponseTypeDef:
return {
"ClaimCode": ...,
"Total": ...,
"ResponseMetadata": ...,
}
# ClaimDevicesByClaimCodeResponseTypeDef definition
class ClaimDevicesByClaimCodeResponseTypeDef(TypedDict):
ClaimCode: str,
Total: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeDeviceRequestRequestTypeDef#
# DescribeDeviceRequestRequestTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import DescribeDeviceRequestRequestTypeDef
def get_value() -> DescribeDeviceRequestRequestTypeDef:
return {
"DeviceId": ...,
}
# DescribeDeviceRequestRequestTypeDef definition
class DescribeDeviceRequestRequestTypeDef(TypedDict):
DeviceId: str,
DeviceDescriptionTypeDef#
# DeviceDescriptionTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import DeviceDescriptionTypeDef
def get_value() -> DeviceDescriptionTypeDef:
return {
"Arn": ...,
}
# DeviceDescriptionTypeDef definition
class DeviceDescriptionTypeDef(TypedDict):
Arn: NotRequired[str],
Attributes: NotRequired[Dict[str, str]],
DeviceId: NotRequired[str],
Enabled: NotRequired[bool],
RemainingLife: NotRequired[float],
Type: NotRequired[str],
Tags: NotRequired[Dict[str, str]],
DeviceTypeDef#
# DeviceTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import DeviceTypeDef
def get_value() -> DeviceTypeDef:
return {
"Attributes": ...,
}
# DeviceTypeDef definition
class DeviceTypeDef(TypedDict):
Attributes: NotRequired[Dict[str, Any]],
DeviceId: NotRequired[str],
Type: NotRequired[str],
DeviceMethodTypeDef#
# DeviceMethodTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import DeviceMethodTypeDef
def get_value() -> DeviceMethodTypeDef:
return {
"DeviceType": ...,
}
# DeviceMethodTypeDef definition
class DeviceMethodTypeDef(TypedDict):
DeviceType: NotRequired[str],
MethodName: NotRequired[str],
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
FinalizeDeviceClaimRequestRequestTypeDef#
# FinalizeDeviceClaimRequestRequestTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import FinalizeDeviceClaimRequestRequestTypeDef
def get_value() -> FinalizeDeviceClaimRequestRequestTypeDef:
return {
"DeviceId": ...,
}
# FinalizeDeviceClaimRequestRequestTypeDef definition
class FinalizeDeviceClaimRequestRequestTypeDef(TypedDict):
DeviceId: str,
Tags: NotRequired[Mapping[str, str]],
FinalizeDeviceClaimResponseTypeDef#
# FinalizeDeviceClaimResponseTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import FinalizeDeviceClaimResponseTypeDef
def get_value() -> FinalizeDeviceClaimResponseTypeDef:
return {
"State": ...,
"ResponseMetadata": ...,
}
# FinalizeDeviceClaimResponseTypeDef definition
class FinalizeDeviceClaimResponseTypeDef(TypedDict):
State: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetDeviceMethodsRequestRequestTypeDef#
# GetDeviceMethodsRequestRequestTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import GetDeviceMethodsRequestRequestTypeDef
def get_value() -> GetDeviceMethodsRequestRequestTypeDef:
return {
"DeviceId": ...,
}
# GetDeviceMethodsRequestRequestTypeDef definition
class GetDeviceMethodsRequestRequestTypeDef(TypedDict):
DeviceId: str,
InitiateDeviceClaimRequestRequestTypeDef#
# InitiateDeviceClaimRequestRequestTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import InitiateDeviceClaimRequestRequestTypeDef
def get_value() -> InitiateDeviceClaimRequestRequestTypeDef:
return {
"DeviceId": ...,
}
# InitiateDeviceClaimRequestRequestTypeDef definition
class InitiateDeviceClaimRequestRequestTypeDef(TypedDict):
DeviceId: str,
InitiateDeviceClaimResponseTypeDef#
# InitiateDeviceClaimResponseTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import InitiateDeviceClaimResponseTypeDef
def get_value() -> InitiateDeviceClaimResponseTypeDef:
return {
"State": ...,
"ResponseMetadata": ...,
}
# InitiateDeviceClaimResponseTypeDef definition
class InitiateDeviceClaimResponseTypeDef(TypedDict):
State: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
InvokeDeviceMethodResponseTypeDef#
# InvokeDeviceMethodResponseTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import InvokeDeviceMethodResponseTypeDef
def get_value() -> InvokeDeviceMethodResponseTypeDef:
return {
"DeviceMethodResponse": ...,
"ResponseMetadata": ...,
}
# InvokeDeviceMethodResponseTypeDef definition
class InvokeDeviceMethodResponseTypeDef(TypedDict):
DeviceMethodResponse: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListDeviceEventsRequestListDeviceEventsPaginateTypeDef#
# ListDeviceEventsRequestListDeviceEventsPaginateTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import ListDeviceEventsRequestListDeviceEventsPaginateTypeDef
def get_value() -> ListDeviceEventsRequestListDeviceEventsPaginateTypeDef:
return {
"DeviceId": ...,
"FromTimeStamp": ...,
"ToTimeStamp": ...,
}
# ListDeviceEventsRequestListDeviceEventsPaginateTypeDef definition
class ListDeviceEventsRequestListDeviceEventsPaginateTypeDef(TypedDict):
DeviceId: str,
FromTimeStamp: Union[datetime, str],
ToTimeStamp: Union[datetime, str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDeviceEventsRequestRequestTypeDef#
# ListDeviceEventsRequestRequestTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import ListDeviceEventsRequestRequestTypeDef
def get_value() -> ListDeviceEventsRequestRequestTypeDef:
return {
"DeviceId": ...,
"FromTimeStamp": ...,
"ToTimeStamp": ...,
}
# ListDeviceEventsRequestRequestTypeDef definition
class ListDeviceEventsRequestRequestTypeDef(TypedDict):
DeviceId: str,
FromTimeStamp: Union[datetime, str],
ToTimeStamp: Union[datetime, str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListDevicesRequestListDevicesPaginateTypeDef#
# ListDevicesRequestListDevicesPaginateTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import ListDevicesRequestListDevicesPaginateTypeDef
def get_value() -> ListDevicesRequestListDevicesPaginateTypeDef:
return {
"DeviceType": ...,
}
# ListDevicesRequestListDevicesPaginateTypeDef definition
class ListDevicesRequestListDevicesPaginateTypeDef(TypedDict):
DeviceType: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDevicesRequestRequestTypeDef#
# ListDevicesRequestRequestTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import ListDevicesRequestRequestTypeDef
def get_value() -> ListDevicesRequestRequestTypeDef:
return {
"DeviceType": ...,
}
# ListDevicesRequestRequestTypeDef definition
class ListDevicesRequestRequestTypeDef(TypedDict):
DeviceType: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
"ResponseMetadata": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"Tags": ...,
}
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Mapping[str, str],
UnclaimDeviceRequestRequestTypeDef#
# UnclaimDeviceRequestRequestTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import UnclaimDeviceRequestRequestTypeDef
def get_value() -> UnclaimDeviceRequestRequestTypeDef:
return {
"DeviceId": ...,
}
# UnclaimDeviceRequestRequestTypeDef definition
class UnclaimDeviceRequestRequestTypeDef(TypedDict):
DeviceId: str,
UnclaimDeviceResponseTypeDef#
# UnclaimDeviceResponseTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import UnclaimDeviceResponseTypeDef
def get_value() -> UnclaimDeviceResponseTypeDef:
return {
"State": ...,
"ResponseMetadata": ...,
}
# UnclaimDeviceResponseTypeDef definition
class UnclaimDeviceResponseTypeDef(TypedDict):
State: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"TagKeys": ...,
}
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
UpdateDeviceStateRequestRequestTypeDef#
# UpdateDeviceStateRequestRequestTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import UpdateDeviceStateRequestRequestTypeDef
def get_value() -> UpdateDeviceStateRequestRequestTypeDef:
return {
"DeviceId": ...,
}
# UpdateDeviceStateRequestRequestTypeDef definition
class UpdateDeviceStateRequestRequestTypeDef(TypedDict):
DeviceId: str,
Enabled: NotRequired[bool],
DescribeDeviceResponseTypeDef#
# DescribeDeviceResponseTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import DescribeDeviceResponseTypeDef
def get_value() -> DescribeDeviceResponseTypeDef:
return {
"DeviceDescription": ...,
"ResponseMetadata": ...,
}
# DescribeDeviceResponseTypeDef definition
class DescribeDeviceResponseTypeDef(TypedDict):
DeviceDescription: DeviceDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDevicesResponseTypeDef#
# ListDevicesResponseTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import ListDevicesResponseTypeDef
def get_value() -> ListDevicesResponseTypeDef:
return {
"Devices": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListDevicesResponseTypeDef definition
class ListDevicesResponseTypeDef(TypedDict):
Devices: List[DeviceDescriptionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeviceEventTypeDef#
# DeviceEventTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import DeviceEventTypeDef
def get_value() -> DeviceEventTypeDef:
return {
"Device": ...,
}
# DeviceEventTypeDef definition
class DeviceEventTypeDef(TypedDict):
Device: NotRequired[DeviceTypeDef], # (1)
StdEvent: NotRequired[str],
- See DeviceTypeDef
GetDeviceMethodsResponseTypeDef#
# GetDeviceMethodsResponseTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import GetDeviceMethodsResponseTypeDef
def get_value() -> GetDeviceMethodsResponseTypeDef:
return {
"DeviceMethods": ...,
"ResponseMetadata": ...,
}
# GetDeviceMethodsResponseTypeDef definition
class GetDeviceMethodsResponseTypeDef(TypedDict):
DeviceMethods: List[DeviceMethodTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
InvokeDeviceMethodRequestRequestTypeDef#
# InvokeDeviceMethodRequestRequestTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import InvokeDeviceMethodRequestRequestTypeDef
def get_value() -> InvokeDeviceMethodRequestRequestTypeDef:
return {
"DeviceId": ...,
}
# InvokeDeviceMethodRequestRequestTypeDef definition
class InvokeDeviceMethodRequestRequestTypeDef(TypedDict):
DeviceId: str,
DeviceMethod: NotRequired[DeviceMethodTypeDef], # (1)
DeviceMethodParameters: NotRequired[str],
ListDeviceEventsResponseTypeDef#
# ListDeviceEventsResponseTypeDef usage example
from mypy_boto3_iot1click_devices.type_defs import ListDeviceEventsResponseTypeDef
def get_value() -> ListDeviceEventsResponseTypeDef:
return {
"Events": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListDeviceEventsResponseTypeDef definition
class ListDeviceEventsResponseTypeDef(TypedDict):
Events: List[DeviceEventTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)