/* * 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-projects-2018-05-14.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.IoT1ClickProjects.Model; namespace Amazon.IoT1ClickProjects { /// <summary> /// Interface for accessing IoT1ClickProjects /// /// The AWS IoT 1-Click Projects API Reference /// </summary> public partial interface IAmazonIoT1ClickProjects : IAmazonService, IDisposable { #region AssociateDeviceWithPlacement /// <summary> /// Associates a physical device with a placement. /// </summary> /// <param name="request">Container for the necessary parameters to execute the AssociateDeviceWithPlacement service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the AssociateDeviceWithPlacement service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceConflictException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceNotFoundException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/AssociateDeviceWithPlacement">REST API Reference for AssociateDeviceWithPlacement Operation</seealso> Task<AssociateDeviceWithPlacementResponse> AssociateDeviceWithPlacementAsync(AssociateDeviceWithPlacementRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreatePlacement /// <summary> /// Creates an empty placement. /// </summary> /// <param name="request">Container for the necessary parameters to execute the CreatePlacement service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the CreatePlacement service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceConflictException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceNotFoundException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/CreatePlacement">REST API Reference for CreatePlacement Operation</seealso> Task<CreatePlacementResponse> CreatePlacementAsync(CreatePlacementRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateProject /// <summary> /// Creates an empty project with a placement template. A project contains zero or more /// placements that adhere to the placement template defined in the project. /// </summary> /// <param name="request">Container for the necessary parameters to execute the CreateProject service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the CreateProject service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceConflictException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/CreateProject">REST API Reference for CreateProject Operation</seealso> Task<CreateProjectResponse> CreateProjectAsync(CreateProjectRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeletePlacement /// <summary> /// Deletes a placement. To delete a placement, it must not have any devices associated /// with it. /// /// <note> /// <para> /// When you delete a placement, all associated data becomes irretrievable. /// </para> /// </note> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeletePlacement service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the DeletePlacement service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceNotFoundException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.TooManyRequestsException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DeletePlacement">REST API Reference for DeletePlacement Operation</seealso> Task<DeletePlacementResponse> DeletePlacementAsync(DeletePlacementRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteProject /// <summary> /// Deletes a project. To delete a project, it must not have any placements associated /// with it. /// /// <note> /// <para> /// When you delete a project, all associated data becomes irretrievable. /// </para> /// </note> /// </summary> /// <param name="request">Container for the necessary parameters to execute the DeleteProject service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the DeleteProject service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceNotFoundException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.TooManyRequestsException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DeleteProject">REST API Reference for DeleteProject Operation</seealso> Task<DeleteProjectResponse> DeleteProjectAsync(DeleteProjectRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribePlacement /// <summary> /// Describes a placement in a project. /// </summary> /// <param name="request">Container for the necessary parameters to execute the DescribePlacement service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the DescribePlacement service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceNotFoundException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DescribePlacement">REST API Reference for DescribePlacement Operation</seealso> Task<DescribePlacementResponse> DescribePlacementAsync(DescribePlacementRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeProject /// <summary> /// Returns an object describing a project. /// </summary> /// <param name="request">Container for the necessary parameters to execute the DescribeProject service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the DescribeProject service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceNotFoundException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DescribeProject">REST API Reference for DescribeProject Operation</seealso> Task<DescribeProjectResponse> DescribeProjectAsync(DescribeProjectRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DisassociateDeviceFromPlacement /// <summary> /// Removes a physical device from a placement. /// </summary> /// <param name="request">Container for the necessary parameters to execute the DisassociateDeviceFromPlacement service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the DisassociateDeviceFromPlacement service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceNotFoundException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.TooManyRequestsException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DisassociateDeviceFromPlacement">REST API Reference for DisassociateDeviceFromPlacement Operation</seealso> Task<DisassociateDeviceFromPlacementResponse> DisassociateDeviceFromPlacementAsync(DisassociateDeviceFromPlacementRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetDevicesInPlacement /// <summary> /// Returns an object enumerating the devices in a placement. /// </summary> /// <param name="request">Container for the necessary parameters to execute the GetDevicesInPlacement service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the GetDevicesInPlacement service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceNotFoundException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/GetDevicesInPlacement">REST API Reference for GetDevicesInPlacement Operation</seealso> Task<GetDevicesInPlacementResponse> GetDevicesInPlacementAsync(GetDevicesInPlacementRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListPlacements /// <summary> /// Lists the placement(s) of a project. /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListPlacements service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the ListPlacements service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceNotFoundException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListPlacements">REST API Reference for ListPlacements Operation</seealso> Task<ListPlacementsResponse> ListPlacementsAsync(ListPlacementsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListProjects /// <summary> /// Lists the AWS IoT 1-Click project(s) associated with your AWS account and region. /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListProjects service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the ListProjects service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListProjects">REST API Reference for ListProjects Operation</seealso> Task<ListProjectsResponse> ListProjectsAsync(ListProjectsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListTagsForResource /// <summary> /// Lists the tags (metadata key/value pairs) which you have assigned to the resource. /// </summary> /// <param name="request">Container for the necessary parameters to execute the ListTagsForResource service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the ListTagsForResource service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceNotFoundException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListTagsForResource">REST API Reference for ListTagsForResource Operation</seealso> Task<ListTagsForResourceResponse> ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region TagResource /// <summary> /// Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that /// can be used to manage a resource. For more information, see <a href="https://aws.amazon.com/answers/account-management/aws-tagging-strategies/">AWS /// Tagging Strategies</a>. /// </summary> /// <param name="request">Container for the necessary parameters to execute the TagResource service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the TagResource service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceNotFoundException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/TagResource">REST API Reference for TagResource Operation</seealso> Task<TagResourceResponse> TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UntagResource /// <summary> /// Removes one or more tags (metadata key/value pairs) from a resource. /// </summary> /// <param name="request">Container for the necessary parameters to execute the UntagResource service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the UntagResource service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceNotFoundException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UntagResource">REST API Reference for UntagResource Operation</seealso> Task<UntagResourceResponse> UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdatePlacement /// <summary> /// Updates a placement with the given attributes. To clear an attribute, pass an empty /// value (i.e., ""). /// </summary> /// <param name="request">Container for the necessary parameters to execute the UpdatePlacement service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the UpdatePlacement service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceNotFoundException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.TooManyRequestsException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UpdatePlacement">REST API Reference for UpdatePlacement Operation</seealso> Task<UpdatePlacementResponse> UpdatePlacementAsync(UpdatePlacementRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateProject /// <summary> /// Updates a project associated with your AWS account and region. With the exception /// of device template names, you can pass just the values that need to be updated because /// the update request will change only the values that are provided. To clear a value, /// pass the empty string (i.e., <code>""</code>). /// </summary> /// <param name="request">Container for the necessary parameters to execute the UpdateProject service method.</param> /// <param name="cancellationToken"> /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// </param> /// /// <returns>The response from the UpdateProject service method, as returned by IoT1ClickProjects.</returns> /// <exception cref="Amazon.IoT1ClickProjects.Model.InternalFailureException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.InvalidRequestException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.ResourceNotFoundException"> /// /// </exception> /// <exception cref="Amazon.IoT1ClickProjects.Model.TooManyRequestsException"> /// /// </exception> /// <seealso href="http://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UpdateProject">REST API Reference for UpdateProject Operation</seealso> Task<UpdateProjectResponse> UpdateProjectAsync(UpdateProjectRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion } }