AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class CloseTunnelRequest

Container for the parameters to the CloseTunnel operation. 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.

Requires permission to access the CloseTunnel action.

Class CloseTunnelResponse

This is the response object from the CloseTunnel operation.

Class ConnectionState

The state of a connection.

Class DescribeTunnelRequest

Container for the parameters to the DescribeTunnel operation. Gets information about a tunnel identified by the unique tunnel id.

Requires permission to access the DescribeTunnel action.

Class DescribeTunnelResponse

This is the response object from the DescribeTunnel operation.

Class DestinationConfig

The destination configuration.

Class IoTSecureTunnelingPaginatorFactory

Paginators for the IoTSecureTunneling service

Class LimitExceededException

Thrown when a tunnel limit is exceeded.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists the tags for the specified resource.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class ListTunnelsRequest

Container for the parameters to the ListTunnels operation. List all tunnels for an Amazon Web Services account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.

Requires permission to access the ListTunnels action.

Class ListTunnelsResponse

This is the response object from the ListTunnels operation.

Class OpenTunnelRequest

Container for the parameters to the OpenTunnel operation. Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure Tunneling proxy server.

Requires permission to access the OpenTunnel action.

Class OpenTunnelResponse

This is the response object from the OpenTunnel operation.

Class ResourceNotFoundException

Thrown when an operation is attempted on a resource that does not exist.

Class RotateTunnelAccessTokenRequest

Container for the parameters to the RotateTunnelAccessToken operation. Revokes the current client access token (CAT) and returns new CAT for clients to use when reconnecting to secure tunneling to access the same tunnel.

Requires permission to access the RotateTunnelAccessToken action.

Rotating the CAT doesn't extend the tunnel duration. For example, say the tunnel duration is 12 hours and the tunnel has already been open for 4 hours. When you rotate the access tokens, the new tokens that are generated can only be used for the remaining 8 hours.

Class RotateTunnelAccessTokenResponse

This is the response object from the RotateTunnelAccessToken operation.

Class Tag

An arbitary key/value pair used to add searchable metadata to secure tunnel resources.

Class TagResourceRequest

Container for the parameters to the TagResource operation. A resource tag.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class TimeoutConfig

Tunnel timeout configuration.

Class Tunnel

A connection between a source computer and a destination device.

Class TunnelSummary

Information about the tunnel.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes a tag from a resource.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Interfaces

NameDescription
Interface IIoTSecureTunnelingPaginatorFactory

Paginators for the IoTSecureTunneling service

Interface IListTunnelsPaginator

Paginator for the ListTunnels operation