iot1clickdevicesservice

package
v2.0.0-preview.4+incom... Latest Latest
Warning

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

 Go to latest Published: May 26, 2018 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

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

Stub description

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 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" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName         // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type Attributes 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/Attributes

func (Attributes) GoString 

func (s Attributes) GoString() string

GoString returns the string representation

func (Attributes) MarshalFields 

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

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

func (Attributes) String 

func (s Attributes) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ClaimDevicesByClaimCodeRequest

func (ClaimDevicesByClaimCodeInput) GoString 

func (s ClaimDevicesByClaimCodeInput) GoString() string

GoString returns the string representation

func (ClaimDevicesByClaimCodeInput) MarshalFields 

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

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

func (ClaimDevicesByClaimCodeInput) String 

func (s ClaimDevicesByClaimCodeInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ClaimDevicesByClaimCodeResponse

func (ClaimDevicesByClaimCodeOutput) GoString 

func (s ClaimDevicesByClaimCodeOutput) GoString() string

GoString returns the string representation

func (ClaimDevicesByClaimCodeOutput) MarshalFields 

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

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

func (ClaimDevicesByClaimCodeOutput) SDKResponseMetadata 

func (s ClaimDevicesByClaimCodeOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ClaimDevicesByClaimCodeOutput) String 

func (s ClaimDevicesByClaimCodeOutput) String() string

String returns the string representation

type ClaimDevicesByClaimCodeRequest 

type ClaimDevicesByClaimCodeRequest struct {
	*aws.Request
	Input *ClaimDevicesByClaimCodeInput
	Copy  func(*ClaimDevicesByClaimCodeInput) ClaimDevicesByClaimCodeRequest
}

ClaimDevicesByClaimCodeRequest is a API request type for the ClaimDevicesByClaimCode API operation.

func (ClaimDevicesByClaimCodeRequest) Send 

func (r ClaimDevicesByClaimCodeRequest) Send() (*ClaimDevicesByClaimCodeOutput, error)

Send marshals and sends the ClaimDevicesByClaimCode API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/DescribeDeviceRequest

func (DescribeDeviceInput) GoString 

func (s DescribeDeviceInput) GoString() string

GoString returns the string representation

func (DescribeDeviceInput) MarshalFields 

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

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

func (DescribeDeviceInput) String 

func (s DescribeDeviceInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/DescribeDeviceResponse

func (DescribeDeviceOutput) GoString 

func (s DescribeDeviceOutput) GoString() string

GoString returns the string representation

func (DescribeDeviceOutput) MarshalFields 

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

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

func (DescribeDeviceOutput) SDKResponseMetadata 

func (s DescribeDeviceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeDeviceOutput) String 

func (s DescribeDeviceOutput) String() string

String returns the string representation

type DescribeDeviceRequest 

type DescribeDeviceRequest struct {
	*aws.Request
	Input *DescribeDeviceInput
	Copy  func(*DescribeDeviceInput) DescribeDeviceRequest
}

DescribeDeviceRequest is a API request type for the DescribeDevice API operation.

func (DescribeDeviceRequest) Send 

func (r DescribeDeviceRequest) Send() (*DescribeDeviceOutput, error)

Send marshals and sends the DescribeDevice API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/Device

func (Device) GoString 

func (s Device) GoString() string

GoString returns the string representation

func (Device) MarshalFields 

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

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

func (Device) String 

func (s Device) String() string

String returns the string representation

type DeviceDescription 

type DeviceDescription struct {

	// 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"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/DeviceDescription

func (DeviceDescription) GoString 

func (s DeviceDescription) GoString() string

GoString returns the string representation

func (DeviceDescription) MarshalFields 

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

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

func (DeviceDescription) String 

func (s DeviceDescription) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/DeviceEvent

func (DeviceEvent) GoString 

func (s DeviceEvent) GoString() string

GoString returns the string representation

func (DeviceEvent) MarshalFields 

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

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

func (DeviceEvent) String 

func (s DeviceEvent) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/DeviceMethod

func (DeviceMethod) GoString 

func (s DeviceMethod) GoString() string

GoString returns the string representation

func (DeviceMethod) MarshalFields 

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

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

func (DeviceMethod) String 

func (s DeviceMethod) String() string

String returns the string representation

type FinalizeDeviceClaimInput 

type FinalizeDeviceClaimInput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/FinalizeDeviceClaimRequest

func (FinalizeDeviceClaimInput) GoString 

func (s FinalizeDeviceClaimInput) GoString() string

GoString returns the string representation

func (FinalizeDeviceClaimInput) MarshalFields 

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

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

func (FinalizeDeviceClaimInput) String 

func (s FinalizeDeviceClaimInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/FinalizeDeviceClaimResponse

func (FinalizeDeviceClaimOutput) GoString 

func (s FinalizeDeviceClaimOutput) GoString() string

GoString returns the string representation

func (FinalizeDeviceClaimOutput) MarshalFields 

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

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

func (FinalizeDeviceClaimOutput) SDKResponseMetadata 

func (s FinalizeDeviceClaimOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (FinalizeDeviceClaimOutput) String 

func (s FinalizeDeviceClaimOutput) String() string

String returns the string representation

type FinalizeDeviceClaimRequest 

type FinalizeDeviceClaimRequest struct {
	*aws.Request
	Input *FinalizeDeviceClaimInput
	Copy  func(*FinalizeDeviceClaimInput) FinalizeDeviceClaimRequest
}

FinalizeDeviceClaimRequest is a API request type for the FinalizeDeviceClaim API operation.

func (FinalizeDeviceClaimRequest) Send 

func (r FinalizeDeviceClaimRequest) Send() (*FinalizeDeviceClaimOutput, error)

Send marshals and sends the FinalizeDeviceClaim API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/GetDeviceMethodsRequest

func (GetDeviceMethodsInput) GoString 

func (s GetDeviceMethodsInput) GoString() string

GoString returns the string representation

func (GetDeviceMethodsInput) MarshalFields 

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

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

func (GetDeviceMethodsInput) String 

func (s GetDeviceMethodsInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/GetDeviceMethodsResponse

func (GetDeviceMethodsOutput) GoString 

func (s GetDeviceMethodsOutput) GoString() string

GoString returns the string representation

func (GetDeviceMethodsOutput) MarshalFields 

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

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

func (GetDeviceMethodsOutput) SDKResponseMetadata 

func (s GetDeviceMethodsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetDeviceMethodsOutput) String 

func (s GetDeviceMethodsOutput) String() string

String returns the string representation

type GetDeviceMethodsRequest 

type GetDeviceMethodsRequest struct {
	*aws.Request
	Input *GetDeviceMethodsInput
	Copy  func(*GetDeviceMethodsInput) GetDeviceMethodsRequest
}

GetDeviceMethodsRequest is a API request type for the GetDeviceMethods API operation.

func (GetDeviceMethodsRequest) Send 

func (r GetDeviceMethodsRequest) Send() (*GetDeviceMethodsOutput, error)

Send marshals and sends the GetDeviceMethods API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/InitiateDeviceClaimRequest

func (InitiateDeviceClaimInput) GoString 

func (s InitiateDeviceClaimInput) GoString() string

GoString returns the string representation

func (InitiateDeviceClaimInput) MarshalFields 

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

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

func (InitiateDeviceClaimInput) String 

func (s InitiateDeviceClaimInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/InitiateDeviceClaimResponse

func (InitiateDeviceClaimOutput) GoString 

func (s InitiateDeviceClaimOutput) GoString() string

GoString returns the string representation

func (InitiateDeviceClaimOutput) MarshalFields 

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

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

func (InitiateDeviceClaimOutput) SDKResponseMetadata 

func (s InitiateDeviceClaimOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (InitiateDeviceClaimOutput) String 

func (s InitiateDeviceClaimOutput) String() string

String returns the string representation

type InitiateDeviceClaimRequest 

type InitiateDeviceClaimRequest struct {
	*aws.Request
	Input *InitiateDeviceClaimInput
	Copy  func(*InitiateDeviceClaimInput) InitiateDeviceClaimRequest
}

InitiateDeviceClaimRequest is a API request type for the InitiateDeviceClaim API operation.

func (InitiateDeviceClaimRequest) Send 

func (r InitiateDeviceClaimRequest) Send() (*InitiateDeviceClaimOutput, error)

Send marshals and sends the InitiateDeviceClaim API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/InvokeDeviceMethodRequest

func (InvokeDeviceMethodInput) GoString 

func (s InvokeDeviceMethodInput) GoString() string

GoString returns the string representation

func (InvokeDeviceMethodInput) MarshalFields 

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

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

func (InvokeDeviceMethodInput) String 

func (s InvokeDeviceMethodInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/InvokeDeviceMethodResponse

func (InvokeDeviceMethodOutput) GoString 

func (s InvokeDeviceMethodOutput) GoString() string

GoString returns the string representation

func (InvokeDeviceMethodOutput) MarshalFields 

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

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

func (InvokeDeviceMethodOutput) SDKResponseMetadata 

func (s InvokeDeviceMethodOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (InvokeDeviceMethodOutput) String 

func (s InvokeDeviceMethodOutput) String() string

String returns the string representation

type InvokeDeviceMethodRequest 

type InvokeDeviceMethodRequest struct {
	*aws.Request
	Input *InvokeDeviceMethodInput
	Copy  func(*InvokeDeviceMethodInput) InvokeDeviceMethodRequest
}

InvokeDeviceMethodRequest is a API request type for the InvokeDeviceMethod API operation.

func (InvokeDeviceMethodRequest) Send 

func (r InvokeDeviceMethodRequest) Send() (*InvokeDeviceMethodOutput, error)

Send marshals and sends the InvokeDeviceMethod API request.

type IoT1ClickDevicesService 

type IoT1ClickDevicesService struct {
	*aws.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(config aws.Config) *IoT1ClickDevicesService

New creates a new instance of the IoT1ClickDevicesService client with a config.

Example: 

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

func (*IoT1ClickDevicesService) ClaimDevicesByClaimCodeRequest 

func (c *IoT1ClickDevicesService) ClaimDevicesByClaimCodeRequest(input *ClaimDevicesByClaimCodeInput) ClaimDevicesByClaimCodeRequest

ClaimDevicesByClaimCodeRequest returns a request value for making 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). 

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

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

func (*IoT1ClickDevicesService) DescribeDeviceRequest 

func (c *IoT1ClickDevicesService) DescribeDeviceRequest(input *DescribeDeviceInput) DescribeDeviceRequest

DescribeDeviceRequest returns a request value for making API operation for AWS IoT 1-Click Devices Service.

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

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

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

func (*IoT1ClickDevicesService) FinalizeDeviceClaimRequest 

func (c *IoT1ClickDevicesService) FinalizeDeviceClaimRequest(input *FinalizeDeviceClaimInput) FinalizeDeviceClaimRequest

FinalizeDeviceClaimRequest returns a request value for making 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. 

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

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

func (*IoT1ClickDevicesService) GetDeviceMethodsRequest 

func (c *IoT1ClickDevicesService) GetDeviceMethodsRequest(input *GetDeviceMethodsInput) GetDeviceMethodsRequest

GetDeviceMethodsRequest returns a request value for making API operation for AWS IoT 1-Click Devices Service.

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

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

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

func (*IoT1ClickDevicesService) InitiateDeviceClaimRequest 

func (c *IoT1ClickDevicesService) InitiateDeviceClaimRequest(input *InitiateDeviceClaimInput) InitiateDeviceClaimRequest

InitiateDeviceClaimRequest returns a request value for making 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. 

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

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

func (*IoT1ClickDevicesService) InvokeDeviceMethodRequest 

func (c *IoT1ClickDevicesService) InvokeDeviceMethodRequest(input *InvokeDeviceMethodInput) InvokeDeviceMethodRequest

InvokeDeviceMethodRequest returns a request value for making 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. 

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

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

func (*IoT1ClickDevicesService) ListDeviceEventsRequest 

func (c *IoT1ClickDevicesService) ListDeviceEventsRequest(input *ListDeviceEventsInput) ListDeviceEventsRequest

ListDeviceEventsRequest returns a request value for making 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. 

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

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

func (*IoT1ClickDevicesService) ListDevicesRequest 

func (c *IoT1ClickDevicesService) ListDevicesRequest(input *ListDevicesInput) ListDevicesRequest

ListDevicesRequest returns a request value for making API operation for AWS IoT 1-Click Devices Service.

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

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

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

func (*IoT1ClickDevicesService) UnclaimDeviceRequest 

func (c *IoT1ClickDevicesService) UnclaimDeviceRequest(input *UnclaimDeviceInput) UnclaimDeviceRequest

UnclaimDeviceRequest returns a request value for making API operation for AWS IoT 1-Click Devices Service.

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

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

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

func (*IoT1ClickDevicesService) UpdateDeviceStateRequest 

func (c *IoT1ClickDevicesService) UpdateDeviceStateRequest(input *UpdateDeviceStateInput) UpdateDeviceStateRequest

UpdateDeviceStateRequest returns a request value for making 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. 

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

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

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:"unix" 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:"unix" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ListDeviceEventsRequest

func (ListDeviceEventsInput) GoString 

func (s ListDeviceEventsInput) GoString() string

GoString returns the string representation

func (ListDeviceEventsInput) MarshalFields 

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

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

func (ListDeviceEventsInput) String 

func (s ListDeviceEventsInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ListDeviceEventsResponse

func (ListDeviceEventsOutput) GoString 

func (s ListDeviceEventsOutput) GoString() string

GoString returns the string representation

func (ListDeviceEventsOutput) MarshalFields 

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

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

func (ListDeviceEventsOutput) SDKResponseMetadata 

func (s ListDeviceEventsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListDeviceEventsOutput) String 

func (s ListDeviceEventsOutput) String() string

String returns the string representation

type ListDeviceEventsRequest 

type ListDeviceEventsRequest struct {
	*aws.Request
	Input *ListDeviceEventsInput
	Copy  func(*ListDeviceEventsInput) ListDeviceEventsRequest
}

ListDeviceEventsRequest is a API request type for the ListDeviceEvents API operation.

func (ListDeviceEventsRequest) Send 

func (r ListDeviceEventsRequest) Send() (*ListDeviceEventsOutput, error)

Send marshals and sends the ListDeviceEvents API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ListDevicesRequest

func (ListDevicesInput) GoString 

func (s ListDevicesInput) GoString() string

GoString returns the string representation

func (ListDevicesInput) MarshalFields 

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

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

func (ListDevicesInput) String 

func (s ListDevicesInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/ListDevicesResponse

func (ListDevicesOutput) GoString 

func (s ListDevicesOutput) GoString() string

GoString returns the string representation

func (ListDevicesOutput) MarshalFields 

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

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

func (ListDevicesOutput) SDKResponseMetadata 

func (s ListDevicesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListDevicesOutput) String 

func (s ListDevicesOutput) String() string

String returns the string representation

type ListDevicesRequest 

type ListDevicesRequest struct {
	*aws.Request
	Input *ListDevicesInput
	Copy  func(*ListDevicesInput) ListDevicesRequest
}

ListDevicesRequest is a API request type for the ListDevices API operation.

func (ListDevicesRequest) Send 

func (r ListDevicesRequest) Send() (*ListDevicesOutput, error)

Send marshals and sends the ListDevices API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/UnclaimDeviceRequest

func (UnclaimDeviceInput) GoString 

func (s UnclaimDeviceInput) GoString() string

GoString returns the string representation

func (UnclaimDeviceInput) MarshalFields 

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

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

func (UnclaimDeviceInput) String 

func (s UnclaimDeviceInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/UnclaimDeviceResponse

func (UnclaimDeviceOutput) GoString 

func (s UnclaimDeviceOutput) GoString() string

GoString returns the string representation

func (UnclaimDeviceOutput) MarshalFields 

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

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

func (UnclaimDeviceOutput) SDKResponseMetadata 

func (s UnclaimDeviceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UnclaimDeviceOutput) String 

func (s UnclaimDeviceOutput) String() string

String returns the string representation

type UnclaimDeviceRequest 

type UnclaimDeviceRequest struct {
	*aws.Request
	Input *UnclaimDeviceInput
	Copy  func(*UnclaimDeviceInput) UnclaimDeviceRequest
}

UnclaimDeviceRequest is a API request type for the UnclaimDevice API operation.

func (UnclaimDeviceRequest) Send 

func (r UnclaimDeviceRequest) Send() (*UnclaimDeviceOutput, error)

Send marshals and sends the UnclaimDevice API request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/UpdateDeviceStateRequest

func (UpdateDeviceStateInput) GoString 

func (s UpdateDeviceStateInput) GoString() string

GoString returns the string representation

func (UpdateDeviceStateInput) MarshalFields 

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

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

func (UpdateDeviceStateInput) String 

func (s UpdateDeviceStateInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/devices-2018-05-14/UpdateDeviceStateResponse

func (UpdateDeviceStateOutput) GoString 

func (s UpdateDeviceStateOutput) GoString() string

GoString returns the string representation

func (UpdateDeviceStateOutput) MarshalFields 

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

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

func (UpdateDeviceStateOutput) SDKResponseMetadata 

func (s UpdateDeviceStateOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateDeviceStateOutput) String 

func (s UpdateDeviceStateOutput) String() string

String returns the string representation

type UpdateDeviceStateRequest 

type UpdateDeviceStateRequest struct {
	*aws.Request
	Input *UpdateDeviceStateInput
	Copy  func(*UpdateDeviceStateInput) UpdateDeviceStateRequest
}

UpdateDeviceStateRequest is a API request type for the UpdateDeviceState API operation.

func (UpdateDeviceStateRequest) Send 

func (r UpdateDeviceStateRequest) Send() (*UpdateDeviceStateOutput, error)

Send marshals and sends the UpdateDeviceState API request.

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.