Struct rusoto_ssm::DocumentKeyValuesFilter

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.

Other valid values include Owner, Name, PlatformTypes, and DocumentType.

Note that only one Owner can be specified in a request. For example: Key=Owner,Values=Self.

If you use Name as a key, you can use a name prefix to return a list of documents. For example, in the AWS 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

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 and value pair, use the format Key=tag:[tagName],Values=[valueName].

For example, if you created a Key called region and are using the AWS CLI to call the list-documents command:

aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self

Fields

key: Option<String>

The name of the filter key.

values: Option<Vec<String>>

The value for the filter key.

Trait Implementations

impl Default for DocumentKeyValuesFilter

fn default() -> DocumentKeyValuesFilter

Returns the "default value" for a type.

impl Debug for DocumentKeyValuesFilter

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

Formats the value using the given formatter.

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 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: &DocumentKeyValuesFilter) -> bool

This method tests for !=.