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.

Describes a command request.

Inheritance Hierarchy

System.Object
  Amazon.SimpleSystemsManagement.Model.Command

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

Syntax

C#
public class Command

The Command type exposes the following members

Constructors

NameDescription
Public Method Command()

Properties

NameTypeDescription
Public Property CommandId System.String

Gets and sets the property CommandId.

A unique identifier for this command.

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 CompletedCount System.Int32

Gets and sets the property CompletedCount.

The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.

Public Property DocumentName System.String

Gets and sets the property DocumentName.

The name of the document requested for execution.

Public Property ErrorCount System.Int32

Gets and sets the property ErrorCount.

The number of targets for which the status is Failed or Execution Timed Out.

Public Property ExpiresAfter System.DateTime

Gets and sets the property ExpiresAfter.

If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

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

Gets and sets the property InstanceIds.

The instance IDs against which this command was requested.

Public Property MaxConcurrency System.String

Gets and sets the property MaxConcurrency.

The maximum number of instances that are allowed to execute the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Executing a Command Using Systems Manager Run Command.

Public Property MaxErrors System.String

Gets and sets the property MaxErrors.

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 50. For more information about how to use MaxErrors, see Executing a Command Using Systems Manager Run Command.

Public Property NotificationConfig Amazon.SimpleSystemsManagement.Model.NotificationConfig

Gets and sets the property NotificationConfig.

Configurations for sending notifications about command status changes.

Public Property OutputS3BucketName System.String

Gets and sets the property OutputS3BucketName.

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Public Property OutputS3KeyPrefix System.String

Gets and sets the property OutputS3KeyPrefix.

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

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 parameter values to be inserted in the document when executing the command.

Public Property RequestedDateTime System.DateTime

Gets and sets the property RequestedDateTime.

The date and time the command was requested.

Public Property ServiceRole System.String

Gets and sets the property ServiceRole.

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

Public Property Status Amazon.SimpleSystemsManagement.CommandStatus

Gets and sets the property Status.

The status of the command.

Public Property StatusDetails System.String

Gets and sets the property StatusDetails.

A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Run Command Status. StatusDetails can be one of the following values:

  • Pending: The command has not been sent to any instances.

  • In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.

  • Success: The command successfully executed on all invocations. This is a terminal state.

  • Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

  • Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

  • Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

  • Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

  • Canceled: The command was terminated before it was completed. This is a terminal state.

  • Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before executing it on any instance. This is a terminal state.

Public Property TargetCount System.Int32

Gets and sets the property TargetCount.

The number of targets for the command.

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

Gets and sets the property Targets.

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.

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