Synopsis
Calls the AWS Systems Manager SendCommand API operation.
Syntax
Send-SSMCommand-Comment <String>-DocumentHash <String>-DocumentHashType <DocumentHashType>-DocumentName <String>-DocumentVersion <String>-InstanceId <String[]>-MaxConcurrency <String>-MaxError <String>-NotificationConfig_NotificationArn <String>-NotificationConfig_NotificationEvent <String[]>-NotificationConfig_NotificationType <NotificationType>-OutputS3BucketName <String>-OutputS3KeyPrefix <String>-OutputS3Region <String>-Parameter <Hashtable>-ServiceRoleArn <String>-Target <Target[]>-TimeoutSecond <Int32>-Force <SwitchParameter>
Description
Executes commands on one or more managed instances.
Parameters
-Comment <String>
User-specified information about the command, such as a brief description of what the command should do.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-DocumentHash <String>
The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-DocumentHashType <DocumentHashType>
Sha256 or Sha1.Sha1 hashes have been deprecated.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-DocumentName <String>
Required. The name of the Systems Manager document to execute. This can be a public document or a custom document.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-DocumentVersion <String>
The SSM document version to use in the request. You can specify Default, Latest, or a specific version number.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-InstanceId <String[]>
The instance IDs where the command should execute. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use Targets, see Sending Commands to a Fleet.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-MaxConcurrency <String>
(Optional) The maximum number of instances that are allowed to execute the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using Concurrency Controls.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-MaxError <String>
The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using Error Controls.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NotificationConfig_NotificationArn <String>
An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NotificationConfig_NotificationEvent <String[]>
The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Setting Up Events and Notifications in the AWS Systems Manager User Guide.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NotificationConfig_NotificationType <NotificationType>
Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-OutputS3BucketName <String>
The name of the S3 bucket where command execution responses should be stored.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-OutputS3KeyPrefix <String>
The directory structure within the S3 bucket where the responses should be stored.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-OutputS3Region <String>
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Parameter <Hashtable>
The required and optional parameters specified in the document being executed.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ServiceRoleArn <String>
The IAM role that Systems Manager uses to send notifications.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Target <Target[]>
(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use Targets, see Sending Commands to a Fleet.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-TimeoutSecond <Int32>
If this time is reached and the command has not already started executing, it will not run.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Common Credential and Region Parameters
-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information,
and optionally a token for session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)
If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.
As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EndpointUrl <String>
The endpoint to make the call against.
Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Inputs
This cmdlet does not accept pipeline input.
Outputs
This cmdlet returns a Command object.
The service call response (type Amazon.SimpleSystemsManagement.Model.SendCommandResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Examples
Example 1
PS C:\> Send-SSMCommand -DocumentName "AWS-RunPowerShellScript" -Parameter @{commands = "echo helloWorld"} -Target @{Key="instanceids";Values=@("i-0cb2b964d3e14fd9f")}
CommandId : d8d190fc-32c1-4d65-a0df-ff5ff3965524
Comment :
CompletedCount : 0
DocumentName : AWS-RunPowerShellScript
ErrorCount : 0
ExpiresAfter : 3/7/2017 10:48:37 PM
InstanceIds : {}
MaxConcurrency : 50
MaxErrors : 0
NotificationConfig : Amazon.SimpleSystemsManagement.Model.NotificationConfig
OutputS3BucketName :
OutputS3KeyPrefix :
OutputS3Region :
Parameters : {[commands, Amazon.Runtime.Internal.Util.AlwaysSendList`1[System.String]]}
RequestedDateTime : 3/7/2017 9:48:37 PM
ServiceRole :
Status : Pending
StatusDetails : Pending
TargetCount : 0
Targets : {instanceids}
This example runs an echo command on a target instance.
Example 2
PS C:\>Send-SSMCommand -DocumentName "AWS-RunRemoteScript" -Parameter @{ sourceType="GitHub";sourceInfo='{"owner": "me","repository": "amazon-ssm","path": "Examples/Install-Win32OpenSSH"}'; "commandLine"=".\Install-Win32OpenSSH.ps1"} -InstanceId i-0cb2b964d3e14fd9fThis example shows how to run a command that accepts nested parameters.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
