Documentation

Overview

    Package iot1clickdevicesservice provides the API client, operations, and parameter types for 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.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2018-05-14"
    View Source
    const ServiceID = "IoT 1Click Devices Service"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

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

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

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

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

          Types

          type ClaimDevicesByClaimCodeInput

          type ClaimDevicesByClaimCodeInput struct {
          
          	// The claim code, starting with "C-", as provided by the device manufacturer.
          	//
          	// This member is required.
          	ClaimCode *string
          }

          type ClaimDevicesByClaimCodeOutput

          type ClaimDevicesByClaimCodeOutput struct {
          
          	// The claim code provided by the device manufacturer.
          	ClaimCode *string
          
          	// The total number of devices associated with the claim code that has been
          	// processed in the claim request.
          	Total int32
          
          	// Metadata pertaining to the operation's result.
          	ResultMetadata middleware.Metadata
          }

          type Client

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

            Client provides the API client to make operations call for AWS IoT 1-Click Devices Service.

            func New

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

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

              func NewFromConfig

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

                NewFromConfig returns a new client from the provided config.

                func (*Client) ClaimDevicesByClaimCode

                func (c *Client) ClaimDevicesByClaimCode(ctx context.Context, params *ClaimDevicesByClaimCodeInput, optFns ...func(*Options)) (*ClaimDevicesByClaimCodeOutput, error)

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

                  func (*Client) DescribeDevice

                  func (c *Client) DescribeDevice(ctx context.Context, params *DescribeDeviceInput, optFns ...func(*Options)) (*DescribeDeviceOutput, error)

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

                    func (*Client) FinalizeDeviceClaim

                    func (c *Client) FinalizeDeviceClaim(ctx context.Context, params *FinalizeDeviceClaimInput, optFns ...func(*Options)) (*FinalizeDeviceClaimOutput, error)

                      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.

                      func (*Client) GetDeviceMethods

                      func (c *Client) GetDeviceMethods(ctx context.Context, params *GetDeviceMethodsInput, optFns ...func(*Options)) (*GetDeviceMethodsOutput, error)

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

                        func (*Client) InitiateDeviceClaim

                        func (c *Client) InitiateDeviceClaim(ctx context.Context, params *InitiateDeviceClaimInput, optFns ...func(*Options)) (*InitiateDeviceClaimOutput, error)

                          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.

                          func (*Client) InvokeDeviceMethod

                          func (c *Client) InvokeDeviceMethod(ctx context.Context, params *InvokeDeviceMethodInput, optFns ...func(*Options)) (*InvokeDeviceMethodOutput, error)

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

                            func (*Client) ListDeviceEvents

                            func (c *Client) ListDeviceEvents(ctx context.Context, params *ListDeviceEventsInput, optFns ...func(*Options)) (*ListDeviceEventsOutput, error)

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

                              func (*Client) ListDevices

                              func (c *Client) ListDevices(ctx context.Context, params *ListDevicesInput, optFns ...func(*Options)) (*ListDevicesOutput, error)

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

                                func (*Client) ListTagsForResource

                                func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

                                  Lists the tags associated with the specified resource ARN.

                                  func (*Client) TagResource

                                  func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

                                    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.

                                    func (*Client) UnclaimDevice

                                    func (c *Client) UnclaimDevice(ctx context.Context, params *UnclaimDeviceInput, optFns ...func(*Options)) (*UnclaimDeviceOutput, error)

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

                                      func (*Client) UntagResource

                                      func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

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

                                        func (*Client) UpdateDeviceState

                                        func (c *Client) UpdateDeviceState(ctx context.Context, params *UpdateDeviceStateInput, optFns ...func(*Options)) (*UpdateDeviceStateOutput, error)

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

                                          type DescribeDeviceInput

                                          type DescribeDeviceInput struct {
                                          
                                          	// The unique identifier of the device.
                                          	//
                                          	// This member is required.
                                          	DeviceId *string
                                          }

                                          type DescribeDeviceOutput

                                          type DescribeDeviceOutput struct {
                                          
                                          	// Device details.
                                          	DeviceDescription *types.DeviceDescription
                                          
                                          	// Metadata pertaining to the operation's result.
                                          	ResultMetadata middleware.Metadata
                                          }

                                          type EndpointResolver

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

                                            EndpointResolver interface for resolving service endpoints.

                                            func EndpointResolverFromURL

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

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

                                              type EndpointResolverFunc

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

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

                                                func (EndpointResolverFunc) ResolveEndpoint

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

                                                type EndpointResolverOptions

                                                type EndpointResolverOptions = internalendpoints.Options

                                                  EndpointResolverOptions is the service endpoint resolver options

                                                  type FinalizeDeviceClaimInput

                                                  type FinalizeDeviceClaimInput struct {
                                                  
                                                  	// The unique identifier of the device.
                                                  	//
                                                  	// This member is required.
                                                  	DeviceId *string
                                                  
                                                  	// A collection of key/value pairs defining the resource tags. For example, {
                                                  	// "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS
                                                  	// Tagging Strategies
                                                  	// (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/).
                                                  	Tags map[string]string
                                                  }

                                                  type FinalizeDeviceClaimOutput

                                                  type FinalizeDeviceClaimOutput struct {
                                                  
                                                  	// The device's final claim state.
                                                  	State *string
                                                  
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                  type GetDeviceMethodsInput

                                                  type GetDeviceMethodsInput struct {
                                                  
                                                  	// The unique identifier of the device.
                                                  	//
                                                  	// This member is required.
                                                  	DeviceId *string
                                                  }

                                                  type GetDeviceMethodsOutput

                                                  type GetDeviceMethodsOutput struct {
                                                  
                                                  	// List of available device APIs.
                                                  	DeviceMethods []types.DeviceMethod
                                                  
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                  type HTTPClient

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

                                                  type HTTPSignerV4

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

                                                  type InitiateDeviceClaimInput

                                                  type InitiateDeviceClaimInput struct {
                                                  
                                                  	// The unique identifier of the device.
                                                  	//
                                                  	// This member is required.
                                                  	DeviceId *string
                                                  }

                                                  type InitiateDeviceClaimOutput

                                                  type InitiateDeviceClaimOutput struct {
                                                  
                                                  	// The device's final claim state.
                                                  	State *string
                                                  
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                  type InvokeDeviceMethodInput

                                                  type InvokeDeviceMethodInput struct {
                                                  
                                                  	// The unique identifier of the device.
                                                  	//
                                                  	// This member is required.
                                                  	DeviceId *string
                                                  
                                                  	// The device method to invoke.
                                                  	DeviceMethod *types.DeviceMethod
                                                  
                                                  	// A JSON encoded string containing the device method request parameters.
                                                  	DeviceMethodParameters *string
                                                  }

                                                  type InvokeDeviceMethodOutput

                                                  type InvokeDeviceMethodOutput struct {
                                                  
                                                  	// A JSON encoded string containing the device method response.
                                                  	DeviceMethodResponse *string
                                                  
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                  type ListDeviceEventsInput

                                                  type ListDeviceEventsInput struct {
                                                  
                                                  	// The unique identifier of the device.
                                                  	//
                                                  	// This member is required.
                                                  	DeviceId *string
                                                  
                                                  	// The start date for the device event query, in ISO8061 format. For example,
                                                  	// 2018-03-28T15:45:12.880Z
                                                  	//
                                                  	// This member is required.
                                                  	FromTimeStamp *time.Time
                                                  
                                                  	// The end date for the device event query, in ISO8061 format. For example,
                                                  	// 2018-03-28T15:45:12.880Z
                                                  	//
                                                  	// This member is required.
                                                  	ToTimeStamp *time.Time
                                                  
                                                  	// The maximum number of results to return per request. If not set, a default value
                                                  	// of 100 is used.
                                                  	MaxResults int32
                                                  
                                                  	// The token to retrieve the next set of results.
                                                  	NextToken *string
                                                  }

                                                  type ListDeviceEventsOutput

                                                  type ListDeviceEventsOutput struct {
                                                  
                                                  	// An array of zero or more elements describing the event(s) associated with the
                                                  	// device.
                                                  	Events []types.DeviceEvent
                                                  
                                                  	// The token to retrieve the next set of results.
                                                  	NextToken *string
                                                  
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                  type ListDevicesInput

                                                  type ListDevicesInput struct {
                                                  
                                                  	// The type of the device, such as "button".
                                                  	DeviceType *string
                                                  
                                                  	// The maximum number of results to return per request. If not set, a default value
                                                  	// of 100 is used.
                                                  	MaxResults int32
                                                  
                                                  	// The token to retrieve the next set of results.
                                                  	NextToken *string
                                                  }

                                                  type ListDevicesOutput

                                                  type ListDevicesOutput struct {
                                                  
                                                  	// A list of devices.
                                                  	Devices []types.DeviceDescription
                                                  
                                                  	// The token to retrieve the next set of results.
                                                  	NextToken *string
                                                  
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                  type ListTagsForResourceInput

                                                  type ListTagsForResourceInput struct {
                                                  
                                                  	// The ARN of the resource.
                                                  	//
                                                  	// This member is required.
                                                  	ResourceArn *string
                                                  }

                                                  type ListTagsForResourceOutput

                                                  type ListTagsForResourceOutput struct {
                                                  
                                                  	// A collection of key/value pairs defining the resource tags. For example, {
                                                  	// "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS
                                                  	// Tagging Strategies
                                                  	// (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/).
                                                  	Tags map[string]string
                                                  
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                  type Options

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

                                                  func (Options) Copy

                                                  func (o Options) Copy() Options

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

                                                    type ResolveEndpoint

                                                    type ResolveEndpoint struct {
                                                    	Resolver EndpointResolver
                                                    	Options  EndpointResolverOptions
                                                    }

                                                    func (*ResolveEndpoint) HandleSerialize

                                                    func (*ResolveEndpoint) ID

                                                    func (*ResolveEndpoint) ID() string

                                                    type TagResourceInput

                                                    type TagResourceInput struct {
                                                    
                                                    	// The ARN of the resource.
                                                    	//
                                                    	// This member is required.
                                                    	ResourceArn *string
                                                    
                                                    	// A collection of key/value pairs defining the resource tags. For example, {
                                                    	// "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS
                                                    	// Tagging Strategies
                                                    	// (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/).
                                                    	//
                                                    	// This member is required.
                                                    	Tags map[string]string
                                                    }

                                                    type TagResourceOutput

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

                                                    type UnclaimDeviceInput

                                                    type UnclaimDeviceInput struct {
                                                    
                                                    	// The unique identifier of the device.
                                                    	//
                                                    	// This member is required.
                                                    	DeviceId *string
                                                    }

                                                    type UnclaimDeviceOutput

                                                    type UnclaimDeviceOutput struct {
                                                    
                                                    	// The device's final claim state.
                                                    	State *string
                                                    
                                                    	// Metadata pertaining to the operation's result.
                                                    	ResultMetadata middleware.Metadata
                                                    }

                                                    type UntagResourceInput

                                                    type UntagResourceInput struct {
                                                    
                                                    	// The ARN of the resource.
                                                    	//
                                                    	// This member is required.
                                                    	ResourceArn *string
                                                    
                                                    	// A collections of tag keys. For example, {"key1","key2"}
                                                    	//
                                                    	// This member is required.
                                                    	TagKeys []string
                                                    }

                                                    type UntagResourceOutput

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

                                                    type UpdateDeviceStateInput

                                                    type UpdateDeviceStateInput struct {
                                                    
                                                    	// The unique identifier of the device.
                                                    	//
                                                    	// This member is required.
                                                    	DeviceId *string
                                                    
                                                    	// If true, the device is enabled. If false, the device is disabled.
                                                    	Enabled bool
                                                    }

                                                    type UpdateDeviceStateOutput

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

                                                    Directories

                                                    Path Synopsis
                                                    internal