@Generated(value="software.amazon.awssdk:codegen") public class DocumentKeyValuesFilter extends Object implements StructuredPojo, 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
Modifier and Type | Class and Description |
---|---|
static interface |
DocumentKeyValuesFilter.Builder |
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)
Marshalls this structured data using the given
ProtocolMarshaller . |
static Class<? extends DocumentKeyValuesFilter.Builder> |
serializableBuilderClass() |
DocumentKeyValuesFilter.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<String> |
values()
The value for the filter key.
|
copy
public String key()
The name of the filter key.
public List<String> values()
The value for the filter key.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public DocumentKeyValuesFilter.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DocumentKeyValuesFilter.Builder,DocumentKeyValuesFilter>
public static DocumentKeyValuesFilter.Builder builder()
public static Class<? extends DocumentKeyValuesFilter.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.