NAME

Paws::SSM::ParameterStringFilter

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::ParameterStringFilter 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::ParameterStringFilter object:

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

DESCRIPTION

One or more filters. Use a filter to return a more specific list of results.

ATTRIBUTES

REQUIRED Key => Str

The name of the filter.

The "ParameterStringFilter" object is used by the DescribeParameters and GetParametersByPath API actions. However, not all of the pattern values listed for "Key" can be used with both actions.

For "DescribeActions", all of the listed patterns are valid, with the exception of "Label".

For "GetParametersByPath", the following patterns listed for "Key" are not valid: "tag", "Name", "Path", and "Tier".

For examples of CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters (https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-search.html) in the AWS Systems Manager User Guide.

Option => Str

For all filters used with DescribeParameters, valid options include "Equals" and "BeginsWith". The "Name" filter additionally supports the "Contains" option. (Exception: For filters using the key "Path", valid options include "Recursive" and "OneLevel".)

For filters used with GetParametersByPath, valid options include "Equals" and "BeginsWith". (Exception: For filters using "Label" as the Key name, the only valid option is "Equals".)

Values => ArrayRef[Str|Undef]

The value you want to search for.

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>