Documentation

Describes a command request.

See: newCommand smart constructor.

Create a value of Command with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:alarmConfiguration:Command', command_alarmConfiguration - The details for the CloudWatch alarm applied to your command.

$sel:cloudWatchOutputConfig:Command', command_cloudWatchOutputConfig - Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.

$sel:commandId:Command', command_commandId - A unique identifier for this command.

$sel:comment:Command', command_comment - User-specified information about the command, such as a brief description of what the command should do.

$sel:completedCount:Command', command_completedCount - 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.

$sel:deliveryTimedOutCount:Command', command_deliveryTimedOutCount - The number of targets for which the status is Delivery Timed Out.

$sel:documentName:Command', command_documentName - The name of the document requested for execution.

$sel:documentVersion:Command', command_documentVersion - The Systems Manager document (SSM document) version.

$sel:errorCount:Command', command_errorCount - The number of targets for which the status is Failed or Execution Timed Out.

$sel:expiresAfter:Command', command_expiresAfter - 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.

$sel:instanceIds:Command', command_instanceIds - The managed node IDs against which this command was requested.

$sel:maxConcurrency:Command', command_maxConcurrency - 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.

$sel:maxErrors:Command', command_maxErrors - 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.

$sel:notificationConfig:Command', command_notificationConfig - Configurations for sending notifications about command status changes.

$sel:outputS3BucketName:Command', command_outputS3BucketName - The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

$sel:outputS3KeyPrefix:Command', command_outputS3KeyPrefix - The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

$sel:outputS3Region:Command', command_outputS3Region - (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.

$sel:parameters:Command', command_parameters - The parameter values to be inserted in the document when running the command.

$sel:requestedDateTime:Command', command_requestedDateTime - The date and time the command was requested.

$sel:serviceRole:Command', command_serviceRole - 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.

$sel:status:Command', command_status - The status of the command.

$sel:statusDetails:Command', command_statusDetails - 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:

• Pending: The command hasn't been sent to any managed nodes.
• In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.
• Success: The command successfully ran on all invocations. This is a terminal state.
• Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
• Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
• Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
• Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
• Cancelled: The command was terminated before it was completed. This is a terminal state.
• Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state.
• Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.

$sel:targetCount:Command', command_targetCount - The number of targets for the command.

$sel:targets:Command', command_targets - An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.

$sel:timeoutSeconds:Command', command_timeoutSeconds - The TimeoutSeconds value specified for a command.

$sel:triggeredAlarms:Command', command_triggeredAlarms - The CloudWatch alarm that was invoked by the command.

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.

A unique identifier for this command.

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

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:

• Pending: The command hasn't been sent to any managed nodes.
• In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all managed nodes.
• Success: The command successfully ran on all invocations. This is a terminal state.
• Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.
• Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.
• Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.
• Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.
• Cancelled: The command was terminated before it was completed. This is a terminal state.
• Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any managed node. This is a terminal state.
• Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries again.

The number of targets for the command.

An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is required if you don't provide one or more managed node IDs in the call.

The TimeoutSeconds value specified for a command.

The CloudWatch alarm that was invoked by the command.