CommandFilter (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.simplesystemsmanagement.model.CommandFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CommandFilter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CommandFilter()

Constructors
Constructor and Description
`CommandFilter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CommandFilter`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getKey()` The name of the filter.
`String`	`getValue()` The filter value.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setKey(CommandFilterKey key)` The name of the filter.
`void`	`setKey(String key)` The name of the filter.
`void`	`setValue(String value)` The filter value.
`String`	`toString()` Returns a string representation of this object.
`CommandFilter`	`withKey(CommandFilterKey key)` The name of the filter.
`CommandFilter`	`withKey(String key)` The name of the filter.
`CommandFilter`	`withValue(String value)` The filter value.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CommandFilter
```
public CommandFilter()
```
- Method Detail
  - setKey
```
public void setKey(String key)
```
    The name of the filter.
    
    The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.
    
    Parameters:
    
    key - The name of the filter.
    
    The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.
    
    See Also:
    
    CommandFilterKey
  - getKey
```
public String getKey()
```
    The name of the filter.
    
    The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.
    
    Returns:
    
    The name of the filter.
    
    The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.
    
    See Also:
    
    CommandFilterKey
  - withKey
```
public CommandFilter withKey(String key)
```
    The name of the filter.
    
    The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.
    
    Parameters:
    
    key - The name of the filter.
    
    The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CommandFilterKey
  - setKey
```
public void setKey(CommandFilterKey key)
```
    The name of the filter.
    
    The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.
    
    Parameters:
    
    key - The name of the filter.
    
    The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.
    
    See Also:
    
    CommandFilterKey
  - withKey
```
public CommandFilter withKey(CommandFilterKey key)
```
    The name of the filter.
    
    The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.
    
    Parameters:
    
    key - The name of the filter.
    
    The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CommandFilterKey
  - setValue
```
public void setValue(String value)
```
    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.
    Parameters:
    value - 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.
  - getValue
```
public String getValue()
```
    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:
    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.
  - withValue
```
public CommandFilter withValue(String value)
```
    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.
    Parameters:
    value - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CommandFilter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class CommandFilter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CommandFilter

Method Detail

setKey

getKey

withKey

setKey

withKey

setValue

getValue

withValue

toString

equals

hashCode

clone

marshall