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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGetPasswordData and EndGetPasswordData.
Namespace: Amazon.EC2
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z
public virtual Task<GetPasswordDataResponse> GetPasswordDataAsync( GetPasswordDataRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the GetPasswordData service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5