Package software.amazon.awssdk.services.ssm.model

Class CommandFilter

java.lang.Object

software.amazon.awssdk.services.ssm.model.CommandFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CommandFilter.Builder,CommandFilter>

@Generated("software.amazon.awssdk:codegen")
public final class CommandFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CommandFilter.Builder,CommandFilter>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CommandFilter.Builder

Method Summary

Modifier and Type	Method	Description
static CommandFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
CommandFilterKey	key()	The name of the filter.
String	keyAsString()	The name of the filter.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CommandFilter.Builder>	serializableBuilderClass()
CommandFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	value()	The filter value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

key

public final CommandFilterKey key()

The name of the filter.

The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.

If the service returns an enum value that is not available in the current SDK version, key will return CommandFilterKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

The name of the filter.

The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.

See Also:

CommandFilterKey

keyAsString

public final String keyAsString()

The name of the filter.

The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.

If the service returns an enum value that is not available in the current SDK version, key will return CommandFilterKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

The name of the filter.

The ExecutionStage filter can't be used with the ListCommandInvocations operation, only with ListCommands.

See Also:

CommandFilterKey

value

public final 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 2024-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 2024-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 2024-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 2024-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.

toBuilder

public CommandFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CommandFilter.Builder,CommandFilter>

builder

public static CommandFilter.Builder builder()

serializableBuilderClass

public static Class<? extends CommandFilter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo