AWS SDK Version 4 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.

Container for the parameters to the GetConnection operation. Retrieves connection information for the specified MQTT client.

Requires permission to access the GetConnection action.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IotData.AmazonIotDataRequest
      Amazon.IotData.Model.GetConnectionRequest

Namespace: Amazon.IotData.Model
Assembly: AWSSDK.IotData.dll
Version: 3.x.y.z

Syntax

C#
public class GetConnectionRequest : AmazonIotDataRequest
         IAmazonWebServiceRequest

The GetConnectionRequest type exposes the following members

Constructors

NameDescription
Public Method GetConnectionRequest()

Properties

NameTypeDescription
Public Property ClientId System.String

Gets and sets the property ClientId.

The unique identifier of the MQTT client to retrieve connection information. The client ID can't start with a dollar sign ($).

MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.

Public Property IncludeSocketInformation System.Nullable<System.Boolean>

Gets and sets the property IncludeSocketInformation.

Specifies if socket information (sourcePort, targetPort, sourceIp, targetIp) should be included in the GetConnection response. Set to TRUE to include socket information. Set to FALSE to omit socket information. By default, this is set to FALSE. See the developer guide for how to authorize this parameter.

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