AWS Systems Manager
API Reference (API Version 2014-11-06)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

GetConnectionStatus

Retrieves the Session Manager connection status for an instance to determine whether it is connected 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 ID of the instance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

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.

Status

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

Type: String

Valid Values: Connected | NotConnected

Target

The ID of the instance to check connection status.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: