Documentation

Overview

    Package iotdataplane provides the API client, operations, and parameter types for AWS IoT Data Plane.

    AWS IoT 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.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2015-05-28"
    View Source
    const ServiceID = "IoT Data Plane"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for AWS IoT Data Plane.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) DeleteThingShadow

                func (c *Client) DeleteThingShadow(ctx context.Context, params *DeleteThingShadowInput, optFns ...func(*Options)) (*DeleteThingShadowOutput, error)

                  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.

                  func (*Client) GetThingShadow

                  func (c *Client) GetThingShadow(ctx context.Context, params *GetThingShadowInput, optFns ...func(*Options)) (*GetThingShadowOutput, error)

                    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.

                    func (*Client) ListNamedShadowsForThing

                    func (c *Client) ListNamedShadowsForThing(ctx context.Context, params *ListNamedShadowsForThingInput, optFns ...func(*Options)) (*ListNamedShadowsForThingOutput, error)

                      Lists the shadows for the specified thing.

                      func (*Client) Publish

                      func (c *Client) Publish(ctx context.Context, params *PublishInput, optFns ...func(*Options)) (*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 (*Client) UpdateThingShadow

                        func (c *Client) UpdateThingShadow(ctx context.Context, params *UpdateThingShadowInput, optFns ...func(*Options)) (*UpdateThingShadowOutput, error)

                          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.

                          type DeleteThingShadowInput

                          type DeleteThingShadowInput struct {
                          
                          	// The name of the thing.
                          	//
                          	// This member is required.
                          	ThingName *string
                          
                          	// The name of the shadow.
                          	ShadowName *string
                          }

                            The input for the DeleteThingShadow operation.

                            type DeleteThingShadowOutput

                            type DeleteThingShadowOutput struct {
                            
                            	// The state information, in JSON format.
                            	//
                            	// This member is required.
                            	Payload []byte
                            
                            	// Metadata pertaining to the operation's result.
                            	ResultMetadata middleware.Metadata
                            }

                              The output from the DeleteThingShadow operation.

                              type EndpointResolver

                              type EndpointResolver interface {
                              	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                              }

                                EndpointResolver interface for resolving service endpoints.

                                func EndpointResolverFromURL

                                func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                  EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                  type EndpointResolverFunc

                                  type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                    EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                    func (EndpointResolverFunc) ResolveEndpoint

                                    func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                    type EndpointResolverOptions

                                    type EndpointResolverOptions = internalendpoints.Options

                                      EndpointResolverOptions is the service endpoint resolver options

                                      type GetThingShadowInput

                                      type GetThingShadowInput struct {
                                      
                                      	// The name of the thing.
                                      	//
                                      	// This member is required.
                                      	ThingName *string
                                      
                                      	// The name of the shadow.
                                      	ShadowName *string
                                      }

                                        The input for the GetThingShadow operation.

                                        type GetThingShadowOutput

                                        type GetThingShadowOutput struct {
                                        
                                        	// The state information, in JSON format.
                                        	Payload []byte
                                        
                                        	// Metadata pertaining to the operation's result.
                                        	ResultMetadata middleware.Metadata
                                        }

                                          The output from the GetThingShadow operation.

                                          type HTTPClient

                                          type HTTPClient interface {
                                          	Do(*http.Request) (*http.Response, error)
                                          }

                                          type HTTPSignerV4

                                          type HTTPSignerV4 interface {
                                          	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                          }

                                          type ListNamedShadowsForThingInput

                                          type ListNamedShadowsForThingInput struct {
                                          
                                          	// The name of the thing.
                                          	//
                                          	// This member is required.
                                          	ThingName *string
                                          
                                          	// The token to retrieve the next set of results.
                                          	NextToken *string
                                          
                                          	// The result page size.
                                          	PageSize *int32
                                          }

                                          type ListNamedShadowsForThingOutput

                                          type ListNamedShadowsForThingOutput struct {
                                          
                                          	// The token for the next set of results, or null if there are no additional
                                          	// results.
                                          	NextToken *string
                                          
                                          	// The list of shadows for the specified thing.
                                          	Results []string
                                          
                                          	// The Epoch date and time the response was generated by AWS IoT.
                                          	Timestamp int64
                                          
                                          	// Metadata pertaining to the operation's result.
                                          	ResultMetadata middleware.Metadata
                                          }

                                          type Options

                                          type Options struct {
                                          	// Set of options to modify how an operation is invoked. These apply to all
                                          	// operations invoked for this client. Use functional options on operation call to
                                          	// modify this list for per operation behavior.
                                          	APIOptions []func(*middleware.Stack) error
                                          
                                          	// Configures the events that will be sent to the configured logger.
                                          	ClientLogMode aws.ClientLogMode
                                          
                                          	// The credentials object to use when signing requests.
                                          	Credentials aws.CredentialsProvider
                                          
                                          	// The endpoint options to be used when attempting to resolve an endpoint.
                                          	EndpointOptions EndpointResolverOptions
                                          
                                          	// The service endpoint resolver.
                                          	EndpointResolver EndpointResolver
                                          
                                          	// Signature Version 4 (SigV4) Signer
                                          	HTTPSignerV4 HTTPSignerV4
                                          
                                          	// The logger writer interface to write logging messages to.
                                          	Logger logging.Logger
                                          
                                          	// The region to send requests to. (Required)
                                          	Region string
                                          
                                          	// Retryer guides how HTTP requests should be retried in case of recoverable
                                          	// failures. When nil the API client will use a default retryer.
                                          	Retryer aws.Retryer
                                          
                                          	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                          	// implementation if nil.
                                          	HTTPClient HTTPClient
                                          }

                                          func (Options) Copy

                                          func (o Options) Copy() Options

                                            Copy creates a clone where the APIOptions list is deep copied.

                                            type PublishInput

                                            type PublishInput struct {
                                            
                                            	// The name of the MQTT topic.
                                            	//
                                            	// This member is required.
                                            	Topic *string
                                            
                                            	// The state information, in JSON format.
                                            	Payload []byte
                                            
                                            	// The Quality of Service (QoS) level.
                                            	Qos int32
                                            }

                                              The input for the Publish operation.

                                              type PublishOutput

                                              type PublishOutput struct {
                                              	// Metadata pertaining to the operation's result.
                                              	ResultMetadata middleware.Metadata
                                              }

                                              type ResolveEndpoint

                                              type ResolveEndpoint struct {
                                              	Resolver EndpointResolver
                                              	Options  EndpointResolverOptions
                                              }

                                              func (*ResolveEndpoint) HandleSerialize

                                              func (*ResolveEndpoint) ID

                                              func (*ResolveEndpoint) ID() string

                                              type UpdateThingShadowInput

                                              type UpdateThingShadowInput struct {
                                              
                                              	// The state information, in JSON format.
                                              	//
                                              	// This member is required.
                                              	Payload []byte
                                              
                                              	// The name of the thing.
                                              	//
                                              	// This member is required.
                                              	ThingName *string
                                              
                                              	// The name of the shadow.
                                              	ShadowName *string
                                              }

                                                The input for the UpdateThingShadow operation.

                                                type UpdateThingShadowOutput

                                                type UpdateThingShadowOutput struct {
                                                
                                                	// The state information, in JSON format.
                                                	Payload []byte
                                                
                                                	// Metadata pertaining to the operation's result.
                                                	ResultMetadata middleware.Metadata
                                                }

                                                  The output from the UpdateThingShadow operation.

                                                  Directories

                                                  Path Synopsis
                                                  internal