import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient"; import type { GetInstanceAccessDetailsRequest, GetInstanceAccessDetailsResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetInstanceAccessDetailsCommand}. */ export interface GetInstanceAccessDetailsCommandInput extends GetInstanceAccessDetailsRequest { } /** * @public * * The output of {@link GetInstanceAccessDetailsCommand}. */ export interface GetInstanceAccessDetailsCommandOutput extends GetInstanceAccessDetailsResult, __MetadataBearer { } declare const GetInstanceAccessDetailsCommand_base: { new (input: GetInstanceAccessDetailsCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: GetInstanceAccessDetailsCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Returns temporary SSH keys you can use to connect to a specific virtual private server, or * instance.

*

The get instance access details operation supports tag-based access control * via resource tags applied to the resource identified by instance name. For more * information, see the Amazon Lightsail Developer Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { LightsailClient, GetInstanceAccessDetailsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import * // const { LightsailClient, GetInstanceAccessDetailsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import * // import type { LightsailClientConfig } from "@aws-sdk/client-lightsail"; * const config = {}; // type is LightsailClientConfig * const client = new LightsailClient(config); * const input = { // GetInstanceAccessDetailsRequest * instanceName: "STRING_VALUE", // required * protocol: "ssh" || "rdp", * }; * const command = new GetInstanceAccessDetailsCommand(input); * const response = await client.send(command); * // { // GetInstanceAccessDetailsResult * // accessDetails: { // InstanceAccessDetails * // certKey: "STRING_VALUE", * // expiresAt: new Date("TIMESTAMP"), * // ipAddress: "STRING_VALUE", * // ipv6Addresses: [ // Ipv6AddressList * // "STRING_VALUE", * // ], * // password: "STRING_VALUE", * // passwordData: { // PasswordData * // ciphertext: "STRING_VALUE", * // keyPairName: "STRING_VALUE", * // }, * // privateKey: "STRING_VALUE", * // protocol: "ssh" || "rdp", * // instanceName: "STRING_VALUE", * // username: "STRING_VALUE", * // hostKeys: [ // HostKeysList * // { // HostKeyAttributes * // algorithm: "STRING_VALUE", * // publicKey: "STRING_VALUE", * // witnessedAt: new Date("TIMESTAMP"), * // fingerprintSHA1: "STRING_VALUE", * // fingerprintSHA256: "STRING_VALUE", * // notValidBefore: new Date("TIMESTAMP"), * // notValidAfter: new Date("TIMESTAMP"), * // }, * // ], * // }, * // }; * * ``` * * @param GetInstanceAccessDetailsCommandInput - {@link GetInstanceAccessDetailsCommandInput} * @returns {@link GetInstanceAccessDetailsCommandOutput} * @see {@link GetInstanceAccessDetailsCommandInput} for command's `input` shape. * @see {@link GetInstanceAccessDetailsCommandOutput} for command's `response` shape. * @see {@link LightsailClientResolvedConfig | config} for LightsailClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

Lightsail throws this exception when the user cannot be authenticated or uses invalid * credentials to access a resource.

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

Lightsail throws this exception when an account is still in the setup in progress * state.

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

Lightsail throws this exception when user input does not conform to the validation rules * of an input field.

* *

Domain and distribution APIs are only available in the N. Virginia * (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services * Region configuration to us-east-1 to create, view, or edit these * resources.

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

Lightsail throws this exception when it cannot find a resource.

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

Lightsail throws this exception when an operation fails to execute.

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

Lightsail throws this exception when an operation is performed on resources in an opt-in * Region that is currently being set up.

* * @throws {@link ServiceException} (server fault) *

A general service exception.

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

Lightsail throws this exception when the user has not been authenticated.

* * @throws {@link LightsailServiceException} *

Base exception class for all service exceptions from Lightsail service.

* * * @public */ export declare class GetInstanceAccessDetailsCommand extends GetInstanceAccessDetailsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetInstanceAccessDetailsRequest; output: GetInstanceAccessDetailsResult; }; sdk: { input: GetInstanceAccessDetailsCommandInput; output: GetInstanceAccessDetailsCommandOutput; }; }; }