View on GitHub
IoT1ClickDevicesService Structure Reference
IoT1ClickDevicesService
public struct IoT1ClickDevicesServiceClient object for interacting with AWS IoT1ClickDevicesService 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.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the IoT1ClickDevicesService client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
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).
Declaration
Swift
public func claimDevicesByClaimCode(_ input: ClaimDevicesByClaimCodeRequest) -> EventLoopFuture<ClaimDevicesByClaimCodeResponse> -
Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
Declaration
Swift
public func describeDevice(_ input: DescribeDeviceRequest) -> EventLoopFuture<DescribeDeviceResponse> -
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.
Declaration
Swift
public func finalizeDeviceClaim(_ input: FinalizeDeviceClaimRequest) -> EventLoopFuture<FinalizeDeviceClaimResponse> -
Given a device ID, returns the invokable methods associated with the device.
Declaration
Swift
public func getDeviceMethods(_ input: GetDeviceMethodsRequest) -> EventLoopFuture<GetDeviceMethodsResponse> -
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.
Declaration
Swift
public func initiateDeviceClaim(_ input: InitiateDeviceClaimRequest) -> EventLoopFuture<InitiateDeviceClaimResponse> -
Given a device ID, issues a request to invoke a named device method (with possible parameters). See the “Example POST” code snippet below.
Declaration
Swift
public func invokeDeviceMethod(_ input: InvokeDeviceMethodRequest) -> EventLoopFuture<InvokeDeviceMethodResponse> -
Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
Declaration
Swift
public func listDeviceEvents(_ input: ListDeviceEventsRequest) -> EventLoopFuture<ListDeviceEventsResponse> -
Lists the 1-Click compatible devices associated with your AWS account.
Declaration
Swift
public func listDevices(_ input: ListDevicesRequest) -> EventLoopFuture<ListDevicesResponse> -
Lists the tags associated with the specified resource ARN.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse> -
Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per resource.
Declaration
Swift
@discardableResult public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<Void> -
Disassociates a device from your AWS account using its device ID.
Declaration
Swift
public func unclaimDevice(_ input: UnclaimDeviceRequest) -> EventLoopFuture<UnclaimDeviceResponse> -
Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
Declaration
Swift
@discardableResult public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<Void> -
Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
Declaration
Swift
public func updateDeviceState(_ input: UpdateDeviceStateRequest) -> EventLoopFuture<UpdateDeviceStateResponse>