@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CommandFilter extends Object implements Serializable, Cloneable, StructuredPojo
Describes a command filter.
An instance ID can't be specified when a command status is Pending
because the command hasn't run on the
instance yet.
Constructor and Description |
---|
CommandFilter() |
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.
|
public void setKey(String key)
The name of the filter.
key
- The name of the filter.CommandFilterKey
public String getKey()
The name of the filter.
CommandFilterKey
public CommandFilter withKey(String key)
The name of the filter.
key
- The name of the filter.CommandFilterKey
public void setKey(CommandFilterKey key)
The name of the filter.
key
- The name of the filter.CommandFilterKey
public CommandFilter withKey(CommandFilterKey key)
The name of the filter.
key
- The name of the filter.CommandFilterKey
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.
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.
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.
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.
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.
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.
public String toString()
toString
in class Object
Object.toString()
public CommandFilter clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.