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

Inherits:
Struct
  • Object
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.

<note markdown=“1”> A managed node ID can't be specified when a command status is `Pending` because the command hasn't run on the node yet.

</note>

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#key ⇒ String

The name of the filter.

<note markdown=“1”> The `ExecutionStage` filter can't be used with the `ListCommandInvocations` operation, only with `ListCommands`.

</note>

Returns:

  • (String) 

2104
2105
2106
2107
2108
2109
 
# File 'lib/aws-sdk-ssm/types.rb', line 2104

class CommandFilter < Struct.new(
  :key,
  :value)
  SENSITIVE = []
  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 `2021-07-07T00:00:00Z` to see a list of command executions occurring July 7, 2021, and later.

  • InvokedBefore: Specify a timestamp to limit your results. For example, specify `2021-07-07T00:00:00Z` to 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-RunPatchBaseline` to see command executions that used this SSM document to perform security patching operations on managed nodes.

  • ExecutionStage: Specify one of the following values (`ListCommands` operations only):

    • `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) 

2104
2105
2106
2107
2108
2109
 
# File 'lib/aws-sdk-ssm/types.rb', line 2104

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