AWS powershell documentation change
Summary
Updated all references from 'Tools for PowerShell' to 'Tools for PowerShell V4' and adjusted API documentation links to point to version 4 references. Added 'installation' to the migration topic description.
Security assessment
The changes are documentation updates to reflect version-specific references (V4) and correct API links. There is no indication of addressing security vulnerabilities or adding new security features. The modifications are routine documentation maintenance.
Diff
diff --git a/powershell/v5/userguide/powershell_iam_code_examples.md b/powershell/v5/userguide/powershell_iam_code_examples.md index 90ee7f63a..775b6dccc 100644 --- a//powershell/v5/userguide/powershell_iam_code_examples.md +++ b//powershell/v5/userguide/powershell_iam_code_examples.md @@ -7 +7 @@ Actions -The AWS Tools for PowerShell version 5 (V5) is in preview, therefore this content is subject to change. For information about breaking changes and migration, see the [migration topic](https://docs.aws.amazon.com/powershell/v5/userguide/migrating-v5.html). For released content, see the [version 4 user guide](https://docs.aws.amazon.com/powershell/v4/userguide/) instead. +The AWS Tools for PowerShell version 5 (V5) is in preview, therefore this content is subject to change. For information about breaking changes, installation, and migration, see the [migration topic](https://docs.aws.amazon.com/powershell/v5/userguide/migrating-v5.html). For released content, see the [version 4 user guide](https://docs.aws.amazon.com/powershell/v4/userguide/) instead. @@ -9 +9 @@ The AWS Tools for PowerShell version 5 (V5) is in preview, therefore this conten -# IAM examples using Tools for PowerShell +# IAM examples using Tools for PowerShell V4 @@ -11 +11 @@ The AWS Tools for PowerShell version 5 (V5) is in preview, therefore this conten -The following code examples show you how to perform actions and implement common scenarios by using the AWS Tools for PowerShell with IAM. +The following code examples show you how to perform actions and implement common scenarios by using the AWS Tools for PowerShell V4 with IAM. @@ -28 +28 @@ The following code example shows how to use `Add-IAMClientIDToOpenIDConnectProvi -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -37 +37 @@ The following code example shows how to use `Add-IAMClientIDToOpenIDConnectProvi - * For API details, see [AddClientIdToOpenIdConnectProvider](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [AddClientIdToOpenIdConnectProvider](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -44 +44 @@ The following code example shows how to use `Add-IAMRoleTag`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -53 +53 @@ The following code example shows how to use `Add-IAMRoleTag`. - * For API details, see [TagRole](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [TagRole](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -60 +60 @@ The following code example shows how to use `Add-IAMRoleToInstanceProfile`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -69 +69 @@ The following code example shows how to use `Add-IAMRoleToInstanceProfile`. - * For API details, see [AddRoleToInstanceProfile](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [AddRoleToInstanceProfile](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -76 +76 @@ The following code example shows how to use `Add-IAMUserTag`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -85 +85 @@ The following code example shows how to use `Add-IAMUserTag`. - * For API details, see [TagUser](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [TagUser](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -92 +92 @@ The following code example shows how to use `Add-IAMUserToGroup`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -101 +101 @@ The following code example shows how to use `Add-IAMUserToGroup`. - * For API details, see [AddUserToGroup](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [AddUserToGroup](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -108 +108 @@ The following code example shows how to use `Disable-IAMMFADevice`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -123 +123 @@ The following code example shows how to use `Disable-IAMMFADevice`. - * For API details, see [DeactivateMfaDevice](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [DeactivateMfaDevice](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -130 +130 @@ The following code example shows how to use `Edit-IAMPassword`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -139 +139 @@ The following code example shows how to use `Edit-IAMPassword`. - * For API details, see [ChangePassword](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [ChangePassword](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -146 +146 @@ The following code example shows how to use `Enable-IAMMFADevice`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -163 +163 @@ The following code example shows how to use `Enable-IAMMFADevice`. - * For API details, see [EnableMfaDevice](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [EnableMfaDevice](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -170 +170 @@ The following code example shows how to use `Get-IAMAccessKey`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -187 +187 @@ The following code example shows how to use `Get-IAMAccessKey`. - * For API details, see [ListAccessKeys](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [ListAccessKeys](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -194 +194 @@ The following code example shows how to use `Get-IAMAccessKeyLastUsed`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -203 +203 @@ The following code example shows how to use `Get-IAMAccessKeyLastUsed`. - * For API details, see [GetAccessKeyLastUsed](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [GetAccessKeyLastUsed](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -210 +210 @@ The following code example shows how to use `Get-IAMAccountAlias`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -224 +224 @@ The following code example shows how to use `Get-IAMAccountAlias`. - * For API details, see [ListAccountAliases](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [ListAccountAliases](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -231 +231 @@ The following code example shows how to use `Get-IAMAccountAuthorizationDetail`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -281 +281 @@ The following code example shows how to use `Get-IAMAccountAuthorizationDetail`. - * For API details, see [GetAccountAuthorizationDetails](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [GetAccountAuthorizationDetails](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -288 +288 @@ The following code example shows how to use `Get-IAMAccountPasswordPolicy`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -311 +311 @@ The following code example shows how to use `Get-IAMAccountPasswordPolicy`. - * For API details, see [GetAccountPasswordPolicy](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [GetAccountPasswordPolicy](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -318 +318 @@ The following code example shows how to use `Get-IAMAccountSummary`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -365 +365 @@ The following code example shows how to use `Get-IAMAccountSummary`. - * For API details, see [GetAccountSummary](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [GetAccountSummary](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -372 +372 @@ The following code example shows how to use `Get-IAMAttachedGroupPolicyList`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -389 +389 @@ The following code example shows how to use `Get-IAMAttachedGroupPolicyList`. - * For API details, see [ListAttachedGroupPolicies](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [ListAttachedGroupPolicies](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -396 +396 @@ The following code example shows how to use `Get-IAMAttachedRolePolicyList`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -412 +412 @@ The following code example shows how to use `Get-IAMAttachedRolePolicyList`. - * For API details, see [ListAttachedRolePolicies](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [ListAttachedRolePolicies](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -419 +419 @@ The following code example shows how to use `Get-IAMAttachedUserPolicyList`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -435 +435 @@ The following code example shows how to use `Get-IAMAttachedUserPolicyList`. - * For API details, see [ListAttachedUserPolicies](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [ListAttachedUserPolicies](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -442 +442 @@ The following code example shows how to use `Get-IAMContextKeysForCustomPolicy`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -453 +453 @@ The following code example shows how to use `Get-IAMContextKeysForCustomPolicy`. - * For API details, see [GetContextKeysForCustomPolicy](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [GetContextKeysForCustomPolicy](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -460 +460 @@ The following code example shows how to use `Get-IAMContextKeysForPrincipalPolic -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -471 +471 @@ The following code example shows how to use `Get-IAMContextKeysForPrincipalPolic - * For API details, see [GetContextKeysForPrincipalPolicy](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [GetContextKeysForPrincipalPolicy](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -478 +478 @@ The following code example shows how to use `Get-IAMCredentialReport`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -505 +505 @@ The following code example shows how to use `Get-IAMCredentialReport`. - * For API details, see [GetCredentialReport](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [GetCredentialReport](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -512 +512 @@ The following code example shows how to use `Get-IAMEntitiesForPolicy`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -530 +530 @@ The following code example shows how to use `Get-IAMEntitiesForPolicy`. - * For API details, see [ListEntitiesForPolicy](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [ListEntitiesForPolicy](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -537 +537 @@ The following code example shows how to use `Get-IAMGroup`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -588 +588 @@ The following code example shows how to use `Get-IAMGroup`. - * For API details, see [GetGroup](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [GetGroup](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -595 +595 @@ The following code example shows how to use `Get-IAMGroupForUser`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -625 +625 @@ The following code example shows how to use `Get-IAMGroupForUser`. - * For API details, see [ListGroupsForUser](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [ListGroupsForUser](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -632 +632 @@ The following code example shows how to use `Get-IAMGroupList`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -662 +662 @@ The following code example shows how to use `Get-IAMGroupList`. - * For API details, see [ListGroups](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [ListGroups](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -669 +669 @@ The following code example shows how to use `Get-IAMGroupPolicy`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -699 +699 @@ The following code example shows how to use `Get-IAMGroupPolicy`. - * For API details, see [GetGroupPolicy](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [GetGroupPolicy](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -706 +706 @@ The following code example shows how to use `Get-IAMGroupPolicyList`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -721 +721 @@ The following code example shows how to use `Get-IAMGroupPolicyList`. - * For API details, see [ListGroupPolicies](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [ListGroupPolicies](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -728 +728 @@ The following code example shows how to use `Get-IAMInstanceProfile`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -747 +747 @@ The following code example shows how to use `Get-IAMInstanceProfile`. - * For API details, see [GetInstanceProfile](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [GetInstanceProfile](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -754 +754 @@ The following code example shows how to use `Get-IAMInstanceProfileForRole`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -773 +773 @@ The following code example shows how to use `Get-IAMInstanceProfileForRole`. - * For API details, see [ListInstanceProfilesForRole](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [ListInstanceProfilesForRole](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -780 +780 @@ The following code example shows how to use `Get-IAMInstanceProfileList`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -799 +799 @@ The following code example shows how to use `Get-IAMInstanceProfileList`. - * For API details, see [ListInstanceProfiles](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [ListInstanceProfiles](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -806 +806 @@ The following code example shows how to use `Get-IAMLoginProfile`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -822 +822 @@ The following code example shows how to use `Get-IAMLoginProfile`. - * For API details, see [GetLoginProfile](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [GetLoginProfile](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -829 +829 @@ The following code example shows how to use `Get-IAMMFADevice`. -**Tools for PowerShell** +**Tools for PowerShell V4** @@ -845 +845 @@ The following code example shows how to use `Get-IAMMFADevice`. - * For API details, see [ListMfaDevices](https://docs.aws.amazon.com/powershell/latest/reference) in _AWS Tools for PowerShell Cmdlet Reference_. + * For API details, see [ListMfaDevices](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. @@ -852 +852 @@ The following code example shows how to use `Get-IAMOpenIDConnectProvider`.