Class: Aws::SSM::Types::CommandFilter

Inherits:

Struct

Object
Struct
Aws::SSM::Types::CommandFilter

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass CommandFilter data as a hash:

{
  key: "InvokedAfter", # required, accepts InvokedAfter, InvokedBefore, Status, ExecutionStage, DocumentName
  value: "CommandFilterValue", # required
}

Describes a command filter.

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.

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 1432

class CommandFilter < Struct.new(
  :key,
  :value)
  include Aws::Structure
end

#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.