NAME

Paws::SSM::DocumentKeyValuesFilter

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::SSM::DocumentKeyValuesFilter object:

  $service_obj->Method(Att1 => { Key => $value, ..., Values => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::DocumentKeyValuesFilter object:

  $result = $service_obj->Method(...);
  $result->Att1->Key

DESCRIPTION

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

DocumentType

Owner

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

PlatformTypes

"Name" is another AWS-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 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"

You can also use the "TargetType" AWS-provided key. For a list of valid resource type values that can be used with this key, see AWS resource and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the AWS 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 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"

ATTRIBUTES

SEE ALSO

This class forms part of Paws, describing an object used in Paws::SSM

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>