DocumentKeyValuesFilter - Amazon Systems Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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-provided keys, some of which have specific allowed values. These keys and their associated values are as follows:

  • ApplicationConfiguration

  • ApplicationConfigurationSchema

  • Automation

  • ChangeCalendar

  • Command

  • Package

  • Policy

  • Session


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

  • Amazon

  • Private

  • Public

  • Self

  • ThirdParty

  • Linux

  • Windows

Name is another Amazon-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 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-provided key. For a list of valid resource type values that can be used with this key, see Amazon resource and property types reference in the Amazon 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 CLI to call the list-documents command:

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



The name of the filter key.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No


The value for the filter key.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: