Documentation
¶
Overview ¶
Package iotdataplane provides a client for AWS IoT Data Plane.
Index ¶
- Constants
- 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 ¶
const ServiceName = "data.iot"
A ServiceName is the name of the service the client will make API calls to.
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.
func (DeleteThingShadowInput) GoString ¶
func (s DeleteThingShadowInput) GoString() string
GoString returns the string representation
func (DeleteThingShadowInput) String ¶
func (s DeleteThingShadowInput) String() string
String returns the string representation
func (*DeleteThingShadowInput) Validate ¶
func (s *DeleteThingShadowInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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.
func (DeleteThingShadowOutput) GoString ¶
func (s DeleteThingShadowOutput) GoString() string
GoString returns the string representation
func (DeleteThingShadowOutput) String ¶
func (s DeleteThingShadowOutput) String() string
String returns the string representation
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.
func (GetThingShadowInput) GoString ¶
func (s GetThingShadowInput) GoString() string
GoString returns the string representation
func (GetThingShadowInput) String ¶
func (s GetThingShadowInput) String() string
String returns the string representation
func (*GetThingShadowInput) Validate ¶
func (s *GetThingShadowInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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.
func (GetThingShadowOutput) GoString ¶
func (s GetThingShadowOutput) GoString() string
GoString returns the string representation
func (GetThingShadowOutput) String ¶
func (s GetThingShadowOutput) String() string
String returns the string representation
type IoTDataPlane ¶
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. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *IoTDataPlane
New creates a new instance of the IoTDataPlane client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a IoTDataPlane client from just a session. svc := iotdataplane.New(mySession) // Create a IoTDataPlane client with additional configuration svc := iotdataplane.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/iotdataplane" ) func main() { svc := iotdataplane.New(session.New()) params := &iotdataplane.DeleteThingShadowInput{ ThingName: aws.String("ThingName"), // Required } resp, err := svc.DeleteThingShadow(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/iotdataplane" ) func main() { svc := iotdataplane.New(session.New()) params := &iotdataplane.GetThingShadowInput{ ThingName: aws.String("ThingName"), // Required } resp, err := svc.GetThingShadow(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/iotdataplane" ) func main() { svc := iotdataplane.New(session.New()) params := &iotdataplane.PublishInput{ Topic: aws.String("Topic"), // Required Payload: []byte("PAYLOAD"), Qos: aws.Int64(1), } resp, err := svc.Publish(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/iotdataplane" ) func main() { svc := iotdataplane.New(session.New()) params := &iotdataplane.UpdateThingShadowInput{ Payload: []byte("PAYLOAD"), // Required ThingName: aws.String("ThingName"), // Required } resp, err := svc.UpdateThingShadow(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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.
func (PublishInput) GoString ¶
func (s PublishInput) GoString() string
GoString returns the string representation
func (PublishInput) String ¶
func (s PublishInput) String() string
String returns the string representation
func (*PublishInput) Validate ¶
func (s *PublishInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PublishOutput ¶
type PublishOutput struct {
// contains filtered or unexported fields
}
func (PublishOutput) GoString ¶
func (s PublishOutput) GoString() string
GoString returns the string representation
func (PublishOutput) String ¶
func (s PublishOutput) String() string
String returns the string representation
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.
func (UpdateThingShadowInput) GoString ¶
func (s UpdateThingShadowInput) GoString() string
GoString returns the string representation
func (UpdateThingShadowInput) String ¶
func (s UpdateThingShadowInput) String() string
String returns the string representation
func (*UpdateThingShadowInput) Validate ¶
func (s *UpdateThingShadowInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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.
func (UpdateThingShadowOutput) GoString ¶
func (s UpdateThingShadowOutput) GoString() string
GoString returns the string representation
func (UpdateThingShadowOutput) String ¶
func (s UpdateThingShadowOutput) String() string
String returns the string representation
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. |