com.amazonaws.services.simplesystemsmanagement.model

Class CommandFilter

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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandFilter()

Method Summary

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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CommandFilter

public CommandFilter()

Method Detail

setKey

public void setKey(String key)

The name of the filter.

Parameters:

key - The name of the filter.

See Also:

CommandFilterKey

getKey

public String getKey()

The name of the filter.

Returns:

The name of the filter.

See Also:

CommandFilterKey

withKey

public CommandFilter withKey(String key)

The name of the filter.

Parameters:

key - The name of the filter.

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.

Parameters:

key - The name of the filter.

See Also:

CommandFilterKey

withKey

public CommandFilter withKey(CommandFilterKey key)

The name of the filter.

Parameters:

key - The name of the filter.

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

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

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 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:

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.

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

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 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:

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)

Specified by:

marshall in interface StructuredPojo