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.

Container for the parameters to the SendCommand operation. Executes commands on one or more managed instances.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementRequest
      Amazon.SimpleSystemsManagement.Model.SendCommandRequest

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

Syntax

C#
public class SendCommandRequest : AmazonSimpleSystemsManagementRequest
         IAmazonWebServiceRequest

The SendCommandRequest type exposes the following members

Constructors

NameDescription
Public Method SendCommandRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method SendCommandRequest(string, List<String>)

Instantiates SendCommandRequest with the parameterized properties

Properties

NameTypeDescription
Public Property Comment System.String

Gets and sets the property Comment.

User-specified information about the command, such as a brief description of what the command should do.

Public Property DocumentHash System.String

Gets and sets the property DocumentHash.

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Public Property DocumentHashType Amazon.SimpleSystemsManagement.DocumentHashType

Gets and sets the property DocumentHashType.

Sha256 or Sha1.

Sha1 hashes have been deprecated.

Public Property DocumentName System.String

Gets and sets the property DocumentName.

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

Public Property InstanceIds System.Collections.Generic.List<System.String>

Gets and sets the property InstanceIds.

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.

Public Property MaxConcurrency System.String

Gets and sets the property MaxConcurrency.

(Optional) The maximum number of instances that are allowed to execute 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.

Public Property MaxErrors System.String

Gets and sets the property 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 50. For more information about how to use MaxErrors, see Using Error Controls.

Public Property NotificationConfig Amazon.SimpleSystemsManagement.Model.NotificationConfig

Gets and sets the property NotificationConfig.

Configurations for sending notifications.

Public Property OutputS3BucketName System.String

Gets and sets the property OutputS3BucketName.

The name of the S3 bucket where command execution responses should be stored.

Public Property OutputS3KeyPrefix System.String

Gets and sets the property OutputS3KeyPrefix.

The directory structure within the S3 bucket where the responses should be stored.

Public Property OutputS3Region System.String

Gets and sets the property OutputS3Region.

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

Public Property Parameters System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

Gets and sets the property Parameters.

The required and optional parameters specified in the document being executed.

Public Property ServiceRoleArn System.String

Gets and sets the property ServiceRoleArn.

The IAM role that Systems Manager uses to send notifications.

Public Property Targets System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.Target>

Gets and sets the property 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.

Public Property TimeoutSeconds System.Int32

Gets and sets the property TimeoutSeconds.

If this time is reached and the command has not already started executing, it will not execute.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.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