CommandInvocation class

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 runs 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 ran.

Constructors

CommandInvocation({CloudWatchOutputConfig? cloudWatchOutputConfig, String? commandId, List<CommandPlugin>? commandPlugins, String? comment, String? documentName, String? documentVersion, String? instanceId, String? instanceName, NotificationConfig? notificationConfig, DateTime? requestedDateTime, String? serviceRole, String? standardErrorUrl, String? standardOutputUrl, CommandInvocationStatus? status, String? statusDetails, String? traceOutput})

CommandInvocation.fromJson(Map<String, dynamic> json)

factory

Properties

cloudWatchOutputConfig → CloudWatchOutputConfig?

CloudWatch Logs information where you want Systems Manager to send the command output.

final

commandId → String?

The command against which this invocation was requested.

final

commandPlugins → List<CommandPlugin>?

final

comment → String?

User-specified information about the command, such as a brief description of what the command should do.

final

documentName → String?

The document name that was requested for execution.

final

documentVersion → String?

The SSM document version.

final

hashCode → int

The hash code for this object.

no setter, inherited

instanceId → String?

The instance ID in which this invocation was requested.

final

instanceName → String?

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

final

notificationConfig → NotificationConfig?

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

final

requestedDateTime → DateTime?

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

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serviceRole → String?

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.

final

standardErrorUrl → String?

The URL to the plugin's StdErr file in Amazon S3, if the 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 S3 bucket was defined for the command.

final

standardOutputUrl → String?

The URL to the plugin's StdOut file in Amazon S3, if the 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 S3 bucket was defined for the command.

final

status → CommandInvocationStatus?

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

final

statusDetails → String?

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 Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:

final

traceOutput → String?

Gets the trace output sent by the agent.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited