ssm_send_command: Runs commands on one or more managed nodes
In paws.management: 'Amazon Web Services' Management & Governance Services

ssm_send_command

R Documentation

Runs commands on one or more managed nodes

Description

Runs commands on one or more managed nodes.

See https://www.paws-r-sdk.com/docs/ssm_send_command/ for full documentation.

Usage

ssm_send_command(
  InstanceIds = NULL,
  Targets = NULL,
  DocumentName,
  DocumentVersion = NULL,
  DocumentHash = NULL,
  DocumentHashType = NULL,
  TimeoutSeconds = NULL,
  Comment = NULL,
  Parameters = NULL,
  OutputS3Region = NULL,
  OutputS3BucketName = NULL,
  OutputS3KeyPrefix = NULL,
  MaxConcurrency = NULL,
  MaxErrors = NULL,
  ServiceRoleArn = NULL,
  NotificationConfig = NULL,
  CloudWatchOutputConfig = NULL,
  AlarmConfiguration = NULL
)

Arguments

`InstanceIds`	The IDs of the managed nodes where the command should run. Specifying managed node IDs is most useful when you are targeting a limited number of managed nodes, though you can specify up to 50 IDs. To target a larger number of managed nodes, or if you prefer not to list individual node IDs, we recommend using the `Targets` option instead. Using `Targets`, which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a send command to tens, hundreds, or thousands of nodes at once. For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.
`Targets`	An array of search criteria that targets managed nodes using a `⁠Key,Value⁠` combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using `Targets`, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once. To send a command to a smaller number of managed nodes, you can use the `InstanceIds` option instead. For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.
`DocumentName`	[required] The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document Amazon Resource Name (ARN). For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide. If you specify a document name or ARN that hasn't been shared with your account, you receive an `InvalidDocument` error.
`DocumentVersion`	The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services 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"
`DocumentHash`	The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated.
`DocumentHashType`	Sha256 or Sha1. Sha1 hashes have been deprecated.
`TimeoutSeconds`	If this time is reached and the command hasn't already started running, it won't run.
`Comment`	User-specified information about the command, such as a brief description of what the command should do.
`Parameters`	The required and optional parameters specified in the document being run.
`OutputS3Region`	(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.
`OutputS3BucketName`	The name of the S3 bucket where command execution responses should be stored.
`OutputS3KeyPrefix`	The directory structure within the S3 bucket where the responses should be stored.
`MaxConcurrency`	(Optional) The maximum number of managed nodes that are allowed to run 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 Amazon Web Services Systems Manager User Guide.
`MaxErrors`	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 Amazon Web Services Systems Manager User Guide.
`ServiceRoleArn`	The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands. This role must provide the `sns:Publish` permission for your notification topic. For information about creating and using this service role, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.
`NotificationConfig`	Configurations for sending notifications.
`CloudWatchOutputConfig`	Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.
`AlarmConfiguration`	The CloudWatch alarm you want to apply to your command.