Executes commands on one or more managed instances.
ssm_send_command(InstanceIds, Targets, DocumentName, DocumentVersion,
DocumentHash, DocumentHashType, TimeoutSeconds, Comment, Parameters,
OutputS3Region, OutputS3BucketName, OutputS3KeyPrefix, MaxConcurrency,
MaxErrors, ServiceRoleArn, NotificationConfig, CloudWatchOutputConfig)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 in the AWS Systems Manager User Guide.
(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 in the AWS Systems Manager User Guide.
[required] Required. The name of the Systems Manager document to execute. This can be a public document or a custom document.
The SSM document version to use in the request. You can specify \$DEFAULT, \$LATEST, or a specific version number. If you execute commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
\--document-version "\$DEFAULT"
\--document-version "\$LATEST"
\--document-version "3"
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
Sha256 or Sha1.
Sha1 hashes have been deprecated.
If this time is reached and the command has not already started executing, it will not run.
User-specified information about the command, such as a brief description of what the command should do.
The required and optional parameters specified in the document being executed.
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.
The name of the S3 bucket where command execution responses should be stored.
The directory structure within the S3 bucket where the responses should be stored.
(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 in the AWS Systems Manager User Guide.
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 in the AWS Systems Manager User Guide.
The IAM role that Systems Manager uses to send notifications.
Configurations for sending notifications.
Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.
svc$send_command(
InstanceIds = list(
"string"
),
Targets = list(
list(
Key = "string",
Values = list(
"string"
)
)
),
DocumentName = "string",
DocumentVersion = "string",
DocumentHash = "string",
DocumentHashType = "Sha256"|"Sha1",
TimeoutSeconds = 123,
Comment = "string",
Parameters = list(
list(
"string"
)
),
OutputS3Region = "string",
OutputS3BucketName = "string",
OutputS3KeyPrefix = "string",
MaxConcurrency = "string",
MaxErrors = "string",
ServiceRoleArn = "string",
NotificationConfig = list(
NotificationArn = "string",
NotificationEvents = list(
"All"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed"
),
NotificationType = "Command"|"Invocation"
),
CloudWatchOutputConfig = list(
CloudWatchLogGroupName = "string",
CloudWatchOutputEnabled = TRUE|FALSE
)
)