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

Updates all currently installed AWS.Tools modules.

Syntax

Update-AWSToolsModule
-RequiredVersion <System.Version>
-MaximumVersion <System.Version>
-CleanUp <SwitchParameter>
-SkipPublisherCheck <SwitchParameter>
-Scope <String>
-AllowClobber <SwitchParameter>
-Proxy <System.Uri>
-ProxyCredential <PSCredential>
-Force <SwitchParameter>
-WhatIf <SwitchParameter>
-Confirm <SwitchParameter>

Description

This cmdlet uses Install-Module to update all AWS.Tools modules.

Parameters

-RequiredVersion <Version>
Specifies exact version number of the module to update to.
Required? False
Position? 1
Accept pipeline input? True (ByPropertyName)
-MaximumVersion <Version>
Specifies the maximum version of the modules to update to.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-CleanUp <SwitchParameter>
Specifies that, after a successful install, all other versions of the AWS Tools modules should be uninstalled.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-SkipPublisherCheck <SwitchParameter>
Allows skipping the publisher validation check.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-Scope <String>
Specifies the installation scope of the module. The acceptable values for this parameter are AllUsers and CurrentUser. The AllUsers scope installs modules in a location that is accessible to all users of the computer: $env:ProgramFiles\PowerShell\Modules. The CurrentUser installs modules in a location that is accessible only to the current user of the computer: $home\Documents\PowerShell\Modules. When no Scope is defined, the default is CurrentUser.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-AllowClobber <SwitchParameter>
Overrides warning messages about installation conflicts about existing commands on a computer.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-Proxy <URI>
Specifies a proxy server for the request, rather than connecting directly to an internet resource.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-ProxyCredential <PSCredential>
Specifies a user account that has permission to use the proxy server specified by the Proxy parameter.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-Force <SwitchParameter>
Forces an update of each specified module without a prompt to request confirmation.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)

Notes

This cmdlet uses the PSRepository named PSGallery as source.
Use 'Get-PSRepository -Name PSGallery' for information on the PSRepository used by Update-AWSToolsModule.
This cmdlet downloads all modules from https://www.powershellgallery.com/api/v2/package/ and considers it a trusted source.

Examples

Example 1

Update-AWSToolsModule -CleanUp
This example updates all installed AWS.Tools modules to the latest version available on the PSGallery and uninstalls all other versions.
Service User Guide
Service API Reference
Microsoft Windows Guide
AWS Tools for PowerShell User Guide

Supported Version

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