GetConnectionStatus
Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.
Request Syntax
{
"Target": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Target
-
The managed node ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 400.
Required: Yes
Response Syntax
{
"Status": "string",
"Target": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of GetConnectionStatus.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetConnectionStatus
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.0.0 Python/3.7.5 Windows/10 botocore/2.0.0dev4
X-Amz-Date: 20240221T180655Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240221/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 33
{
"Target": "i-02573cafcfEXAMPLE"
}Sample Response
{
"Status": "connected",
"Target": "i-02573cafcfEXAMPLE"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
