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.

This is the response object from the GetCommandInvocation operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.SimpleSystemsManagement.Model.GetCommandInvocationResponse

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

Syntax

C#
public class GetCommandInvocationResponse : AmazonWebServiceResponse

The GetCommandInvocationResponse type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property CommandId System.String

Gets and sets the property CommandId.

The parent command ID of the invocation plugin.

Public Property Comment System.String

Gets and sets the property Comment.

The comment text for the command.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property DocumentName System.String

Gets and sets the property DocumentName.

The name of the document that was executed. For example, AWS-RunShellScript.

Public Property ExecutionElapsedTime System.String

Gets and sets the property ExecutionElapsedTime.

Duration since ExecutionStartDateTime.

Public Property ExecutionEndDateTime System.String

Gets and sets the property ExecutionEndDateTime.

The date and time the plugin was finished executing. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedAfter filter.

aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z

If the plugin has not started to execute, the string is empty.

Public Property ExecutionStartDateTime System.String

Gets and sets the property ExecutionStartDateTime.

The date and time the plugin started executing. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedBefore filter.

aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z

If the plugin has not started to execute, the string is empty.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property InstanceId System.String

Gets and sets the property InstanceId.

The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.

Public Property PluginName System.String

Gets and sets the property PluginName.

The name of the plugin for which you want detailed results. For example, aws:RunShellScript is a plugin.

Public Property ResponseCode System.Int32

Gets and sets the property ResponseCode.

The error level response code for the plugin script. If the response code is -1, then the command has not started executing on the instance, or it was not received by the instance.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property StandardErrorContent System.String

Gets and sets the property StandardErrorContent.

The first 8,000 characters written by the plugin to stderr. If the command has not finished executing, then this string is empty.

Public Property StandardErrorUrl System.String

Gets and sets the property StandardErrorUrl.

The URL for the complete text written by the plugin to stderr. If the command has not finished executing, then this string is empty.

Public Property StandardOutputContent System.String

Gets and sets the property StandardOutputContent.

The first 24,000 characters written by the plugin to stdout. If the command has not finished executing, if ExecutionStatus is neither Succeeded nor Failed, 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 an Amazon S3 bucket was not specified, then this string is empty.

Public Property Status Amazon.SimpleSystemsManagement.CommandInvocationStatus

Gets and sets the property Status.

The status of the parent command for this invocation. This status can be different than StatusDetails.

Public Property StatusDetails System.String

Gets and sets the property StatusDetails.

A detailed status of the command execution for an invocation. 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.

  • Delayed: The system attempted to send the command to the target, but the target was not available. The instance might not be available because of network issues, the instance was stopped, etc. The system will try to deliver the command again.

  • Success: The command or plugin was executed successfully. 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: The command started to execute on the instance, but the execution was not complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

  • Failed: The command wasn't executed successfully 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 might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and 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