import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { StartSessionRequest, StartSessionResponse } from "../models/models_2"; import { ServiceInputTypes, ServiceOutputTypes, SSMClientResolvedConfig } from "../SSMClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link StartSessionCommand}. */ export interface StartSessionCommandInput extends StartSessionRequest { } /** * @public * * The output of {@link StartSessionCommand}. */ export interface StartSessionCommandOutput extends StartSessionResponse, __MetadataBearer { } declare const StartSessionCommand_base: { new (input: StartSessionCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: StartSessionCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Initiates a connection to a target (for example, a managed node) for a Session Manager session. * Returns a URL and token that can be used to open a WebSocket connection for sending input and * receiving outputs.

* *

Amazon Web Services CLI usage: start-session is an interactive command that requires the Session Manager * plugin to be installed on the client machine making the call. For information, see Install * the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.

*

Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools * for PowerShell on Windows local machines.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SSMClient, StartSessionCommand } from "@aws-sdk/client-ssm"; // ES Modules import * // const { SSMClient, StartSessionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import * const client = new SSMClient(config); * const input = { // StartSessionRequest * Target: "STRING_VALUE", // required * DocumentName: "STRING_VALUE", * Reason: "STRING_VALUE", * Parameters: { // SessionManagerParameters * "": [ // SessionManagerParameterValueList * "STRING_VALUE", * ], * }, * }; * const command = new StartSessionCommand(input); * const response = await client.send(command); * // { // StartSessionResponse * // SessionId: "STRING_VALUE", * // TokenValue: "STRING_VALUE", * // StreamUrl: "STRING_VALUE", * // }; * * ``` * * @param StartSessionCommandInput - {@link StartSessionCommandInput} * @returns {@link StartSessionCommandOutput} * @see {@link StartSessionCommandInput} for command's `input` shape. * @see {@link StartSessionCommandOutput} for command's `response` shape. * @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape. * * @throws {@link InternalServerError} (server fault) *

An error occurred on the server side.

* * @throws {@link InvalidDocument} (client fault) *

The specified SSM document doesn't exist.

* * @throws {@link TargetNotConnected} (client fault) *

The specified target managed node for the session isn't fully configured for use with Session Manager. * For more information, see Setting up * Session Manager in the Amazon Web Services Systems Manager User Guide. This error is also returned if you * attempt to start a session on a managed node that is located in a different account or * Region

* * @throws {@link SSMServiceException} *

Base exception class for all service exceptions from SSM service.

* * * @public */ export declare class StartSessionCommand extends StartSessionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartSessionRequest; output: StartSessionResponse; }; sdk: { input: StartSessionCommandInput; output: StartSessionCommandOutput; }; }; }