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 CloudWatchOutputConfig Amazon.SimpleSystemsManagement.Model.CloudWatchOutputConfig

Gets and sets the property CloudWatchOutputConfig.

Amazon CloudWatch Logs information where Systems Manager sent the command output.

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 run. For example, AWS-RunShellScript.

Public Property DocumentVersion System.String

Gets and sets the property DocumentVersion.

The Systems Manager document (SSM document) version used in the request.

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 finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the InvokedAfter filter.

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

If the plugin hasn't started to run, the string is empty.

Public Property ExecutionStartDateTime System.String

Gets and sets the property ExecutionStartDateTime.

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

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

If the plugin hasn't started to run, 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 node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.

Public Property PluginName System.String

Gets and sets the property PluginName.

The name of the plugin, or step name, for which details are reported. 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 hasn't started running on the managed node, or it wasn't received by the node.

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 hasn't finished running, 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 hasn't finished running, 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 hasn't finished running, 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 Simple Storage Service (Amazon S3). If an S3 bucket wasn't specified, then this string is empty.

Public Property Status Amazon.SimpleSystemsManagement.CommandInvocationStatus

Gets and sets the property Status.

The status of this invocation plugin. 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 Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:

  • Pending: The command hasn't been sent to the managed node.

  • In Progress: The command has been sent to the managed node but hasn't reached a terminal state.

  • Delayed: The system attempted to send the command to the target, but the target wasn't available. The managed node might not be available because of network issues, because the node was stopped, or for similar reasons. The system will try to send the command again.

  • Success: The command or plugin ran successfully. This is a terminal state.

  • Delivery Timed Out: The command wasn't delivered to the managed node before the delivery timeout expired. Delivery timeouts don't 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 run on the managed node, but the execution wasn't 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 run successfully on the managed node. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

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

  • Undeliverable: The command can't be delivered to the managed node. The node 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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5