iot1clickdevicesservice

package
v1.0.1 Latest Latest
Warning

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

 Go to latest Published: Jul 4, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package iot1clickdevicesservice provides the client and types for making API requests to AWS IoT 1-Click Devices Service.

Describes all of the AWS IoT 1-Click device-related API operations for the service. Also provides sample requests, responses, and errors for the supported web services protocols.

See https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14 for more information on this service.

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

Using the Client

To contact AWS IoT 1-Click Devices Service 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 1-Click Devices Service client IoT1ClickDevicesService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iot1clickdevicesservice/#New

Index

Constants

View Source 
const (

	// ErrCodeForbiddenException for service response error code
	// "ForbiddenException".
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	ErrCodeInternalFailureException = "InternalFailureException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodePreconditionFailedException for service response error code
	// "PreconditionFailedException".
	ErrCodePreconditionFailedException = "PreconditionFailedException"

	// ErrCodeRangeNotSatisfiableException for service response error code
	// "RangeNotSatisfiableException".
	ErrCodeRangeNotSatisfiableException = "RangeNotSatisfiableException"

	// ErrCodeResourceConflictException for service response error code
	// "ResourceConflictException".
	ErrCodeResourceConflictException = "ResourceConflictException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source 
const (
	ServiceName = "devices.iot1click"          // Name of service.
	EndpointsID = ServiceName                  // ID to lookup a service endpoint with.
	ServiceID   = "IoT 1Click Devices Service" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type Attributes 

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

func (Attributes) GoString 

func (s Attributes) 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 (Attributes) String 

func (s Attributes) 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 ClaimDevicesByClaimCodeInput 

type ClaimDevicesByClaimCodeInput struct {

	// ClaimCode is a required field
	ClaimCode *string `location:"uri" locationName:"claimCode" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ClaimDevicesByClaimCodeInput) GoString 

func (s ClaimDevicesByClaimCodeInput) 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 (*ClaimDevicesByClaimCodeInput) SetClaimCode 

func (s *ClaimDevicesByClaimCodeInput) SetClaimCode(v string) *ClaimDevicesByClaimCodeInput

SetClaimCode sets the ClaimCode field's value.

func (ClaimDevicesByClaimCodeInput) String 

func (s ClaimDevicesByClaimCodeInput) 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 (*ClaimDevicesByClaimCodeInput) Validate 

func (s *ClaimDevicesByClaimCodeInput) Validate() error

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

type ClaimDevicesByClaimCodeOutput 

type ClaimDevicesByClaimCodeOutput struct {

	// The claim code provided by the device manufacturer.
	ClaimCode *string `locationName:"claimCode" min:"12" type:"string"`

	// The total number of devices associated with the claim code that has been
	// processed in the claim request.
	Total *int64 `locationName:"total" type:"integer"`
	// contains filtered or unexported fields
}

func (ClaimDevicesByClaimCodeOutput) GoString 

func (s ClaimDevicesByClaimCodeOutput) 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 (*ClaimDevicesByClaimCodeOutput) SetClaimCode 

func (s *ClaimDevicesByClaimCodeOutput) SetClaimCode(v string) *ClaimDevicesByClaimCodeOutput

SetClaimCode sets the ClaimCode field's value.

func (*ClaimDevicesByClaimCodeOutput) SetTotal 

func (s *ClaimDevicesByClaimCodeOutput) SetTotal(v int64) *ClaimDevicesByClaimCodeOutput

SetTotal sets the Total field's value.

func (ClaimDevicesByClaimCodeOutput) String 

func (s ClaimDevicesByClaimCodeOutput) 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 DescribeDeviceInput 

type DescribeDeviceInput struct {

	// DeviceId is a required field
	DeviceId *string `location:"uri" locationName:"deviceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDeviceInput) GoString 

func (s DescribeDeviceInput) 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 (*DescribeDeviceInput) SetDeviceId 

func (s *DescribeDeviceInput) SetDeviceId(v string) *DescribeDeviceInput

SetDeviceId sets the DeviceId field's value.

func (DescribeDeviceInput) String 

func (s DescribeDeviceInput) 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 (*DescribeDeviceInput) Validate 

func (s *DescribeDeviceInput) Validate() error

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

type DescribeDeviceOutput 

type DescribeDeviceOutput struct {

	// Device details.
	DeviceDescription *DeviceDescription `locationName:"deviceDescription" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDeviceOutput) GoString 

func (s DescribeDeviceOutput) 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 (*DescribeDeviceOutput) SetDeviceDescription 

func (s *DescribeDeviceOutput) SetDeviceDescription(v *DeviceDescription) *DescribeDeviceOutput

SetDeviceDescription sets the DeviceDescription field's value.

func (DescribeDeviceOutput) String 

func (s DescribeDeviceOutput) 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 Device 

type Device struct {

	// The user specified attributes associated with the device for an event.
	Attributes *Attributes `locationName:"attributes" type:"structure"`

	// The unique identifier of the device.
	DeviceId *string `locationName:"deviceId" type:"string"`

	// The device type, such as "button".
	Type *string `locationName:"type" type:"string"`
	// contains filtered or unexported fields
}

func (Device) GoString 

func (s Device) 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 (*Device) SetAttributes 

func (s *Device) SetAttributes(v *Attributes) *Device

SetAttributes sets the Attributes field's value.

func (*Device) SetDeviceId 

func (s *Device) SetDeviceId(v string) *Device

SetDeviceId sets the DeviceId field's value.

func (*Device) SetType 

func (s *Device) SetType(v string) *Device

SetType sets the Type field's value.

func (Device) String 

func (s Device) 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 DeviceDescription 

type DeviceDescription struct {

	// The ARN of the device.
	Arn *string `locationName:"arn" type:"string"`

	// An array of zero or more elements of DeviceAttribute objects providing user
	// specified device attributes.
	Attributes map[string]*string `locationName:"attributes" type:"map"`

	// The unique identifier of the device.
	DeviceId *string `locationName:"deviceId" type:"string"`

	// A Boolean value indicating whether or not the device is enabled.
	Enabled *bool `locationName:"enabled" type:"boolean"`

	// A value between 0 and 1 inclusive, representing the fraction of life remaining
	// for the device.
	RemainingLife *float64 `locationName:"remainingLife" type:"double"`

	Tags map[string]*string `locationName:"tags" type:"map"`

	// The type of the device, such as "button".
	Type *string `locationName:"type" type:"string"`
	// contains filtered or unexported fields
}

func (DeviceDescription) GoString 

func (s DeviceDescription) 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 (*DeviceDescription) SetArn 

func (s *DeviceDescription) SetArn(v string) *DeviceDescription

SetArn sets the Arn field's value.

func (*DeviceDescription) SetAttributes 

func (s *DeviceDescription) SetAttributes(v map[string]*string) *DeviceDescription

SetAttributes sets the Attributes field's value.

func (*DeviceDescription) SetDeviceId 

func (s *DeviceDescription) SetDeviceId(v string) *DeviceDescription

SetDeviceId sets the DeviceId field's value.

func (*DeviceDescription) SetEnabled 

func (s *DeviceDescription) SetEnabled(v bool) *DeviceDescription

SetEnabled sets the Enabled field's value.

func (*DeviceDescription) SetRemainingLife 

func (s *DeviceDescription) SetRemainingLife(v float64) *DeviceDescription

SetRemainingLife sets the RemainingLife field's value.

func (*DeviceDescription) SetTags 

func (s *DeviceDescription) SetTags(v map[string]*string) *DeviceDescription

SetTags sets the Tags field's value.

func (*DeviceDescription) SetType 

func (s *DeviceDescription) SetType(v string) *DeviceDescription

SetType sets the Type field's value.

func (DeviceDescription) String 

func (s DeviceDescription) 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 DeviceEvent 

type DeviceEvent struct {

	// An object representing the device associated with the event.
	Device *Device `locationName:"device" type:"structure"`

	// A serialized JSON object representing the device-type specific event.
	StdEvent *string `locationName:"stdEvent" type:"string"`
	// contains filtered or unexported fields
}

func (DeviceEvent) GoString 

func (s DeviceEvent) 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 (*DeviceEvent) SetDevice 

func (s *DeviceEvent) SetDevice(v *Device) *DeviceEvent

SetDevice sets the Device field's value.

func (*DeviceEvent) SetStdEvent 

func (s *DeviceEvent) SetStdEvent(v string) *DeviceEvent

SetStdEvent sets the StdEvent field's value.

func (DeviceEvent) String 

func (s DeviceEvent) 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 DeviceMethod 

type DeviceMethod struct {

	// The type of the device, such as "button".
	DeviceType *string `locationName:"deviceType" type:"string"`

	// The name of the method applicable to the deviceType.
	MethodName *string `locationName:"methodName" type:"string"`
	// contains filtered or unexported fields
}

func (DeviceMethod) GoString 

func (s DeviceMethod) 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 (*DeviceMethod) SetDeviceType 

func (s *DeviceMethod) SetDeviceType(v string) *DeviceMethod

SetDeviceType sets the DeviceType field's value.

func (*DeviceMethod) SetMethodName 

func (s *DeviceMethod) SetMethodName(v string) *DeviceMethod

SetMethodName sets the MethodName field's value.

func (DeviceMethod) String 

func (s DeviceMethod) 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 FinalizeDeviceClaimInput 

type FinalizeDeviceClaimInput struct {

	// DeviceId is a required field
	DeviceId *string `location:"uri" locationName:"deviceId" type:"string" required:"true"`

	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (FinalizeDeviceClaimInput) GoString 

func (s FinalizeDeviceClaimInput) 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 (*FinalizeDeviceClaimInput) SetDeviceId 

func (s *FinalizeDeviceClaimInput) SetDeviceId(v string) *FinalizeDeviceClaimInput

SetDeviceId sets the DeviceId field's value.

func (*FinalizeDeviceClaimInput) SetTags 

func (s *FinalizeDeviceClaimInput) SetTags(v map[string]*string) *FinalizeDeviceClaimInput

SetTags sets the Tags field's value.

func (FinalizeDeviceClaimInput) String 

func (s FinalizeDeviceClaimInput) 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 (*FinalizeDeviceClaimInput) Validate 

func (s *FinalizeDeviceClaimInput) Validate() error

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

type FinalizeDeviceClaimOutput 

type FinalizeDeviceClaimOutput struct {
	State *string `locationName:"state" type:"string"`
	// contains filtered or unexported fields
}

func (FinalizeDeviceClaimOutput) GoString 

func (s FinalizeDeviceClaimOutput) 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 (*FinalizeDeviceClaimOutput) SetState 

func (s *FinalizeDeviceClaimOutput) SetState(v string) *FinalizeDeviceClaimOutput

SetState sets the State field's value.

func (FinalizeDeviceClaimOutput) String 

func (s FinalizeDeviceClaimOutput) 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 ForbiddenException 

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

	// 403
	Code_ *string `locationName:"code" type:"string"`

	// The 403 error message returned by the web server.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*ForbiddenException) Code 

func (s *ForbiddenException) Code() string

Code returns the exception type name.

func (*ForbiddenException) Error 

func (s *ForbiddenException) Error() string

func (ForbiddenException) GoString 

func (s ForbiddenException) 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 (*ForbiddenException) Message 

func (s *ForbiddenException) Message() string

Message returns the exception's message.

func (*ForbiddenException) OrigErr 

func (s *ForbiddenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ForbiddenException) RequestID 

func (s *ForbiddenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ForbiddenException) StatusCode 

func (s *ForbiddenException) StatusCode() int

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

func (ForbiddenException) String 

func (s ForbiddenException) 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 GetDeviceMethodsInput 

type GetDeviceMethodsInput struct {

	// DeviceId is a required field
	DeviceId *string `location:"uri" locationName:"deviceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDeviceMethodsInput) GoString 

func (s GetDeviceMethodsInput) 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 (*GetDeviceMethodsInput) SetDeviceId 

func (s *GetDeviceMethodsInput) SetDeviceId(v string) *GetDeviceMethodsInput

SetDeviceId sets the DeviceId field's value.

func (GetDeviceMethodsInput) String 

func (s GetDeviceMethodsInput) 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 (*GetDeviceMethodsInput) Validate 

func (s *GetDeviceMethodsInput) Validate() error

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

type GetDeviceMethodsOutput 

type GetDeviceMethodsOutput struct {

	// List of available device APIs.
	DeviceMethods []*DeviceMethod `locationName:"deviceMethods" type:"list"`
	// contains filtered or unexported fields
}

func (GetDeviceMethodsOutput) GoString 

func (s GetDeviceMethodsOutput) 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 (*GetDeviceMethodsOutput) SetDeviceMethods 

func (s *GetDeviceMethodsOutput) SetDeviceMethods(v []*DeviceMethod) *GetDeviceMethodsOutput

SetDeviceMethods sets the DeviceMethods field's value.

func (GetDeviceMethodsOutput) String 

func (s GetDeviceMethodsOutput) 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 InitiateDeviceClaimInput 

type InitiateDeviceClaimInput struct {

	// DeviceId is a required field
	DeviceId *string `location:"uri" locationName:"deviceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (InitiateDeviceClaimInput) GoString 

func (s InitiateDeviceClaimInput) 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 (*InitiateDeviceClaimInput) SetDeviceId 

func (s *InitiateDeviceClaimInput) SetDeviceId(v string) *InitiateDeviceClaimInput

SetDeviceId sets the DeviceId field's value.

func (InitiateDeviceClaimInput) String 

func (s InitiateDeviceClaimInput) 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 (*InitiateDeviceClaimInput) Validate 

func (s *InitiateDeviceClaimInput) Validate() error

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

type InitiateDeviceClaimOutput 

type InitiateDeviceClaimOutput struct {
	State *string `locationName:"state" type:"string"`
	// contains filtered or unexported fields
}

func (InitiateDeviceClaimOutput) GoString 

func (s InitiateDeviceClaimOutput) 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 (*InitiateDeviceClaimOutput) SetState 

func (s *InitiateDeviceClaimOutput) SetState(v string) *InitiateDeviceClaimOutput

SetState sets the State field's value.

func (InitiateDeviceClaimOutput) String 

func (s InitiateDeviceClaimOutput) 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 

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

	// 500
	Code_ *string `locationName:"code" type:"string"`

	// The 500 error message returned by the web server.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*InternalFailureException) Code 

func (s *InternalFailureException) Code() string

Code returns the exception type name.

func (*InternalFailureException) Error 

func (s *InternalFailureException) Error() string

func (InternalFailureException) GoString 

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 

func (s *InternalFailureException) Message() string

Message returns the exception's message.

func (*InternalFailureException) OrigErr 

func (s *InternalFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailureException) RequestID 

func (s *InternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailureException) StatusCode 

func (s *InternalFailureException) StatusCode() int

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

func (InternalFailureException) String 

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 

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

	// 400
	Code_ *string `locationName:"code" type:"string"`

	// The 400 error message returned by the web server.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*InvalidRequestException) Code 

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error 

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString 

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 

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr 

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID 

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode 

func (s *InvalidRequestException) StatusCode() int

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

func (InvalidRequestException) String 

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 InvokeDeviceMethodInput 

type InvokeDeviceMethodInput struct {

	// DeviceId is a required field
	DeviceId *string `location:"uri" locationName:"deviceId" type:"string" required:"true"`

	// The device method to invoke.
	DeviceMethod *DeviceMethod `locationName:"deviceMethod" type:"structure"`

	// A JSON encoded string containing the device method request parameters.
	DeviceMethodParameters *string `locationName:"deviceMethodParameters" type:"string"`
	// contains filtered or unexported fields
}

func (InvokeDeviceMethodInput) GoString 

func (s InvokeDeviceMethodInput) 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 (*InvokeDeviceMethodInput) SetDeviceId 

func (s *InvokeDeviceMethodInput) SetDeviceId(v string) *InvokeDeviceMethodInput

SetDeviceId sets the DeviceId field's value.

func (*InvokeDeviceMethodInput) SetDeviceMethod 

func (s *InvokeDeviceMethodInput) SetDeviceMethod(v *DeviceMethod) *InvokeDeviceMethodInput

SetDeviceMethod sets the DeviceMethod field's value.

func (*InvokeDeviceMethodInput) SetDeviceMethodParameters 

func (s *InvokeDeviceMethodInput) SetDeviceMethodParameters(v string) *InvokeDeviceMethodInput

SetDeviceMethodParameters sets the DeviceMethodParameters field's value.

func (InvokeDeviceMethodInput) String 

func (s InvokeDeviceMethodInput) 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 (*InvokeDeviceMethodInput) Validate 

func (s *InvokeDeviceMethodInput) Validate() error

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

type InvokeDeviceMethodOutput 

type InvokeDeviceMethodOutput struct {

	// A JSON encoded string containing the device method response.
	DeviceMethodResponse *string `locationName:"deviceMethodResponse" type:"string"`
	// contains filtered or unexported fields
}

func (InvokeDeviceMethodOutput) GoString 

func (s InvokeDeviceMethodOutput) 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 (*InvokeDeviceMethodOutput) SetDeviceMethodResponse 

func (s *InvokeDeviceMethodOutput) SetDeviceMethodResponse(v string) *InvokeDeviceMethodOutput

SetDeviceMethodResponse sets the DeviceMethodResponse field's value.

func (InvokeDeviceMethodOutput) String 

func (s InvokeDeviceMethodOutput) 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 IoT1ClickDevicesService 

type IoT1ClickDevicesService struct {
	*client.Client
}

IoT1ClickDevicesService provides the API operation methods for making requests to AWS IoT 1-Click Devices Service. See this package's package overview docs for details on the service.

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *IoT1ClickDevicesService

New creates a new instance of the IoT1ClickDevicesService 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 IoT1ClickDevicesService client from just a session.
svc := iot1clickdevicesservice.New(mySession)

// Create a IoT1ClickDevicesService client with additional configuration
svc := iot1clickdevicesservice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*IoT1ClickDevicesService) ClaimDevicesByClaimCode 

func (c *IoT1ClickDevicesService) ClaimDevicesByClaimCode(input *ClaimDevicesByClaimCodeInput) (*ClaimDevicesByClaimCodeOutput, error)

ClaimDevicesByClaimCode API operation for AWS IoT 1-Click Devices Service.

Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).

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 1-Click Devices Service's API operation ClaimDevicesByClaimCode for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • InternalFailureException

  • ForbiddenException

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ClaimDevicesByClaimCode

func (*IoT1ClickDevicesService) ClaimDevicesByClaimCodeRequest 

func (c *IoT1ClickDevicesService) ClaimDevicesByClaimCodeRequest(input *ClaimDevicesByClaimCodeInput) (req *request.Request, output *ClaimDevicesByClaimCodeOutput)

ClaimDevicesByClaimCodeRequest generates a "aws/request.Request" representing the client's request for the ClaimDevicesByClaimCode 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 ClaimDevicesByClaimCode for more information on using the ClaimDevicesByClaimCode 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 ClaimDevicesByClaimCodeRequest method.
req, resp := client.ClaimDevicesByClaimCodeRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ClaimDevicesByClaimCode

func (*IoT1ClickDevicesService) ClaimDevicesByClaimCodeWithContext 

func (c *IoT1ClickDevicesService) ClaimDevicesByClaimCodeWithContext(ctx aws.Context, input *ClaimDevicesByClaimCodeInput, opts ...request.Option) (*ClaimDevicesByClaimCodeOutput, error)

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

See ClaimDevicesByClaimCode 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 (*IoT1ClickDevicesService) DescribeDevice 

func (c *IoT1ClickDevicesService) DescribeDevice(input *DescribeDeviceInput) (*DescribeDeviceOutput, error)

DescribeDevice API operation for AWS IoT 1-Click Devices Service.

Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.

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 1-Click Devices Service's API operation DescribeDevice for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InvalidRequestException

  • InternalFailureException

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/DescribeDevice

func (*IoT1ClickDevicesService) DescribeDeviceRequest 

func (c *IoT1ClickDevicesService) DescribeDeviceRequest(input *DescribeDeviceInput) (req *request.Request, output *DescribeDeviceOutput)

DescribeDeviceRequest generates a "aws/request.Request" representing the client's request for the DescribeDevice 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 DescribeDevice for more information on using the DescribeDevice 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 DescribeDeviceRequest method.
req, resp := client.DescribeDeviceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/DescribeDevice

func (*IoT1ClickDevicesService) DescribeDeviceWithContext 

func (c *IoT1ClickDevicesService) DescribeDeviceWithContext(ctx aws.Context, input *DescribeDeviceInput, opts ...request.Option) (*DescribeDeviceOutput, error)

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

See DescribeDevice 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 (*IoT1ClickDevicesService) FinalizeDeviceClaim 

func (c *IoT1ClickDevicesService) FinalizeDeviceClaim(input *FinalizeDeviceClaimInput) (*FinalizeDeviceClaimOutput, error)

FinalizeDeviceClaim API operation for AWS IoT 1-Click Devices Service.

Given a device ID, finalizes the claim request for the associated device.

Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.

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 1-Click Devices Service's API operation FinalizeDeviceClaim for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InvalidRequestException

  • InternalFailureException

  • PreconditionFailedException

  • ResourceConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/FinalizeDeviceClaim

func (*IoT1ClickDevicesService) FinalizeDeviceClaimRequest 

func (c *IoT1ClickDevicesService) FinalizeDeviceClaimRequest(input *FinalizeDeviceClaimInput) (req *request.Request, output *FinalizeDeviceClaimOutput)

FinalizeDeviceClaimRequest generates a "aws/request.Request" representing the client's request for the FinalizeDeviceClaim 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 FinalizeDeviceClaim for more information on using the FinalizeDeviceClaim 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 FinalizeDeviceClaimRequest method.
req, resp := client.FinalizeDeviceClaimRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/FinalizeDeviceClaim

func (*IoT1ClickDevicesService) FinalizeDeviceClaimWithContext 

func (c *IoT1ClickDevicesService) FinalizeDeviceClaimWithContext(ctx aws.Context, input *FinalizeDeviceClaimInput, opts ...request.Option) (*FinalizeDeviceClaimOutput, error)

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

See FinalizeDeviceClaim 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 (*IoT1ClickDevicesService) GetDeviceMethods 

func (c *IoT1ClickDevicesService) GetDeviceMethods(input *GetDeviceMethodsInput) (*GetDeviceMethodsOutput, error)

GetDeviceMethods API operation for AWS IoT 1-Click Devices Service.

Given a device ID, returns the invokable methods associated with the device.

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 1-Click Devices Service's API operation GetDeviceMethods for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InvalidRequestException

  • InternalFailureException

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/GetDeviceMethods

func (*IoT1ClickDevicesService) GetDeviceMethodsRequest 

func (c *IoT1ClickDevicesService) GetDeviceMethodsRequest(input *GetDeviceMethodsInput) (req *request.Request, output *GetDeviceMethodsOutput)

GetDeviceMethodsRequest generates a "aws/request.Request" representing the client's request for the GetDeviceMethods 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 GetDeviceMethods for more information on using the GetDeviceMethods 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 GetDeviceMethodsRequest method.
req, resp := client.GetDeviceMethodsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/GetDeviceMethods

func (*IoT1ClickDevicesService) GetDeviceMethodsWithContext 

func (c *IoT1ClickDevicesService) GetDeviceMethodsWithContext(ctx aws.Context, input *GetDeviceMethodsInput, opts ...request.Option) (*GetDeviceMethodsOutput, error)

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

See GetDeviceMethods 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 (*IoT1ClickDevicesService) InitiateDeviceClaim 

func (c *IoT1ClickDevicesService) InitiateDeviceClaim(input *InitiateDeviceClaimInput) (*InitiateDeviceClaimOutput, error)

InitiateDeviceClaim API operation for AWS IoT 1-Click Devices Service.

Given a device ID, initiates a claim request for the associated device.

Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.

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 1-Click Devices Service's API operation InitiateDeviceClaim for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InvalidRequestException

  • InternalFailureException

  • ResourceConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/InitiateDeviceClaim

func (*IoT1ClickDevicesService) InitiateDeviceClaimRequest 

func (c *IoT1ClickDevicesService) InitiateDeviceClaimRequest(input *InitiateDeviceClaimInput) (req *request.Request, output *InitiateDeviceClaimOutput)

InitiateDeviceClaimRequest generates a "aws/request.Request" representing the client's request for the InitiateDeviceClaim 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 InitiateDeviceClaim for more information on using the InitiateDeviceClaim 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 InitiateDeviceClaimRequest method.
req, resp := client.InitiateDeviceClaimRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/InitiateDeviceClaim

func (*IoT1ClickDevicesService) InitiateDeviceClaimWithContext 

func (c *IoT1ClickDevicesService) InitiateDeviceClaimWithContext(ctx aws.Context, input *InitiateDeviceClaimInput, opts ...request.Option) (*InitiateDeviceClaimOutput, error)

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

See InitiateDeviceClaim 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 (*IoT1ClickDevicesService) InvokeDeviceMethod 

func (c *IoT1ClickDevicesService) InvokeDeviceMethod(input *InvokeDeviceMethodInput) (*InvokeDeviceMethodOutput, error)

InvokeDeviceMethod API operation for AWS IoT 1-Click Devices Service.

Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.

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 1-Click Devices Service's API operation InvokeDeviceMethod for usage and error information.

Returned Error Types:

  • InvalidRequestException

  • PreconditionFailedException

  • InternalFailureException

  • ResourceNotFoundException

  • RangeNotSatisfiableException

  • ResourceConflictException

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/InvokeDeviceMethod

func (*IoT1ClickDevicesService) InvokeDeviceMethodRequest 

func (c *IoT1ClickDevicesService) InvokeDeviceMethodRequest(input *InvokeDeviceMethodInput) (req *request.Request, output *InvokeDeviceMethodOutput)

InvokeDeviceMethodRequest generates a "aws/request.Request" representing the client's request for the InvokeDeviceMethod 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 InvokeDeviceMethod for more information on using the InvokeDeviceMethod 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 InvokeDeviceMethodRequest method.
req, resp := client.InvokeDeviceMethodRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/InvokeDeviceMethod

func (*IoT1ClickDevicesService) InvokeDeviceMethodWithContext 

func (c *IoT1ClickDevicesService) InvokeDeviceMethodWithContext(ctx aws.Context, input *InvokeDeviceMethodInput, opts ...request.Option) (*InvokeDeviceMethodOutput, error)

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

See InvokeDeviceMethod 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 (*IoT1ClickDevicesService) ListDeviceEvents 

func (c *IoT1ClickDevicesService) ListDeviceEvents(input *ListDeviceEventsInput) (*ListDeviceEventsOutput, error)

ListDeviceEvents API operation for AWS IoT 1-Click Devices Service.

Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.

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 1-Click Devices Service's API operation ListDeviceEvents for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • RangeNotSatisfiableException

  • InvalidRequestException

  • InternalFailureException

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ListDeviceEvents

func (*IoT1ClickDevicesService) ListDeviceEventsRequest 

func (c *IoT1ClickDevicesService) ListDeviceEventsRequest(input *ListDeviceEventsInput) (req *request.Request, output *ListDeviceEventsOutput)

ListDeviceEventsRequest generates a "aws/request.Request" representing the client's request for the ListDeviceEvents 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 ListDeviceEvents for more information on using the ListDeviceEvents 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 ListDeviceEventsRequest method.
req, resp := client.ListDeviceEventsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ListDeviceEvents

func (*IoT1ClickDevicesService) ListDeviceEventsWithContext 

func (c *IoT1ClickDevicesService) ListDeviceEventsWithContext(ctx aws.Context, input *ListDeviceEventsInput, opts ...request.Option) (*ListDeviceEventsOutput, error)

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

See ListDeviceEvents 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 (*IoT1ClickDevicesService) ListDevices 

func (c *IoT1ClickDevicesService) ListDevices(input *ListDevicesInput) (*ListDevicesOutput, error)

ListDevices API operation for AWS IoT 1-Click Devices Service.

Lists the 1-Click compatible devices associated with your AWS account.

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 1-Click Devices Service's API operation ListDevices for usage and error information.

Returned Error Types:

  • RangeNotSatisfiableException

  • InvalidRequestException

  • InternalFailureException

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ListDevices

func (*IoT1ClickDevicesService) ListDevicesRequest 

func (c *IoT1ClickDevicesService) ListDevicesRequest(input *ListDevicesInput) (req *request.Request, output *ListDevicesOutput)

ListDevicesRequest generates a "aws/request.Request" representing the client's request for the ListDevices 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 ListDevices for more information on using the ListDevices 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 ListDevicesRequest method.
req, resp := client.ListDevicesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ListDevices

func (*IoT1ClickDevicesService) ListDevicesWithContext 

func (c *IoT1ClickDevicesService) ListDevicesWithContext(ctx aws.Context, input *ListDevicesInput, opts ...request.Option) (*ListDevicesOutput, error)

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

See ListDevices 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 (*IoT1ClickDevicesService) ListTagsForResource 

func (c *IoT1ClickDevicesService) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS IoT 1-Click Devices Service.

Lists the tags associated with the specified resource ARN.

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 1-Click Devices Service's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InternalFailureException

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ListTagsForResource

func (*IoT1ClickDevicesService) ListTagsForResourceRequest 

func (c *IoT1ClickDevicesService) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource 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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ListTagsForResource

func (*IoT1ClickDevicesService) ListTagsForResourceWithContext 

func (c *IoT1ClickDevicesService) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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 (*IoT1ClickDevicesService) TagResource 

func (c *IoT1ClickDevicesService) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS IoT 1-Click Devices Service.

Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits (https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-appendix.html#1click-limits) for the maximum number of tags allowed per resource.

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 1-Click Devices Service's API operation TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InvalidRequestException

  • InternalFailureException

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/TagResource

func (*IoT1ClickDevicesService) TagResourceRequest 

func (c *IoT1ClickDevicesService) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource 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 TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/TagResource

func (*IoT1ClickDevicesService) TagResourceWithContext 

func (c *IoT1ClickDevicesService) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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 (*IoT1ClickDevicesService) UnclaimDevice 

func (c *IoT1ClickDevicesService) UnclaimDevice(input *UnclaimDeviceInput) (*UnclaimDeviceOutput, error)

UnclaimDevice API operation for AWS IoT 1-Click Devices Service.

Disassociates a device from your AWS account using its device ID.

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 1-Click Devices Service's API operation UnclaimDevice for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InvalidRequestException

  • InternalFailureException

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/UnclaimDevice

func (*IoT1ClickDevicesService) UnclaimDeviceRequest 

func (c *IoT1ClickDevicesService) UnclaimDeviceRequest(input *UnclaimDeviceInput) (req *request.Request, output *UnclaimDeviceOutput)

UnclaimDeviceRequest generates a "aws/request.Request" representing the client's request for the UnclaimDevice 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 UnclaimDevice for more information on using the UnclaimDevice 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 UnclaimDeviceRequest method.
req, resp := client.UnclaimDeviceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/UnclaimDevice

func (*IoT1ClickDevicesService) UnclaimDeviceWithContext 

func (c *IoT1ClickDevicesService) UnclaimDeviceWithContext(ctx aws.Context, input *UnclaimDeviceInput, opts ...request.Option) (*UnclaimDeviceOutput, error)

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

See UnclaimDevice 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 (*IoT1ClickDevicesService) UntagResource 

func (c *IoT1ClickDevicesService) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS IoT 1-Click Devices Service.

Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.

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 1-Click Devices Service's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InvalidRequestException

  • InternalFailureException

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/UntagResource

func (*IoT1ClickDevicesService) UntagResourceRequest 

func (c *IoT1ClickDevicesService) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource 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 UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/UntagResource

func (*IoT1ClickDevicesService) UntagResourceWithContext 

func (c *IoT1ClickDevicesService) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource 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 (*IoT1ClickDevicesService) UpdateDeviceState 

func (c *IoT1ClickDevicesService) UpdateDeviceState(input *UpdateDeviceStateInput) (*UpdateDeviceStateOutput, error)

UpdateDeviceState API operation for AWS IoT 1-Click Devices Service.

Using a Boolean value (true or false), this operation enables or disables the device given a device ID.

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 1-Click Devices Service's API operation UpdateDeviceState for usage and error information.

Returned Error Types:

  • ResourceNotFoundException

  • InvalidRequestException

  • InternalFailureException

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/UpdateDeviceState

func (*IoT1ClickDevicesService) UpdateDeviceStateRequest 

func (c *IoT1ClickDevicesService) UpdateDeviceStateRequest(input *UpdateDeviceStateInput) (req *request.Request, output *UpdateDeviceStateOutput)

UpdateDeviceStateRequest generates a "aws/request.Request" representing the client's request for the UpdateDeviceState 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 UpdateDeviceState for more information on using the UpdateDeviceState 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 UpdateDeviceStateRequest method.
req, resp := client.UpdateDeviceStateRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/UpdateDeviceState

func (*IoT1ClickDevicesService) UpdateDeviceStateWithContext 

func (c *IoT1ClickDevicesService) UpdateDeviceStateWithContext(ctx aws.Context, input *UpdateDeviceStateInput, opts ...request.Option) (*UpdateDeviceStateOutput, error)

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

See UpdateDeviceState 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 ListDeviceEventsInput 

type ListDeviceEventsInput struct {

	// DeviceId is a required field
	DeviceId *string `location:"uri" locationName:"deviceId" type:"string" required:"true"`

	// FromTimeStamp is a required field
	FromTimeStamp *time.Time `location:"querystring" locationName:"fromTimeStamp" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// ToTimeStamp is a required field
	ToTimeStamp *time.Time `location:"querystring" locationName:"toTimeStamp" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (ListDeviceEventsInput) GoString 

func (s ListDeviceEventsInput) 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 (*ListDeviceEventsInput) SetDeviceId 

func (s *ListDeviceEventsInput) SetDeviceId(v string) *ListDeviceEventsInput

SetDeviceId sets the DeviceId field's value.

func (*ListDeviceEventsInput) SetFromTimeStamp 

func (s *ListDeviceEventsInput) SetFromTimeStamp(v time.Time) *ListDeviceEventsInput

SetFromTimeStamp sets the FromTimeStamp field's value.

func (*ListDeviceEventsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDeviceEventsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListDeviceEventsInput) SetToTimeStamp 

func (s *ListDeviceEventsInput) SetToTimeStamp(v time.Time) *ListDeviceEventsInput

SetToTimeStamp sets the ToTimeStamp field's value.

func (ListDeviceEventsInput) String 

func (s ListDeviceEventsInput) 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 (*ListDeviceEventsInput) Validate 

func (s *ListDeviceEventsInput) Validate() error

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

type ListDeviceEventsOutput 

type ListDeviceEventsOutput struct {
	Events []*DeviceEvent `locationName:"events" type:"list"`

	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDeviceEventsOutput) GoString 

func (s ListDeviceEventsOutput) 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 (*ListDeviceEventsOutput) SetEvents 

func (s *ListDeviceEventsOutput) SetEvents(v []*DeviceEvent) *ListDeviceEventsOutput

SetEvents sets the Events field's value.

func (*ListDeviceEventsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDeviceEventsOutput) String 

func (s ListDeviceEventsOutput) 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 ListDevicesInput 

type ListDevicesInput struct {
	DeviceType *string `location:"querystring" locationName:"deviceType" type:"string"`

	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDevicesInput) GoString 

func (s ListDevicesInput) 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 (*ListDevicesInput) SetDeviceType 

func (s *ListDevicesInput) SetDeviceType(v string) *ListDevicesInput

SetDeviceType sets the DeviceType field's value.

func (*ListDevicesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDevicesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDevicesInput) String 

func (s ListDevicesInput) 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 (*ListDevicesInput) Validate 

func (s *ListDevicesInput) Validate() error

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

type ListDevicesOutput 

type ListDevicesOutput struct {

	// A list of devices.
	Devices []*DeviceDescription `locationName:"devices" type:"list"`

	// The token to retrieve the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDevicesOutput) GoString 

func (s ListDevicesOutput) 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 (*ListDevicesOutput) SetDevices 

func (s *ListDevicesOutput) SetDevices(v []*DeviceDescription) *ListDevicesOutput

SetDevices sets the Devices field's value.

func (*ListDevicesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDevicesOutput) String 

func (s ListDevicesOutput) 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 ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) 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 (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) 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 (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) 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 (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) 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 PreconditionFailedException 

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

	// 412
	Code_ *string `locationName:"code" type:"string"`

	// An error message explaining the error or its remedy.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*PreconditionFailedException) Code 

func (s *PreconditionFailedException) Code() string

Code returns the exception type name.

func (*PreconditionFailedException) Error 

func (s *PreconditionFailedException) Error() string

func (PreconditionFailedException) GoString 

func (s PreconditionFailedException) 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 (*PreconditionFailedException) Message 

func (s *PreconditionFailedException) Message() string

Message returns the exception's message.

func (*PreconditionFailedException) OrigErr 

func (s *PreconditionFailedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*PreconditionFailedException) RequestID 

func (s *PreconditionFailedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*PreconditionFailedException) StatusCode 

func (s *PreconditionFailedException) StatusCode() int

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

func (PreconditionFailedException) String 

func (s PreconditionFailedException) 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 RangeNotSatisfiableException 

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

	// 416
	Code_ *string `locationName:"code" type:"string"`

	// The requested number of results specified by nextToken cannot be satisfied.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*RangeNotSatisfiableException) Code 

func (s *RangeNotSatisfiableException) Code() string

Code returns the exception type name.

func (*RangeNotSatisfiableException) Error 

func (s *RangeNotSatisfiableException) Error() string

func (RangeNotSatisfiableException) GoString 

func (s RangeNotSatisfiableException) 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 (*RangeNotSatisfiableException) Message 

func (s *RangeNotSatisfiableException) Message() string

Message returns the exception's message.

func (*RangeNotSatisfiableException) OrigErr 

func (s *RangeNotSatisfiableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RangeNotSatisfiableException) RequestID 

func (s *RangeNotSatisfiableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RangeNotSatisfiableException) StatusCode 

func (s *RangeNotSatisfiableException) StatusCode() int

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

func (RangeNotSatisfiableException) String 

func (s RangeNotSatisfiableException) 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 ResourceConflictException 

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

	// 409
	Code_ *string `locationName:"code" type:"string"`

	// An error message explaining the error or its remedy.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*ResourceConflictException) Code 

func (s *ResourceConflictException) Code() string

Code returns the exception type name.

func (*ResourceConflictException) Error 

func (s *ResourceConflictException) Error() string

func (ResourceConflictException) GoString 

func (s ResourceConflictException) 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 (*ResourceConflictException) Message 

func (s *ResourceConflictException) Message() string

Message returns the exception's message.

func (*ResourceConflictException) OrigErr 

func (s *ResourceConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceConflictException) RequestID 

func (s *ResourceConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceConflictException) StatusCode 

func (s *ResourceConflictException) StatusCode() int

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

func (ResourceConflictException) String 

func (s ResourceConflictException) 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 

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

	// 404
	Code_ *string `locationName:"code" type:"string"`

	// The requested device could not be found.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

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 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String 

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 TagResourceInput 

type TagResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"`

	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

func (s TagResourceInput) 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 (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) 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 (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput 

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

func (TagResourceOutput) GoString 

func (s TagResourceOutput) 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 (TagResourceOutput) String 

func (s TagResourceOutput) 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 UnclaimDeviceInput 

type UnclaimDeviceInput struct {

	// DeviceId is a required field
	DeviceId *string `location:"uri" locationName:"deviceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UnclaimDeviceInput) GoString 

func (s UnclaimDeviceInput) 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 (*UnclaimDeviceInput) SetDeviceId 

func (s *UnclaimDeviceInput) SetDeviceId(v string) *UnclaimDeviceInput

SetDeviceId sets the DeviceId field's value.

func (UnclaimDeviceInput) String 

func (s UnclaimDeviceInput) 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 (*UnclaimDeviceInput) Validate 

func (s *UnclaimDeviceInput) Validate() error

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

type UnclaimDeviceOutput 

type UnclaimDeviceOutput struct {
	State *string `locationName:"state" type:"string"`
	// contains filtered or unexported fields
}

func (UnclaimDeviceOutput) GoString 

func (s UnclaimDeviceOutput) 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 (*UnclaimDeviceOutput) SetState 

func (s *UnclaimDeviceOutput) SetState(v string) *UnclaimDeviceOutput

SetState sets the State field's value.

func (UnclaimDeviceOutput) String 

func (s UnclaimDeviceOutput) 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 UntagResourceInput 

type UntagResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"`

	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) 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 (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) 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 (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput 

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

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) 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 (UntagResourceOutput) String 

func (s UntagResourceOutput) 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 UpdateDeviceStateInput 

type UpdateDeviceStateInput struct {

	// DeviceId is a required field
	DeviceId *string `location:"uri" locationName:"deviceId" type:"string" required:"true"`

	// If true, the device is enabled. If false, the device is disabled.
	Enabled *bool `locationName:"enabled" type:"boolean"`
	// contains filtered or unexported fields
}

func (UpdateDeviceStateInput) GoString 

func (s UpdateDeviceStateInput) 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 (*UpdateDeviceStateInput) SetDeviceId 

func (s *UpdateDeviceStateInput) SetDeviceId(v string) *UpdateDeviceStateInput

SetDeviceId sets the DeviceId field's value.

func (*UpdateDeviceStateInput) SetEnabled 

func (s *UpdateDeviceStateInput) SetEnabled(v bool) *UpdateDeviceStateInput

SetEnabled sets the Enabled field's value.

func (UpdateDeviceStateInput) String 

func (s UpdateDeviceStateInput) 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 (*UpdateDeviceStateInput) Validate 

func (s *UpdateDeviceStateInput) Validate() error

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

type UpdateDeviceStateOutput 

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

func (UpdateDeviceStateOutput) GoString 

func (s UpdateDeviceStateOutput) 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 (UpdateDeviceStateOutput) String 

func (s UpdateDeviceStateOutput) 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 iot1clickdevicesserviceiface provides an interface to enable mocking the AWS IoT 1-Click Devices Service service client for testing your code.
 Package iot1clickdevicesserviceiface provides an interface to enable mocking the AWS IoT 1-Click Devices Service 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.