iotdataplane

package
v0.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 7 Imported by: 27

Documentation

Overview

Package iotdataplane provides the client and types for making API requests to AWS IoT Data Plane.

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 shadows. A shadow is a persistent representation of your things and their state in the AWS cloud.

Find the endpoint address for actions in the AWS IoT data plane by running this CLI command:

aws iot describe-endpoint --endpoint-type iot:Data-ATS

The service name used by AWS Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) to sign requests is: iotdevicegateway.

See iotdataplane package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/iotdataplane/

Using the Client

To use AWS IoT Data Plane with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS IoT Data Plane client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iotdataplane/#New

Index

Constants

View Source 
const (
	ServiceName = "AWS IoT Data Plane" // Service's name
	ServiceID   = "IoTDataPlane"       // Service's identifier
	EndpointsID = "data.iot"           // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The specified version does not match the version of the document.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	//
	// An unexpected error has occurred.
	ErrCodeInternalFailureException = "InternalFailureException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request is not valid.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeMethodNotAllowedException for service response error code
	// "MethodNotAllowedException".
	//
	// The specified combination of HTTP verb and URI is not supported.
	ErrCodeMethodNotAllowedException = "MethodNotAllowedException"

	// ErrCodeRequestEntityTooLargeException for service response error code
	// "RequestEntityTooLargeException".
	//
	// The payload exceeds the maximum size allowed.
	ErrCodeRequestEntityTooLargeException = "RequestEntityTooLargeException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The service is temporarily unavailable.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The rate exceeds the limit.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeUnauthorizedException for service response error code
	// "UnauthorizedException".
	//
	// You are not authorized to perform this operation.
	ErrCodeUnauthorizedException = "UnauthorizedException"

	// ErrCodeUnsupportedDocumentEncodingException for service response error code
	// "UnsupportedDocumentEncodingException".
	//
	// The document encoding is not supported.
	ErrCodeUnsupportedDocumentEncodingException = "UnsupportedDocumentEncodingException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AWS IoT Data Plane. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := iotdataplane.New(myConfig)

func (*Client) DeleteThingShadowRequest added in v0.9.0 

func (c *Client) DeleteThingShadowRequest(input *DeleteThingShadowInput) DeleteThingShadowRequest

DeleteThingShadowRequest returns a request value for making API operation for AWS IoT Data Plane.

Deletes the 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 sending a request using DeleteThingShadowRequest.
req := client.DeleteThingShadowRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) GetThingShadowRequest added in v0.9.0 

func (c *Client) GetThingShadowRequest(input *GetThingShadowInput) GetThingShadowRequest

GetThingShadowRequest returns a request value for making API operation for AWS IoT Data Plane.

Gets the 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 sending a request using GetThingShadowRequest.
req := client.GetThingShadowRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) ListNamedShadowsForThingRequest added in v0.24.0 

func (c *Client) ListNamedShadowsForThingRequest(input *ListNamedShadowsForThingInput) ListNamedShadowsForThingRequest

ListNamedShadowsForThingRequest returns a request value for making API operation for AWS IoT Data Plane.

Lists the shadows for the specified thing. 

// Example sending a request using ListNamedShadowsForThingRequest.
req := client.ListNamedShadowsForThingRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) PublishRequest added in v0.9.0 

func (c *Client) PublishRequest(input *PublishInput) PublishRequest

PublishRequest returns a request value for making API operation for AWS IoT Data Plane.

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 sending a request using PublishRequest.
req := client.PublishRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

func (*Client) UpdateThingShadowRequest added in v0.9.0 

func (c *Client) UpdateThingShadowRequest(input *UpdateThingShadowInput) UpdateThingShadowRequest

UpdateThingShadowRequest returns a request value for making API operation for AWS IoT Data Plane.

Updates the 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 sending a request using UpdateThingShadowRequest.
req := client.UpdateThingShadowRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

type DeleteThingShadowInput 

type DeleteThingShadowInput struct {

	// The name of the shadow.
	ShadowName *string `location:"querystring" locationName:"name" min:"1" type:"string"`

	// The name of the thing.
	//
	// ThingName is a required field
	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) MarshalFields added in v0.3.0 

func (s DeleteThingShadowInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 is a required field
	Payload []byte `locationName:"payload" type:"blob" required:"true"`
	// contains filtered or unexported fields
}

The output from the DeleteThingShadow operation.

func (DeleteThingShadowOutput) MarshalFields added in v0.3.0 

func (s DeleteThingShadowOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteThingShadowOutput) String 

func (s DeleteThingShadowOutput) String() string

String returns the string representation

type DeleteThingShadowRequest 

type DeleteThingShadowRequest struct {
	*aws.Request
	Input *DeleteThingShadowInput
	Copy  func(*DeleteThingShadowInput) DeleteThingShadowRequest
}

DeleteThingShadowRequest is the request type for the DeleteThingShadow API operation.

func (DeleteThingShadowRequest) Send 

func (r DeleteThingShadowRequest) Send(ctx context.Context) (*DeleteThingShadowResponse, error)

Send marshals and sends the DeleteThingShadow API request.

type DeleteThingShadowResponse added in v0.9.0 

type DeleteThingShadowResponse struct {
	*DeleteThingShadowOutput
	// contains filtered or unexported fields
}

DeleteThingShadowResponse is the response type for the DeleteThingShadow API operation.

func (*DeleteThingShadowResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteThingShadowResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteThingShadow request.

type GetThingShadowInput 

type GetThingShadowInput struct {

	// The name of the shadow.
	ShadowName *string `location:"querystring" locationName:"name" min:"1" type:"string"`

	// The name of the thing.
	//
	// ThingName is a required field
	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) MarshalFields added in v0.3.0 

func (s GetThingShadowInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields added in v0.3.0 

func (s GetThingShadowOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetThingShadowOutput) String 

func (s GetThingShadowOutput) String() string

String returns the string representation

type GetThingShadowRequest 

type GetThingShadowRequest struct {
	*aws.Request
	Input *GetThingShadowInput
	Copy  func(*GetThingShadowInput) GetThingShadowRequest
}

GetThingShadowRequest is the request type for the GetThingShadow API operation.

func (GetThingShadowRequest) Send 

func (r GetThingShadowRequest) Send(ctx context.Context) (*GetThingShadowResponse, error)

Send marshals and sends the GetThingShadow API request.

type GetThingShadowResponse added in v0.9.0 

type GetThingShadowResponse struct {
	*GetThingShadowOutput
	// contains filtered or unexported fields
}

GetThingShadowResponse is the response type for the GetThingShadow API operation.

func (*GetThingShadowResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetThingShadowResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetThingShadow request.

type ListNamedShadowsForThingInput added in v0.24.0 

type ListNamedShadowsForThingInput struct {

	// The token to retrieve the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The result page size.
	PageSize *int64 `location:"querystring" locationName:"pageSize" min:"1" type:"integer"`

	// The name of the thing.
	//
	// ThingName is a required field
	ThingName *string `location:"uri" locationName:"thingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListNamedShadowsForThingInput) MarshalFields added in v0.24.0 

func (s ListNamedShadowsForThingInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListNamedShadowsForThingInput) String added in v0.24.0 

func (s ListNamedShadowsForThingInput) String() string

String returns the string representation

func (*ListNamedShadowsForThingInput) Validate added in v0.24.0 

func (s *ListNamedShadowsForThingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListNamedShadowsForThingOutput added in v0.24.0 

type ListNamedShadowsForThingOutput struct {

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The list of shadows for the specified thing.
	Results []string `locationName:"results" type:"list"`

	// The Epoch date and time the response was generated by AWS IoT.
	Timestamp *int64 `locationName:"timestamp" type:"long"`
	// contains filtered or unexported fields
}

func (ListNamedShadowsForThingOutput) MarshalFields added in v0.24.0 

func (s ListNamedShadowsForThingOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListNamedShadowsForThingOutput) String added in v0.24.0 

func (s ListNamedShadowsForThingOutput) String() string

String returns the string representation

type ListNamedShadowsForThingRequest added in v0.24.0 

type ListNamedShadowsForThingRequest struct {
	*aws.Request
	Input *ListNamedShadowsForThingInput
	Copy  func(*ListNamedShadowsForThingInput) ListNamedShadowsForThingRequest
}

ListNamedShadowsForThingRequest is the request type for the ListNamedShadowsForThing API operation.

func (ListNamedShadowsForThingRequest) Send added in v0.24.0 

func (r ListNamedShadowsForThingRequest) Send(ctx context.Context) (*ListNamedShadowsForThingResponse, error)

Send marshals and sends the ListNamedShadowsForThing API request.

type ListNamedShadowsForThingResponse added in v0.24.0 

type ListNamedShadowsForThingResponse struct {
	*ListNamedShadowsForThingOutput
	// contains filtered or unexported fields
}

ListNamedShadowsForThingResponse is the response type for the ListNamedShadowsForThing API operation.

func (*ListNamedShadowsForThingResponse) SDKResponseMetdata added in v0.24.0 

func (r *ListNamedShadowsForThingResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListNamedShadowsForThing request.

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 is a required field
	Topic *string `location:"uri" locationName:"topic" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the Publish operation.

func (PublishInput) MarshalFields added in v0.3.0 

func (s PublishInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields added in v0.3.0 

func (s PublishOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PublishOutput) String 

func (s PublishOutput) String() string

String returns the string representation

type PublishRequest 

type PublishRequest struct {
	*aws.Request
	Input *PublishInput
	Copy  func(*PublishInput) PublishRequest
}

PublishRequest is the request type for the Publish API operation.

func (PublishRequest) Send 

func (r PublishRequest) Send(ctx context.Context) (*PublishResponse, error)

Send marshals and sends the Publish API request.

type PublishResponse added in v0.9.0 

type PublishResponse struct {
	*PublishOutput
	// contains filtered or unexported fields
}

PublishResponse is the response type for the Publish API operation.

func (*PublishResponse) SDKResponseMetdata added in v0.9.0 

func (r *PublishResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the Publish request.

type UpdateThingShadowInput 

type UpdateThingShadowInput struct {

	// The state information, in JSON format.
	//
	// Payload is a required field
	Payload []byte `locationName:"payload" type:"blob" required:"true"`

	// The name of the shadow.
	ShadowName *string `location:"querystring" locationName:"name" min:"1" type:"string"`

	// The name of the thing.
	//
	// ThingName is a required field
	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) MarshalFields added in v0.3.0 

func (s UpdateThingShadowInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields added in v0.3.0 

func (s UpdateThingShadowOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateThingShadowOutput) String 

func (s UpdateThingShadowOutput) String() string

String returns the string representation

type UpdateThingShadowRequest 

type UpdateThingShadowRequest struct {
	*aws.Request
	Input *UpdateThingShadowInput
	Copy  func(*UpdateThingShadowInput) UpdateThingShadowRequest
}

UpdateThingShadowRequest is the request type for the UpdateThingShadow API operation.

func (UpdateThingShadowRequest) Send 

func (r UpdateThingShadowRequest) Send(ctx context.Context) (*UpdateThingShadowResponse, error)

Send marshals and sends the UpdateThingShadow API request.

type UpdateThingShadowResponse added in v0.9.0 

type UpdateThingShadowResponse struct {
	*UpdateThingShadowOutput
	// contains filtered or unexported fields
}

UpdateThingShadowResponse is the response type for the UpdateThingShadow API operation.

func (*UpdateThingShadowResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateThingShadowResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateThingShadow request.

Source Files

View all Source files

Directories

Path Synopsis
Package iotdataplaneiface provides an interface to enable mocking the AWS IoT Data Plane service client for testing your code.
 Package iotdataplaneiface provides an interface to enable mocking the AWS IoT Data Plane service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.