Builder
Properties
The details for the CloudWatch alarm applied to your command.
Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
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, Cancelled, Terminated, or Undeliverable.
The number of targets for which the status is Delivery Timed Out.
The name of the document requested for execution.
The Systems Manager document (SSM document) version.
The number of targets for which the status is Failed or Execution Timed Out.
If a command expires, it changes status to DeliveryTimedOut
for all invocations that have the status InProgress
, Pending
, or Delayed
. ExpiresAfter
is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.
The managed node IDs against which this command was requested.
The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number of managed nodes, such as 10, or a percentage of nodes, 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 Amazon Web Services Systems Manager User Guide.
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 Amazon Web Services Systems Manager User Guide.
Configurations for sending notifications about command status changes.
The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.
The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.
(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.
The parameter values to be inserted in the document when running the command.
The date and time the command was requested.
The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes.
The status of the command.
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 Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:
The number of targets for the command.
The TimeoutSeconds
value specified for a command.
The CloudWatch alarm that was invoked by the command.
Functions
construct an aws.sdk.kotlin.services.ssm.model.AlarmConfiguration inside the given block
construct an aws.sdk.kotlin.services.ssm.model.CloudWatchOutputConfig inside the given block
construct an aws.sdk.kotlin.services.ssm.model.NotificationConfig inside the given block