class
Amazonite::Ssm::CommandFilter
- Amazonite::Ssm::CommandFilter
- Reference
- Object
Overview
Describes a command filter.
A managed node ID can't be specified when a command status is Pending because the command
hasn't run on the node yet.
Included Modules
- JSON::Serializable
Defined in:
ssm/command_filter.crConstructors
- .new(key : CommandFilterKey, value : String)
- .new(pull : JSON::PullParser)
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#hash(hasher)
See
Object#hash(hasher) -
#key : CommandFilterKey
The name of the filter.
-
#key=(key : CommandFilterKey)
The name of the filter.
- #validate! : Nil
-
#value : String
The filter value.
-
#value=(value : String)
The filter value.
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
The name of the filter.
The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with
ListCommands.
The name of the filter.
The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with
ListCommands.
The filter value. Valid values for each filter key are as follows:
-
InvokedAfter: Specify a timestamp to limit your results. For example, specify
2024-07-07T00:00:00Zto see a list of command executions occurring July 7, 2021, and later. -
InvokedBefore: Specify a timestamp to limit your results. For example, specify
2024-07-07T00:00:00Zto see a list of command executions from before July 7, 2021. -
Status: Specify a valid command status to see a list of all command executions with that status. The status choices depend on the API you call.
The status values you can specify for ListCommands are:
-
Pending -
InProgress -
Success -
Cancelled -
Failed -
TimedOut(this includes both Delivery and Execution time outs) -
AccessDenied -
DeliveryTimedOut -
ExecutionTimedOut -
Incomplete -
NoInstancesInTag -
LimitExceeded
The status values you can specify for ListCommandInvocations are:
-
Pending -
InProgress -
Delayed -
Success -
Cancelled -
Failed -
TimedOut(this includes both Delivery and Execution time outs) -
AccessDenied -
DeliveryTimedOut -
ExecutionTimedOut -
Undeliverable -
InvalidPlatform -
Terminated -
DocumentName: Specify name of the Amazon Web Services Systems Manager document (SSM document) for which you want to see command execution results. For example, specify
AWS-RunPatchBaselineto see command executions that used this SSM document to perform security patching operations on managed nodes. -
ExecutionStage: Specify one of the following values (
ListCommandsoperations only): -
Executing: Returns a list of command executions that are currently still running. -
Complete: Returns a list of command executions that have already completed.
The filter value. Valid values for each filter key are as follows:
-
InvokedAfter: Specify a timestamp to limit your results. For example, specify
2024-07-07T00:00:00Zto see a list of command executions occurring July 7, 2021, and later. -
InvokedBefore: Specify a timestamp to limit your results. For example, specify
2024-07-07T00:00:00Zto see a list of command executions from before July 7, 2021. -
Status: Specify a valid command status to see a list of all command executions with that status. The status choices depend on the API you call.
The status values you can specify for ListCommands are:
-
Pending -
InProgress -
Success -
Cancelled -
Failed -
TimedOut(this includes both Delivery and Execution time outs) -
AccessDenied -
DeliveryTimedOut -
ExecutionTimedOut -
Incomplete -
NoInstancesInTag -
LimitExceeded
The status values you can specify for ListCommandInvocations are:
-
Pending -
InProgress -
Delayed -
Success -
Cancelled -
Failed -
TimedOut(this includes both Delivery and Execution time outs) -
AccessDenied -
DeliveryTimedOut -
ExecutionTimedOut -
Undeliverable -
InvalidPlatform -
Terminated -
DocumentName: Specify name of the Amazon Web Services Systems Manager document (SSM document) for which you want to see command execution results. For example, specify
AWS-RunPatchBaselineto see command executions that used this SSM document to perform security patching operations on managed nodes. -
ExecutionStage: Specify one of the following values (
ListCommandsoperations only): -
Executing: Returns a list of command executions that are currently still running. -
Complete: Returns a list of command executions that have already completed.