IoTSecureTunneling

public struct IoTSecureTunneling

Client object for interacting with AWS IoTSecureTunneling service.

AWS IoT Secure Tunneling AWS IoT Secure Tunnling enables you to create remote connections to devices deployed in the field. For more information about how AWS IoT Secure Tunneling works, see the User Guide.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the IoTSecureTunneling 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

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls

closeTunnel(_:)
Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted.
Declaration
Swift

public func closeTunnel(_ input: CloseTunnelRequest) -> EventLoopFuture<CloseTunnelResponse>


                    
                    
                    describeTunnel(_:)

Gets information about a tunnel identified by the unique tunnel id.

Declaration

Swift

public func describeTunnel(_ input: DescribeTunnelRequest) -> EventLoopFuture<DescribeTunnelResponse>


                    
                    
                    listTagsForResource(_:)

Lists the tags for the specified resource.

Declaration

Swift

public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>

listTunnels(_:)
List all tunnels for an AWS account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.
Declaration
Swift

public func listTunnels(_ input: ListTunnelsRequest) -> EventLoopFuture<ListTunnelsResponse>
openTunnel(_:)
Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server. .
Declaration
Swift

public func openTunnel(_ input: OpenTunnelRequest) -> EventLoopFuture<OpenTunnelResponse>


                    
                    
                    tagResource(_:)

A resource tag.

Declaration

Swift

public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>


                    
                    
                    untagResource(_:)

Removes a tag from a resource.

Declaration

Swift

public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>

Paginators

listTunnelsPaginator(_:onPage:)
List all tunnels for an AWS account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.
Declaration
Swift

public func listTunnelsPaginator(_ input: ListTunnelsRequest, onPage: @escaping (ListTunnelsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListTunnelsRequest

Undocumented

Declaration

Swift

public struct ListTunnelsRequest : AWSShape

extension IoTSecureTunneling.ListTunnelsRequest: AWSPaginateStringToken

CloseTunnelRequest
Undocumented
See more
Declaration
Swift

public struct CloseTunnelRequest : AWSShape
CloseTunnelResponse
Undocumented
See more
Declaration
Swift

public struct CloseTunnelResponse : AWSShape
ConnectionState
Undocumented
See more
Declaration
Swift

public struct ConnectionState : AWSShape
DescribeTunnelRequest
Undocumented
See more
Declaration
Swift

public struct DescribeTunnelRequest : AWSShape
DescribeTunnelResponse
Undocumented
See more
Declaration
Swift

public struct DescribeTunnelResponse : AWSShape
DestinationConfig
Undocumented
See more
Declaration
Swift

public struct DestinationConfig : AWSShape
ListTagsForResourceRequest
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceRequest : AWSShape
ListTagsForResourceResponse
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceResponse : AWSShape
ListTunnelsResponse
Undocumented
See more
Declaration
Swift

public struct ListTunnelsResponse : AWSShape
OpenTunnelRequest
Undocumented
See more
Declaration
Swift

public struct OpenTunnelRequest : AWSShape
OpenTunnelResponse
Undocumented
See more
Declaration
Swift

public struct OpenTunnelResponse : AWSShape
Tag
Undocumented
See more
Declaration
Swift

public struct Tag : AWSShape
TagResourceRequest
Undocumented
See more
Declaration
Swift

public struct TagResourceRequest : AWSShape
TagResourceResponse
Undocumented
See more
Declaration
Swift

public struct TagResourceResponse : AWSShape
TimeoutConfig
Undocumented
See more
Declaration
Swift

public struct TimeoutConfig : AWSShape
Tunnel
Undocumented
See more
Declaration
Swift

public struct Tunnel : AWSShape
TunnelSummary
Undocumented
See more
Declaration
Swift

public struct TunnelSummary : AWSShape
UntagResourceRequest
Undocumented
See more
Declaration
Swift

public struct UntagResourceRequest : AWSShape
UntagResourceResponse
Undocumented
See more
Declaration
Swift

public struct UntagResourceResponse : AWSShape

Enums


                    
                    
                    ConnectionStatus

Undocumented

Declaration

Swift

public enum ConnectionStatus : String, CustomStringConvertible, Codable


                    
                    
                    TunnelStatus

Undocumented

Declaration

Swift

public enum TunnelStatus : String, CustomStringConvertible, Codable