get_connection_status

get_connection_status(**kwargs)

Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.

See also: AWS API Documentation

Request Syntax

response = client.get_connection_status(
    Target='string'
)
Parameters
Target (string) --

[REQUIRED]

The managed node ID.

Return type
dict
Returns
Response Syntax
{
    'Target': 'string',
    'Status': 'Connected'|'NotConnected'
}

Response Structure

  • (dict) --
    • Target (string) --

      The ID of the managed node to check connection status.

    • Status (string) --

      The status of the connection to the managed node. For example, 'Connected' or 'Not Connected'.

Exceptions

  • SSM.Client.exceptions.InternalServerError