Class: Aws::IoTDataPlane::Types::GetConnectionRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotdataplane/types.rb

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_id ⇒ String

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.

Returns:

  • (String) 


137
138
139
140
141
142
 
# File 'lib/aws-sdk-iotdataplane/types.rb', line 137

class GetConnectionRequest < Struct.new(
  :client_id,
  :include_socket_information)
  SENSITIVE = []
  include Aws::Structure
end

#include_socket_information ⇒ Boolean

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.

[1]: docs.aws.amazon.com/iot/latest/developerguide/mqtt.html#mqtt-client-disconnect

Returns:

  • (Boolean) 


137
138
139
140
141
142
 
# File 'lib/aws-sdk-iotdataplane/types.rb', line 137

class GetConnectionRequest < Struct.new(
  :client_id,
  :include_socket_information)
  SENSITIVE = []
  include Aws::Structure
end