CommandPlugin class
Describes plugin details.
Constructors
- CommandPlugin({String? name, String? output, String? outputS3BucketName, String? outputS3KeyPrefix, String? outputS3Region, int? responseCode, DateTime? responseFinishDateTime, DateTime? responseStartDateTime, String? standardErrorUrl, String? standardOutputUrl, CommandPluginStatus? status, String? statusDetails})
-
CommandPlugin.fromJson(Map<
String, dynamic> json) -
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- name → String?
-
The name of the plugin. Must be one of the following: aws:updateAgent,
aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule,
aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.
final
- output → String?
-
Output of the plugin execution.
final
- outputS3BucketName → String?
-
The S3 bucket where the responses to the command executions should be
stored. This was requested when issuing the command. For example, in the
following response:
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.
For example, in the following response:
final
- outputS3Region → String?
-
(Deprecated) You can no longer specify this parameter. The system ignores
it. Instead, Systems Manager automatically determines the S3 bucket region.
final
- responseCode → int?
-
A numeric response code generated after running the plugin.
final
- responseFinishDateTime → DateTime?
-
The time the plugin stopped running. Could stop prematurely if, for example,
a cancel command was sent.
final
- responseStartDateTime → DateTime?
-
The time the plugin started running.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- standardErrorUrl → String?
-
The URL for the complete text written by the plugin to stderr. If execution
is not yet complete, then this string is empty.
final
- standardOutputUrl → String?
-
The URL for the complete text written by the plugin to stdout in Amazon S3.
If the S3 bucket for the command was not specified, then this string is
empty.
final
- status → CommandPluginStatus?
-
The status of this plugin. You can run a document with multiple plugins.
final
- statusDetails → String?
-
A detailed status of the plugin 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
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