You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/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

Instance Attribute Details

#keyString

The name of the filter.

Returns:

  • (String)


1431
1432
1433
1434
1435
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1431

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

#valueString

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.

Returns:

  • (String)


1431
1432
1433
1434
1435
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1431

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