Skip to content

Typed dictionaries

Index > IoT1ClickDevicesService > Typed dictionaries

Auto-generated documentation for IoT1ClickDevicesService type annotations stubs module mypy-boto3-iot1click-devices.

ClaimDevicesByClaimCodeRequestRequestTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import ClaimDevicesByClaimCodeRequestRequestTypeDef

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

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_iot1click_devices.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,

DescribeDeviceRequestRequestTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import DescribeDeviceRequestRequestTypeDef

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

DeviceDescriptionTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import DeviceDescriptionTypeDef

def get_value() -> DeviceDescriptionTypeDef:
    return {
        "Arn": ...,
    }
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

Usage Example
from mypy_boto3_iot1click_devices.type_defs import DeviceTypeDef

def get_value() -> DeviceTypeDef:
    return {
        "Attributes": ...,
    }
Definition
class DeviceTypeDef(TypedDict):
    Attributes: NotRequired[Dict[str, Any]],
    DeviceId: NotRequired[str],
    Type: NotRequired[str],

DeviceMethodTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import DeviceMethodTypeDef

def get_value() -> DeviceMethodTypeDef:
    return {
        "DeviceType": ...,
    }
Definition
class DeviceMethodTypeDef(TypedDict):
    DeviceType: NotRequired[str],
    MethodName: NotRequired[str],

FinalizeDeviceClaimRequestRequestTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import FinalizeDeviceClaimRequestRequestTypeDef

def get_value() -> FinalizeDeviceClaimRequestRequestTypeDef:
    return {
        "DeviceId": ...,
    }
Definition
class FinalizeDeviceClaimRequestRequestTypeDef(TypedDict):
    DeviceId: str,
    Tags: NotRequired[Mapping[str, str]],

GetDeviceMethodsRequestRequestTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import GetDeviceMethodsRequestRequestTypeDef

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

InitiateDeviceClaimRequestRequestTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import InitiateDeviceClaimRequestRequestTypeDef

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

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListDeviceEventsRequestRequestTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import ListDeviceEventsRequestRequestTypeDef

def get_value() -> ListDeviceEventsRequestRequestTypeDef:
    return {
        "DeviceId": ...,
        "FromTimeStamp": ...,
        "ToTimeStamp": ...,
    }
Definition
class ListDeviceEventsRequestRequestTypeDef(TypedDict):
    DeviceId: str,
    FromTimeStamp: Union[datetime, str],
    ToTimeStamp: Union[datetime, str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListDevicesRequestRequestTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import ListDevicesRequestRequestTypeDef

def get_value() -> ListDevicesRequestRequestTypeDef:
    return {
        "DeviceType": ...,
    }
Definition
class ListDevicesRequestRequestTypeDef(TypedDict):
    DeviceType: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import ListTagsForResourceRequestRequestTypeDef

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

TagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
    }
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UnclaimDeviceRequestRequestTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import UnclaimDeviceRequestRequestTypeDef

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

UntagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateDeviceStateRequestRequestTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import UpdateDeviceStateRequestRequestTypeDef

def get_value() -> UpdateDeviceStateRequestRequestTypeDef:
    return {
        "DeviceId": ...,
    }
Definition
class UpdateDeviceStateRequestRequestTypeDef(TypedDict):
    DeviceId: str,
    Enabled: NotRequired[bool],

ClaimDevicesByClaimCodeResponseTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import ClaimDevicesByClaimCodeResponseTypeDef

def get_value() -> ClaimDevicesByClaimCodeResponseTypeDef:
    return {
        "ClaimCode": ...,
        "Total": ...,
        "ResponseMetadata": ...,
    }
Definition
class ClaimDevicesByClaimCodeResponseTypeDef(TypedDict):
    ClaimCode: str,
    Total: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

FinalizeDeviceClaimResponseTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import FinalizeDeviceClaimResponseTypeDef

def get_value() -> FinalizeDeviceClaimResponseTypeDef:
    return {
        "State": ...,
        "ResponseMetadata": ...,
    }
Definition
class FinalizeDeviceClaimResponseTypeDef(TypedDict):
    State: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

InitiateDeviceClaimResponseTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import InitiateDeviceClaimResponseTypeDef

def get_value() -> InitiateDeviceClaimResponseTypeDef:
    return {
        "State": ...,
        "ResponseMetadata": ...,
    }
Definition
class InitiateDeviceClaimResponseTypeDef(TypedDict):
    State: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

InvokeDeviceMethodResponseTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import InvokeDeviceMethodResponseTypeDef

def get_value() -> InvokeDeviceMethodResponseTypeDef:
    return {
        "DeviceMethodResponse": ...,
        "ResponseMetadata": ...,
    }
Definition
class InvokeDeviceMethodResponseTypeDef(TypedDict):
    DeviceMethodResponse: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UnclaimDeviceResponseTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import UnclaimDeviceResponseTypeDef

def get_value() -> UnclaimDeviceResponseTypeDef:
    return {
        "State": ...,
        "ResponseMetadata": ...,
    }
Definition
class UnclaimDeviceResponseTypeDef(TypedDict):
    State: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeDeviceResponseTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import DescribeDeviceResponseTypeDef

def get_value() -> DescribeDeviceResponseTypeDef:
    return {
        "DeviceDescription": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeDeviceResponseTypeDef(TypedDict):
    DeviceDescription: DeviceDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeviceDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListDevicesResponseTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import ListDevicesResponseTypeDef

def get_value() -> ListDevicesResponseTypeDef:
    return {
        "Devices": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListDevicesResponseTypeDef(TypedDict):
    Devices: List[DeviceDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeviceDescriptionTypeDef
  2. See ResponseMetadataTypeDef

DeviceEventTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import DeviceEventTypeDef

def get_value() -> DeviceEventTypeDef:
    return {
        "Device": ...,
    }
Definition
class DeviceEventTypeDef(TypedDict):
    Device: NotRequired[DeviceTypeDef],  # (1)
    StdEvent: NotRequired[str],
  1. See DeviceTypeDef

GetDeviceMethodsResponseTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import GetDeviceMethodsResponseTypeDef

def get_value() -> GetDeviceMethodsResponseTypeDef:
    return {
        "DeviceMethods": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetDeviceMethodsResponseTypeDef(TypedDict):
    DeviceMethods: List[DeviceMethodTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeviceMethodTypeDef
  2. See ResponseMetadataTypeDef

InvokeDeviceMethodRequestRequestTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import InvokeDeviceMethodRequestRequestTypeDef

def get_value() -> InvokeDeviceMethodRequestRequestTypeDef:
    return {
        "DeviceId": ...,
    }
Definition
class InvokeDeviceMethodRequestRequestTypeDef(TypedDict):
    DeviceId: str,
    DeviceMethod: NotRequired[DeviceMethodTypeDef],  # (1)
    DeviceMethodParameters: NotRequired[str],
  1. See DeviceMethodTypeDef

ListDeviceEventsRequestListDeviceEventsPaginateTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import ListDeviceEventsRequestListDeviceEventsPaginateTypeDef

def get_value() -> ListDeviceEventsRequestListDeviceEventsPaginateTypeDef:
    return {
        "DeviceId": ...,
        "FromTimeStamp": ...,
        "ToTimeStamp": ...,
    }
Definition
class ListDeviceEventsRequestListDeviceEventsPaginateTypeDef(TypedDict):
    DeviceId: str,
    FromTimeStamp: Union[datetime, str],
    ToTimeStamp: Union[datetime, str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDevicesRequestListDevicesPaginateTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import ListDevicesRequestListDevicesPaginateTypeDef

def get_value() -> ListDevicesRequestListDevicesPaginateTypeDef:
    return {
        "DeviceType": ...,
    }
Definition
class ListDevicesRequestListDevicesPaginateTypeDef(TypedDict):
    DeviceType: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDeviceEventsResponseTypeDef

Usage Example
from mypy_boto3_iot1click_devices.type_defs import ListDeviceEventsResponseTypeDef

def get_value() -> ListDeviceEventsResponseTypeDef:
    return {
        "Events": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListDeviceEventsResponseTypeDef(TypedDict):
    Events: List[DeviceEventTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeviceEventTypeDef
  2. See ResponseMetadataTypeDef