View on GitHub
IoT1ClickProjects Structure Reference
IoT1ClickProjects
public struct IoT1ClickProjectsClient object for interacting with AWS IoT1ClickProjects service.
The AWS IoT 1-Click Projects API Reference
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the IoT1ClickProjects 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.
-
Associates a physical device with a placement.
Declaration
Swift
public func associateDeviceWithPlacement(_ input: AssociateDeviceWithPlacementRequest) -> EventLoopFuture<AssociateDeviceWithPlacementResponse> -
Creates an empty placement.
Declaration
Swift
public func createPlacement(_ input: CreatePlacementRequest) -> EventLoopFuture<CreatePlacementResponse> -
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.
Declaration
Swift
public func createProject(_ input: CreateProjectRequest) -> EventLoopFuture<CreateProjectResponse> -
Deletes a placement. To delete a placement, it must not have any devices associated with it. When you delete a placement, all associated data becomes irretrievable.
Declaration
Swift
public func deletePlacement(_ input: DeletePlacementRequest) -> EventLoopFuture<DeletePlacementResponse> -
Deletes a project. To delete a project, it must not have any placements associated with it. When you delete a project, all associated data becomes irretrievable.
Declaration
Swift
public func deleteProject(_ input: DeleteProjectRequest) -> EventLoopFuture<DeleteProjectResponse> -
Describes a placement in a project.
Declaration
Swift
public func describePlacement(_ input: DescribePlacementRequest) -> EventLoopFuture<DescribePlacementResponse> -
Returns an object describing a project.
Declaration
Swift
public func describeProject(_ input: DescribeProjectRequest) -> EventLoopFuture<DescribeProjectResponse> -
Removes a physical device from a placement.
Declaration
Swift
public func disassociateDeviceFromPlacement(_ input: DisassociateDeviceFromPlacementRequest) -> EventLoopFuture<DisassociateDeviceFromPlacementResponse> -
Returns an object enumerating the devices in a placement.
Declaration
Swift
public func getDevicesInPlacement(_ input: GetDevicesInPlacementRequest) -> EventLoopFuture<GetDevicesInPlacementResponse> -
Lists the placement(s) of a project.
Declaration
Swift
public func listPlacements(_ input: ListPlacementsRequest) -> EventLoopFuture<ListPlacementsResponse> -
Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
Declaration
Swift
public func listProjects(_ input: ListProjectsRequest) -> EventLoopFuture<ListProjectsResponse> -
Lists the tags (metadata key/value pairs) which you have assigned to the resource.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse> -
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 AWS Tagging Strategies.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse> -
Removes one or more tags (metadata key/value pairs) from a resource.
Declaration
Swift
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse> -
Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., “”).
Declaration
Swift
public func updatePlacement(_ input: UpdatePlacementRequest) -> EventLoopFuture<UpdatePlacementResponse> -
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., “”).
Declaration
Swift
public func updateProject(_ input: UpdateProjectRequest) -> EventLoopFuture<UpdateProjectResponse>
-
Lists the placement(s) of a project.
Declaration
Swift
public func listPlacementsPaginator(_ input: ListPlacementsRequest, onPage: @escaping (ListPlacementsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
Declaration
Swift
public func listProjectsPaginator(_ input: ListProjectsRequest, onPage: @escaping (ListProjectsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct ListPlacementsRequest : AWSShapeextension IoT1ClickProjects.ListPlacementsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListProjectsRequest : AWSShapeextension IoT1ClickProjects.ListProjectsRequest: AWSPaginateStringToken