Skip to content

get_connection_status

get_connection_status(
    target: SessionTarget, *, config_overrides: Optional[SSMClientConfig] = None
) -> GetConnectionStatusResponse

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

Parameters:

Raises:

Source code in docs_src/capo_ssm/_services/ssm.py
def get_connection_status(
    self,
    target: "capo_ssm.types.session_target.SessionTarget",
    *,
    config_overrides: Optional[SSMClientConfig] = None,
) -> "capo_ssm.types.get_connection_status_response.GetConnectionStatusResponse":
    """<p>Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.</p>

    Args:
        target: <p>The managed node ID.</p>

    Raises:
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.get_connection_status_request.GetConnectionStatusRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.get_connection_status_response.GetConnectionStatusResponse"
    ]:
        import capo_ssm._operations.amazon_ssm.get_connection_status

        output, http_response = (
            capo_ssm._operations.amazon_ssm.get_connection_status.get_connection_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetConnectionStatus")
    )
    input_: capo_ssm.types.get_connection_status_request.GetConnectionStatusRequest = {
        "target": target
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output