ssm_send_command: Runs commands on one or more managed instances

Description Usage Arguments Request syntax

View source: R/ssm_operations.R

Description

Runs commands on one or more managed instances.

Usage

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

Arguments

InstanceIds

The instance IDs where the command should run. 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 Using targets and rate controls to send commands to a fleet in the AWS Systems Manager User Guide.

Targets

(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.

DocumentName

[required] Required. The name of the Systems Manager document to run. This can be a public document or a custom document.

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 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\"

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 has not already started running, it will not 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 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 instances 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 AWS 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 AWS Systems Manager User Guide.

ServiceRoleArn

The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

NotificationConfig

Configurations for sending notifications.

CloudWatchOutputConfig

Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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
  )
)

paws.management documentation built on Aug. 3, 2020, 9:07 a.m.