AWS powershell documentation change
Summary
Restructured documentation by removing detailed installation instructions and replacing them with topic links to dedicated installation guides. Added CloudShell reference and improved module installation path documentation.
Security assessment
The changes primarily reorganize content structure and remove redundant installation steps. While the previous version contained security-related warnings about unblocking ZIP files, these were removed as part of content reorganization rather than addressing a specific vulnerability. No new security features or explicit security guidance were added.
Diff
diff --git a/powershell/v5/userguide/pstools-getting-set-up-windows.md b/powershell/v5/userguide/pstools-getting-set-up-windows.md index 884d6c816..f66608d32 100644 --- a//powershell/v5/userguide/pstools-getting-set-up-windows.md +++ b//powershell/v5/userguide/pstools-getting-set-up-windows.md @@ -5 +5 @@ -PrerequisitesInstall AWS.ToolsInstall AWSPowerShell.NetCoreInstall AWSPowerShellEnable Script ExecutionVersioningUpdating AWS Tools for PowerShell +Prerequisites @@ -10,0 +11,2 @@ The AWS Tools for PowerShell version 5 (V5) is in preview, therefore this conten +For information about the Tools for PowerShell that are pre-installed on AWS CloudShell, see [Installed on CloudShell](./pstools-getting-set-up-cloudshell.html). + @@ -13 +15 @@ A Windows-based computer can run any of the AWS Tools for PowerShell package opt - * AWS.Tools \- The modularized version of AWS Tools for PowerShell. Each AWS service is supported by its own individual, small module, with shared support modules `AWS.Tools.Common` and `AWS.Tools.Installer`. + * [AWS.Tools](./ps-installing-awstools.html) \- The modularized version of AWS Tools for PowerShell. Each AWS service is supported by its own individual, small module, with shared support modules `AWS.Tools.Common` and `AWS.Tools.Installer`. @@ -15 +17 @@ A Windows-based computer can run any of the AWS Tools for PowerShell package opt - * AWSPowerShell.NetCore \- The single, large-module version of AWS Tools for PowerShell. All AWS services are supported by this single, large module. + * [AWSPowerShell.NetCore](./ps-installing-awspowershellnetcore.html) \- The single, large-module version of AWS Tools for PowerShell. All AWS services are supported by this single, large module. @@ -21 +23 @@ Be aware that the single module might be too large to use with [AWS Lambda](http - * AWSPowerShell \- The legacy Windows-specific, single, large-module version of AWS Tools for PowerShell. All AWS services are supported by this single, large module. + * [AWSPowerShell](./ps-installing-awswindowspowershell.html) \- The legacy, Windows-specific, single, large-module version of AWS Tools for PowerShell. All AWS services are supported by this single, large module. @@ -26 +28 @@ Be aware that the single module might be too large to use with [AWS Lambda](http -The package you choose depends on the release and edition of Windows that you're running. +The package you choose depends on the release and edition of Windows that you are running. @@ -32 +34 @@ The AWS Tools for PowerShell are installed by default on all Windows-based Amazo -Setting up the AWS Tools for PowerShell involves the following high-level tasks, described in detail in this topic. +Setting up the AWS Tools for PowerShell involves the following high-level tasks, described in detail in subsequent topics. @@ -47,301 +49 @@ Newer versions of PowerShell, including PowerShell Core, are available as downlo -## Install `AWS.Tools` on Windows - -You can install the modularized version of AWS Tools for PowerShell on computers that are running Windows with Windows PowerShell 5.1, or PowerShell Core 6.0 or later. For information about how to install PowerShell Core, see [Installing various versions of PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell) on Microsoft's Web site. - -You can install `AWS.Tools` in one of three ways: - - * Using the cmdlets in the `AWS.Tools.Installer` module. This module simplifies the installation and update of other `AWS.Tools` modules. `AWS.Tools.Installer` requires `PowerShellGet`, and automatically downloads and installs an updated version of it. `AWS.Tools.Installer` automatically keeps your module versions in sync. When you install or update to a newer version of one module, the cmdlets in `AWS.Tools.Installer` automatically update all of your other `AWS.Tools` modules to the same version. - -This method is described in the procedure that follows. - - * Downloading the modules from `[AWS.Tools.zip](https://sdk-for-net.amazonwebservices.com/ps/v5/latest/AWS.Tools-preview.zip)` and extracting them in one of the module folders. You can discover your module folders by displaying the value of the `PSModulePath` environment variable. - -###### Warning - -After downloading the ZIP file and before extracting the contents, you might need to unblock it. This is typically done by opening the properties of the file, viewing the **General** tab, and selecting the **Unblock** checkbox if one exists. - -If the ZIP file needs to be unblocked but you don't do so, you might receive errors similar to the following: "Import-Module : Could not load file or assembly". - - * Installing each service module from the PowerShell Gallery using the `Install-Module` cmdlet. - - - - -###### To install `AWS.Tools` on Windows using the `AWS.Tools.Installer` module - - 1. Start a PowerShell session. - -###### Note - -We recommend that you _don't_ run PowerShell as an administrator with elevated permissions except when required by the task at hand. This is because of the potential security risk and is inconsistent with the principle of least privilege. - - 2. To install the modularized `AWS.Tools` package, run the following command. - - PS > Install-Module -Name AWS.Tools.Installer - - Untrusted repository - You are installing the modules from an untrusted repository. If you trust this repository, change its InstallationPolicy value by running the Set-PSRepository cmdlet. Are you sure - you want to install the modules from 'PSGallery'? - [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "N"): y - -If you are notified that the repository is "untrusted", it asks you if you want to install anyway. Enter `y` to allow PowerShell to install the module. To avoid the prompt and install the module without trusting the repository, you can run the command with the `-Force` parameter. - - PS > Install-Module -Name AWS.Tools.Installer -Force - - 3. You can now install the module for each AWS service that you want to use by using the `Install-AWSToolsModule` cmdlet. For example, the following command installs the Amazon EC2 and Amazon S3 modules. This command also installs any dependent modules that are required for the specified module to work. For example, when you install your first `AWS.Tools` service module, it also installs `AWS.Tools.Common`. This is a shared module required by all AWS service modules. It also removes older versions of the modules, and updates other modules to the same newer version. - - PS > Install-AWSToolsModule AWS.Tools.EC2,AWS.Tools.S3 -CleanUp - Confirm - Are you sure you want to perform this action? - Performing the operation "Install-AWSToolsModule" on target "AWS Tools version 4.0.0.0". - [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): - - Installing module AWS.Tools.Common version 4.0.0.0 - Installing module AWS.Tools.EC2 version 4.0.0.0 - Installing module AWS.Tools.Glacier version 4.0.0.0 - Installing module AWS.Tools.S3 version 4.0.0.0 - - Uninstalling AWS.Tools version 3.3.618.0 - Uninstalling module AWS.Tools.Glacier - Uninstalling module AWS.Tools.S3 - Uninstalling module AWS.Tools.SimpleNotificationService - Uninstalling module AWS.Tools.SQS - Uninstalling module AWS.Tools.Common - -###### Note - -The `Install-AWSToolsModule` cmdlet downloads all requested modules from the `PSRepository` named `PSGallery` ([https://www.powershellgallery.com/](https://www.powershellgallery.com/)) and considers it a trusted source. Use the command `Get-PSRepository -Name PSGallery` for more information about this `PSRepository`. - -By default, the previous command installs modules into the `%USERPROFILE%\Documents\WindowsPowerShell\Modules` folder. To install the AWS Tools for PowerShell for all users of a computer, you must run the following command in a PowerShell session that you started as an administrator. For example, the following command installs the IAM module to the `%ProgramFiles%\WindowsPowerShell\Modules` folder that is accessible by all users. - - PS > Install-AWSToolsModule AWS.Tools.IdentityManagement -Scope AllUsers - -To install other modules, run similar commands with the appropriate module names, as found in the [PowerShell Gallery](https://www.powershellgallery.com/packages?q=aws). - - - - -## Install AWSPowerShell.NetCore on Windows - -You can install the AWSPowerShell.NetCore on computers that are running Windows with PowerShell version 3 through 5.1, or PowerShell Core 6.0 or later. For information about how to install PowerShell Core, see [Installing various versions of PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell) on the Microsoft PowerShell website. - -You can install AWSPowerShell.NetCore in one of two ways - - * Downloading the module from [AWSPowerShell.NetCore.zip](https://sdk-for-net.amazonwebservices.com/ps/v5/latest/AWSPowerShell.NetCore-preview.zip) and extracting it in one of the module directories. You can discover your module directories by displaying the value of the `PSModulePath` environment variable. - -###### Warning - -After downloading the ZIP file and before extracting the contents, you might need to unblock it. This is typically done by opening the properties of the file, viewing the **General** tab, and selecting the **Unblock** checkbox if one exists. - -If the ZIP file needs to be unblocked but you don't do so, you might receive errors similar to the following: "Import-Module : Could not load file or assembly". - - * Installing from the PowerShell Gallery using the `Install-Module` cmdlet, as described in the following procedure. - - - - -**To install AWSPowerShell.NetCore from the PowerShell Gallery using the Install-Module cmdlet** - -To install the AWSPowerShell.NetCore from the PowerShell Gallery, your computer must be running PowerShell 5.0 or later, or running [PowerShellGet](https://www.powershellgallery.com/packages/PowerShellGet) on PowerShell 3 or later. Run the following command. - - - PS > Install-Module -name AWSPowerShell.NetCore - -If you're running PowerShell as administrator, the previous command installs AWS Tools for PowerShell for all users on the computer. If you're running PowerShell as a standard user without administrator permissions, that same command installs AWS Tools for PowerShell for only the current user. - -To install for only the current user when that user has administrator permissions, run the command with the `-Scope CurrentUser` parameter set, as follows. - - - PS > Install-Module -name AWSPowerShell.NetCore -Scope CurrentUser - -Although PowerShell 3.0 and later releases typically load modules into your PowerShell session the first time you run a cmdlet in the module, the AWSPowerShell.NetCore module is too large to support this functionality. You must instead explicitly load the AWSPowerShell.NetCore Core module into your PowerShell session by running the following command. - - - PS > Import-Module AWSPowerShell.NetCore - -To load the AWSPowerShell.NetCore module into a PowerShell session automatically, add that command to your PowerShell profile. For more information about editing your PowerShell profile, see [About Profiles](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_profiles) in the PowerShell documentation. - -## Install AWSPowerShell on Windows PowerShell - -You can install the AWS Tools for Windows PowerShell in one of two ways: - - * Downloading the module from [AWSPowerShell.zip](https://sdk-for-net.amazonwebservices.com/ps/v5/latest/AWSPowerShell-preview.zip) and extracting it in one of the module directories. You can discover your module directories by displaying the value of the `PSModulePath` environment variable. - -###### Warning - -After downloading the ZIP file and before extracting the contents, you might need to unblock it. This is typically done by opening the properties of the file, viewing the **General** tab, and selecting the **Unblock** checkbox if one exists. - -If the ZIP file needs to be unblocked but you don't do so, you might receive errors similar to the following: "Import-Module : Could not load file or assembly". - - * Installing from the PowerShell Gallery using the `Install-Module` cmdlet as described in the following procedure. - - - - -**To install AWSPowerShell from the PowerShell Gallery using the Install-Module cmdlet** - -You can install the AWSPowerShell from the PowerShell Gallery if you're running PowerShell 5.0 or later, or have installed [PowerShellGet](https://www.powershellgallery.com/packages/PowerShellGet) on PowerShell 3 or later. You can install and update AWSPowerShell from Microsoft's [PowerShell Gallery](https://www.powershellgallery.com/packages/AWSPowerShell) by running the following command. - - - PS > Install-Module -Name AWSPowerShell - -To load the AWSPowerShell module into a PowerShell session automatically, add the previous `import-module` cmdlet to your PowerShell profile. For more information about editing your PowerShell profile, see [About Profiles](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_profiles?view=powershell-6) in the PowerShell documentation. - -###### Note - -The Tools for Windows PowerShell are installed by default on all Windows-based Amazon Machine Images (AMIs). - -## Enable Script Execution - -To load the AWS Tools for PowerShell modules, you must enable PowerShell script execution. To enable script execution, run the `Set-ExecutionPolicy` cmdlet to set a policy of `RemoteSigned`. For more information, see [About Execution Policies](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies) on the Microsoft Technet website. - -###### Note - -This is a requirement only for computers that are running Windows. The `ExecutionPolicy` security restriction is not present on other operating systems. - -**To enable script execution** - - 1. Administrator rights are required to set the execution policy. If you are not logged in as a user with administrator rights, open a PowerShell session as Administrator. Choose **Start** , and then choose **All Programs**. Choose **Accessories** , and then choose **Windows PowerShell**. Right-click **Windows PowerShell** , and on the context menu, choose **Run as administrator**. - - 2. At the command prompt, enter the following. - - PS > Set-ExecutionPolicy RemoteSigned - - - - -###### Note - -On a 64-bit system, you must do this separately for the 32-bit version of PowerShell, **Windows PowerShell (x86)**. - -If you don't have the execution policy set correctly, PowerShell shows the following error whenever you try to run a script, such as your profile. - - - File C:\Users\username\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1 cannot be loaded because the execution