Skip to content

Type definitions#

Index > IoT1ClickDevicesService > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ClaimDevicesByClaimCodeRequestRequestTypeDef#

# ClaimDevicesByClaimCodeRequestRequestTypeDef definition

class ClaimDevicesByClaimCodeRequestRequestTypeDef(TypedDict):
    ClaimCode: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

DescribeDeviceRequestRequestTypeDef#

# DescribeDeviceRequestRequestTypeDef definition

class DescribeDeviceRequestRequestTypeDef(TypedDict):
    DeviceId: str,

DeviceDescriptionTypeDef#

# 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 definition

class DeviceTypeDef(TypedDict):
    Attributes: NotRequired[Dict[str, Any]],
    DeviceId: NotRequired[str],
    Type: NotRequired[str],

DeviceMethodTypeDef#

# DeviceMethodTypeDef definition

class DeviceMethodTypeDef(TypedDict):
    DeviceType: NotRequired[str],
    MethodName: NotRequired[str],

FinalizeDeviceClaimRequestRequestTypeDef#

# FinalizeDeviceClaimRequestRequestTypeDef definition

class FinalizeDeviceClaimRequestRequestTypeDef(TypedDict):
    DeviceId: str,
    Tags: NotRequired[Mapping[str, str]],

GetDeviceMethodsRequestRequestTypeDef#

# GetDeviceMethodsRequestRequestTypeDef definition

class GetDeviceMethodsRequestRequestTypeDef(TypedDict):
    DeviceId: str,

InitiateDeviceClaimRequestRequestTypeDef#

# InitiateDeviceClaimRequestRequestTypeDef definition

class InitiateDeviceClaimRequestRequestTypeDef(TypedDict):
    DeviceId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListDevicesRequestRequestTypeDef#

# ListDevicesRequestRequestTypeDef definition

class ListDevicesRequestRequestTypeDef(TypedDict):
    DeviceType: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UnclaimDeviceRequestRequestTypeDef#

# UnclaimDeviceRequestRequestTypeDef definition

class UnclaimDeviceRequestRequestTypeDef(TypedDict):
    DeviceId: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateDeviceStateRequestRequestTypeDef#

# UpdateDeviceStateRequestRequestTypeDef definition

class UpdateDeviceStateRequestRequestTypeDef(TypedDict):
    DeviceId: str,
    Enabled: NotRequired[bool],

ClaimDevicesByClaimCodeResponseTypeDef#

# ClaimDevicesByClaimCodeResponseTypeDef definition

class ClaimDevicesByClaimCodeResponseTypeDef(TypedDict):
    ClaimCode: str,
    Total: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

FinalizeDeviceClaimResponseTypeDef#

# FinalizeDeviceClaimResponseTypeDef definition

class FinalizeDeviceClaimResponseTypeDef(TypedDict):
    State: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

InitiateDeviceClaimResponseTypeDef#

# InitiateDeviceClaimResponseTypeDef definition

class InitiateDeviceClaimResponseTypeDef(TypedDict):
    State: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

InvokeDeviceMethodResponseTypeDef#

# InvokeDeviceMethodResponseTypeDef definition

class InvokeDeviceMethodResponseTypeDef(TypedDict):
    DeviceMethodResponse: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UnclaimDeviceResponseTypeDef#

# UnclaimDeviceResponseTypeDef definition

class UnclaimDeviceResponseTypeDef(TypedDict):
    State: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeDeviceResponseTypeDef#

# DescribeDeviceResponseTypeDef definition

class DescribeDeviceResponseTypeDef(TypedDict):
    DeviceDescription: DeviceDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeviceDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListDevicesResponseTypeDef#

# ListDevicesResponseTypeDef definition

class ListDevicesResponseTypeDef(TypedDict):
    Devices: List[DeviceDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeviceDescriptionTypeDef
  2. See ResponseMetadataTypeDef

DeviceEventTypeDef#

# DeviceEventTypeDef definition

class DeviceEventTypeDef(TypedDict):
    Device: NotRequired[DeviceTypeDef],  # (1)
    StdEvent: NotRequired[str],
  1. See DeviceTypeDef

GetDeviceMethodsResponseTypeDef#

# GetDeviceMethodsResponseTypeDef definition

class GetDeviceMethodsResponseTypeDef(TypedDict):
    DeviceMethods: List[DeviceMethodTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeviceMethodTypeDef
  2. See ResponseMetadataTypeDef

InvokeDeviceMethodRequestRequestTypeDef#

# InvokeDeviceMethodRequestRequestTypeDef definition

class InvokeDeviceMethodRequestRequestTypeDef(TypedDict):
    DeviceId: str,
    DeviceMethod: NotRequired[DeviceMethodTypeDef],  # (1)
    DeviceMethodParameters: NotRequired[str],
  1. See DeviceMethodTypeDef

ListDevicesRequestListDevicesPaginateTypeDef#

# ListDevicesRequestListDevicesPaginateTypeDef definition

class ListDevicesRequestListDevicesPaginateTypeDef(TypedDict):
    DeviceType: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDeviceEventsRequestListDeviceEventsPaginateTypeDef#

# ListDeviceEventsRequestListDeviceEventsPaginateTypeDef definition

class ListDeviceEventsRequestListDeviceEventsPaginateTypeDef(TypedDict):
    DeviceId: str,
    FromTimeStamp: Union[datetime, str],
    ToTimeStamp: Union[datetime, str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDeviceEventsRequestRequestTypeDef#

# ListDeviceEventsRequestRequestTypeDef definition

class ListDeviceEventsRequestRequestTypeDef(TypedDict):
    DeviceId: str,
    FromTimeStamp: Union[datetime, str],
    ToTimeStamp: Union[datetime, str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListDeviceEventsResponseTypeDef#

# ListDeviceEventsResponseTypeDef definition

class ListDeviceEventsResponseTypeDef(TypedDict):
    Events: List[DeviceEventTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeviceEventTypeDef
  2. See ResponseMetadataTypeDef