Class: Aws::SSM::Types::DocumentKeyValuesFilter
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::DocumentKeyValuesFilter
- Defined in:
- gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb
Overview
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
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#key ⇒ String
The name of the filter key.
-
#values ⇒ Array<String>
The value for the filter key.
Instance Attribute Details
#key ⇒ String
The name of the filter key.
6838 6839 6840 6841 6842 6843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6838 class DocumentKeyValuesFilter < Struct.new( :key, :values) SENSITIVE = [] include Aws::Structure end |
#values ⇒ Array<String>
The value for the filter key.
6838 6839 6840 6841 6842 6843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6838 class DocumentKeyValuesFilter < Struct.new( :key, :values) SENSITIVE = [] include Aws::Structure end |