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

Installs AWS.Tools modules.

Syntax

Install-AWSToolsModule
-Name <String>
-RequiredVersion <System.Version>
-MinimumVersion <System.Version>
-MaximumVersion <System.Version>
-CleanUp <SwitchParameter>
-SkipUpdate <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 install AWS.Tools modules. Unless -SkipUpdate is specified, this cmdlet also updates all other currently installed AWS.Tools modules to the version being installed.

Parameters

-Name <String[]>
Specifies names of the AWS.Tools modules to install. The names can be listed either with or without the "AWS.Tools." prefix (i.e. "AWS.Tools.Common" or simply "Common").
Required? True
Position? 1
Accept pipeline input? True (ByValue, ByPropertyName)
-RequiredVersion <Version>
Specifies exact version number of the module to install.
Required? False
Position? 2
Accept pipeline input? True (ByPropertyName)
-MinimumVersion <Version>
Specifies the minimum version of the modules to install.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-MaximumVersion <Version>
Specifies the maximum version of the modules to install.
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)
-SkipUpdate <SwitchParameter>
Install-AWSToolsModule by default also updates all currently installed AWS.Tools modules. -SkipUpdate disables the update.
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 install of each specified module without a prompt to request confirmation.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)

Inputs

System.String
You can pipe a String object to this cmdlet for the Name parameter.

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

Install-AWSToolsModule EC2,S3 -RequiredVersion 4.0.0.0
This example installs version 4.0.0.0 of AWS.Tools.EC2, AWS.Tools.S3 and their dependencies.
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