AWS powershell documentation change
Summary
Updated all references from AWS Tools for PowerShell V4 to V5 across code examples, cmdlet references, and documentation links
Security assessment
The changes are version updates from V4 to V5 without any security-specific context. No vulnerabilities, security fixes, or security features are mentioned. This appears to be routine documentation maintenance for version alignment.
Diff
diff --git a/powershell/v5/userguide/powershell_ssm_code_examples.md b/powershell/v5/userguide/powershell_ssm_code_examples.md index 78a0edfe3..ac895936c 100644 --- a//powershell/v5/userguide/powershell_ssm_code_examples.md +++ b//powershell/v5/userguide/powershell_ssm_code_examples.md @@ -13 +13 @@ For information about breaking changes and migrating your applications, see the -# Systems Manager examples using Tools for PowerShell V4 +# Systems Manager examples using Tools for PowerShell V5 @@ -15 +15 @@ For information about breaking changes and migrating your applications, see the -The following code examples show you how to perform actions and implement common scenarios by using the AWS Tools for PowerShell V4 with Systems Manager. +The following code examples show you how to perform actions and implement common scenarios by using the AWS Tools for PowerShell V5 with Systems Manager. @@ -32 +32 @@ The following code example shows how to use `Add-SSMResourceTag`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -52 +52 @@ The following code example shows how to use `Add-SSMResourceTag`. - * For API details, see [AddTagsToResource](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [AddTagsToResource](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -59 +59 @@ The following code example shows how to use `Edit-SSMDocumentPermission`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -74 +74 @@ The following code example shows how to use `Edit-SSMDocumentPermission`. - * For API details, see [ModifyDocumentPermission](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [ModifyDocumentPermission](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -81 +81 @@ The following code example shows how to use `Get-SSMActivation`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -103 +103 @@ The following code example shows how to use `Get-SSMActivation`. - * For API details, see [DescribeActivations](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [DescribeActivations](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -110 +110 @@ The following code example shows how to use `Get-SSMAssociation`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -130 +130 @@ The following code example shows how to use `Get-SSMAssociation`. - * For API details, see [DescribeAssociation](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [DescribeAssociation](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -137 +137 @@ The following code example shows how to use `Get-SSMAssociationExecution`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -158 +158 @@ The following code example shows how to use `Get-SSMAssociationExecution`. - * For API details, see [DescribeAssociationExecutions](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [DescribeAssociationExecutions](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -165 +165 @@ The following code example shows how to use `Get-SSMAssociationExecutionTarget`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -220 +220 @@ The following code example shows how to use `Get-SSMAssociationExecutionTarget`. - * For API details, see [DescribeAssociationExecutionTargets](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [DescribeAssociationExecutionTargets](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -227 +227 @@ The following code example shows how to use `Get-SSMAssociationList`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -290 +290 @@ The following code example shows how to use `Get-SSMAssociationList`. - * For API details, see [ListAssociations](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [ListAssociations](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -297 +297 @@ The following code example shows how to use `Get-SSMAssociationVersionList`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -337 +337 @@ The following code example shows how to use `Get-SSMAssociationVersionList`. - * For API details, see [ListAssociationVersions](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [ListAssociationVersions](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -344 +344 @@ The following code example shows how to use `Get-SSMAutomationExecution`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -401 +401 @@ The following code example shows how to use `Get-SSMAutomationExecution`. - * For API details, see [GetAutomationExecution](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [GetAutomationExecution](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -408 +408 @@ The following code example shows how to use `Get-SSMAutomationExecutionList`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -445 +445 @@ The following code example shows how to use `Get-SSMAutomationExecutionList`. - * For API details, see [DescribeAutomationExecutions](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [DescribeAutomationExecutions](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -452 +452 @@ The following code example shows how to use `Get-SSMAutomationStepExecution`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -481 +481 @@ The following code example shows how to use `Get-SSMAutomationStepExecution`. - * For API details, see [DescribeAutomationStepExecutions](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [DescribeAutomationStepExecutions](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -488 +488 @@ The following code example shows how to use `Get-SSMAvailablePatch`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -548 +548 @@ The following code example shows how to use `Get-SSMAvailablePatch`. - * For API details, see [DescribeAvailablePatches](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [DescribeAvailablePatches](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -555 +555 @@ The following code example shows how to use `Get-SSMCommand`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -612 +612 @@ The following code example shows how to use `Get-SSMCommand`. - * For API details, see [ListCommands](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [ListCommands](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -619 +619 @@ The following code example shows how to use `Get-SSMCommandInvocation`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -670 +670 @@ The following code example shows how to use `Get-SSMCommandInvocation`. - * For API details, see [ListCommandInvocations](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [ListCommandInvocations](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -677 +677 @@ The following code example shows how to use `Get-SSMCommandInvocationDetail`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -705 +705 @@ The following code example shows how to use `Get-SSMCommandInvocationDetail`. - * For API details, see [GetCommandInvocation](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [GetCommandInvocation](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -712 +712 @@ The following code example shows how to use `Get-SSMComplianceItemList`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -734 +734 @@ The following code example shows how to use `Get-SSMComplianceItemList`. - * For API details, see [ListComplianceItems](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [ListComplianceItems](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -741 +741 @@ The following code example shows how to use `Get-SSMComplianceSummaryList`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -760 +760 @@ The following code example shows how to use `Get-SSMComplianceSummaryList`. - * For API details, see [ListComplianceSummaries](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [ListComplianceSummaries](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -767 +767 @@ The following code example shows how to use `Get-SSMConnectionStatus`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -783 +783 @@ The following code example shows how to use `Get-SSMConnectionStatus`. - * For API details, see [GetConnectionStatus](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [GetConnectionStatus](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -790 +790 @@ The following code example shows how to use `Get-SSMDefaultPatchBaseline`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -804 +804 @@ The following code example shows how to use `Get-SSMDefaultPatchBaseline`. - * For API details, see [GetDefaultPatchBaseline](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [GetDefaultPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -811 +811 @@ The following code example shows how to use `Get-SSMDeployablePatchSnapshotForIn -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -840 +840 @@ The following code example shows how to use `Get-SSMDeployablePatchSnapshotForIn - * For API details, see [GetDeployablePatchSnapshotForInstance](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [GetDeployablePatchSnapshotForInstance](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -847 +847 @@ The following code example shows how to use `Get-SSMDocument`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -897 +897 @@ The following code example shows how to use `Get-SSMDocument`. - * For API details, see [GetDocument](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [GetDocument](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -904 +904 @@ The following code example shows how to use `Get-SSMDocumentDescription`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -932 +932 @@ The following code example shows how to use `Get-SSMDocumentDescription`. - * For API details, see [DescribeDocument](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [DescribeDocument](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -939 +939 @@ The following code example shows how to use `Get-SSMDocumentList`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -993 +993 @@ The following code example shows how to use `Get-SSMDocumentList`. - * For API details, see [ListDocuments](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [ListDocuments](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -1000 +1000 @@ The following code example shows how to use `Get-SSMDocumentPermission`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -1016 +1016 @@ The following code example shows how to use `Get-SSMDocumentPermission`. - * For API details, see [DescribeDocumentPermission](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [DescribeDocumentPermission](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -1023 +1023 @@ The following code example shows how to use `Get-SSMDocumentVersionList`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -1042 +1042 @@ The following code example shows how to use `Get-SSMDocumentVersionList`. - * For API details, see [ListDocumentVersions](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [ListDocumentVersions](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -1049 +1049 @@ The following code example shows how to use `Get-SSMEffectiveInstanceAssociation -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -1109 +1109 @@ The following code example shows how to use `Get-SSMEffectiveInstanceAssociation - * For API details, see [DescribeEffectiveInstanceAssociations](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [DescribeEffectiveInstanceAssociations](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -1116 +1116 @@ The following code example shows how to use `Get-SSMEffectivePatchesForPatchBase -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -1145 +1145 @@ The following code example shows how to use `Get-SSMEffectivePatchesForPatchBase - * For API details, see [DescribeEffectivePatchesForPatchBaseline](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [DescribeEffectivePatchesForPatchBaseline](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -1152 +1152 @@ The following code example shows how to use `Get-SSMInstanceAssociationsStatus`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -1193 +1193 @@ The following code example shows how to use `Get-SSMInstanceAssociationsStatus`. - * For API details, see [DescribeInstanceAssociationsStatus](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [DescribeInstanceAssociationsStatus](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -1200 +1200 @@ The following code example shows how to use `Get-SSMInstanceInformation`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -1344 +1344 @@ The following code example shows how to use `Get-SSMInstanceInformation`. - * For API details, see [DescribeInstanceInformation](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [DescribeInstanceInformation](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -1351 +1351 @@ The following code example shows how to use `Get-SSMInstancePatch`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -1360 +1360 @@ The following code example shows how to use `Get-SSMInstancePatch`. - * For API details, see [DescribeInstancePatches](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [DescribeInstancePatches](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -1367 +1367 @@ The following code example shows how to use `Get-SSMInstancePatchState`. -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -1382 +1382 @@ The following code example shows how to use `Get-SSMInstancePatchState`. - * For API details, see [DescribeInstancePatchStates](https://docs.aws.amazon.com/powershell/v4/reference) in _AWS Tools for PowerShell Cmdlet Reference (V4)_. + * For API details, see [DescribeInstancePatchStates](https://docs.aws.amazon.com/powershell/v5/reference) in _AWS Tools for PowerShell Cmdlet Reference (V5)_. @@ -1389 +1389 @@ The following code example shows how to use `Get-SSMInstancePatchStatesForPatchG -**Tools for PowerShell V4** +**Tools for PowerShell V5** @@ -1398 +1398 @@ The following code example shows how to use `Get-SSMInstancePatchStatesForPatchG