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 plugin details.

Inheritance Hierarchy

System.Object
  Amazon.SimpleSystemsManagement.Model.CommandPlugin

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

Syntax

C#
public class CommandPlugin

The CommandPlugin type exposes the following members

Constructors

NameDescription
Public Method CommandPlugin()

Properties

NameTypeDescription
Public Property Name System.String

Gets and sets the property Name.

The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.

Public Property Output System.String

Gets and sets the property Output.

Output of the plugin execution.

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. For example, in the following response:

test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript

test_folder is the name of the Amazon S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-1234567876543 is the instance ID;

awsrunShellScript is the name of the plugin.

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. For example, in the following response:

test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript

test_folder is the name of the Amazon S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-1234567876543 is the instance ID;

awsrunShellScript is the name of the plugin.

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

Gets and sets the property ResponseCode.

A numeric response code generated after executing the plugin.

Public Property ResponseFinishDateTime System.DateTime

Gets and sets the property ResponseFinishDateTime.

The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.

Public Property ResponseStartDateTime System.DateTime

Gets and sets the property ResponseStartDateTime.

The time the plugin started executing.

Public Property StandardErrorUrl System.String

Gets and sets the property StandardErrorUrl.

The URL for the complete text written by the plugin to stderr. If execution is not yet complete, then this string is empty.

Public Property StandardOutputUrl System.String

Gets and sets the property StandardOutputUrl.

The URL for the complete text written by the plugin to stdout in Amazon S3. If the Amazon S3 bucket for the command was not specified, then this string is empty.

Public Property Status Amazon.SimpleSystemsManagement.CommandPluginStatus

Gets and sets the property Status.

The status of this plugin. You can execute a document with multiple plugins.

Public Property StatusDetails System.String

Gets and sets the property StatusDetails.

A detailed status of the plugin 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 the instance.

  • In Progress: The command has been sent to the instance but has not reached a terminal state.

  • Success: The execution of the command or plugin was successfully completed. This is a terminal state.

  • Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

  • Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

  • Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

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

  • Undeliverable: The command can't be delivered to the instance. The instance might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

  • Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

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