AWS Tools for Windows PowerShell
Command 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.

Synopsis

Calls the Amazon Elastic Compute Cloud GetPasswordData API operation.

Syntax

AutoInspectForPemFile (Default)

Get-EC2PasswordData
-InstanceId <String>
-Decrypt <SwitchParameter>

ManuallySupplyPemFile

Get-EC2PasswordData
-InstanceId <String>
-Decrypt <SwitchParameter>
-PemFile <String>

Description

Retrieves the encrypted administrator password for the instances running Windows and optionally decrypts it. When running on Windows with the desktop version of PowerShell if the -Decrypt switch is specified the cmdlet can attempt to auto-discover the name of the keypair that was used to launch the instance, and inspects the configuration store of the AWS Toolkit for Visual Studio to determine if the corresponding keypair data needed to decrypt the password is available locally. If it is the password will be decrypted without needing to specify the location of the Pem file. On platforms other than Windows, or when running PowerShell Core on Windows, the configuration store of the AWS Toolkit for Visual Studio is not available. In these situations the location of a Pem file containing the data needed to decrypt the password can be supplied to the -PemFile parameter. Note that if the -PemFile parameter is supplied (on any platform), the cmdlet automatically assumes that -Decrypt is set.

Parameters

-Decrypt <SwitchParameter>
If specified the instance password is decrypted and emitted to the pipeline as a string. Note: If the -Pem File parameter is used this switch is assumed to be set. It is included in both parameter sets for this cmdlet for legacy, non-breaking change reasons.
Required?False
Position?Named
Accept pipeline input?False
-InstanceId <String>
The ID of the instance for which to get the password.
Required?True
Position?1
Accept pipeline input?True (ByPropertyName)
-PemFile <String>
The name of a .pem file containing the key materials corresponding to the keypair used to launch the instance. This will be used to decrypt the password data. If -PemFile is specified, then -Decrypt is assumed.
Required?True
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

This cmdlet does not accept pipeline input.

Outputs

PasswordData
If -Decrypt or -PemFile are not specified, returns a string containing the encrypted password for later decryption. The service response (type Amazon.EC2.Model.GetPasswordDataResponse) is added to the cmdlet entry in the $AWSHistory stack.
string
If -Decrypt or -PemFile is specified, the decrypted password.

Examples

Example 1

PS C:\> Get-EC2PasswordData -InstanceId i-12345678 -PemFile C:\path\my-key-pair.pem

mYZ(PA9?C)Q
This example decrypts the password that Amazon EC2 assigned to the Administrator account for the specified Windows instance. As a pem file was specified, the setting of the -Decrypt switch is automatically assumed.

Example 2

PS C:\> Get-EC2PasswordData -InstanceId i-12345678 -Decrypt

mYZ(PA9?C)Q
(Windows PowerShell only) Inspects the instance to determine the name of the keypair used to launch the instance and then attempts to find the corresponding keypair data in the configuration store of the AWS Toolkit for Visual Studio. If the keypair data is found the password is decrypted.

Example 3

PS C:\> Get-EC2PasswordData -InstanceId i-12345678

iVz3BAK/WAXV.....dqt8WeMA==
Returns the encrypted password data for the instance.

Supported Version

AWS Tools for PowerShell: 2.x.y.z