iotdataplane

package
v1.51.5 Latest Latest
Warning

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

 Go to latest Published: Mar 21, 2024 License: Apache-2.0 Imports: 9 Imported by: 44

Documentation

Overview

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

IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services 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 Amazon Web Services cloud.

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

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

The service name used by Amazon Web ServicesSignature 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 contact 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 IoTDataPlane for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iotdataplane/#New

Index

Examples

Constants

View Source 
const (
	// PayloadFormatIndicatorUnspecifiedBytes is a PayloadFormatIndicator enum value
	PayloadFormatIndicatorUnspecifiedBytes = "UNSPECIFIED_BYTES"

	// PayloadFormatIndicatorUtf8Data is a PayloadFormatIndicator enum value
	PayloadFormatIndicatorUtf8Data = "UTF8_DATA"
)
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"
)
View Source 
const (
	ServiceName = "data.iot"       // Name of service.
	EndpointsID = "data-ats.iot"   // ID to lookup a service endpoint with.
	ServiceID   = "IoT Data Plane" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func PayloadFormatIndicator_Values added in v1.44.146 

func PayloadFormatIndicator_Values() []string

PayloadFormatIndicator_Values returns all elements of the PayloadFormatIndicator enum

Types

type ConflictException added in v1.28.0 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified version does not match the version of the document.

func (*ConflictException) Code added in v1.28.0 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.28.0 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.28.0 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message added in v1.28.0 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.28.0 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.28.0 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.28.0 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String added in v1.28.0 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s DeleteThingShadowInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteThingShadowInput) SetShadowName added in v1.32.0 

func (s *DeleteThingShadowInput) SetShadowName(v string) *DeleteThingShadowInput

SetShadowName sets the ShadowName field's value.

func (*DeleteThingShadowInput) SetThingName added in v1.5.0 

func (s *DeleteThingShadowInput) SetThingName(v string) *DeleteThingShadowInput

SetThingName sets the ThingName field's value.

func (DeleteThingShadowInput) String 

func (s DeleteThingShadowInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteThingShadowInput) Validate added in v1.1.21 

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) GoString 

func (s DeleteThingShadowOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteThingShadowOutput) SetPayload added in v1.5.0 

func (s *DeleteThingShadowOutput) SetPayload(v []byte) *DeleteThingShadowOutput

SetPayload sets the Payload field's value.

func (DeleteThingShadowOutput) String 

func (s DeleteThingShadowOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetRetainedMessageInput added in v1.40.29 

type GetRetainedMessageInput struct {

	// The topic name of the retained message to retrieve.
	//
	// Topic is a required field
	Topic *string `location:"uri" locationName:"topic" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the GetRetainedMessage operation.

func (GetRetainedMessageInput) GoString added in v1.40.29 

func (s GetRetainedMessageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRetainedMessageInput) SetTopic added in v1.40.29 

func (s *GetRetainedMessageInput) SetTopic(v string) *GetRetainedMessageInput

SetTopic sets the Topic field's value.

func (GetRetainedMessageInput) String added in v1.40.29 

func (s GetRetainedMessageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRetainedMessageInput) Validate added in v1.40.29 

func (s *GetRetainedMessageInput) Validate() error

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

type GetRetainedMessageOutput added in v1.40.29 

type GetRetainedMessageOutput struct {

	// The Epoch date and time, in milliseconds, when the retained message was stored
	// by IoT.
	LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"`

	// The Base64-encoded message payload of the retained message body.
	// Payload is automatically base64 encoded/decoded by the SDK.
	Payload []byte `locationName:"payload" type:"blob"`

	// The quality of service (QoS) level used to publish the retained message.
	Qos *int64 `locationName:"qos" type:"integer"`

	// The topic name to which the retained message was published.
	Topic *string `locationName:"topic" type:"string"`

	// A base64-encoded JSON string that includes an array of JSON objects, or null
	// if the retained message doesn't include any user properties.
	//
	// The following example userProperties parameter is a JSON string that represents
	// two user properties. Note that it will be base64-encoded:
	//
	// [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
	// UserProperties is automatically base64 encoded/decoded by the SDK.
	UserProperties []byte `locationName:"userProperties" type:"blob"`
	// contains filtered or unexported fields
}

The output from the GetRetainedMessage operation.

func (GetRetainedMessageOutput) GoString added in v1.40.29 

func (s GetRetainedMessageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRetainedMessageOutput) SetLastModifiedTime added in v1.40.29 

func (s *GetRetainedMessageOutput) SetLastModifiedTime(v int64) *GetRetainedMessageOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*GetRetainedMessageOutput) SetPayload added in v1.40.29 

func (s *GetRetainedMessageOutput) SetPayload(v []byte) *GetRetainedMessageOutput

SetPayload sets the Payload field's value.

func (*GetRetainedMessageOutput) SetQos added in v1.40.29 

func (s *GetRetainedMessageOutput) SetQos(v int64) *GetRetainedMessageOutput

SetQos sets the Qos field's value.

func (*GetRetainedMessageOutput) SetTopic added in v1.40.29 

func (s *GetRetainedMessageOutput) SetTopic(v string) *GetRetainedMessageOutput

SetTopic sets the Topic field's value.

func (*GetRetainedMessageOutput) SetUserProperties added in v1.44.241 

func (s *GetRetainedMessageOutput) SetUserProperties(v []byte) *GetRetainedMessageOutput

SetUserProperties sets the UserProperties field's value.

func (GetRetainedMessageOutput) String added in v1.40.29 

func (s GetRetainedMessageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s GetThingShadowInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetThingShadowInput) SetShadowName added in v1.32.0 

func (s *GetThingShadowInput) SetShadowName(v string) *GetThingShadowInput

SetShadowName sets the ShadowName field's value.

func (*GetThingShadowInput) SetThingName added in v1.5.0 

func (s *GetThingShadowInput) SetThingName(v string) *GetThingShadowInput

SetThingName sets the ThingName field's value.

func (GetThingShadowInput) String 

func (s GetThingShadowInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetThingShadowInput) Validate added in v1.1.21 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetThingShadowOutput) SetPayload added in v1.5.0 

func (s *GetThingShadowOutput) SetPayload(v []byte) *GetThingShadowOutput

SetPayload sets the Payload field's value.

func (GetThingShadowOutput) String 

func (s GetThingShadowOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalFailureException added in v1.28.0 

type InternalFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An unexpected error has occurred.

func (*InternalFailureException) Code added in v1.28.0 

func (s *InternalFailureException) Code() string

Code returns the exception type name.

func (*InternalFailureException) Error added in v1.28.0 

func (s *InternalFailureException) Error() string

func (InternalFailureException) GoString added in v1.28.0 

func (s InternalFailureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalFailureException) Message added in v1.28.0 

func (s *InternalFailureException) Message() string

Message returns the exception's message.

func (*InternalFailureException) OrigErr added in v1.28.0 

func (s *InternalFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailureException) RequestID added in v1.28.0 

func (s *InternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailureException) StatusCode added in v1.28.0 

func (s *InternalFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalFailureException) String added in v1.28.0 

func (s InternalFailureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidRequestException added in v1.28.0 

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request is not valid.

func (*InvalidRequestException) Code added in v1.28.0 

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error added in v1.28.0 

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString added in v1.28.0 

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message added in v1.28.0 

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr added in v1.28.0 

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID added in v1.28.0 

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode added in v1.28.0 

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String added in v1.28.0 

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IoTDataPlane 

type IoTDataPlane struct {
	*client.Client
}

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

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

Example (DescribeEndpoint) 
package main

import (
	"fmt"
	"log"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/iot"
	"github.com/aws/aws-sdk-go/service/iotdataplane"
)

func main() {
	sess, err := session.NewSession(aws.NewConfig())
	if err != nil {
		log.Fatal("Failed to create aws session", err)
	}

	// we need to use an IoT control plane client to get an endpoint address
	ctrlSvc := iot.New(sess)
	descResp, err := ctrlSvc.DescribeEndpoint(&iot.DescribeEndpointInput{})
	if err != nil {
		log.Fatal("failed to get dataplane endpoint", err)
	}

	// create a IoT data plane client using the endpoint address we retrieved
	dataSvc := iotdataplane.New(sess, &aws.Config{
		Endpoint: descResp.EndpointAddress,
	})
	output, err := dataSvc.GetThingShadow(&iotdataplane.GetThingShadowInput{
		// specify a ThingName
		ThingName: aws.String("fake-thing"),
	})
	// prints the string representation of GetThingShadowOutput
	fmt.Println(output.GoString())
}

Output:

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: 

mySession := session.Must(session.NewSession())

// 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)

DeleteThingShadow API operation for AWS IoT Data Plane.

Deletes the shadow for the specified thing.

Requires permission to access the DeleteThingShadow (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

For more information, see DeleteThingShadow (http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html) in the IoT Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Data Plane's API operation DeleteThingShadow for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • MethodNotAllowedException The specified combination of HTTP verb and URI is not supported.

  • UnsupportedDocumentEncodingException The document encoding is not supported.

func (*IoTDataPlane) DeleteThingShadowRequest 

func (c *IoTDataPlane) DeleteThingShadowRequest(input *DeleteThingShadowInput) (req *request.Request, output *DeleteThingShadowOutput)

DeleteThingShadowRequest generates a "aws/request.Request" representing the client's request for the DeleteThingShadow operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteThingShadow for more information on using the DeleteThingShadow API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteThingShadowRequest method.
req, resp := client.DeleteThingShadowRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoTDataPlane) DeleteThingShadowWithContext added in v1.8.0 

func (c *IoTDataPlane) DeleteThingShadowWithContext(ctx aws.Context, input *DeleteThingShadowInput, opts ...request.Option) (*DeleteThingShadowOutput, error)

DeleteThingShadowWithContext is the same as DeleteThingShadow with the addition of the ability to pass a context and additional request options.

See DeleteThingShadow for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDataPlane) GetRetainedMessage added in v1.40.29 

func (c *IoTDataPlane) GetRetainedMessage(input *GetRetainedMessageInput) (*GetRetainedMessageOutput, error)

GetRetainedMessage API operation for AWS IoT Data Plane.

Gets the details of a single retained message for the specified topic.

This action returns the message payload of the retained message, which can incur messaging costs. To list only the topic names of the retained messages, call ListRetainedMessages (https://docs.aws.amazon.com/iot/latest/apireference/API_iotdata_ListRetainedMessages.html).

Requires permission to access the GetRetainedMessage (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions) action.

For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging (http://aws.amazon.com/iot-core/pricing/#Messaging).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Data Plane's API operation GetRetainedMessage for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • MethodNotAllowedException The specified combination of HTTP verb and URI is not supported.

func (*IoTDataPlane) GetRetainedMessageRequest added in v1.40.29 

func (c *IoTDataPlane) GetRetainedMessageRequest(input *GetRetainedMessageInput) (req *request.Request, output *GetRetainedMessageOutput)

GetRetainedMessageRequest generates a "aws/request.Request" representing the client's request for the GetRetainedMessage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRetainedMessage for more information on using the GetRetainedMessage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetRetainedMessageRequest method.
req, resp := client.GetRetainedMessageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoTDataPlane) GetRetainedMessageWithContext added in v1.40.29 

func (c *IoTDataPlane) GetRetainedMessageWithContext(ctx aws.Context, input *GetRetainedMessageInput, opts ...request.Option) (*GetRetainedMessageOutput, error)

GetRetainedMessageWithContext is the same as GetRetainedMessage with the addition of the ability to pass a context and additional request options.

See GetRetainedMessage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDataPlane) GetThingShadow 

func (c *IoTDataPlane) GetThingShadow(input *GetThingShadowInput) (*GetThingShadowOutput, error)

GetThingShadow API operation for AWS IoT Data Plane.

Gets the shadow for the specified thing.

Requires permission to access the GetThingShadow (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

For more information, see GetThingShadow (http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html) in the IoT Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Data Plane's API operation GetThingShadow for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • MethodNotAllowedException The specified combination of HTTP verb and URI is not supported.

  • UnsupportedDocumentEncodingException The document encoding is not supported.

func (*IoTDataPlane) GetThingShadowRequest 

func (c *IoTDataPlane) GetThingShadowRequest(input *GetThingShadowInput) (req *request.Request, output *GetThingShadowOutput)

GetThingShadowRequest generates a "aws/request.Request" representing the client's request for the GetThingShadow operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetThingShadow for more information on using the GetThingShadow API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetThingShadowRequest method.
req, resp := client.GetThingShadowRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoTDataPlane) GetThingShadowWithContext added in v1.8.0 

func (c *IoTDataPlane) GetThingShadowWithContext(ctx aws.Context, input *GetThingShadowInput, opts ...request.Option) (*GetThingShadowOutput, error)

GetThingShadowWithContext is the same as GetThingShadow with the addition of the ability to pass a context and additional request options.

See GetThingShadow for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDataPlane) ListNamedShadowsForThing added in v1.32.0 

func (c *IoTDataPlane) ListNamedShadowsForThing(input *ListNamedShadowsForThingInput) (*ListNamedShadowsForThingOutput, error)

ListNamedShadowsForThing API operation for AWS IoT Data Plane.

Lists the shadows for the specified thing.

Requires permission to access the ListNamedShadowsForThing (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Data Plane's API operation ListNamedShadowsForThing for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource does not exist.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • MethodNotAllowedException The specified combination of HTTP verb and URI is not supported.

func (*IoTDataPlane) ListNamedShadowsForThingRequest added in v1.32.0 

func (c *IoTDataPlane) ListNamedShadowsForThingRequest(input *ListNamedShadowsForThingInput) (req *request.Request, output *ListNamedShadowsForThingOutput)

ListNamedShadowsForThingRequest generates a "aws/request.Request" representing the client's request for the ListNamedShadowsForThing operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListNamedShadowsForThing for more information on using the ListNamedShadowsForThing API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListNamedShadowsForThingRequest method.
req, resp := client.ListNamedShadowsForThingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoTDataPlane) ListNamedShadowsForThingWithContext added in v1.32.0 

func (c *IoTDataPlane) ListNamedShadowsForThingWithContext(ctx aws.Context, input *ListNamedShadowsForThingInput, opts ...request.Option) (*ListNamedShadowsForThingOutput, error)

ListNamedShadowsForThingWithContext is the same as ListNamedShadowsForThing with the addition of the ability to pass a context and additional request options.

See ListNamedShadowsForThing for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDataPlane) ListRetainedMessages added in v1.40.29 

func (c *IoTDataPlane) ListRetainedMessages(input *ListRetainedMessagesInput) (*ListRetainedMessagesOutput, error)

ListRetainedMessages API operation for AWS IoT Data Plane.

Lists summary information about the retained messages stored for the account.

This action returns only the topic names of the retained messages. It doesn't return any message payloads. Although this action doesn't return a message payload, it can still incur messaging costs.

To get the message payload of a retained message, call GetRetainedMessage (https://docs.aws.amazon.com/iot/latest/apireference/API_iotdata_GetRetainedMessage.html) with the topic name of the retained message.

Requires permission to access the ListRetainedMessages (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions) action.

For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging (http://aws.amazon.com/iot-core/pricing/#Messaging).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Data Plane's API operation ListRetainedMessages for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • MethodNotAllowedException The specified combination of HTTP verb and URI is not supported.

func (*IoTDataPlane) ListRetainedMessagesPages added in v1.40.29 

func (c *IoTDataPlane) ListRetainedMessagesPages(input *ListRetainedMessagesInput, fn func(*ListRetainedMessagesOutput, bool) bool) error

ListRetainedMessagesPages iterates over the pages of a ListRetainedMessages operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListRetainedMessages method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListRetainedMessages operation.
pageNum := 0
err := client.ListRetainedMessagesPages(params,
    func(page *iotdataplane.ListRetainedMessagesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTDataPlane) ListRetainedMessagesPagesWithContext added in v1.40.29 

func (c *IoTDataPlane) ListRetainedMessagesPagesWithContext(ctx aws.Context, input *ListRetainedMessagesInput, fn func(*ListRetainedMessagesOutput, bool) bool, opts ...request.Option) error

ListRetainedMessagesPagesWithContext same as ListRetainedMessagesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDataPlane) ListRetainedMessagesRequest added in v1.40.29 

func (c *IoTDataPlane) ListRetainedMessagesRequest(input *ListRetainedMessagesInput) (req *request.Request, output *ListRetainedMessagesOutput)

ListRetainedMessagesRequest generates a "aws/request.Request" representing the client's request for the ListRetainedMessages operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRetainedMessages for more information on using the ListRetainedMessages API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListRetainedMessagesRequest method.
req, resp := client.ListRetainedMessagesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoTDataPlane) ListRetainedMessagesWithContext added in v1.40.29 

func (c *IoTDataPlane) ListRetainedMessagesWithContext(ctx aws.Context, input *ListRetainedMessagesInput, opts ...request.Option) (*ListRetainedMessagesOutput, error)

ListRetainedMessagesWithContext is the same as ListRetainedMessages with the addition of the ability to pass a context and additional request options.

See ListRetainedMessages for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDataPlane) Publish 

func (c *IoTDataPlane) Publish(input *PublishInput) (*PublishOutput, error)

Publish API operation for AWS IoT Data Plane.

Publishes an MQTT message.

Requires permission to access the Publish (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

For more information about MQTT messages, see MQTT Protocol (http://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html) in the IoT Developer Guide.

For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging (http://aws.amazon.com/iot-core/pricing/#Messaging).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Data Plane's API operation Publish for usage and error information.

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • UnauthorizedException You are not authorized to perform this operation.

  • MethodNotAllowedException The specified combination of HTTP verb and URI is not supported.

  • ThrottlingException The rate exceeds the limit.

func (*IoTDataPlane) PublishRequest 

func (c *IoTDataPlane) PublishRequest(input *PublishInput) (req *request.Request, output *PublishOutput)

PublishRequest generates a "aws/request.Request" representing the client's request for the Publish operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See Publish for more information on using the Publish API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PublishRequest method.
req, resp := client.PublishRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoTDataPlane) PublishWithContext added in v1.8.0 

func (c *IoTDataPlane) PublishWithContext(ctx aws.Context, input *PublishInput, opts ...request.Option) (*PublishOutput, error)

PublishWithContext is the same as Publish with the addition of the ability to pass a context and additional request options.

See Publish for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDataPlane) UpdateThingShadow 

func (c *IoTDataPlane) UpdateThingShadow(input *UpdateThingShadowInput) (*UpdateThingShadowOutput, error)

UpdateThingShadow API operation for AWS IoT Data Plane.

Updates the shadow for the specified thing.

Requires permission to access the UpdateThingShadow (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

For more information, see UpdateThingShadow (http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html) in the IoT Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Data Plane's API operation UpdateThingShadow for usage and error information.

Returned Error Types:

  • ConflictException The specified version does not match the version of the document.

  • RequestEntityTooLargeException The payload exceeds the maximum size allowed.

  • InvalidRequestException The request is not valid.

  • ThrottlingException The rate exceeds the limit.

  • UnauthorizedException You are not authorized to perform this operation.

  • ServiceUnavailableException The service is temporarily unavailable.

  • InternalFailureException An unexpected error has occurred.

  • MethodNotAllowedException The specified combination of HTTP verb and URI is not supported.

  • UnsupportedDocumentEncodingException The document encoding is not supported.

func (*IoTDataPlane) UpdateThingShadowRequest 

func (c *IoTDataPlane) UpdateThingShadowRequest(input *UpdateThingShadowInput) (req *request.Request, output *UpdateThingShadowOutput)

UpdateThingShadowRequest generates a "aws/request.Request" representing the client's request for the UpdateThingShadow operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateThingShadow for more information on using the UpdateThingShadow API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateThingShadowRequest method.
req, resp := client.UpdateThingShadowRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*IoTDataPlane) UpdateThingShadowWithContext added in v1.8.0 

func (c *IoTDataPlane) UpdateThingShadowWithContext(ctx aws.Context, input *UpdateThingShadowInput, opts ...request.Option) (*UpdateThingShadowOutput, error)

UpdateThingShadowWithContext is the same as UpdateThingShadow with the addition of the ability to pass a context and additional request options.

See UpdateThingShadow for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ListNamedShadowsForThingInput added in v1.32.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) GoString added in v1.32.0 

func (s ListNamedShadowsForThingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListNamedShadowsForThingInput) SetNextToken added in v1.32.0 

func (s *ListNamedShadowsForThingInput) SetNextToken(v string) *ListNamedShadowsForThingInput

SetNextToken sets the NextToken field's value.

func (*ListNamedShadowsForThingInput) SetPageSize added in v1.32.0 

func (s *ListNamedShadowsForThingInput) SetPageSize(v int64) *ListNamedShadowsForThingInput

SetPageSize sets the PageSize field's value.

func (*ListNamedShadowsForThingInput) SetThingName added in v1.32.0 

func (s *ListNamedShadowsForThingInput) SetThingName(v string) *ListNamedShadowsForThingInput

SetThingName sets the ThingName field's value.

func (ListNamedShadowsForThingInput) String added in v1.32.0 

func (s ListNamedShadowsForThingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListNamedShadowsForThingInput) Validate added in v1.32.0 

func (s *ListNamedShadowsForThingInput) Validate() error

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

type ListNamedShadowsForThingOutput added in v1.32.0 

type ListNamedShadowsForThingOutput struct {

	// The token to use to get 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 IoT.
	Timestamp *int64 `locationName:"timestamp" type:"long"`
	// contains filtered or unexported fields
}

func (ListNamedShadowsForThingOutput) GoString added in v1.32.0 

func (s ListNamedShadowsForThingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListNamedShadowsForThingOutput) SetNextToken added in v1.32.0 

func (s *ListNamedShadowsForThingOutput) SetNextToken(v string) *ListNamedShadowsForThingOutput

SetNextToken sets the NextToken field's value.

func (*ListNamedShadowsForThingOutput) SetResults added in v1.32.0 

func (s *ListNamedShadowsForThingOutput) SetResults(v []*string) *ListNamedShadowsForThingOutput

SetResults sets the Results field's value.

func (*ListNamedShadowsForThingOutput) SetTimestamp added in v1.32.0 

func (s *ListNamedShadowsForThingOutput) SetTimestamp(v int64) *ListNamedShadowsForThingOutput

SetTimestamp sets the Timestamp field's value.

func (ListNamedShadowsForThingOutput) String added in v1.32.0 

func (s ListNamedShadowsForThingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListRetainedMessagesInput added in v1.40.29 

type ListRetainedMessagesInput struct {

	// The maximum number of results to return at one time.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// To retrieve the next set of results, the nextToken value from a previous
	// response; otherwise null to receive the first set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListRetainedMessagesInput) GoString added in v1.40.29 

func (s ListRetainedMessagesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRetainedMessagesInput) SetMaxResults added in v1.40.29 

func (s *ListRetainedMessagesInput) SetMaxResults(v int64) *ListRetainedMessagesInput

SetMaxResults sets the MaxResults field's value.

func (*ListRetainedMessagesInput) SetNextToken added in v1.40.29 

func (s *ListRetainedMessagesInput) SetNextToken(v string) *ListRetainedMessagesInput

SetNextToken sets the NextToken field's value.

func (ListRetainedMessagesInput) String added in v1.40.29 

func (s ListRetainedMessagesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRetainedMessagesInput) Validate added in v1.40.29 

func (s *ListRetainedMessagesInput) Validate() error

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

type ListRetainedMessagesOutput added in v1.40.29 

type ListRetainedMessagesOutput struct {

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

	// A summary list the account's retained messages. The information returned
	// doesn't include the message payloads of the retained messages.
	RetainedTopics []*RetainedMessageSummary `locationName:"retainedTopics" type:"list"`
	// contains filtered or unexported fields
}

func (ListRetainedMessagesOutput) GoString added in v1.40.29 

func (s ListRetainedMessagesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRetainedMessagesOutput) SetNextToken added in v1.40.29 

func (s *ListRetainedMessagesOutput) SetNextToken(v string) *ListRetainedMessagesOutput

SetNextToken sets the NextToken field's value.

func (*ListRetainedMessagesOutput) SetRetainedTopics added in v1.40.29 

func (s *ListRetainedMessagesOutput) SetRetainedTopics(v []*RetainedMessageSummary) *ListRetainedMessagesOutput

SetRetainedTopics sets the RetainedTopics field's value.

func (ListRetainedMessagesOutput) String added in v1.40.29 

func (s ListRetainedMessagesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MethodNotAllowedException added in v1.28.0 

type MethodNotAllowedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified combination of HTTP verb and URI is not supported.

func (*MethodNotAllowedException) Code added in v1.28.0 

func (s *MethodNotAllowedException) Code() string

Code returns the exception type name.

func (*MethodNotAllowedException) Error added in v1.28.0 

func (s *MethodNotAllowedException) Error() string

func (MethodNotAllowedException) GoString added in v1.28.0 

func (s MethodNotAllowedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MethodNotAllowedException) Message added in v1.28.0 

func (s *MethodNotAllowedException) Message() string

Message returns the exception's message.

func (*MethodNotAllowedException) OrigErr added in v1.28.0 

func (s *MethodNotAllowedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MethodNotAllowedException) RequestID added in v1.28.0 

func (s *MethodNotAllowedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MethodNotAllowedException) StatusCode added in v1.28.0 

func (s *MethodNotAllowedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MethodNotAllowedException) String added in v1.28.0 

func (s MethodNotAllowedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PublishInput 

type PublishInput struct {

	// A UTF-8 encoded string that describes the content of the publishing message.
	ContentType *string `location:"querystring" locationName:"contentType" type:"string"`

	// The base64-encoded binary data used by the sender of the request message
	// to identify which request the response message is for when it's received.
	// correlationData is an HTTP header value in the API.
	CorrelationData *string `location:"header" locationName:"x-amz-mqtt5-correlation-data" type:"string"`

	// A user-defined integer value that represents the message expiry interval
	// in seconds. If absent, the message doesn't expire. For more information about
	// the limits of messageExpiry, see Amazon Web Services IoT Core message broker
	// and protocol limits and quotas (https://docs.aws.amazon.com/general/latest/gr/iot-core.html#message-broker-limits)
	// from the Amazon Web Services Reference Guide.
	MessageExpiry *int64 `location:"querystring" locationName:"messageExpiry" type:"long"`

	// The message body. MQTT accepts text, binary, and empty (null) message payloads.
	//
	// Publishing an empty (null) payload with retain = true deletes the retained
	// message identified by topic from Amazon Web Services IoT Core.
	Payload []byte `locationName:"payload" type:"blob"`

	// An Enum string value that indicates whether the payload is formatted as UTF-8.
	// payloadFormatIndicator is an HTTP header value in the API.
	PayloadFormatIndicator *string `location:"header" locationName:"x-amz-mqtt5-payload-format-indicator" type:"string" enum:"PayloadFormatIndicator"`

	// The Quality of Service (QoS) level. The default QoS level is 0.
	Qos *int64 `location:"querystring" locationName:"qos" type:"integer"`

	// A UTF-8 encoded string that's used as the topic name for a response message.
	// The response topic is used to describe the topic which the receiver should
	// publish to as part of the request-response flow. The topic must not contain
	// wildcard characters.
	ResponseTopic *string `location:"querystring" locationName:"responseTopic" type:"string"`

	// A Boolean value that determines whether to set the RETAIN flag when the message
	// is published.
	//
	// Setting the RETAIN flag causes the message to be retained and sent to new
	// subscribers to the topic.
	//
	// Valid values: true | false
	//
	// Default value: false
	Retain *bool `location:"querystring" locationName:"retain" type:"boolean"`

	// The name of the MQTT topic.
	//
	// Topic is a required field
	Topic *string `location:"uri" locationName:"topic" type:"string" required:"true"`

	// A JSON string that contains an array of JSON objects. If you don’t use
	// Amazon Web Services SDK or CLI, you must encode the JSON string to base64
	// format before adding it to the HTTP header. userProperties is an HTTP header
	// value in the API.
	//
	// The following example userProperties parameter is a JSON string which represents
	// two User Properties. Note that it needs to be base64-encoded:
	//
	// [{"deviceName": "alpha"}, {"deviceCnt": "45"}]
	UserProperties *string `location:"header" locationName:"x-amz-mqtt5-user-properties" type:"string" suppressedJSONValue:"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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PublishInput) SetContentType added in v1.44.146 

func (s *PublishInput) SetContentType(v string) *PublishInput

SetContentType sets the ContentType field's value.

func (*PublishInput) SetCorrelationData added in v1.44.146 

func (s *PublishInput) SetCorrelationData(v string) *PublishInput

SetCorrelationData sets the CorrelationData field's value.

func (*PublishInput) SetMessageExpiry added in v1.44.146 

func (s *PublishInput) SetMessageExpiry(v int64) *PublishInput

SetMessageExpiry sets the MessageExpiry field's value.

func (*PublishInput) SetPayload added in v1.5.0 

func (s *PublishInput) SetPayload(v []byte) *PublishInput

SetPayload sets the Payload field's value.

func (*PublishInput) SetPayloadFormatIndicator added in v1.44.146 

func (s *PublishInput) SetPayloadFormatIndicator(v string) *PublishInput

SetPayloadFormatIndicator sets the PayloadFormatIndicator field's value.

func (*PublishInput) SetQos added in v1.5.0 

func (s *PublishInput) SetQos(v int64) *PublishInput

SetQos sets the Qos field's value.

func (*PublishInput) SetResponseTopic added in v1.44.146 

func (s *PublishInput) SetResponseTopic(v string) *PublishInput

SetResponseTopic sets the ResponseTopic field's value.

func (*PublishInput) SetRetain added in v1.40.29 

func (s *PublishInput) SetRetain(v bool) *PublishInput

SetRetain sets the Retain field's value.

func (*PublishInput) SetTopic added in v1.5.0 

func (s *PublishInput) SetTopic(v string) *PublishInput

SetTopic sets the Topic field's value.

func (*PublishInput) SetUserProperties added in v1.44.146 

func (s *PublishInput) SetUserProperties(v string) *PublishInput

SetUserProperties sets the UserProperties field's value.

func (PublishInput) String 

func (s PublishInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PublishInput) Validate added in v1.1.21 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PublishOutput) String 

func (s PublishOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RequestEntityTooLargeException added in v1.28.0 

type RequestEntityTooLargeException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The payload exceeds the maximum size allowed.

func (*RequestEntityTooLargeException) Code added in v1.28.0 

func (s *RequestEntityTooLargeException) Code() string

Code returns the exception type name.

func (*RequestEntityTooLargeException) Error added in v1.28.0 

func (s *RequestEntityTooLargeException) Error() string

func (RequestEntityTooLargeException) GoString added in v1.28.0 

func (s RequestEntityTooLargeException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RequestEntityTooLargeException) Message added in v1.28.0 

func (s *RequestEntityTooLargeException) Message() string

Message returns the exception's message.

func (*RequestEntityTooLargeException) OrigErr added in v1.28.0 

func (s *RequestEntityTooLargeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RequestEntityTooLargeException) RequestID added in v1.28.0 

func (s *RequestEntityTooLargeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RequestEntityTooLargeException) StatusCode added in v1.28.0 

func (s *RequestEntityTooLargeException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (RequestEntityTooLargeException) String added in v1.28.0 

func (s RequestEntityTooLargeException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource does not exist.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RetainedMessageSummary added in v1.40.29 

type RetainedMessageSummary struct {

	// The Epoch date and time, in milliseconds, when the retained message was stored
	// by IoT.
	LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"`

	// The size of the retained message's payload in bytes.
	PayloadSize *int64 `locationName:"payloadSize" type:"long"`

	// The quality of service (QoS) level used to publish the retained message.
	Qos *int64 `locationName:"qos" type:"integer"`

	// The topic name to which the retained message was published.
	Topic *string `locationName:"topic" type:"string"`
	// contains filtered or unexported fields
}

Information about a single retained message.

func (RetainedMessageSummary) GoString added in v1.40.29 

func (s RetainedMessageSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetainedMessageSummary) SetLastModifiedTime added in v1.40.29 

func (s *RetainedMessageSummary) SetLastModifiedTime(v int64) *RetainedMessageSummary

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*RetainedMessageSummary) SetPayloadSize added in v1.40.29 

func (s *RetainedMessageSummary) SetPayloadSize(v int64) *RetainedMessageSummary

SetPayloadSize sets the PayloadSize field's value.

func (*RetainedMessageSummary) SetQos added in v1.40.29 

func (s *RetainedMessageSummary) SetQos(v int64) *RetainedMessageSummary

SetQos sets the Qos field's value.

func (*RetainedMessageSummary) SetTopic added in v1.40.29 

func (s *RetainedMessageSummary) SetTopic(v string) *RetainedMessageSummary

SetTopic sets the Topic field's value.

func (RetainedMessageSummary) String added in v1.40.29 

func (s RetainedMessageSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceUnavailableException added in v1.28.0 

type ServiceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The service is temporarily unavailable.

func (*ServiceUnavailableException) Code added in v1.28.0 

func (s *ServiceUnavailableException) Code() string

Code returns the exception type name.

func (*ServiceUnavailableException) Error added in v1.28.0 

func (s *ServiceUnavailableException) Error() string

func (ServiceUnavailableException) GoString added in v1.28.0 

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceUnavailableException) Message added in v1.28.0 

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr added in v1.28.0 

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID added in v1.28.0 

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode added in v1.28.0 

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String added in v1.28.0 

func (s ServiceUnavailableException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException added in v1.28.0 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The rate exceeds the limit.

func (*ThrottlingException) Code added in v1.28.0 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error added in v1.28.0 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString added in v1.28.0 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message added in v1.28.0 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr added in v1.28.0 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID added in v1.28.0 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode added in v1.28.0 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String added in v1.28.0 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnauthorizedException added in v1.28.0 

type UnauthorizedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You are not authorized to perform this operation.

func (*UnauthorizedException) Code added in v1.28.0 

func (s *UnauthorizedException) Code() string

Code returns the exception type name.

func (*UnauthorizedException) Error added in v1.28.0 

func (s *UnauthorizedException) Error() string

func (UnauthorizedException) GoString added in v1.28.0 

func (s UnauthorizedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnauthorizedException) Message added in v1.28.0 

func (s *UnauthorizedException) Message() string

Message returns the exception's message.

func (*UnauthorizedException) OrigErr added in v1.28.0 

func (s *UnauthorizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthorizedException) RequestID added in v1.28.0 

func (s *UnauthorizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthorizedException) StatusCode added in v1.28.0 

func (s *UnauthorizedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnauthorizedException) String added in v1.28.0 

func (s UnauthorizedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnsupportedDocumentEncodingException added in v1.28.0 

type UnsupportedDocumentEncodingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The message for the exception.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The document encoding is not supported.

func (*UnsupportedDocumentEncodingException) Code added in v1.28.0 

func (s *UnsupportedDocumentEncodingException) Code() string

Code returns the exception type name.

func (*UnsupportedDocumentEncodingException) Error added in v1.28.0 

func (s *UnsupportedDocumentEncodingException) Error() string

func (UnsupportedDocumentEncodingException) GoString added in v1.28.0 

func (s UnsupportedDocumentEncodingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnsupportedDocumentEncodingException) Message added in v1.28.0 

func (s *UnsupportedDocumentEncodingException) Message() string

Message returns the exception's message.

func (*UnsupportedDocumentEncodingException) OrigErr added in v1.28.0 

func (s *UnsupportedDocumentEncodingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedDocumentEncodingException) RequestID added in v1.28.0 

func (s *UnsupportedDocumentEncodingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedDocumentEncodingException) StatusCode added in v1.28.0 

func (s *UnsupportedDocumentEncodingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnsupportedDocumentEncodingException) String added in v1.28.0 

func (s UnsupportedDocumentEncodingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s UpdateThingShadowInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateThingShadowInput) SetPayload added in v1.5.0 

func (s *UpdateThingShadowInput) SetPayload(v []byte) *UpdateThingShadowInput

SetPayload sets the Payload field's value.

func (*UpdateThingShadowInput) SetShadowName added in v1.32.0 

func (s *UpdateThingShadowInput) SetShadowName(v string) *UpdateThingShadowInput

SetShadowName sets the ShadowName field's value.

func (*UpdateThingShadowInput) SetThingName added in v1.5.0 

func (s *UpdateThingShadowInput) SetThingName(v string) *UpdateThingShadowInput

SetThingName sets the ThingName field's value.

func (UpdateThingShadowInput) String 

func (s UpdateThingShadowInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateThingShadowInput) Validate added in v1.1.21 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateThingShadowOutput) SetPayload added in v1.5.0 

func (s *UpdateThingShadowOutput) SetPayload(v []byte) *UpdateThingShadowOutput

SetPayload sets the Payload field's value.

func (UpdateThingShadowOutput) String 

func (s UpdateThingShadowOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.