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.

An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. A command invocation returns status and detail information about a command you executed.

Inheritance Hierarchy

System.Object
  Amazon.SimpleSystemsManagement.Model.CommandInvocation

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

Syntax

C#
public class CommandInvocation

The CommandInvocation type exposes the following members

Constructors

NameDescription
Public Method CommandInvocation()

Properties

NameTypeDescription
Public Property CommandId System.String

Gets and sets the property CommandId.

The command against which this invocation was requested.

Public Property CommandPlugins System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.CommandPlugin>

Gets and sets the property CommandPlugins.

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 DocumentName System.String

Gets and sets the property DocumentName.

The document name that was requested for execution.

Public Property InstanceId System.String

Gets and sets the property InstanceId.

The instance ID in which this invocation was requested.

Public Property InstanceName System.String

Gets and sets the property InstanceName.

The name of the invocation target. For Amazon EC2 instances this is the value for the aws:Name tag. For on-premises instances, this is the name of the instance.

Public Property NotificationConfig Amazon.SimpleSystemsManagement.Model.NotificationConfig

Gets and sets the property NotificationConfig.

Configurations for sending notifications about command status changes on a per instance basis.

Public Property RequestedDateTime System.DateTime

Gets and sets the property RequestedDateTime.

The time and date the request was sent to this instance.

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 on a per instance basis.

Public Property StandardErrorUrl System.String

Gets and sets the property StandardErrorUrl.

The URL to the plugin's StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.

Public Property StandardOutputUrl System.String

Gets and sets the property StandardOutputUrl.

The URL to the plugin's StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.

Public Property Status Amazon.SimpleSystemsManagement.CommandInvocationStatus

Gets and sets the property Status.

Whether or not the invocation succeeded, failed, or is pending.

Public Property StatusDetails System.String

Gets and sets the property StatusDetails.

A detailed status of the command execution for each invocation (each instance targeted by the command). 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 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.

Public Property TraceOutput System.String

Gets and sets the property TraceOutput.

Gets the trace output sent by the agent.

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