AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to GetPasswordDataAsync.

Namespace: Amazon.EC2
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public abstract GetPasswordDataResponse GetPasswordData(
         GetPasswordDataRequest request
)

Parameters

request
Type: Amazon.EC2.Model.GetPasswordDataRequest

Container for the necessary parameters to execute the GetPasswordData service method.

Return Value


The response from the GetPasswordData service method, as returned by EC2.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also