@aws-sdk/client-ssm
Version:
AWS SDK for JavaScript Ssm Client for Node.js, Browser and React Native
76 lines (75 loc) • 3.17 kB
TypeScript
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
import type { TerminateSessionRequest, TerminateSessionResponse } from "../models/models_1";
/**
* @public
*/
export type { __MetadataBearer };
/**
* @public
*
* The input for {@link TerminateSessionCommand}.
*/
export interface TerminateSessionCommandInput extends TerminateSessionRequest {
}
/**
* @public
*
* The output of {@link TerminateSessionCommand}.
*/
export interface TerminateSessionCommandOutput extends TerminateSessionResponse, __MetadataBearer {
}
declare const TerminateSessionCommand_base: {
new (input: TerminateSessionCommandInput): import("@smithy/core/client").CommandImpl<TerminateSessionCommandInput, TerminateSessionCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
new (input: TerminateSessionCommandInput): import("@smithy/core/client").CommandImpl<TerminateSessionCommandInput, TerminateSessionCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
};
/**
* <p>Permanently ends a session and closes the data connection between the Session Manager client and
* SSM Agent on the managed node. A terminated session can't be resumed.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { SSMClient, TerminateSessionCommand } from "@aws-sdk/client-ssm"; // ES Modules import
* // const { SSMClient, TerminateSessionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import
* // import type { SSMClientConfig } from "@aws-sdk/client-ssm";
* const config = {}; // type is SSMClientConfig
* const client = new SSMClient(config);
* const input = { // TerminateSessionRequest
* SessionId: "STRING_VALUE", // required
* };
* const command = new TerminateSessionCommand(input);
* const response = await client.send(command);
* // { // TerminateSessionResponse
* // SessionId: "STRING_VALUE",
* // };
*
* ```
*
* @param TerminateSessionCommandInput - {@link TerminateSessionCommandInput}
* @returns {@link TerminateSessionCommandOutput}
* @see {@link TerminateSessionCommandInput} for command's `input` shape.
* @see {@link TerminateSessionCommandOutput} for command's `response` shape.
* @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape.
*
* @throws {@link InternalServerError} (server fault)
* <p>An error occurred on the server side.</p>
*
* @throws {@link SSMServiceException}
* <p>Base exception class for all service exceptions from SSM service.</p>
*
*
* @public
*/
export declare class TerminateSessionCommand extends TerminateSessionCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: TerminateSessionRequest;
output: TerminateSessionResponse;
};
sdk: {
input: TerminateSessionCommandInput;
output: TerminateSessionCommandOutput;
};
};
}