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

Clears the set of AWS credentials currently set as default in the shell or, if supplied with a name, deletes the set of credentials associated with the supplied name from the local credentials store.

Syntax

Clear-AWSCredential
-ProfileName <String>
-ProfileLocation <String>

Description

Clears the set of AWS credentials currently set as default in the shell or, if supplied with a name, deletes the set of credentials associated with the supplied name from the local credentials store. Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias Clear-AWSCredentials.

Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias, Clear-AWSCredentials.

Parameters

-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.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 name associated with a set of credentials in the local store that are to be deleted. If not specified, the default credentials in the shell are cleared.
Required?False
Position?Named
Accept pipeline input?False

Inputs

This cmdlet does not accept pipeline input.

Outputs

None
This cmdlet does not generate any output.

Examples

Example 1

PS C:\>Clear-AWSCredential
Clears any credentials set as default in the current shell. The stored profiles are not affected.

Example 2

PS C:\>Clear-AWSCredential -ProfileName myCredentials
Deletes the credential profile named 'myCredentials'.

Supported Version

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