aws-sdk-go: github.com/aws/aws-sdk-go/service/iot1clickdevicesservice Index | Files | Directories

package iot1clickdevicesservice

import "github.com/aws/aws-sdk-go/service/iot1clickdevicesservice"

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

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

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

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

Using the Client

To contact AWS IoT 1-Click Devices Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS IoT 1-Click Devices Service client IoT1ClickDevicesService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iot1clickdevicesservice/#New

Index

Package Files

api.go doc.go errors.go service.go

Constants

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"
)
const (
    ServiceName = "devices.iot1click"          // Name of service.
    EndpointsID = ServiceName                  // ID to lookup a service endpoint with.
    ServiceID   = "IoT 1Click Devices Service" // ServiceID is a unique identifer of a specific service.
)

Service information constants

type Attributes Uses

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

func (Attributes) GoString Uses

func (s Attributes) GoString() string

GoString returns the string representation

func (Attributes) String Uses

func (s Attributes) String() string

String returns the string representation

type ClaimDevicesByClaimCodeInput Uses

type ClaimDevicesByClaimCodeInput struct {

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

func (ClaimDevicesByClaimCodeInput) GoString Uses

func (s ClaimDevicesByClaimCodeInput) GoString() string

GoString returns the string representation

func (*ClaimDevicesByClaimCodeInput) SetClaimCode Uses

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

SetClaimCode sets the ClaimCode field's value.

func (ClaimDevicesByClaimCodeInput) String Uses

func (s ClaimDevicesByClaimCodeInput) String() string

String returns the string representation

func (*ClaimDevicesByClaimCodeInput) Validate Uses

func (s *ClaimDevicesByClaimCodeInput) Validate() error

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

type ClaimDevicesByClaimCodeOutput Uses

type ClaimDevicesByClaimCodeOutput struct {

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

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

func (ClaimDevicesByClaimCodeOutput) GoString Uses

func (s ClaimDevicesByClaimCodeOutput) GoString() string

GoString returns the string representation

func (*ClaimDevicesByClaimCodeOutput) SetClaimCode Uses

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

SetClaimCode sets the ClaimCode field's value.

func (*ClaimDevicesByClaimCodeOutput) SetTotal Uses

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

SetTotal sets the Total field's value.

func (ClaimDevicesByClaimCodeOutput) String Uses

func (s ClaimDevicesByClaimCodeOutput) String() string

String returns the string representation

type DescribeDeviceInput Uses

type DescribeDeviceInput struct {

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

func (DescribeDeviceInput) GoString Uses

func (s DescribeDeviceInput) GoString() string

GoString returns the string representation

func (*DescribeDeviceInput) SetDeviceId Uses

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

SetDeviceId sets the DeviceId field's value.

func (DescribeDeviceInput) String Uses

func (s DescribeDeviceInput) String() string

String returns the string representation

func (*DescribeDeviceInput) Validate Uses

func (s *DescribeDeviceInput) Validate() error

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

type DescribeDeviceOutput Uses

type DescribeDeviceOutput struct {

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

func (DescribeDeviceOutput) GoString Uses

func (s DescribeDeviceOutput) GoString() string

GoString returns the string representation

func (*DescribeDeviceOutput) SetDeviceDescription Uses

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

SetDeviceDescription sets the DeviceDescription field's value.

func (DescribeDeviceOutput) String Uses

func (s DescribeDeviceOutput) String() string

String returns the string representation

type Device Uses

type Device struct {

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

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

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

func (Device) GoString Uses

func (s Device) GoString() string

GoString returns the string representation

func (*Device) SetAttributes Uses

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

SetAttributes sets the Attributes field's value.

func (*Device) SetDeviceId Uses

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

SetDeviceId sets the DeviceId field's value.

func (*Device) SetType Uses

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

SetType sets the Type field's value.

func (Device) String Uses

func (s Device) String() string

String returns the string representation

type DeviceDescription Uses

type DeviceDescription struct {

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

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

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

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

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

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

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

func (DeviceDescription) GoString Uses

func (s DeviceDescription) GoString() string

GoString returns the string representation

func (*DeviceDescription) SetArn Uses

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

SetArn sets the Arn field's value.

func (*DeviceDescription) SetAttributes Uses

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

SetAttributes sets the Attributes field's value.

func (*DeviceDescription) SetDeviceId Uses

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

SetDeviceId sets the DeviceId field's value.

func (*DeviceDescription) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (*DeviceDescription) SetRemainingLife Uses

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

SetRemainingLife sets the RemainingLife field's value.

func (*DeviceDescription) SetTags Uses

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

SetTags sets the Tags field's value.

func (*DeviceDescription) SetType Uses

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

SetType sets the Type field's value.

func (DeviceDescription) String Uses

func (s DeviceDescription) String() string

String returns the string representation

type DeviceEvent Uses

type DeviceEvent struct {

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

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

func (DeviceEvent) GoString Uses

func (s DeviceEvent) GoString() string

GoString returns the string representation

func (*DeviceEvent) SetDevice Uses

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

SetDevice sets the Device field's value.

func (*DeviceEvent) SetStdEvent Uses

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

SetStdEvent sets the StdEvent field's value.

func (DeviceEvent) String Uses

func (s DeviceEvent) String() string

String returns the string representation

type DeviceMethod Uses

type DeviceMethod struct {

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

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

func (DeviceMethod) GoString Uses

func (s DeviceMethod) GoString() string

GoString returns the string representation

func (*DeviceMethod) SetDeviceType Uses

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

SetDeviceType sets the DeviceType field's value.

func (*DeviceMethod) SetMethodName Uses

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

SetMethodName sets the MethodName field's value.

func (DeviceMethod) String Uses

func (s DeviceMethod) String() string

String returns the string representation

type FinalizeDeviceClaimInput Uses

type FinalizeDeviceClaimInput struct {

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

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

func (FinalizeDeviceClaimInput) GoString Uses

func (s FinalizeDeviceClaimInput) GoString() string

GoString returns the string representation

func (*FinalizeDeviceClaimInput) SetDeviceId Uses

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

SetDeviceId sets the DeviceId field's value.

func (*FinalizeDeviceClaimInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (FinalizeDeviceClaimInput) String Uses

func (s FinalizeDeviceClaimInput) String() string

String returns the string representation

func (*FinalizeDeviceClaimInput) Validate Uses

func (s *FinalizeDeviceClaimInput) Validate() error

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

type FinalizeDeviceClaimOutput Uses

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

func (FinalizeDeviceClaimOutput) GoString Uses

func (s FinalizeDeviceClaimOutput) GoString() string

GoString returns the string representation

func (*FinalizeDeviceClaimOutput) SetState Uses

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

SetState sets the State field's value.

func (FinalizeDeviceClaimOutput) String Uses

func (s FinalizeDeviceClaimOutput) String() string

String returns the string representation

type GetDeviceMethodsInput Uses

type GetDeviceMethodsInput struct {

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

func (GetDeviceMethodsInput) GoString Uses

func (s GetDeviceMethodsInput) GoString() string

GoString returns the string representation

func (*GetDeviceMethodsInput) SetDeviceId Uses

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

SetDeviceId sets the DeviceId field's value.

func (GetDeviceMethodsInput) String Uses

func (s GetDeviceMethodsInput) String() string

String returns the string representation

func (*GetDeviceMethodsInput) Validate Uses

func (s *GetDeviceMethodsInput) Validate() error

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

type GetDeviceMethodsOutput Uses

type GetDeviceMethodsOutput struct {

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

func (GetDeviceMethodsOutput) GoString Uses

func (s GetDeviceMethodsOutput) GoString() string

GoString returns the string representation

func (*GetDeviceMethodsOutput) SetDeviceMethods Uses

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

SetDeviceMethods sets the DeviceMethods field's value.

func (GetDeviceMethodsOutput) String Uses

func (s GetDeviceMethodsOutput) String() string

String returns the string representation

type InitiateDeviceClaimInput Uses

type InitiateDeviceClaimInput struct {

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

func (InitiateDeviceClaimInput) GoString Uses

func (s InitiateDeviceClaimInput) GoString() string

GoString returns the string representation

func (*InitiateDeviceClaimInput) SetDeviceId Uses

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

SetDeviceId sets the DeviceId field's value.

func (InitiateDeviceClaimInput) String Uses

func (s InitiateDeviceClaimInput) String() string

String returns the string representation

func (*InitiateDeviceClaimInput) Validate Uses

func (s *InitiateDeviceClaimInput) Validate() error

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

type InitiateDeviceClaimOutput Uses

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

func (InitiateDeviceClaimOutput) GoString Uses

func (s InitiateDeviceClaimOutput) GoString() string

GoString returns the string representation

func (*InitiateDeviceClaimOutput) SetState Uses

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

SetState sets the State field's value.

func (InitiateDeviceClaimOutput) String Uses

func (s InitiateDeviceClaimOutput) String() string

String returns the string representation

type InvokeDeviceMethodInput Uses

type InvokeDeviceMethodInput struct {

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

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

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

func (InvokeDeviceMethodInput) GoString Uses

func (s InvokeDeviceMethodInput) GoString() string

GoString returns the string representation

func (*InvokeDeviceMethodInput) SetDeviceId Uses

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

SetDeviceId sets the DeviceId field's value.

func (*InvokeDeviceMethodInput) SetDeviceMethod Uses

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

SetDeviceMethod sets the DeviceMethod field's value.

func (*InvokeDeviceMethodInput) SetDeviceMethodParameters Uses

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

SetDeviceMethodParameters sets the DeviceMethodParameters field's value.

func (InvokeDeviceMethodInput) String Uses

func (s InvokeDeviceMethodInput) String() string

String returns the string representation

func (*InvokeDeviceMethodInput) Validate Uses

func (s *InvokeDeviceMethodInput) Validate() error

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

type InvokeDeviceMethodOutput Uses

type InvokeDeviceMethodOutput struct {

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

func (InvokeDeviceMethodOutput) GoString Uses

func (s InvokeDeviceMethodOutput) GoString() string

GoString returns the string representation

func (*InvokeDeviceMethodOutput) SetDeviceMethodResponse Uses

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

SetDeviceMethodResponse sets the DeviceMethodResponse field's value.

func (InvokeDeviceMethodOutput) String Uses

func (s InvokeDeviceMethodOutput) String() string

String returns the string representation

type IoT1ClickDevicesService Uses

type IoT1ClickDevicesService struct {
    *client.Client
}

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

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

func New Uses

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

New creates a new instance of the IoT1ClickDevicesService client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a IoT1ClickDevicesService client from just a session.
svc := iot1clickdevicesservice.New(mySession)

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

func (*IoT1ClickDevicesService) ClaimDevicesByClaimCode Uses

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

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

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

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

See the AWS API reference guide for AWS IoT 1-Click Devices Service's API operation ClaimDevicesByClaimCode for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"

* ErrCodeInternalFailureException "InternalFailureException"

* ErrCodeForbiddenException "ForbiddenException"

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

func (*IoT1ClickDevicesService) ClaimDevicesByClaimCodeRequest Uses

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

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

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

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

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

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

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

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

func (*IoT1ClickDevicesService) ClaimDevicesByClaimCodeWithContext Uses

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

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

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

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

func (*IoT1ClickDevicesService) DescribeDevice Uses

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

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

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

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

See the AWS API reference guide for AWS IoT 1-Click Devices Service's API operation DescribeDevice for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"

* ErrCodeInvalidRequestException "InvalidRequestException"

* ErrCodeInternalFailureException "InternalFailureException"

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

func (*IoT1ClickDevicesService) DescribeDeviceRequest Uses

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

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

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

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

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

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

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

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

func (*IoT1ClickDevicesService) DescribeDeviceWithContext Uses

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

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

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

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

func (*IoT1ClickDevicesService) FinalizeDeviceClaim Uses

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

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

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

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

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

See the AWS API reference guide for AWS IoT 1-Click Devices Service's API operation FinalizeDeviceClaim for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"

* ErrCodeInvalidRequestException "InvalidRequestException"

* ErrCodeInternalFailureException "InternalFailureException"

* ErrCodePreconditionFailedException "PreconditionFailedException"

* ErrCodeResourceConflictException "ResourceConflictException"

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

func (*IoT1ClickDevicesService) FinalizeDeviceClaimRequest Uses

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

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

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

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

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

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

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

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

func (*IoT1ClickDevicesService) FinalizeDeviceClaimWithContext Uses

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

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

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

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

func (*IoT1ClickDevicesService) GetDeviceMethods Uses

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

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

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

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

See the AWS API reference guide for AWS IoT 1-Click Devices Service's API operation GetDeviceMethods for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"

* ErrCodeInvalidRequestException "InvalidRequestException"

* ErrCodeInternalFailureException "InternalFailureException"

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

func (*IoT1ClickDevicesService) GetDeviceMethodsRequest Uses

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

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

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

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

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

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

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

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

func (*IoT1ClickDevicesService) GetDeviceMethodsWithContext Uses

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

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

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

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

func (*IoT1ClickDevicesService) InitiateDeviceClaim Uses

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

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

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

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

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

See the AWS API reference guide for AWS IoT 1-Click Devices Service's API operation InitiateDeviceClaim for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"

* ErrCodeInvalidRequestException "InvalidRequestException"

* ErrCodeInternalFailureException "InternalFailureException"

* ErrCodeResourceConflictException "ResourceConflictException"

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

func (*IoT1ClickDevicesService) InitiateDeviceClaimRequest Uses

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

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

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

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

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

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

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

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

func (*IoT1ClickDevicesService) InitiateDeviceClaimWithContext Uses

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

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

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

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

func (*IoT1ClickDevicesService) InvokeDeviceMethod Uses

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

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

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

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

See the AWS API reference guide for AWS IoT 1-Click Devices Service's API operation InvokeDeviceMethod for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"

* ErrCodePreconditionFailedException "PreconditionFailedException"

* ErrCodeInternalFailureException "InternalFailureException"

* ErrCodeResourceNotFoundException "ResourceNotFoundException"

* ErrCodeRangeNotSatisfiableException "RangeNotSatisfiableException"

* ErrCodeResourceConflictException "ResourceConflictException"

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

func (*IoT1ClickDevicesService) InvokeDeviceMethodRequest Uses

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

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

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

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

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

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

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

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

func (*IoT1ClickDevicesService) InvokeDeviceMethodWithContext Uses

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

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

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

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

func (*IoT1ClickDevicesService) ListDeviceEvents Uses

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

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

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

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

See the AWS API reference guide for AWS IoT 1-Click Devices Service's API operation ListDeviceEvents for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"

* ErrCodeRangeNotSatisfiableException "RangeNotSatisfiableException"

* ErrCodeInvalidRequestException "InvalidRequestException"

* ErrCodeInternalFailureException "InternalFailureException"

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

func (*IoT1ClickDevicesService) ListDeviceEventsRequest Uses

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

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

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

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

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

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

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

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

func (*IoT1ClickDevicesService) ListDeviceEventsWithContext Uses

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

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

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

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

func (*IoT1ClickDevicesService) ListDevices Uses

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

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

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

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

See the AWS API reference guide for AWS IoT 1-Click Devices Service's API operation ListDevices for usage and error information.

Returned Error Codes:

* ErrCodeRangeNotSatisfiableException "RangeNotSatisfiableException"

* ErrCodeInvalidRequestException "InvalidRequestException"

* ErrCodeInternalFailureException "InternalFailureException"

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

func (*IoT1ClickDevicesService) ListDevicesRequest Uses

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

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

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

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

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

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

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

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

func (*IoT1ClickDevicesService) ListDevicesWithContext Uses

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

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

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

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

func (*IoT1ClickDevicesService) ListTagsForResource Uses

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

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

Lists the tags associated with the specified resource ARN.

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

See the AWS API reference guide for AWS IoT 1-Click Devices Service's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"

* ErrCodeInternalFailureException "InternalFailureException"

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

func (*IoT1ClickDevicesService) ListTagsForResourceRequest Uses

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

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

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

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

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

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

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

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

func (*IoT1ClickDevicesService) ListTagsForResourceWithContext Uses

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

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

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

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

func (*IoT1ClickDevicesService) TagResource Uses

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

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

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

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

See the AWS API reference guide for AWS IoT 1-Click Devices Service's API operation TagResource for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"

* ErrCodeInvalidRequestException "InvalidRequestException"

* ErrCodeInternalFailureException "InternalFailureException"

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

func (*IoT1ClickDevicesService) TagResourceRequest Uses

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

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

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

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

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

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

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

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

func (*IoT1ClickDevicesService) TagResourceWithContext Uses

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

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

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

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

func (*IoT1ClickDevicesService) UnclaimDevice Uses

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

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

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

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

See the AWS API reference guide for AWS IoT 1-Click Devices Service's API operation UnclaimDevice for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"

* ErrCodeInvalidRequestException "InvalidRequestException"

* ErrCodeInternalFailureException "InternalFailureException"

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

func (*IoT1ClickDevicesService) UnclaimDeviceRequest Uses

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

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

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

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

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

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

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

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

func (*IoT1ClickDevicesService) UnclaimDeviceWithContext Uses

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

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

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

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

func (*IoT1ClickDevicesService) UntagResource Uses

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

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

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

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

See the AWS API reference guide for AWS IoT 1-Click Devices Service's API operation UntagResource for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"

* ErrCodeInvalidRequestException "InvalidRequestException"

* ErrCodeInternalFailureException "InternalFailureException"

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

func (*IoT1ClickDevicesService) UntagResourceRequest Uses

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

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

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

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

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

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

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

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

func (*IoT1ClickDevicesService) UntagResourceWithContext Uses

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

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

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

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

func (*IoT1ClickDevicesService) UpdateDeviceState Uses

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

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

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

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

See the AWS API reference guide for AWS IoT 1-Click Devices Service's API operation UpdateDeviceState for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"

* ErrCodeInvalidRequestException "InvalidRequestException"

* ErrCodeInternalFailureException "InternalFailureException"

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

func (*IoT1ClickDevicesService) UpdateDeviceStateRequest Uses

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

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

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

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

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

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

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

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

func (*IoT1ClickDevicesService) UpdateDeviceStateWithContext Uses

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

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

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

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

type ListDeviceEventsInput Uses

type ListDeviceEventsInput struct {

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

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

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

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

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

func (ListDeviceEventsInput) GoString Uses

func (s ListDeviceEventsInput) GoString() string

GoString returns the string representation

func (*ListDeviceEventsInput) SetDeviceId Uses

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

SetDeviceId sets the DeviceId field's value.

func (*ListDeviceEventsInput) SetFromTimeStamp Uses

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

SetFromTimeStamp sets the FromTimeStamp field's value.

func (*ListDeviceEventsInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListDeviceEventsInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListDeviceEventsInput) SetToTimeStamp Uses

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

SetToTimeStamp sets the ToTimeStamp field's value.

func (ListDeviceEventsInput) String Uses

func (s ListDeviceEventsInput) String() string

String returns the string representation

func (*ListDeviceEventsInput) Validate Uses

func (s *ListDeviceEventsInput) Validate() error

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

type ListDeviceEventsOutput Uses

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

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

func (ListDeviceEventsOutput) GoString Uses

func (s ListDeviceEventsOutput) GoString() string

GoString returns the string representation

func (*ListDeviceEventsOutput) SetEvents Uses

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

SetEvents sets the Events field's value.

func (*ListDeviceEventsOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListDeviceEventsOutput) String Uses

func (s ListDeviceEventsOutput) String() string

String returns the string representation

type ListDevicesInput Uses

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

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

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

func (ListDevicesInput) GoString Uses

func (s ListDevicesInput) GoString() string

GoString returns the string representation

func (*ListDevicesInput) SetDeviceType Uses

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

SetDeviceType sets the DeviceType field's value.

func (*ListDevicesInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListDevicesInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListDevicesInput) String Uses

func (s ListDevicesInput) String() string

String returns the string representation

func (*ListDevicesInput) Validate Uses

func (s *ListDevicesInput) Validate() error

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

type ListDevicesOutput Uses

type ListDevicesOutput struct {

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

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

func (ListDevicesOutput) GoString Uses

func (s ListDevicesOutput) GoString() string

GoString returns the string representation

func (*ListDevicesOutput) SetDevices Uses

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

SetDevices sets the Devices field's value.

func (*ListDevicesOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListDevicesOutput) String Uses

func (s ListDevicesOutput) String() string

String returns the string representation

type ListTagsForResourceInput Uses

type ListTagsForResourceInput struct {

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

func (ListTagsForResourceInput) GoString Uses

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceArn Uses

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

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String Uses

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate Uses

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput Uses

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

func (ListTagsForResourceOutput) GoString Uses

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags Uses

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

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String Uses

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type TagResourceInput Uses

type TagResourceInput struct {

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

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

func (TagResourceInput) GoString Uses

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceArn Uses

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

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (TagResourceInput) String Uses

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate Uses

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput Uses

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

func (TagResourceOutput) GoString Uses

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String Uses

func (s TagResourceOutput) String() string

String returns the string representation

type UnclaimDeviceInput Uses

type UnclaimDeviceInput struct {

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

func (UnclaimDeviceInput) GoString Uses

func (s UnclaimDeviceInput) GoString() string

GoString returns the string representation

func (*UnclaimDeviceInput) SetDeviceId Uses

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

SetDeviceId sets the DeviceId field's value.

func (UnclaimDeviceInput) String Uses

func (s UnclaimDeviceInput) String() string

String returns the string representation

func (*UnclaimDeviceInput) Validate Uses

func (s *UnclaimDeviceInput) Validate() error

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

type UnclaimDeviceOutput Uses

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

func (UnclaimDeviceOutput) GoString Uses

func (s UnclaimDeviceOutput) GoString() string

GoString returns the string representation

func (*UnclaimDeviceOutput) SetState Uses

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

SetState sets the State field's value.

func (UnclaimDeviceOutput) String Uses

func (s UnclaimDeviceOutput) String() string

String returns the string representation

type UntagResourceInput Uses

type UntagResourceInput struct {

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

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

func (UntagResourceInput) GoString Uses

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceArn Uses

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

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys Uses

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

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String Uses

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate Uses

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput Uses

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

func (UntagResourceOutput) GoString Uses

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String Uses

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateDeviceStateInput Uses

type UpdateDeviceStateInput struct {

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

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

func (UpdateDeviceStateInput) GoString Uses

func (s UpdateDeviceStateInput) GoString() string

GoString returns the string representation

func (*UpdateDeviceStateInput) SetDeviceId Uses

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

SetDeviceId sets the DeviceId field's value.

func (*UpdateDeviceStateInput) SetEnabled Uses

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

SetEnabled sets the Enabled field's value.

func (UpdateDeviceStateInput) String Uses

func (s UpdateDeviceStateInput) String() string

String returns the string representation

func (*UpdateDeviceStateInput) Validate Uses

func (s *UpdateDeviceStateInput) Validate() error

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

type UpdateDeviceStateOutput Uses

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

func (UpdateDeviceStateOutput) GoString Uses

func (s UpdateDeviceStateOutput) GoString() string

GoString returns the string representation

func (UpdateDeviceStateOutput) String Uses

func (s UpdateDeviceStateOutput) String() string

String returns the string representation

Directories

PathSynopsis
iot1clickdevicesserviceifacePackage iot1clickdevicesserviceiface provides an interface to enable mocking the AWS IoT 1-Click Devices Service service client for testing your code.

Package iot1clickdevicesservice imports 9 packages (graph) and is imported by 13 packages. Updated 2019-10-25. Refresh now. Tools for package owners.