software.amazon.awssdk.services.ssm.model

Class DocumentKeyValuesFilter

java.lang.Object

software.amazon.awssdk.services.ssm.model.DocumentKeyValuesFilter

All Implemented Interfaces:

StructuredPojo, software.amazon.awssdk.utils.builder.ToCopyableBuilder<DocumentKeyValuesFilter.Builder,DocumentKeyValuesFilter>

@Generated(value="software.amazon.awssdk:codegen")
public class DocumentKeyValuesFilter
extends Object
implements StructuredPojo, software.amazon.awssdk.utils.builder.ToCopyableBuilder<DocumentKeyValuesFilter.Builder,DocumentKeyValuesFilter>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DocumentKeyValuesFilter.Builder

Method Summary

Modifier and Type	Method and Description
static DocumentKeyValuesFilter.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key() The name of the filter key.
void	marshall(ProtocolMarshaller protocolMarshaller)
static Class<? extends DocumentKeyValuesFilter.Builder>	serializableBuilderClass()
DocumentKeyValuesFilter.Builder	toBuilder()
String	toString()
List<String>	values() The value for the filter key.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

key

public String key()

The name of the filter key.

Returns:

The name of the filter key.

values

public List<String> values()

The value for the filter key.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The value for the filter key.

toBuilder

public DocumentKeyValuesFilter.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<DocumentKeyValuesFilter.Builder,DocumentKeyValuesFilter>

builder

public static DocumentKeyValuesFilter.Builder builder()

serializableBuilderClass

public static Class<? extends DocumentKeyValuesFilter.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo