IoTDataPlane

Table of Contents

• IoTDataPlane
  • Client

Client

class IoTDataPlane.Client

A low-level client representing AWS IoT Data Plane:

client = session.create_client('iot-data')

These are the available methods:

• can_paginate()
• delete_thing_shadow()
• generate_presigned_url()
• get_paginator()
• get_thing_shadow()
• get_waiter()
• publish()
• update_thing_shadow()

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 thing shadow for the specified thing.

For more information, see DeleteThingShadow in the AWS IoT Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_thing_shadow(
    thingName='string'
)

Parameters:thingName (string) –

[REQUIRED]

The name of the thing.

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.

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_thing_shadow(**kwargs)

Gets the thing shadow for the specified thing.

For more information, see GetThingShadow in the AWS IoT Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_thing_shadow(
    thingName='string'
)

Parameters:thingName (string) –

[REQUIRED]

The name of the thing.

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.

get_waiter(waiter_name)

publish(**kwargs)

Publishes state information.

For more information, see HTTP Protocol in the AWS IoT Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.publish(
    topic='string',
    qos=123,
    payload=b'bytes'|file
)

Parameters:

• topic (string) –

  [REQUIRED]

  The name of the MQTT topic.

• qos (integer) – The Quality of Service (QoS) level.
• payload (bytes or seekable file-like object) – The state information, in JSON format.

Returns:

None

update_thing_shadow(**kwargs)

Updates the thing shadow for the specified thing.

For more information, see UpdateThingShadow in the AWS IoT Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.update_thing_shadow(
    thingName='string',
    payload=b'bytes'|file
)

Parameters:

• thingName (string) –

  [REQUIRED]

  The name of the thing.

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