Documentation
¶
Overview ¶
Package iotdataplane provides a client for AWS IoT Data Plane.
Index ¶
- type DeleteThingShadowInput
- type DeleteThingShadowOutput
- type GetThingShadowInput
- type GetThingShadowOutput
- type IoTDataPlane
- func (c *IoTDataPlane) DeleteThingShadow(input *DeleteThingShadowInput) (*DeleteThingShadowOutput, error)
- func (c *IoTDataPlane) DeleteThingShadowRequest(input *DeleteThingShadowInput) (req *request.Request, output *DeleteThingShadowOutput)
- func (c *IoTDataPlane) GetThingShadow(input *GetThingShadowInput) (*GetThingShadowOutput, error)
- func (c *IoTDataPlane) GetThingShadowRequest(input *GetThingShadowInput) (req *request.Request, output *GetThingShadowOutput)
- func (c *IoTDataPlane) Publish(input *PublishInput) (*PublishOutput, error)
- func (c *IoTDataPlane) PublishRequest(input *PublishInput) (req *request.Request, output *PublishOutput)
- func (c *IoTDataPlane) UpdateThingShadow(input *UpdateThingShadowInput) (*UpdateThingShadowOutput, error)
- func (c *IoTDataPlane) UpdateThingShadowRequest(input *UpdateThingShadowInput) (req *request.Request, output *UpdateThingShadowOutput)
- type PublishInput
- type PublishOutput
- type UpdateThingShadowInput
- type UpdateThingShadowOutput
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DeleteThingShadowInput ¶
type DeleteThingShadowInput struct {
// The name of the thing.
ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
The input for the DeleteThingShadow operation.
type DeleteThingShadowOutput ¶
type DeleteThingShadowOutput struct {
// The state information, in JSON format.
Payload []byte `locationName:"payload" type:"blob" required:"true"`
// contains filtered or unexported fields
}
The output from the DeleteThingShadow operation.
type GetThingShadowInput ¶
type GetThingShadowInput struct {
// The name of the thing.
ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
The input for the GetThingShadow operation.
type GetThingShadowOutput ¶
type GetThingShadowOutput struct {
// The state information, in JSON format.
Payload []byte `locationName:"payload" type:"blob"`
// contains filtered or unexported fields
}
The output from the GetThingShadow operation.
type IoTDataPlane ¶
type IoTDataPlane struct {
*service.Service
}
AWS IoT is considered a beta service as defined in the Service Terms
AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete thing shadows. A thing shadow is a persistent representation of your things and their state in the AWS cloud.
func (*IoTDataPlane) DeleteThingShadow ¶
func (c *IoTDataPlane) DeleteThingShadow(input *DeleteThingShadowInput) (*DeleteThingShadowOutput, error)
Deletes the thing shadow for the specified thing.
For more information, see DeleteThingShadow (http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html) in the AWS IoT Developer Guide.
func (*IoTDataPlane) DeleteThingShadowRequest ¶
func (c *IoTDataPlane) DeleteThingShadowRequest(input *DeleteThingShadowInput) (req *request.Request, output *DeleteThingShadowOutput)
DeleteThingShadowRequest generates a request for the DeleteThingShadow operation.
func (*IoTDataPlane) GetThingShadow ¶
func (c *IoTDataPlane) GetThingShadow(input *GetThingShadowInput) (*GetThingShadowOutput, error)
Gets the thing shadow for the specified thing.
For more information, see GetThingShadow (http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html) in the AWS IoT Developer Guide.
func (*IoTDataPlane) GetThingShadowRequest ¶
func (c *IoTDataPlane) GetThingShadowRequest(input *GetThingShadowInput) (req *request.Request, output *GetThingShadowOutput)
GetThingShadowRequest generates a request for the GetThingShadow operation.
func (*IoTDataPlane) Publish ¶
func (c *IoTDataPlane) Publish(input *PublishInput) (*PublishOutput, error)
Publishes state information.
For more information, see HTTP Protocol (http://docs.aws.amazon.com/iot/latest/developerguide/protocols.html#http) in the AWS IoT Developer Guide.
func (*IoTDataPlane) PublishRequest ¶
func (c *IoTDataPlane) PublishRequest(input *PublishInput) (req *request.Request, output *PublishOutput)
PublishRequest generates a request for the Publish operation.
func (*IoTDataPlane) UpdateThingShadow ¶
func (c *IoTDataPlane) UpdateThingShadow(input *UpdateThingShadowInput) (*UpdateThingShadowOutput, error)
Updates the thing shadow for the specified thing.
For more information, see UpdateThingShadow (http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html) in the AWS IoT Developer Guide.
func (*IoTDataPlane) UpdateThingShadowRequest ¶
func (c *IoTDataPlane) UpdateThingShadowRequest(input *UpdateThingShadowInput) (req *request.Request, output *UpdateThingShadowOutput)
UpdateThingShadowRequest generates a request for the UpdateThingShadow operation.
type PublishInput ¶
type PublishInput struct {
// The state information, in JSON format.
Payload []byte `locationName:"payload" type:"blob"`
// The Quality of Service (QoS) level.
Qos *int64 `location:"querystring" locationName:"qos" type:"integer"`
// The name of the MQTT topic.
Topic *string `location:"uri" locationName:"topic" type:"string" required:"true"`
// contains filtered or unexported fields
}
The input for the Publish operation.
type PublishOutput ¶
type PublishOutput struct {
// contains filtered or unexported fields
}
type UpdateThingShadowInput ¶
type UpdateThingShadowInput struct {
// The state information, in JSON format.
Payload []byte `locationName:"payload" type:"blob" required:"true"`
// The name of the thing.
ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
// contains filtered or unexported fields
}
The input for the UpdateThingShadow operation.
type UpdateThingShadowOutput ¶
type UpdateThingShadowOutput struct {
// The state information, in JSON format.
Payload []byte `locationName:"payload" type:"blob"`
// contains filtered or unexported fields
}
The output from the UpdateThingShadow operation.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package iotdataplaneiface provides an interface for the AWS IoT Data Plane.
|
Package iotdataplaneiface provides an interface for the AWS IoT Data Plane. |