This is the response object from the GetConnection operation.
In this article ▶
Inheritance Hierarchy
Namespace: Amazon.IotData.Model
Assembly: AWSSDK.IotData.dll
Version: 3.x.y.z
Syntax
public class GetConnectionResponse : AmazonWebServiceResponse
The GetConnectionResponse type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GetConnectionResponse() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
CleanSession | System.Nullable<System.Boolean> |
Gets and sets the property CleanSession.
Indicates whether the client is using a clean session. Returns |
|
|
ClientId | System.String |
Gets and sets the property ClientId. The unique identifier of the MQTT client. This is the same client ID that was used when the client established the connection. |
|
|
Connected | System.Nullable<System.Boolean> |
Gets and sets the property Connected.
The connection state of the client. Returns |
|
|
ConnectedSince | System.Nullable<System.Int64> |
Gets and sets the property ConnectedSince. Unix timestamp (in milliseconds) indicating when the client connected. Present only when connected is true. |
|
|
ContentLength | System.Int64 | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
|
|
DisconnectedSince | System.Nullable<System.Int64> |
Gets and sets the property DisconnectedSince. Unix timestamp (in milliseconds) indicating when the client disconnected. Present only when connected is false. This information is available for 30 minutes after the client disconnects. |
|
|
DisconnectReason | System.String |
Gets and sets the property DisconnectReason. The reason for the last disconnection, if the client is currently disconnected. See the developer guide for valid disconnect reasons. |
|
|
HttpStatusCode | System.Net.HttpStatusCode | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
|
|
KeepAliveDuration | System.Nullable<System.Int32> |
Gets and sets the property KeepAliveDuration. The keep-alive interval in seconds that the client specified when establishing the connection. |
|
|
ResponseMetadata | Amazon.Runtime.ResponseMetadata | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
|
|
SessionExpiry | System.Nullable<System.Int64> |
Gets and sets the property SessionExpiry. The session expiry interval in seconds for the MQTT client connection. This is configured by the user. This value indicates how long the session will remain active after the client disconnects. |
|
|
SourceIp | System.String |
Gets and sets the property SourceIp. The IP address of the client that initiated the connection. |
|
|
SourcePort | System.Nullable<System.Int32> |
Gets and sets the property SourcePort. The client's source port. |
|
|
TargetIp | System.String |
Gets and sets the property TargetIp. The IP address of the Amazon Web Services IoT Core endpoint that the client connected to. For clients connected to VPC endpoints, this is the private IP address of the network interface the client is connected to. |
|
|
TargetPort | System.Nullable<System.Int32> |
Gets and sets the property TargetPort. The port number of the Amazon Web Services IoT Core endpoint that the client connected to. |
|
|
ThingName | System.String |
Gets and sets the property ThingName. The name of the thing associated with the principal of the MQTT client, if applicable. |
|
|
VpcEndpointId | System.String |
Gets and sets the property VpcEndpointId. The ID of the VPC endpoint. Present for clients connected to IoT Core via a VPC endpoint. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer