[ aws . iot ]

get-thing-connectivity-data

Description

Retrieves the live connectivity status per device.

See also: AWS API Documentation

Synopsis

  get-thing-connectivity-data
--thing-name <value>
[--include-socket-information | --no-include-socket-information]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--thing-name (string) [required]

The name of your IoT thing.

Constraints:

• min: 1
• max: 128
• pattern: [a-zA-Z0-9:_-]+

--include-socket-information | --no-include-socket-information (boolean)

Specifies if socket information (sourcePort, targetPort, sourceIp, targetIp, vpcEndpointId) should be included in the GetThingConnectivityData response. Set to true to include socket information. Set to false to omit socket information. By default, this is set to false .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream
• off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

thingName -> (string)

The name of your IoT thing.

Constraints:

• min: 1
• max: 128
• pattern: [a-zA-Z0-9:_-]+

connected -> (boolean)

A Boolean that indicates the connectivity status.

timestamp -> (timestamp)

The timestamp of when the event occurred. When you enable or update the indexing configuration, this value might be the Unix epoch time (0) for devices that have never connected or have been disconnected for more than an hour.

disconnectReason -> (string)

The reason why the client is disconnecting. When you enable or update the indexing configuration, this value might be UNKNOWN for devices that have never connected or have been disconnected for more than an hour.

Possible values:

• AUTH_ERROR
• CLIENT_INITIATED_DISCONNECT
• CLIENT_ERROR
• CONNECTION_LOST
• DUPLICATE_CLIENTID
• FORBIDDEN_ACCESS
• MQTT_KEEP_ALIVE_TIMEOUT
• SERVER_ERROR
• SERVER_INITIATED_DISCONNECT
• API_INITIATED_DISCONNECT
• THROTTLED
• WEBSOCKET_TTL_EXPIRATION
• CUSTOMAUTH_TTL_EXPIRATION
• UNKNOWN
• NONE

sourceIp -> (string)

The IP address of the client that initiated the connection.

sourcePort -> (integer)

The client’s source port.

targetIp -> (string)

The IP address of the Amazon Web Services IoT Core endpoint that the client connected to.

targetPort -> (integer)

The port number of the Amazon Web Services IoT Core endpoint that the client connected to.

vpcEndpointId -> (string)

The ID of the VPC endpoint. Present for clients connected to Amazon Web Services IoT Core via a VPC endpoint.

keepAliveDuration -> (integer)

The keep-alive interval in seconds that the client specified when establishing the connection.

cleanSession -> (boolean)

Indicates whether the client is using a clean session. Returns true for clean sessions.

sessionExpiry -> (long)

The session expiry interval in seconds for the MQTT client connection. This value indicates how long the session will remain active after the client disconnects.

clientId -> (string)

The unique identifier of the MQTT client.