Command class

Describes a command request.

Constructors

Command({CloudWatchOutputConfig? cloudWatchOutputConfig, String? commandId, String? comment, int? completedCount, int? deliveryTimedOutCount, String? documentName, String? documentVersion, int? errorCount, DateTime? expiresAfter, List<String>? instanceIds, String? maxConcurrency, String? maxErrors, NotificationConfig? notificationConfig, String? outputS3BucketName, String? outputS3KeyPrefix, String? outputS3Region, Map<String, List<String>>? parameters, DateTime? requestedDateTime, String? serviceRole, CommandStatus? status, String? statusDetails, int? targetCount, List<Target>? targets, int? timeoutSeconds})
Command.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?
A unique identifier for this command.
final
comment → String?
User-specified information about the command, such as a brief description of what the command should do.
final
completedCount → int?
The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.
final
deliveryTimedOutCount → int?
The number of targets for which the status is Delivery Timed Out.
final
documentName → String?
The name of the document requested for execution.
final
documentVersion → String?
The SSM document version.
final
errorCount → int?
The number of targets for which the status is Failed or Execution Timed Out.
final
expiresAfter → DateTime?
If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.
final
hashCode → int
The hash code for this object.
no setterinherited
instanceIds → List<String>?
The instance IDs against which this command was requested.
final
maxConcurrency → String?
The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.
final
maxErrors → String?
The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.
final
notificationConfig → NotificationConfig?
Configurations for sending notifications about command status changes.
final
outputS3BucketName → String?
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
final
outputS3KeyPrefix → String?
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
final
outputS3Region → String?
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Region of the S3 bucket.
final
parameters → Map<String, List<String>>?
The parameter values to be inserted in the document when running the command.
final
requestedDateTime → DateTime?
The date and time the command was requested.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serviceRole → String?
The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.
final
status → CommandStatus?
The status of the command.
final
statusDetails → String?
A detailed status of the command 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 Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:
final
targetCount → int?
The number of targets for the command.
final
targets → List<Target>?
An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.
final
timeoutSeconds → int?
The TimeoutSeconds value specified for a command.
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