Class: Aws::SSM::Types::DocumentKeyValuesFilter

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass DocumentKeyValuesFilter data as a hash:

{
  key: "DocumentKeyValuesFilterKey",
  values: ["DocumentKeyValuesFilterValue"],
}

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:,Values=`.

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`

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#key ⇒ String

The name of the filter key.

Returns:

  • (String) 


6161
6162
6163
6164
6165
 
# File 'lib/aws-sdk-ssm/types.rb', line 6161

class DocumentKeyValuesFilter < Struct.new(
  :key,
  :values)
  include Aws::Structure
end

#values ⇒ Array<String>

The value for the filter key.

Returns:

  • (Array<String>) 


6161
6162
6163
6164
6165
 
# File 'lib/aws-sdk-ssm/types.rb', line 6161

class DocumentKeyValuesFilter < Struct.new(
  :key,
  :values)
  include Aws::Structure
end