Table Of Contents

  1. Docs
  2. Available services
  3. IoTDataPlane

IoTDataPlane

Table of Contents

Client

class 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(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").
Returns
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'
)
Parameters
  • thingName (string) --

    [REQUIRED]

    The name of the thing.

  • shadowName (string) -- The name of the shadow.
Return type

dict

Returns

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.ResourceNotFoundException
  • IoTDataPlane.Client.exceptions.InvalidRequestException
  • IoTDataPlane.Client.exceptions.ThrottlingException
  • IoTDataPlane.Client.exceptions.UnauthorizedException
  • IoTDataPlane.Client.exceptions.ServiceUnavailableException
  • IoTDataPlane.Client.exceptions.InternalFailureException
  • IoTDataPlane.Client.exceptions.MethodNotAllowedException
  • IoTDataPlane.Client.exceptions.UnsupportedDocumentEncodingException
get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
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'
)
Parameters
topic (string) --

[REQUIRED]

The topic name of the retained message to retrieve.

Return type
dict
Returns
Response Syntax
{
    'topic': 'string',
    'payload': b'bytes',
    'qos': 123,
    'lastModifiedTime': 123
}

Response Structure

  • (dict) --

    The output from the GetRetainedMessage operation.

    • topic (string) --

      The topic name to which the retained message was published.

    • payload (bytes) --

      The Base64-encoded message payload of the retained message body.

    • 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.

Exceptions

  • IoTDataPlane.Client.exceptions.InvalidRequestException
  • IoTDataPlane.Client.exceptions.ResourceNotFoundException
  • IoTDataPlane.Client.exceptions.ThrottlingException
  • IoTDataPlane.Client.exceptions.UnauthorizedException
  • IoTDataPlane.Client.exceptions.ServiceUnavailableException
  • IoTDataPlane.Client.exceptions.InternalFailureException
  • IoTDataPlane.Client.exceptions.MethodNotAllowedException
get_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'
)
Parameters
  • thingName (string) --

    [REQUIRED]

    The name of the thing.

  • shadowName (string) -- The name of the shadow.
Return type

dict

Returns

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.InvalidRequestException
  • IoTDataPlane.Client.exceptions.ResourceNotFoundException
  • IoTDataPlane.Client.exceptions.ThrottlingException
  • IoTDataPlane.Client.exceptions.UnauthorizedException
  • IoTDataPlane.Client.exceptions.ServiceUnavailableException
  • IoTDataPlane.Client.exceptions.InternalFailureException
  • IoTDataPlane.Client.exceptions.MethodNotAllowedException
  • IoTDataPlane.Client.exceptions.UnsupportedDocumentEncodingException
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
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
)
Parameters
  • thingName (string) --

    [REQUIRED]

    The name of the thing.

  • nextToken (string) -- The token to retrieve the next set of results.
  • pageSize (integer) -- The result page size.
Return type

dict

Returns

Response Syntax

{
    'results': [
        'string',
    ],
    'nextToken': 'string',
    'timestamp': 123
}

Response Structure

  • (dict) --

    • results (list) --

      The list of shadows for the specified thing.

      • (string) --

    • 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.ResourceNotFoundException
  • IoTDataPlane.Client.exceptions.InvalidRequestException
  • IoTDataPlane.Client.exceptions.ThrottlingException
  • IoTDataPlane.Client.exceptions.UnauthorizedException
  • IoTDataPlane.Client.exceptions.ServiceUnavailableException
  • IoTDataPlane.Client.exceptions.InternalFailureException
  • IoTDataPlane.Client.exceptions.MethodNotAllowedException
list_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
)
Parameters
  • nextToken (string) -- To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
  • maxResults (integer) -- The maximum number of results to return at one time.
Return type

dict

Returns

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.InvalidRequestException
  • IoTDataPlane.Client.exceptions.ThrottlingException
  • IoTDataPlane.Client.exceptions.UnauthorizedException
  • IoTDataPlane.Client.exceptions.ServiceUnavailableException
  • IoTDataPlane.Client.exceptions.InternalFailureException
  • IoTDataPlane.Client.exceptions.MethodNotAllowedException
publish(**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,
    userProperties={...}|[...]|123|123.4|'string'|True|None,
    payloadFormatIndicator='UNSPECIFIED_BYTES'|'UTF8_DATA',
    contentType='string',
    responseTopic='string',
    correlationData='string',
    messageExpiry=123
)
Parameters
  • topic (string) --

    [REQUIRED]

    The name of the MQTT topic.

  • qos (integer) -- The Quality of Service (QoS) level. The default QoS level is 0.
  • retain (boolean) --

    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

  • payload (bytes or seekable file-like object) --

    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.

  • userProperties (JSON serializable) --

    A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.

    The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:

    [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
  • payloadFormatIndicator (string) -- An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
  • contentType (string) -- A UTF-8 encoded string that describes the content of the publishing message.
  • responseTopic (string) -- A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
  • correlationData (string) -- The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received. correlationData is an HTTP header value in the API.
  • messageExpiry (integer) -- A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more information about the limits of messageExpiry , see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.
Returns

None

Exceptions

  • IoTDataPlane.Client.exceptions.InternalFailureException
  • IoTDataPlane.Client.exceptions.InvalidRequestException
  • IoTDataPlane.Client.exceptions.UnauthorizedException
  • IoTDataPlane.Client.exceptions.MethodNotAllowedException
  • IoTDataPlane.Client.exceptions.ThrottlingException
update_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
)
Parameters
  • thingName (string) --

    [REQUIRED]

    The name of the thing.

  • shadowName (string) -- The name of the shadow.
  • payload (bytes or seekable file-like object) --

    [REQUIRED]

    The state information, in JSON format.

Return type

dict

Returns

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.ConflictException
  • IoTDataPlane.Client.exceptions.RequestEntityTooLargeException
  • IoTDataPlane.Client.exceptions.InvalidRequestException
  • IoTDataPlane.Client.exceptions.ThrottlingException
  • IoTDataPlane.Client.exceptions.UnauthorizedException
  • IoTDataPlane.Client.exceptions.ServiceUnavailableException
  • IoTDataPlane.Client.exceptions.InternalFailureException
  • IoTDataPlane.Client.exceptions.MethodNotAllowedException
  • IoTDataPlane.Client.exceptions.UnsupportedDocumentEncodingException

Paginators

The available paginators are:

class 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'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
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) --

      A token to resume pagination.

IoT
IoTJobsDataPlane
Privacy | Site Terms | Cookie preferences | © Copyright 2022, Amazon Web Services, Inc. Created using Sphinx.