Struct aws_sdk_ssm::types::DocumentKeyValuesFilter

#[non_exhaustive]
pub struct DocumentKeyValuesFilter {
    pub key: Option<String>,
    pub values: Option<Vec<String>>,
}

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)

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<String>

The name of the filter key.

values: Option<Vec<String>>

The value for the filter key.

Implementations

impl DocumentKeyValuesFilter

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

The name of the filter key.

pub fn values(&self) -> &[String]

The value for the filter key.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .values.is_none().

impl DocumentKeyValuesFilter

pub fn builder() -> DocumentKeyValuesFilterBuilder

Creates a new builder-style object to manufacture DocumentKeyValuesFilter.

Trait Implementations

impl Clone for DocumentKeyValuesFilter

fn clone(&self) -> DocumentKeyValuesFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentKeyValuesFilter

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

Formats the value using the given formatter.

impl PartialEq for DocumentKeyValuesFilter

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DocumentKeyValuesFilter