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.

Executes commands on one or more managed instances.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginSendCommand and EndSendCommand.

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

Syntax

C#
public abstract Task<SendCommandResponse> SendCommandAsync(
         String documentName,
         List<String> instanceIds,
         CancellationToken cancellationToken
)
Parameters
documentName
Type: System.String

Required. The name of the Systems Manager document to execute. This can be a public document or a custom document.

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

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.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

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

Exceptions

ExceptionCondition
DuplicateInstanceIdException You cannot specify an instance ID in more than one association.
InternalServerErrorException An error occurred on the server side.
InvalidDocumentException The specified document does not exist.
InvalidInstanceIdException The following problems can cause this exception: You do not have permission to access the instance. The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running. The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service. The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidNotificationConfigException One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon SNS topic.
InvalidOutputFolderException The S3 bucket does not exist.
InvalidParametersException You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager 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 Configuring Amazon SNS Notifications for Run Command in the Amazon EC2 Systems Manager User Guide.
MaxDocumentSizeExceededException The size limit of a document is 64 KB.
UnsupportedPlatformTypeException The document does not support the platform type of the given instance ID(s). For example, you sent an document for a Windows instance to a Linux instance.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also