Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.Types.DocumentKeyValuesFilter

Description

Documentation

data DocumentKeyValuesFilter Source #

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

See: newDocumentKeyValuesFilter smart constructor.

Constructors

DocumentKeyValuesFilter'
Fields key :: Maybe Text The name of the filter key. values :: Maybe [Text] The value for the filter key.

Instances

Instances details

ToJSON DocumentKeyValuesFilter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentKeyValuesFilter Methods toJSON :: DocumentKeyValuesFilter -> Value # toEncoding :: DocumentKeyValuesFilter -> Encoding # toJSONList :: [DocumentKeyValuesFilter] -> Value # toEncodingList :: [DocumentKeyValuesFilter] -> Encoding #
Generic DocumentKeyValuesFilter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentKeyValuesFilter Associated Types type Rep DocumentKeyValuesFilter :: Type -> Type # Methods from :: DocumentKeyValuesFilter -> Rep DocumentKeyValuesFilter x # to :: Rep DocumentKeyValuesFilter x -> DocumentKeyValuesFilter #
Read DocumentKeyValuesFilter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentKeyValuesFilter Methods readsPrec :: Int -> ReadS DocumentKeyValuesFilter # readList :: ReadS [DocumentKeyValuesFilter] # readPrec :: ReadPrec DocumentKeyValuesFilter # readListPrec :: ReadPrec [DocumentKeyValuesFilter] #
Show DocumentKeyValuesFilter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentKeyValuesFilter Methods showsPrec :: Int -> DocumentKeyValuesFilter -> ShowS # show :: DocumentKeyValuesFilter -> String # showList :: [DocumentKeyValuesFilter] -> ShowS #
NFData DocumentKeyValuesFilter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentKeyValuesFilter Methods rnf :: DocumentKeyValuesFilter -> () #
Eq DocumentKeyValuesFilter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentKeyValuesFilter Methods (==) :: DocumentKeyValuesFilter -> DocumentKeyValuesFilter -> Bool # (/=) :: DocumentKeyValuesFilter -> DocumentKeyValuesFilter -> Bool #
Hashable DocumentKeyValuesFilter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentKeyValuesFilter Methods hashWithSalt :: Int -> DocumentKeyValuesFilter -> Int # hash :: DocumentKeyValuesFilter -> Int #
type Rep DocumentKeyValuesFilter Source #
Instance details Defined in Amazonka.SSM.Types.DocumentKeyValuesFilter type Rep DocumentKeyValuesFilter = D1 ('MetaData "DocumentKeyValuesFilter" "Amazonka.SSM.Types.DocumentKeyValuesFilter" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DocumentKeyValuesFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newDocumentKeyValuesFilter :: DocumentKeyValuesFilter Source #

Create a value of DocumentKeyValuesFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:key:DocumentKeyValuesFilter', documentKeyValuesFilter_key - The name of the filter key.

$sel:values:DocumentKeyValuesFilter', documentKeyValuesFilter_values - The value for the filter key.

documentKeyValuesFilter_key :: Lens' DocumentKeyValuesFilter (Maybe Text) Source #

The name of the filter key.

documentKeyValuesFilter_values :: Lens' DocumentKeyValuesFilter (Maybe [Text]) Source #

The value for the filter key.