Struct aws_sdk_ssm::model::DocumentKeyValuesFilter
source · [−]#[non_exhaustive]pub struct DocumentKeyValuesFilter {
pub key: Option<String>,
pub values: Option<Vec<String>>,
}
Expand description
One or more filters. Use a filter to return a more specific list of documents.
For keys, you can specify one or more tags that have been applied to a document.
You can also use Amazon Web Services-provided keys, some of which have specific allowed values. These keys and their associated values are as follows:
- DocumentType
-
-
ApplicationConfiguration
-
ApplicationConfigurationSchema
-
Automation
-
ChangeCalendar
-
Command
-
Package
-
Policy
-
Session
-
- Owner
-
Note that only one
Owner
can be specified in a request. For example:Key=Owner,Values=Self
.-
Amazon
-
Private
-
Public
-
Self
-
ThirdParty
-
- PlatformTypes
-
-
Linux
-
Windows
-
Name
is another Amazon Web Services-provided key. If you use Name
as a key, you can use a name prefix to return a list of documents. For example, in the Amazon Web Services CLI, to return a list of all documents that begin with Te
, run the following command:
aws ssm list-documents --filters Key=Name,Values=Te
You can also use the TargetType
Amazon Web Services-provided key. For a list of valid resource type values that can be used with this key, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
If you specify more than two keys, only documents that are identified by all the tags are returned in the results. If you specify more than two values for a key, documents that are identified by any of the values are returned in the results.
To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName
.
For example, if you created a key called region and are using the Amazon Web Services CLI to call the list-documents
command:
aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.key: Option<String>
The name of the filter key.
values: Option<Vec<String>>
The value for the filter key.
Implementations
sourceimpl DocumentKeyValuesFilter
impl DocumentKeyValuesFilter
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture DocumentKeyValuesFilter
Trait Implementations
sourceimpl Clone for DocumentKeyValuesFilter
impl Clone for DocumentKeyValuesFilter
sourcefn clone(&self) -> DocumentKeyValuesFilter
fn clone(&self) -> DocumentKeyValuesFilter
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for DocumentKeyValuesFilter
impl Debug for DocumentKeyValuesFilter
sourceimpl PartialEq<DocumentKeyValuesFilter> for DocumentKeyValuesFilter
impl PartialEq<DocumentKeyValuesFilter> for DocumentKeyValuesFilter
sourcefn eq(&self, other: &DocumentKeyValuesFilter) -> bool
fn eq(&self, other: &DocumentKeyValuesFilter) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &DocumentKeyValuesFilter) -> bool
fn ne(&self, other: &DocumentKeyValuesFilter) -> bool
This method tests for !=
.
impl StructuralPartialEq for DocumentKeyValuesFilter
Auto Trait Implementations
impl RefUnwindSafe for DocumentKeyValuesFilter
impl Send for DocumentKeyValuesFilter
impl Sync for DocumentKeyValuesFilter
impl Unpin for DocumentKeyValuesFilter
impl UnwindSafe for DocumentKeyValuesFilter
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more