/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the iot1click-devices-2018-05-14.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.IoT1ClickDevicesService.Model; namespace Amazon.IoT1ClickDevicesService { /// /// Interface for accessing IoT1ClickDevicesService /// /// 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. /// public partial interface IAmazonIoT1ClickDevicesService : IAmazonService, IDisposable { #region ClaimDevicesByClaimCode /// /// 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). /// /// Container for the necessary parameters to execute the ClaimDevicesByClaimCode service method. /// /// The response from the ClaimDevicesByClaimCode service method, as returned by IoT1ClickDevicesService. /// /// /// /// /// /// /// /// /// /// REST API Reference for ClaimDevicesByClaimCode Operation ClaimDevicesByClaimCodeResponse ClaimDevicesByClaimCode(ClaimDevicesByClaimCodeRequest request); /// /// Initiates the asynchronous execution of the ClaimDevicesByClaimCode operation. /// /// /// Container for the necessary parameters to execute the ClaimDevicesByClaimCode operation on AmazonIoT1ClickDevicesServiceClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndClaimDevicesByClaimCode /// operation. /// REST API Reference for ClaimDevicesByClaimCode Operation IAsyncResult BeginClaimDevicesByClaimCode(ClaimDevicesByClaimCodeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ClaimDevicesByClaimCode operation. /// /// /// The IAsyncResult returned by the call to BeginClaimDevicesByClaimCode. /// /// Returns a ClaimDevicesByClaimCodeResult from IoT1ClickDevicesService. /// REST API Reference for ClaimDevicesByClaimCode Operation ClaimDevicesByClaimCodeResponse EndClaimDevicesByClaimCode(IAsyncResult asyncResult); #endregion #region DescribeDevice /// /// Given a device ID, returns a DescribeDeviceResponse object describing the details /// of the device. /// /// Container for the necessary parameters to execute the DescribeDevice service method. /// /// The response from the DescribeDevice service method, as returned by IoT1ClickDevicesService. /// /// /// /// /// /// /// /// /// /// REST API Reference for DescribeDevice Operation DescribeDeviceResponse DescribeDevice(DescribeDeviceRequest request); /// /// Initiates the asynchronous execution of the DescribeDevice operation. /// /// /// Container for the necessary parameters to execute the DescribeDevice operation on AmazonIoT1ClickDevicesServiceClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDevice /// operation. /// REST API Reference for DescribeDevice Operation IAsyncResult BeginDescribeDevice(DescribeDeviceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeDevice operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeDevice. /// /// Returns a DescribeDeviceResult from IoT1ClickDevicesService. /// REST API Reference for DescribeDevice Operation DescribeDeviceResponse EndDescribeDevice(IAsyncResult asyncResult); #endregion #region FinalizeDeviceClaim /// /// 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. /// /// /// /// Container for the necessary parameters to execute the FinalizeDeviceClaim service method. /// /// The response from the FinalizeDeviceClaim service method, as returned by IoT1ClickDevicesService. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for FinalizeDeviceClaim Operation FinalizeDeviceClaimResponse FinalizeDeviceClaim(FinalizeDeviceClaimRequest request); /// /// Initiates the asynchronous execution of the FinalizeDeviceClaim operation. /// /// /// Container for the necessary parameters to execute the FinalizeDeviceClaim operation on AmazonIoT1ClickDevicesServiceClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndFinalizeDeviceClaim /// operation. /// REST API Reference for FinalizeDeviceClaim Operation IAsyncResult BeginFinalizeDeviceClaim(FinalizeDeviceClaimRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the FinalizeDeviceClaim operation. /// /// /// The IAsyncResult returned by the call to BeginFinalizeDeviceClaim. /// /// Returns a FinalizeDeviceClaimResult from IoT1ClickDevicesService. /// REST API Reference for FinalizeDeviceClaim Operation FinalizeDeviceClaimResponse EndFinalizeDeviceClaim(IAsyncResult asyncResult); #endregion #region GetDeviceMethods /// /// Given a device ID, returns the invokable methods associated with the device. /// /// Container for the necessary parameters to execute the GetDeviceMethods service method. /// /// The response from the GetDeviceMethods service method, as returned by IoT1ClickDevicesService. /// /// /// /// /// /// /// /// /// /// REST API Reference for GetDeviceMethods Operation GetDeviceMethodsResponse GetDeviceMethods(GetDeviceMethodsRequest request); /// /// Initiates the asynchronous execution of the GetDeviceMethods operation. /// /// /// Container for the necessary parameters to execute the GetDeviceMethods operation on AmazonIoT1ClickDevicesServiceClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDeviceMethods /// operation. /// REST API Reference for GetDeviceMethods Operation IAsyncResult BeginGetDeviceMethods(GetDeviceMethodsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetDeviceMethods operation. /// /// /// The IAsyncResult returned by the call to BeginGetDeviceMethods. /// /// Returns a GetDeviceMethodsResult from IoT1ClickDevicesService. /// REST API Reference for GetDeviceMethods Operation GetDeviceMethodsResponse EndGetDeviceMethods(IAsyncResult asyncResult); #endregion #region InitiateDeviceClaim /// /// 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. /// /// /// /// Container for the necessary parameters to execute the InitiateDeviceClaim service method. /// /// The response from the InitiateDeviceClaim service method, as returned by IoT1ClickDevicesService. /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for InitiateDeviceClaim Operation InitiateDeviceClaimResponse InitiateDeviceClaim(InitiateDeviceClaimRequest request); /// /// Initiates the asynchronous execution of the InitiateDeviceClaim operation. /// /// /// Container for the necessary parameters to execute the InitiateDeviceClaim operation on AmazonIoT1ClickDevicesServiceClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndInitiateDeviceClaim /// operation. /// REST API Reference for InitiateDeviceClaim Operation IAsyncResult BeginInitiateDeviceClaim(InitiateDeviceClaimRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the InitiateDeviceClaim operation. /// /// /// The IAsyncResult returned by the call to BeginInitiateDeviceClaim. /// /// Returns a InitiateDeviceClaimResult from IoT1ClickDevicesService. /// REST API Reference for InitiateDeviceClaim Operation InitiateDeviceClaimResponse EndInitiateDeviceClaim(IAsyncResult asyncResult); #endregion #region InvokeDeviceMethod /// /// Given a device ID, issues a request to invoke a named device method (with possible /// parameters). See the "Example POST" code snippet below. /// /// Container for the necessary parameters to execute the InvokeDeviceMethod service method. /// /// The response from the InvokeDeviceMethod service method, as returned by IoT1ClickDevicesService. /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for InvokeDeviceMethod Operation InvokeDeviceMethodResponse InvokeDeviceMethod(InvokeDeviceMethodRequest request); /// /// Initiates the asynchronous execution of the InvokeDeviceMethod operation. /// /// /// Container for the necessary parameters to execute the InvokeDeviceMethod operation on AmazonIoT1ClickDevicesServiceClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndInvokeDeviceMethod /// operation. /// REST API Reference for InvokeDeviceMethod Operation IAsyncResult BeginInvokeDeviceMethod(InvokeDeviceMethodRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the InvokeDeviceMethod operation. /// /// /// The IAsyncResult returned by the call to BeginInvokeDeviceMethod. /// /// Returns a InvokeDeviceMethodResult from IoT1ClickDevicesService. /// REST API Reference for InvokeDeviceMethod Operation InvokeDeviceMethodResponse EndInvokeDeviceMethod(IAsyncResult asyncResult); #endregion #region ListDeviceEvents /// /// Using a device ID, returns a DeviceEventsResponse object containing an array of events /// for the device. /// /// Container for the necessary parameters to execute the ListDeviceEvents service method. /// /// The response from the ListDeviceEvents service method, as returned by IoT1ClickDevicesService. /// /// /// /// /// /// /// /// /// /// /// /// /// REST API Reference for ListDeviceEvents Operation ListDeviceEventsResponse ListDeviceEvents(ListDeviceEventsRequest request); /// /// Initiates the asynchronous execution of the ListDeviceEvents operation. /// /// /// Container for the necessary parameters to execute the ListDeviceEvents operation on AmazonIoT1ClickDevicesServiceClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDeviceEvents /// operation. /// REST API Reference for ListDeviceEvents Operation IAsyncResult BeginListDeviceEvents(ListDeviceEventsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListDeviceEvents operation. /// /// /// The IAsyncResult returned by the call to BeginListDeviceEvents. /// /// Returns a ListDeviceEventsResult from IoT1ClickDevicesService. /// REST API Reference for ListDeviceEvents Operation ListDeviceEventsResponse EndListDeviceEvents(IAsyncResult asyncResult); #endregion #region ListDevices /// /// Lists the 1-Click compatible devices associated with your AWS account. /// /// Container for the necessary parameters to execute the ListDevices service method. /// /// The response from the ListDevices service method, as returned by IoT1ClickDevicesService. /// /// /// /// /// /// /// /// /// /// REST API Reference for ListDevices Operation ListDevicesResponse ListDevices(ListDevicesRequest request); /// /// Initiates the asynchronous execution of the ListDevices operation. /// /// /// Container for the necessary parameters to execute the ListDevices operation on AmazonIoT1ClickDevicesServiceClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDevices /// operation. /// REST API Reference for ListDevices Operation IAsyncResult BeginListDevices(ListDevicesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListDevices operation. /// /// /// The IAsyncResult returned by the call to BeginListDevices. /// /// Returns a ListDevicesResult from IoT1ClickDevicesService. /// REST API Reference for ListDevices Operation ListDevicesResponse EndListDevices(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// /// Lists the tags associated with the specified resource ARN. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by IoT1ClickDevicesService. /// /// /// /// /// /// /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// /// Initiates the asynchronous execution of the ListTagsForResource operation. /// /// /// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonIoT1ClickDevicesServiceClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource /// operation. /// REST API Reference for ListTagsForResource Operation IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListTagsForResource operation. /// /// /// The IAsyncResult returned by the call to BeginListTagsForResource. /// /// Returns a ListTagsForResourceResult from IoT1ClickDevicesService. /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region TagResource /// /// 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. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by IoT1ClickDevicesService. /// /// /// /// /// /// /// /// /// /// REST API Reference for TagResource Operation TagResourceResponse TagResource(TagResourceRequest request); /// /// Initiates the asynchronous execution of the TagResource operation. /// /// /// Container for the necessary parameters to execute the TagResource operation on AmazonIoT1ClickDevicesServiceClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource /// operation. /// REST API Reference for TagResource Operation IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TagResource operation. /// /// /// The IAsyncResult returned by the call to BeginTagResource. /// /// Returns a TagResourceResult from IoT1ClickDevicesService. /// REST API Reference for TagResource Operation TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region UnclaimDevice /// /// Disassociates a device from your AWS account using its device ID. /// /// Container for the necessary parameters to execute the UnclaimDevice service method. /// /// The response from the UnclaimDevice service method, as returned by IoT1ClickDevicesService. /// /// /// /// /// /// /// /// /// /// REST API Reference for UnclaimDevice Operation UnclaimDeviceResponse UnclaimDevice(UnclaimDeviceRequest request); /// /// Initiates the asynchronous execution of the UnclaimDevice operation. /// /// /// Container for the necessary parameters to execute the UnclaimDevice operation on AmazonIoT1ClickDevicesServiceClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUnclaimDevice /// operation. /// REST API Reference for UnclaimDevice Operation IAsyncResult BeginUnclaimDevice(UnclaimDeviceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UnclaimDevice operation. /// /// /// The IAsyncResult returned by the call to BeginUnclaimDevice. /// /// Returns a UnclaimDeviceResult from IoT1ClickDevicesService. /// REST API Reference for UnclaimDevice Operation UnclaimDeviceResponse EndUnclaimDevice(IAsyncResult asyncResult); #endregion #region UntagResource /// /// Using tag keys, deletes the tags (key/value pairs) associated with the specified resource /// ARN. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by IoT1ClickDevicesService. /// /// /// /// /// /// /// /// /// /// REST API Reference for UntagResource Operation UntagResourceResponse UntagResource(UntagResourceRequest request); /// /// Initiates the asynchronous execution of the UntagResource operation. /// /// /// Container for the necessary parameters to execute the UntagResource operation on AmazonIoT1ClickDevicesServiceClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource /// operation. /// REST API Reference for UntagResource Operation IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UntagResource operation. /// /// /// The IAsyncResult returned by the call to BeginUntagResource. /// /// Returns a UntagResourceResult from IoT1ClickDevicesService. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion #region UpdateDeviceState /// /// Using a Boolean value (true or false), this operation enables or disables the device /// given a device ID. /// /// Container for the necessary parameters to execute the UpdateDeviceState service method. /// /// The response from the UpdateDeviceState service method, as returned by IoT1ClickDevicesService. /// /// /// /// /// /// /// /// /// /// REST API Reference for UpdateDeviceState Operation UpdateDeviceStateResponse UpdateDeviceState(UpdateDeviceStateRequest request); /// /// Initiates the asynchronous execution of the UpdateDeviceState operation. /// /// /// Container for the necessary parameters to execute the UpdateDeviceState operation on AmazonIoT1ClickDevicesServiceClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateDeviceState /// operation. /// REST API Reference for UpdateDeviceState Operation IAsyncResult BeginUpdateDeviceState(UpdateDeviceStateRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateDeviceState operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateDeviceState. /// /// Returns a UpdateDeviceStateResult from IoT1ClickDevicesService. /// REST API Reference for UpdateDeviceState Operation UpdateDeviceStateResponse EndUpdateDeviceState(IAsyncResult asyncResult); #endregion } }