Skip to content

Send Command

ssm_send_command R Documentation

Runs commands on one or more managed nodes

Description

Runs commands on one or more managed nodes.

Usage

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

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 Run commands at scale 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 Run commands at scale 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 Sharing 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.

Value

A list with the following syntax: 

list(
  Command = list(
    CommandId = "string",
    DocumentName = "string",
    DocumentVersion = "string",
    Comment = "string",
    ExpiresAfter = as.POSIXct(
      "2015-01-01"
    ),
    Parameters = list(
      list(
        "string"
      )
    ),
    InstanceIds = list(
      "string"
    ),
    Targets = list(
      list(
        Key = "string",
        Values = list(
          "string"
        )
      )
    ),
    RequestedDateTime = as.POSIXct(
      "2015-01-01"
    ),
    Status = "Pending"|"InProgress"|"Success"|"Cancelled"|"Failed"|"TimedOut"|"Cancelling",
    StatusDetails = "string",
    OutputS3Region = "string",
    OutputS3BucketName = "string",
    OutputS3KeyPrefix = "string",
    MaxConcurrency = "string",
    MaxErrors = "string",
    TargetCount = 123,
    CompletedCount = 123,
    ErrorCount = 123,
    DeliveryTimedOutCount = 123,
    ServiceRole = "string",
    NotificationConfig = list(
      NotificationArn = "string",
      NotificationEvents = list(
        "All"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed"
      ),
      NotificationType = "Command"|"Invocation"
    ),
    CloudWatchOutputConfig = list(
      CloudWatchLogGroupName = "string",
      CloudWatchOutputEnabled = TRUE|FALSE
    ),
    TimeoutSeconds = 123,
    AlarmConfiguration = list(
      IgnorePollAlarmFailure = TRUE|FALSE,
      Alarms = list(
        list(
          Name = "string"
        )
      )
    ),
    TriggeredAlarms = list(
      list(
        Name = "string",
        State = "UNKNOWN"|"ALARM"
      )
    )
  )
)

Request syntax

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
  ),
  AlarmConfiguration = list(
    IgnorePollAlarmFailure = TRUE|FALSE,
    Alarms = list(
      list(
        Name = "string"
      )
    )
  )
)