Get Password Data

ec2_get_password_data

R Documentation

Retrieves the encrypted administrator password for a running Windows instance

Description

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.

Usage

ec2_get_password_data(InstanceId, DryRun)

Arguments

InstanceId

[required] The ID of the Windows instance.

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Value

A list with the following syntax:

list(
  InstanceId = "string",
  PasswordData = "string",
  Timestamp = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$get_password_data(
  InstanceId = "string",
  DryRun = TRUE|FALSE
)