software.amazon.awssdk.services.ssm.model

Interface CommandFilter.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CommandFilter.Builder,CommandFilter>, SdkBuilder<CommandFilter.Builder,CommandFilter>, SdkPojo

Enclosing class:

CommandFilter

public static interface CommandFilter.Builder
extends SdkPojo, CopyableBuilder<CommandFilter.Builder,CommandFilter>

Method Summary

Modifier and Type	Method and Description
CommandFilter.Builder	key(CommandFilterKey key) The name of the filter.
CommandFilter.Builder	key(String key) The name of the filter.
CommandFilter.Builder	value(String value) The filter value.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

key

CommandFilter.Builder key(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, CommandFilterKey

key

CommandFilter.Builder key(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, CommandFilterKey

value

CommandFilter.Builder value(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.