Table of Contents
IoTDataPlane.Client¶A low-level client representing AWS IoT Data Plane
IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete shadows. A shadow is a persistent representation of your things and their state in the Amazon Web Services cloud.
Find the endpoint address for actions in IoT data by running this CLI command:
aws iot describe-endpoint --endpoint-type iot:Data-ATS
The service name used by Amazon Web ServicesSignature Version 4 to sign requests is: iotdevicegateway .
import boto3
client = boto3.client('iot-data')
These are the available methods:
can_paginate()close()delete_thing_shadow()get_paginator()get_retained_message()get_thing_shadow()get_waiter()list_named_shadows_for_thing()list_retained_messages()publish()update_thing_shadow()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
delete_thing_shadow(**kwargs)¶Deletes the shadow for the specified thing.
Requires permission to access the DeleteThingShadow action.
For more information, see DeleteThingShadow in the IoT Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.delete_thing_shadow(
thingName='string',
shadowName='string'
)
[REQUIRED]
The name of the thing.
dict
Response Syntax
{
'payload': StreamingBody()
}
Response Structure
(dict) --
The output from the DeleteThingShadow operation.
payload (StreamingBody) --
The state information, in JSON format.
Exceptions
IoTDataPlane.Client.exceptions.ResourceNotFoundExceptionIoTDataPlane.Client.exceptions.InvalidRequestExceptionIoTDataPlane.Client.exceptions.ThrottlingExceptionIoTDataPlane.Client.exceptions.UnauthorizedExceptionIoTDataPlane.Client.exceptions.ServiceUnavailableExceptionIoTDataPlane.Client.exceptions.InternalFailureExceptionIoTDataPlane.Client.exceptions.MethodNotAllowedExceptionIoTDataPlane.Client.exceptions.UnsupportedDocumentEncodingExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_retained_message(**kwargs)¶Gets the details of a single retained message for the specified topic.
This action returns the message payload of the retained message, which can incur messaging costs. To list only the topic names of the retained messages, call ListRetainedMessages .
Requires permission to access the GetRetainedMessage action.
For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging .
See also: AWS API Documentation
Request Syntax
response = client.get_retained_message(
topic='string'
)
[REQUIRED]
The topic name of the retained message to retrieve.
{
'topic': 'string',
'payload': b'bytes',
'qos': 123,
'lastModifiedTime': 123
}
Response Structure
The output from the GetRetainedMessage operation.
The topic name to which the retained message was published.
The Base64-encoded message payload of the retained message body.
The quality of service (QoS) level used to publish the retained message.
The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
Exceptions
IoTDataPlane.Client.exceptions.InvalidRequestExceptionIoTDataPlane.Client.exceptions.ResourceNotFoundExceptionIoTDataPlane.Client.exceptions.ThrottlingExceptionIoTDataPlane.Client.exceptions.UnauthorizedExceptionIoTDataPlane.Client.exceptions.ServiceUnavailableExceptionIoTDataPlane.Client.exceptions.InternalFailureExceptionIoTDataPlane.Client.exceptions.MethodNotAllowedExceptionget_thing_shadow(**kwargs)¶Gets the shadow for the specified thing.
Requires permission to access the GetThingShadow action.
For more information, see GetThingShadow in the IoT Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.get_thing_shadow(
thingName='string',
shadowName='string'
)
[REQUIRED]
The name of the thing.
dict
Response Syntax
{
'payload': StreamingBody()
}
Response Structure
(dict) --
The output from the GetThingShadow operation.
payload (StreamingBody) --
The state information, in JSON format.
Exceptions
IoTDataPlane.Client.exceptions.InvalidRequestExceptionIoTDataPlane.Client.exceptions.ResourceNotFoundExceptionIoTDataPlane.Client.exceptions.ThrottlingExceptionIoTDataPlane.Client.exceptions.UnauthorizedExceptionIoTDataPlane.Client.exceptions.ServiceUnavailableExceptionIoTDataPlane.Client.exceptions.InternalFailureExceptionIoTDataPlane.Client.exceptions.MethodNotAllowedExceptionIoTDataPlane.Client.exceptions.UnsupportedDocumentEncodingExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_named_shadows_for_thing(**kwargs)¶Lists the shadows for the specified thing.
Requires permission to access the ListNamedShadowsForThing action.
See also: AWS API Documentation
Request Syntax
response = client.list_named_shadows_for_thing(
thingName='string',
nextToken='string',
pageSize=123
)
[REQUIRED]
The name of the thing.
dict
Response Syntax
{
'results': [
'string',
],
'nextToken': 'string',
'timestamp': 123
}
Response Structure
(dict) --
results (list) --
The list of shadows for the specified thing.
nextToken (string) --
The token to use to get the next set of results, or null if there are no additional results.
timestamp (integer) --
The Epoch date and time the response was generated by IoT.
Exceptions
IoTDataPlane.Client.exceptions.ResourceNotFoundExceptionIoTDataPlane.Client.exceptions.InvalidRequestExceptionIoTDataPlane.Client.exceptions.ThrottlingExceptionIoTDataPlane.Client.exceptions.UnauthorizedExceptionIoTDataPlane.Client.exceptions.ServiceUnavailableExceptionIoTDataPlane.Client.exceptions.InternalFailureExceptionIoTDataPlane.Client.exceptions.MethodNotAllowedExceptionlist_retained_messages(**kwargs)¶Lists summary information about the retained messages stored for the account.
This action returns only the topic names of the retained messages. It doesn't return any message payloads. Although this action doesn't return a message payload, it can still incur messaging costs.
To get the message payload of a retained message, call GetRetainedMessage with the topic name of the retained message.
Requires permission to access the ListRetainedMessages action.
For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging .
See also: AWS API Documentation
Request Syntax
response = client.list_retained_messages(
nextToken='string',
maxResults=123
)
nextToken value from a previous response; otherwise null to receive the first set of results.dict
Response Syntax
{
'retainedTopics': [
{
'topic': 'string',
'payloadSize': 123,
'qos': 123,
'lastModifiedTime': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
retainedTopics (list) --
A summary list the account's retained messages. The information returned doesn't include the message payloads of the retained messages.
(dict) --
Information about a single retained message.
topic (string) --
The topic name to which the retained message was published.
payloadSize (integer) --
The size of the retained message's payload in bytes.
qos (integer) --
The quality of service (QoS) level used to publish the retained message.
lastModifiedTime (integer) --
The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
nextToken (string) --
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTDataPlane.Client.exceptions.InvalidRequestExceptionIoTDataPlane.Client.exceptions.ThrottlingExceptionIoTDataPlane.Client.exceptions.UnauthorizedExceptionIoTDataPlane.Client.exceptions.ServiceUnavailableExceptionIoTDataPlane.Client.exceptions.InternalFailureExceptionIoTDataPlane.Client.exceptions.MethodNotAllowedExceptionpublish(**kwargs)¶Publishes an MQTT message.
Requires permission to access the Publish action.
For more information about MQTT messages, see MQTT Protocol in the IoT Developer Guide.
For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging .
See also: AWS API Documentation
Request Syntax
response = client.publish(
topic='string',
qos=123,
retain=True|False,
payload=b'bytes'|file
)
[REQUIRED]
The name of the MQTT topic.
A Boolean value that determines whether to set the RETAIN flag when the message is published.
Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.
Valid values: true | false
Default value: false
The message body. MQTT accepts text, binary, and empty (null) message payloads.
Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from Amazon Web Services IoT Core.
None
Exceptions
IoTDataPlane.Client.exceptions.InternalFailureExceptionIoTDataPlane.Client.exceptions.InvalidRequestExceptionIoTDataPlane.Client.exceptions.UnauthorizedExceptionIoTDataPlane.Client.exceptions.MethodNotAllowedExceptionupdate_thing_shadow(**kwargs)¶Updates the shadow for the specified thing.
Requires permission to access the UpdateThingShadow action.
For more information, see UpdateThingShadow in the IoT Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.update_thing_shadow(
thingName='string',
shadowName='string',
payload=b'bytes'|file
)
[REQUIRED]
The name of the thing.
[REQUIRED]
The state information, in JSON format.
dict
Response Syntax
{
'payload': StreamingBody()
}
Response Structure
(dict) --
The output from the UpdateThingShadow operation.
payload (StreamingBody) --
The state information, in JSON format.
Exceptions
IoTDataPlane.Client.exceptions.ConflictExceptionIoTDataPlane.Client.exceptions.RequestEntityTooLargeExceptionIoTDataPlane.Client.exceptions.InvalidRequestExceptionIoTDataPlane.Client.exceptions.ThrottlingExceptionIoTDataPlane.Client.exceptions.UnauthorizedExceptionIoTDataPlane.Client.exceptions.ServiceUnavailableExceptionIoTDataPlane.Client.exceptions.InternalFailureExceptionIoTDataPlane.Client.exceptions.MethodNotAllowedExceptionIoTDataPlane.Client.exceptions.UnsupportedDocumentEncodingExceptionThe available paginators are:
IoTDataPlane.Paginator.ListRetainedMessages¶paginator = client.get_paginator('list_retained_messages')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from IoTDataPlane.Client.list_retained_messages().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'retainedTopics': [
{
'topic': 'string',
'payloadSize': 123,
'qos': 123,
'lastModifiedTime': 123
},
],
'NextToken': 'string'
}
Response Structure
A summary list the account's retained messages. The information returned doesn't include the message payloads of the retained messages.
Information about a single retained message.
The topic name to which the retained message was published.
The size of the retained message's payload in bytes.
The quality of service (QoS) level used to publish the retained message.
The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
A token to resume pagination.