Struct aws_sdk_ssm::model::CommandFilter

#[non_exhaustive]
pub struct CommandFilter {
    pub key: Option<CommandFilterKey>,
    pub value: Option<String>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: Option<CommandFilterKey>

The name of the filter.

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

value: Option<String>

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.

Implementations

impl CommandFilter

pub fn key(&self) -> Option<&CommandFilterKey>

The name of the filter.

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

pub fn value(&self) -> Option<&str>

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.

impl CommandFilter

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CommandFilter.

Trait Implementations

impl Clone for CommandFilter

fn clone(&self) -> CommandFilter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommandFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CommandFilter> for CommandFilter

fn eq(&self, other: &CommandFilter) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CommandFilter) -> bool

This method tests for !=.

impl StructuralPartialEq for CommandFilter