AWS Tools for PowerShell User Guide AWS Tools for PowerShell: User Guide Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS Tools for PowerShell User Guide Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS Tools for PowerShell User Guide Table of Contents What are the AWS Tools for PowerShell? .............................................................................................. 1 Maintenance and support for SDK major versions .......................................................................... 1 AWS.Tools ............................................................................................................................... 1 AWSPowerShell.NetCore .............................................................................................................. 2 AWSPowerShell .......................................................................................................................... 2 How to use this guide ................................................................................................................ 3 Installation ........................................................................................................................................ 4 Prerequisites .............................................................................................................................. 4 Installing on Windows ................................................................................................................ 5 Prerequisites ...................................................................................................................... 6 Install AWS.Tools .............................................................................................................. 6 Install AWSPowerShell.NetCore ............................................................................................ 7 Install AWSPowerShell ........................................................................................................ 8 Enable Script Execution ...................................................................................................... 9 Versioning ....................................................................................................................... 10 Updating AWS Tools for PowerShell ................................................................................... 11 Installing on Linux or macOS ..................................................................................................... 12 Overview of Setup ........................................................................................................... 12 Prerequisites ...................................................................................................................... 6 Install AWS.Tools ............................................................................................................ 13 Install AWSPowerShell.NetCore .......................................................................................... 14 Script Execution ................................................................................................................. 9 Configuring the PowerShell Console ................................................................................... 16 Initialize Your PowerShell Session ....................................................................................... 16 Versioning ....................................................................................................................... 10 Updating the AWS Tools for PowerShell on Linux or macOS ................................................... 17 Related Information .......................................................................................................... 17 Migrating from AWS Tools for PowerShell Version 3.3 to Version 4 ................................................. 18 New Fully Modularized AWS.Tools Version ......................................................................... 18 New Get-AWSService cmdlet .......................................................................................... 18 New -Select Parameter to Control the Object Returned by a Cmdlet .................................... 19 More Consistent Limiting of the Number of Items in the Output ............................................. 20 Easier to Use Stream Parameters ........................................................................................ 20 Extending the Pipe by Property Name ................................................................................ 21 Static Common Parameters ............................................................................................... 21 AWS.Tools Declares and Enforces Manadatory Parameters ................................................... 21 All Parameters Are Nullable ............................................................................................... 21 Removing Previously Deprecated Features ........................................................................... 22 AWS Account and Access Keys ................................................................................................... 22 To get your access key ID and secret access key ................................................................... 22 Getting Started ................................................................................................................................ 24 AWS Credentials ....................................................................................................................... 24 Credentials Store Locations ............................................................................................... 24 Managing Profiles ............................................................................................................. 25 Specifying Credentials ....................................................................................................... 26 Credentials Search Order ................................................................................................... 28 Credential Handling in AWS Tools for PowerShell Core .......................................................... 28 Shared Credentials ................................................................................................................... 29 Using an IAM Role with AWS Tools for PowerShell ................................................................ 30 Using the Credential Profile Types ...................................................................................... 31 The ProfilesLocation Common Parameter ..................................................................... 31 Displaying Your Credential Profiles ..................................................................................... 32 Removing Credential Profiles ............................................................................................. 32 Important Notes .............................................................................................................. 32 iii AWS Tools for PowerShell User Guide AWS Regions ........................................................................................................................... 33 Specifying a Custom or Nonstandard Endpoint .................................................................... 34 Cmdlet Discovery and Aliases .................................................................................................... 34 Cmdlet Discovery ............................................................................................................. 34 Cmdlet Naming and Aliases ............................................................................................... 38 Pipelining and $AWSHistory ...................................................................................................... 41 $AWSHistory .................................................................................................................... 41 Configuring Federated Identity ................................................................................................... 43 Prerequisites .................................................................................................................... 44 How an Identity-Federated User Gets Federated Access to AWS Service APIs ............................. 44 How SAML Support Works in the AWS Tools for PowerShell ................................................... 45 How to Use the PowerShell SAML Configuration Cmdlets ...................................................... 46 Additional Reading ........................................................................................................... 50 Using the AWS Tools for PowerShell ................................................................................................... 51 PowerShell File Concatenation Encoding ..................................................................................... 51 Returned Objects for the PowerShell Tools .................................................................................. 52 Amazon EC2 ...........................................................................................................................