IoT1ClickDevicesServiceClient

Index > IoT1ClickDevicesService > IoT1ClickDevicesServiceClient

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

IoT1ClickDevicesServiceClient

Type annotations and code completion for boto3.client("iot1click-devices"). boto3 documentation

Usage example

from boto3.session import Session
from mypy_boto3_iot1click_devices.client import IoT1ClickDevicesServiceClient

def get_iot1click-devices_client() -> IoT1ClickDevicesServiceClient:
    return Session().client("iot1click-devices")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("iot1click-devices").exceptions structure.

Usage example

client = boto3.client("iot1click-devices")

try:
    do_something(client)
except (
    client.ClientError,
    client.ForbiddenException,
    client.InternalFailureException,
    client.InvalidRequestException,
    client.PreconditionFailedException,
    client.RangeNotSatisfiableException,
    client.ResourceConflictException,
    client.ResourceNotFoundException,
) as e:
    print(e)

Type checking example

from mypy_boto3_iot1click_devices.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("iot1click-devices").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

claim_devices_by_claim_code

Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).

Type annotations and code completion for boto3.client("iot1click-devices").claim_devices_by_claim_code method. boto3 documentation

Method definition

def claim_devices_by_claim_code(
    self,
    *,
    ClaimCode: str,
) -> ClaimDevicesByClaimCodeResponseTypeDef:  # (1)
    ...

1. See ClaimDevicesByClaimCodeResponseTypeDef

Usage example with kwargs

kwargs: ClaimDevicesByClaimCodeRequestRequestTypeDef = {  # (1)
    "ClaimCode": ...,
}

parent.claim_devices_by_claim_code(**kwargs)

1. See ClaimDevicesByClaimCodeRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("iot1click-devices").close method. boto3 documentation

Method definition

def close(
    self,
) -> None:
    ...

describe_device

Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.

Type annotations and code completion for boto3.client("iot1click-devices").describe_device method. boto3 documentation

Method definition

def describe_device(
    self,
    *,
    DeviceId: str,
) -> DescribeDeviceResponseTypeDef:  # (1)
    ...

1. See DescribeDeviceResponseTypeDef

Usage example with kwargs

kwargs: DescribeDeviceRequestRequestTypeDef = {  # (1)
    "DeviceId": ...,
}

parent.describe_device(**kwargs)

1. See DescribeDeviceRequestRequestTypeDef

finalize_device_claim

Given a device ID, finalizes the claim request for the associated device.

Type annotations and code completion for boto3.client("iot1click-devices").finalize_device_claim method. boto3 documentation

Method definition

def finalize_device_claim(
    self,
    *,
    DeviceId: str,
    Tags: Mapping[str, str] = ...,
) -> FinalizeDeviceClaimResponseTypeDef:  # (1)
    ...

1. See FinalizeDeviceClaimResponseTypeDef

Usage example with kwargs

kwargs: FinalizeDeviceClaimRequestRequestTypeDef = {  # (1)
    "DeviceId": ...,
}

parent.finalize_device_claim(**kwargs)

1. See FinalizeDeviceClaimRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("iot1click-devices").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_device_methods

Given a device ID, returns the invokable methods associated with the device.

Type annotations and code completion for boto3.client("iot1click-devices").get_device_methods method. boto3 documentation

Method definition

def get_device_methods(
    self,
    *,
    DeviceId: str,
) -> GetDeviceMethodsResponseTypeDef:  # (1)
    ...

1. See GetDeviceMethodsResponseTypeDef

Usage example with kwargs

kwargs: GetDeviceMethodsRequestRequestTypeDef = {  # (1)
    "DeviceId": ...,
}

parent.get_device_methods(**kwargs)

1. See GetDeviceMethodsRequestRequestTypeDef

initiate_device_claim

Given a device ID, initiates a claim request for the associated device.

Type annotations and code completion for boto3.client("iot1click-devices").initiate_device_claim method. boto3 documentation

Method definition

def initiate_device_claim(
    self,
    *,
    DeviceId: str,
) -> InitiateDeviceClaimResponseTypeDef:  # (1)
    ...

1. See InitiateDeviceClaimResponseTypeDef

Usage example with kwargs

kwargs: InitiateDeviceClaimRequestRequestTypeDef = {  # (1)
    "DeviceId": ...,
}

parent.initiate_device_claim(**kwargs)

1. See InitiateDeviceClaimRequestRequestTypeDef

invoke_device_method

Given a device ID, issues a request to invoke a named device method (with possible parameters).

Type annotations and code completion for boto3.client("iot1click-devices").invoke_device_method method. boto3 documentation

Method definition

def invoke_device_method(
    self,
    *,
    DeviceId: str,
    DeviceMethod: DeviceMethodTypeDef = ...,  # (1)
    DeviceMethodParameters: str = ...,
) -> InvokeDeviceMethodResponseTypeDef:  # (2)
    ...

1. See DeviceMethodTypeDef
2. See InvokeDeviceMethodResponseTypeDef

Usage example with kwargs

kwargs: InvokeDeviceMethodRequestRequestTypeDef = {  # (1)
    "DeviceId": ...,
}

parent.invoke_device_method(**kwargs)

1. See InvokeDeviceMethodRequestRequestTypeDef

list_device_events

Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.

Type annotations and code completion for boto3.client("iot1click-devices").list_device_events method. boto3 documentation

Method definition

def list_device_events(
    self,
    *,
    DeviceId: str,
    FromTimeStamp: Union[datetime, str],
    ToTimeStamp: Union[datetime, str],
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDeviceEventsResponseTypeDef:  # (1)
    ...

1. See ListDeviceEventsResponseTypeDef

Usage example with kwargs

kwargs: ListDeviceEventsRequestRequestTypeDef = {  # (1)
    "DeviceId": ...,
    "FromTimeStamp": ...,
    "ToTimeStamp": ...,
}

parent.list_device_events(**kwargs)

1. See ListDeviceEventsRequestRequestTypeDef

list_devices

Lists the 1-Click compatible devices associated with your AWS account.

Type annotations and code completion for boto3.client("iot1click-devices").list_devices method. boto3 documentation

Method definition

def list_devices(
    self,
    *,
    DeviceType: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDevicesResponseTypeDef:  # (1)
    ...

1. See ListDevicesResponseTypeDef

Usage example with kwargs

kwargs: ListDevicesRequestRequestTypeDef = {  # (1)
    "DeviceType": ...,
}

parent.list_devices(**kwargs)

1. See ListDevicesRequestRequestTypeDef

list_tags_for_resource

Lists the tags associated with the specified resource ARN.

Type annotations and code completion for boto3.client("iot1click-devices").list_tags_for_resource method. boto3 documentation

Method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

tag_resource

Adds or updates the tags associated with the resource ARN.

Type annotations and code completion for boto3.client("iot1click-devices").tag_resource method. boto3 documentation

Method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

unclaim_device

Disassociates a device from your AWS account using its device ID.

Type annotations and code completion for boto3.client("iot1click-devices").unclaim_device method. boto3 documentation

Method definition

def unclaim_device(
    self,
    *,
    DeviceId: str,
) -> UnclaimDeviceResponseTypeDef:  # (1)
    ...

1. See UnclaimDeviceResponseTypeDef

Usage example with kwargs

kwargs: UnclaimDeviceRequestRequestTypeDef = {  # (1)
    "DeviceId": ...,
}

parent.unclaim_device(**kwargs)

1. See UnclaimDeviceRequestRequestTypeDef

untag_resource

Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.

Type annotations and code completion for boto3.client("iot1click-devices").untag_resource method. boto3 documentation

Method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_device_state

Using a Boolean value (true or false), this operation enables or disables the device given a device ID.

Type annotations and code completion for boto3.client("iot1click-devices").update_device_state method. boto3 documentation

Method definition

def update_device_state(
    self,
    *,
    DeviceId: str,
    Enabled: bool = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateDeviceStateRequestRequestTypeDef = {  # (1)
    "DeviceId": ...,
}

parent.update_device_state(**kwargs)

1. See UpdateDeviceStateRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("iot1click-devices").get_paginator method with overloads.

• client.get_paginator("list_device_events") -> ListDeviceEventsPaginator
• client.get_paginator("list_devices") -> ListDevicesPaginator