AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Runs commands on one or more managed nodes.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to SendCommandAsync.

Namespace: Amazon.SimpleSystemsManagement
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z

Syntax

C#
public abstract SendCommandResponse SendCommand(
         String documentName,
         List<String> instanceIds
)

Parameters

documentName
Type: System.String

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.

instanceIds
Type: System.Collections.Generic.List<System.String>

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.

Return Value


The response from the SendCommand service method, as returned by SimpleSystemsManagement.

Exceptions

ExceptionCondition
DuplicateInstanceIdException You can't specify a managed node ID in more than one association.
InternalServerErrorException An error occurred on the server side.
InvalidDocumentException The specified SSM document doesn't exist.
InvalidDocumentVersionException The document version isn't valid or doesn't exist.
InvalidInstanceIdException The following problems can cause this exception: You don't have permission to access the managed node. Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running. SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent. The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.
InvalidNotificationConfigException One or more configuration items isn't valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon Simple Notification Service topic.
InvalidOutputFolderException The S3 bucket doesn't exist.
InvalidParametersException You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
InvalidRoleException The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for Run Command notifications, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.
MaxDocumentSizeExceededException The size limit of a document is 64 KB.
UnsupportedPlatformTypeException The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also