iot1clickdevicesservice

package
v0.24.0 Latest Latest
Warning

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

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

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 use 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 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 (
	ServiceName = "AWS IoT 1-Click Devices Service" // Service's name
	ServiceID   = "IoT1ClickDevicesService"         // Service's identifier
	EndpointsID = "devices.iot1click"               // Service's Endpoint identifier
)
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"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Attributes 

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

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
}

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
}

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) 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 the request type for the ClaimDevicesByClaimCode API operation.

func (ClaimDevicesByClaimCodeRequest) Send 

func (r ClaimDevicesByClaimCodeRequest) Send(ctx context.Context) (*ClaimDevicesByClaimCodeResponse, error)

Send marshals and sends the ClaimDevicesByClaimCode API request.

type ClaimDevicesByClaimCodeResponse added in v0.9.0 

type ClaimDevicesByClaimCodeResponse struct {
	*ClaimDevicesByClaimCodeOutput
	// contains filtered or unexported fields
}

ClaimDevicesByClaimCodeResponse is the response type for the ClaimDevicesByClaimCode API operation.

func (*ClaimDevicesByClaimCodeResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the ClaimDevicesByClaimCode request.

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *Client

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

Example: 

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

func (*Client) ClaimDevicesByClaimCodeRequest added in v0.9.0 

func (c *Client) 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 ClaimDevicesByClaimCodeRequest.
req := client.ClaimDevicesByClaimCodeRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeDeviceRequest added in v0.9.0 

func (c *Client) 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 DescribeDeviceRequest.
req := client.DescribeDeviceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) FinalizeDeviceClaimRequest added in v0.9.0 

func (c *Client) 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 FinalizeDeviceClaimRequest.
req := client.FinalizeDeviceClaimRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetDeviceMethodsRequest added in v0.9.0 

func (c *Client) 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 GetDeviceMethodsRequest.
req := client.GetDeviceMethodsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) InitiateDeviceClaimRequest added in v0.9.0 

func (c *Client) 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 InitiateDeviceClaimRequest.
req := client.InitiateDeviceClaimRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) InvokeDeviceMethodRequest added in v0.9.0 

func (c *Client) 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 InvokeDeviceMethodRequest.
req := client.InvokeDeviceMethodRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListDeviceEventsRequest added in v0.9.0 

func (c *Client) 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 ListDeviceEventsRequest.
req := client.ListDeviceEventsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListDevicesRequest added in v0.9.0 

func (c *Client) 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 ListDevicesRequest.
req := client.ListDevicesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListTagsForResourceRequest added in v0.9.0 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

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

Lists the tags associated with the specified resource ARN. 

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

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

func (*Client) TagResourceRequest added in v0.9.0 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

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

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

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

func (*Client) UnclaimDeviceRequest added in v0.9.0 

func (c *Client) 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 UnclaimDeviceRequest.
req := client.UnclaimDeviceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UntagResourceRequest added in v0.9.0 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

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

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

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

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

func (*Client) UpdateDeviceStateRequest added in v0.9.0 

func (c *Client) 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 UpdateDeviceStateRequest.
req := client.UpdateDeviceStateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

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

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) 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 the request type for the DescribeDevice API operation.

func (DescribeDeviceRequest) Send 

func (r DescribeDeviceRequest) Send(ctx context.Context) (*DescribeDeviceResponse, error)

Send marshals and sends the DescribeDevice API request.

type DescribeDeviceResponse added in v0.9.0 

type DescribeDeviceResponse struct {
	*DescribeDeviceOutput
	// contains filtered or unexported fields
}

DescribeDeviceResponse is the response type for the DescribeDevice API operation.

func (*DescribeDeviceResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DescribeDevice 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
}

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 {

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

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
}

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

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

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
}

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) 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 the request type for the FinalizeDeviceClaim API operation.

func (FinalizeDeviceClaimRequest) Send 

func (r FinalizeDeviceClaimRequest) Send(ctx context.Context) (*FinalizeDeviceClaimResponse, error)

Send marshals and sends the FinalizeDeviceClaim API request.

type FinalizeDeviceClaimResponse added in v0.9.0 

type FinalizeDeviceClaimResponse struct {
	*FinalizeDeviceClaimOutput
	// contains filtered or unexported fields
}

FinalizeDeviceClaimResponse is the response type for the FinalizeDeviceClaim API operation.

func (*FinalizeDeviceClaimResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the FinalizeDeviceClaim 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
}

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
}

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) 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 the request type for the GetDeviceMethods API operation.

func (GetDeviceMethodsRequest) Send 

func (r GetDeviceMethodsRequest) Send(ctx context.Context) (*GetDeviceMethodsResponse, error)

Send marshals and sends the GetDeviceMethods API request.

type GetDeviceMethodsResponse added in v0.9.0 

type GetDeviceMethodsResponse struct {
	*GetDeviceMethodsOutput
	// contains filtered or unexported fields
}

GetDeviceMethodsResponse is the response type for the GetDeviceMethods API operation.

func (*GetDeviceMethodsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the GetDeviceMethods 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
}

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
}

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) 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 the request type for the InitiateDeviceClaim API operation.

func (InitiateDeviceClaimRequest) Send 

func (r InitiateDeviceClaimRequest) Send(ctx context.Context) (*InitiateDeviceClaimResponse, error)

Send marshals and sends the InitiateDeviceClaim API request.

type InitiateDeviceClaimResponse added in v0.9.0 

type InitiateDeviceClaimResponse struct {
	*InitiateDeviceClaimOutput
	// contains filtered or unexported fields
}

InitiateDeviceClaimResponse is the response type for the InitiateDeviceClaim API operation.

func (*InitiateDeviceClaimResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the InitiateDeviceClaim 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
}

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
}

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) 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 the request type for the InvokeDeviceMethod API operation.

func (InvokeDeviceMethodRequest) Send 

func (r InvokeDeviceMethodRequest) Send(ctx context.Context) (*InvokeDeviceMethodResponse, error)

Send marshals and sends the InvokeDeviceMethod API request.

type InvokeDeviceMethodResponse added in v0.9.0 

type InvokeDeviceMethodResponse struct {
	*InvokeDeviceMethodOutput
	// contains filtered or unexported fields
}

InvokeDeviceMethodResponse is the response type for the InvokeDeviceMethod API operation.

func (*InvokeDeviceMethodResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the InvokeDeviceMethod request.

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

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) 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 the request type for the ListDeviceEvents API operation.

func (ListDeviceEventsRequest) Send 

func (r ListDeviceEventsRequest) Send(ctx context.Context) (*ListDeviceEventsResponse, error)

Send marshals and sends the ListDeviceEvents API request.

type ListDeviceEventsResponse added in v0.9.0 

type ListDeviceEventsResponse struct {
	*ListDeviceEventsOutput
	// contains filtered or unexported fields
}

ListDeviceEventsResponse is the response type for the ListDeviceEvents API operation.

func (*ListDeviceEventsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the ListDeviceEvents 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
}

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
}

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) 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 the request type for the ListDevices API operation.

func (ListDevicesRequest) Send 

func (r ListDevicesRequest) Send(ctx context.Context) (*ListDevicesResponse, error)

Send marshals and sends the ListDevices API request.

type ListDevicesResponse added in v0.9.0 

type ListDevicesResponse struct {
	*ListDevicesOutput
	// contains filtered or unexported fields
}

ListDevicesResponse is the response type for the ListDevices API operation.

func (*ListDevicesResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the ListDevices request.

type ListTagsForResourceInput added in v0.8.0 

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

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

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

func (ListTagsForResourceInput) String added in v0.8.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.8.0 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v0.8.0 

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

func (ListTagsForResourceOutput) MarshalFields added in v0.8.0 

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

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

func (ListTagsForResourceOutput) String added in v0.8.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest added in v0.8.0 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.8.0 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type TagResourceInput added in v0.8.0 

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

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

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

func (TagResourceInput) String added in v0.8.0 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.8.0 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v0.8.0 

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

func (TagResourceOutput) MarshalFields added in v0.8.0 

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

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

func (TagResourceOutput) String added in v0.8.0 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.8.0 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.8.0 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0 

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

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the TagResource 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
}

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
}

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) 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 the request type for the UnclaimDevice API operation.

func (UnclaimDeviceRequest) Send 

func (r UnclaimDeviceRequest) Send(ctx context.Context) (*UnclaimDeviceResponse, error)

Send marshals and sends the UnclaimDevice API request.

type UnclaimDeviceResponse added in v0.9.0 

type UnclaimDeviceResponse struct {
	*UnclaimDeviceOutput
	// contains filtered or unexported fields
}

UnclaimDeviceResponse is the response type for the UnclaimDevice API operation.

func (*UnclaimDeviceResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the UnclaimDevice request.

type UntagResourceInput added in v0.8.0 

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

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

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

func (UntagResourceInput) String added in v0.8.0 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.8.0 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v0.8.0 

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

func (UntagResourceOutput) MarshalFields added in v0.8.0 

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

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

func (UntagResourceOutput) String added in v0.8.0 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.8.0 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.8.0 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0 

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

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the UntagResource 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
}

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
}

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) 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 the request type for the UpdateDeviceState API operation.

func (UpdateDeviceStateRequest) Send 

func (r UpdateDeviceStateRequest) Send(ctx context.Context) (*UpdateDeviceStateResponse, error)

Send marshals and sends the UpdateDeviceState API request.

type UpdateDeviceStateResponse added in v0.9.0 

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

UpdateDeviceStateResponse is the response type for the UpdateDeviceState API operation.

func (*UpdateDeviceStateResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the UpdateDeviceState 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.