Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GetPasswordDataCommand

Retrieves the encrypted administrator password for a running Windows instance.

The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon EC2 User Guide.

For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

example

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, GetPasswordDataCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, GetPasswordDataCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const command = new GetPasswordDataCommand(input);
const response = await client.send(command);
see

GetPasswordDataCommandInput for command's input shape.

see

GetPasswordDataCommandOutput for command's response shape.

see

config for EC2Client's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: GetPasswordDataCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<GetPasswordDataCommandInput, GetPasswordDataCommandOutput>

Methods

Static getEndpointParameterInstructions