Update documentation

fireflycons · Jul 11, 2019 · 80054cd · 80054cd
1 parent cbad5c8
commit 80054cd
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 6 deletions.
diff --git a/aws-toolbox/Public/SSM/Invoke-ATSSMPowerShellScript.ps1 b/aws-toolbox/Public/SSM/Invoke-ATSSMPowerShellScript.ps1
@@ -53,6 +53,15 @@ function Invoke-ATSSMPowerShellScript
     .EXAMPLE
         Invoke-ATSSMPowerShellScript -InstanceIds i-00000000 -AsText { dir c:\ }
         Returns directory listing from remote instance to the console.
+
+    .NOTES
+        IAM permissions required to run this command
+
+        - ssm:GetConnectionStatus
+        - ssm:ListCommandInvocations
+        - ssm:ListCommands
+        - ssm:SendCommand
+        - ec2:DescribeInstances
 #>
     [CmdletBinding(DefaultParameterSetName = 'AsText')]
     param

diff --git a/aws-toolbox/Public/SSM/Invoke-ATSSMShellScript.ps1 b/aws-toolbox/Public/SSM/Invoke-ATSSMShellScript.ps1
@@ -47,8 +47,17 @@ function Invoke-ATSSMShellScript
             Format of bucket name is aws-toolbox-workspace-REGIONNAME-AWSACCOUNTID
 
         .EXAMPLE
-            Invoke-ATSSMShellScript -InstanceIds i-00000000 -AsText { ls -la / }
+            Invoke-ATSSMShellScript -InstanceIds i-00000000 -AsText "ls -la /"
             Returns directory listing from remote instance to the console.
+
+        .NOTES
+            IAM permissions required to run this command
+
+            - ssm:GetConnectionStatus
+            - ssm:ListCommandInvocations
+            - ssm:ListCommands
+            - ssm:SendCommand
+            - ec2:DescribeInstances
     #>
     [CmdletBinding(DefaultParameterSetName = 'AsText')]
     param

diff --git a/docs/en-US/Invoke-ATSSMPowerShellScript.md b/docs/en-US/Invoke-ATSSMPowerShellScript.md
@@ -179,7 +179,12 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink
 ### - ResultObject If -AsJson and the result was successfully parsed, then an object else NULL
 ### - ResultText   Standard Output returned by the script (Write-Host etc.)
 ## NOTES
-aws-toolbox uses a working bucket for passing results through S3 which will be created if not found.
-Format of bucket name is aws-toolbox-workspace-REGIONNAME-AWSACCOUNTID
+IAM permissions required to run this command
+
+- ssm:GetConnectionStatus
+- ssm:ListCommandInvocations
+- ssm:ListCommands
+- ssm:SendCommand
+- ec2:DescribeInstances
 
 ## RELATED LINKS
diff --git a/docs/en-US/Invoke-ATSSMShellScript.md b/docs/en-US/Invoke-ATSSMShellScript.md
@@ -38,7 +38,7 @@ Runs the command on the listed instances.
 
 ### EXAMPLE 2
 ```
-Invoke-ATSSMShellScript -InstanceIds i-00000000 -AsText { ls -la / }
+Invoke-ATSSMShellScript -InstanceIds i-00000000 -AsText "ls -la /"
 ```
 
 Returns directory listing from remote instance to the console.
@@ -172,7 +172,12 @@ For more information, see about_CommonParameters (http://go.microsoft.com/fwlink
 ### - ResultObject If -AsJson and the result was successfully parsed, then an object else NULL
 ### - ResultText   Standard Output returned by the script (Write-Host etc.)
 ## NOTES
-aws-toolbox uses a working bucket for passing results through S3 which will be created if not found.
-Format of bucket name is aws-toolbox-workspace-REGIONNAME-AWSACCOUNTID
+IAM permissions required to run this command
+
+- ssm:GetConnectionStatus
+- ssm:ListCommandInvocations
+- ssm:ListCommands
+- ssm:SendCommand
+- ec2:DescribeInstances
 
 ## RELATED LINKS