You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SSM::Types::CommandFilter
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::CommandFilter
- Defined in:
- (unknown)
Overview
When passing CommandFilter as input to an Aws::Client method, you can use a vanilla Hash:
{
key: "InvokedAfter", # required, accepts InvokedAfter, InvokedBefore, Status, ExecutionStage, DocumentName
value: "CommandFilterValue", # required
}
Describes a command filter.
An instance ID can't be specified when a command status is Pending
because the command hasn't run on the instance yet.
Instance Attribute Summary collapse
-
#key ⇒ String
The name of the filter.
-
#value ⇒ String
The filter value.
Instance Attribute Details
#key ⇒ String
The name of the filter.
Possible values:
- InvokedAfter
- InvokedBefore
- Status
- ExecutionStage
- DocumentName
#value ⇒ String
The filter value. Valid values for each filter key are as follows:
InvokedAfter: Specify a timestamp to limit your results. For example, specify
2018-07-07T00:00:00Z
to see a list of command executions occurring July 7, 2018, and later.InvokedBefore: Specify a timestamp to limit your results. For example, specify
2018-07-07T00:00:00Z
to see a list of command executions from before July 7, 2018.Status: Specify a valid command status to see a list of all command executions with that status. Status values you can specify include:
Pending
InProgress
Success
Cancelled
Failed
TimedOut
Cancelling
DocumentName: Specify name of the SSM document for which you want to see command execution results. For example, specify
AWS-RunPatchBaseline
to see command executions that used this SSM document to perform security patching operations on instances.ExecutionStage: Specify one of the following values:
Executing
: Returns a list of command executions that are currently still running.Complete
: Returns a list of command executions that have already completed.