IoTDataPlane

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 .

client = session.create_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.
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

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

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

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

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

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

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

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

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 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
)
Parameters
  • topic (string) --

    [REQUIRED]

    The name of the MQTT topic.

  • qos (integer) -- The Quality of Service (QoS) level.
  • 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 IoT Core.

Returns

None

Exceptions

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

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class IoTDataPlane.Client.exceptions.ConflictException

The specified version does not match the version of the document.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified version does not match the version of the document.

    • message (string) --

      The message for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTDataPlane.Client.exceptions.InternalFailureException

An unexpected error has occurred.

Example

try:
  ...
except client.exceptions.InternalFailureException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    An unexpected error has occurred.

    • message (string) --

      The message for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTDataPlane.Client.exceptions.InvalidRequestException

The request is not valid.

Example

try:
  ...
except client.exceptions.InvalidRequestException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request is not valid.

    • message (string) --

      The message for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTDataPlane.Client.exceptions.MethodNotAllowedException

The specified combination of HTTP verb and URI is not supported.

Example

try:
  ...
except client.exceptions.MethodNotAllowedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified combination of HTTP verb and URI is not supported.

    • message (string) --

      The message for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTDataPlane.Client.exceptions.RequestEntityTooLargeException

The payload exceeds the maximum size allowed.

Example

try:
  ...
except client.exceptions.RequestEntityTooLargeException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The payload exceeds the maximum size allowed.

    • message (string) --

      The message for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTDataPlane.Client.exceptions.ResourceNotFoundException

The specified resource does not exist.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified resource does not exist.

    • message (string) --

      The message for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTDataPlane.Client.exceptions.ServiceUnavailableException

The service is temporarily unavailable.

Example

try:
  ...
except client.exceptions.ServiceUnavailableException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The service is temporarily unavailable.

    • message (string) --

      The message for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTDataPlane.Client.exceptions.ThrottlingException

The rate exceeds the limit.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The rate exceeds the limit.

    • message (string) --

      The message for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTDataPlane.Client.exceptions.UnauthorizedException

You are not authorized to perform this operation.

Example

try:
  ...
except client.exceptions.UnauthorizedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You are not authorized to perform this operation.

    • message (string) --

      The message for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTDataPlane.Client.exceptions.UnsupportedDocumentEncodingException

The document encoding is not supported.

Example

try:
  ...
except client.exceptions.UnsupportedDocumentEncodingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The document encoding is not supported.

    • message (string) --

      The message for the exception.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

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.