Struct aws_sdk_ssm::types::builders::CommandFilterBuilder
source · #[non_exhaustive]pub struct CommandFilterBuilder { /* private fields */ }
Expand description
A builder for CommandFilter
.
Implementations§
source§impl CommandFilterBuilder
impl CommandFilterBuilder
sourcepub fn key(self, input: CommandFilterKey) -> Self
pub fn key(self, input: CommandFilterKey) -> Self
The name of the filter.
The ExecutionStage
filter can't be used with the ListCommandInvocations
operation, only with ListCommands
.
sourcepub fn set_key(self, input: Option<CommandFilterKey>) -> Self
pub fn set_key(self, input: Option<CommandFilterKey>) -> Self
The name of the filter.
The ExecutionStage
filter can't be used with the ListCommandInvocations
operation, only with ListCommands
.
sourcepub fn get_key(&self) -> &Option<CommandFilterKey>
pub fn get_key(&self) -> &Option<CommandFilterKey>
The name of the filter.
The ExecutionStage
filter can't be used with the ListCommandInvocations
operation, only with ListCommands
.
sourcepub fn value(self, input: impl Into<String>) -> Self
pub fn value(self, input: impl Into<String>) -> Self
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.
-
sourcepub fn set_value(self, input: Option<String>) -> Self
pub fn set_value(self, input: Option<String>) -> Self
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.
-
sourcepub fn get_value(&self) -> &Option<String>
pub fn get_value(&self) -> &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.
-
sourcepub fn build(self) -> Result<CommandFilter, BuildError>
pub fn build(self) -> Result<CommandFilter, BuildError>
Consumes the builder and constructs a CommandFilter
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for CommandFilterBuilder
impl Clone for CommandFilterBuilder
source§fn clone(&self) -> CommandFilterBuilder
fn clone(&self) -> CommandFilterBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CommandFilterBuilder
impl Debug for CommandFilterBuilder
source§impl Default for CommandFilterBuilder
impl Default for CommandFilterBuilder
source§fn default() -> CommandFilterBuilder
fn default() -> CommandFilterBuilder
source§impl PartialEq for CommandFilterBuilder
impl PartialEq for CommandFilterBuilder
source§fn eq(&self, other: &CommandFilterBuilder) -> bool
fn eq(&self, other: &CommandFilterBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for CommandFilterBuilder
Auto Trait Implementations§
impl Freeze for CommandFilterBuilder
impl RefUnwindSafe for CommandFilterBuilder
impl Send for CommandFilterBuilder
impl Sync for CommandFilterBuilder
impl Unpin for CommandFilterBuilder
impl UnwindSafe for CommandFilterBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more