ParameterStringFilter - AWS Systems Manager

ParameterStringFilter

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

Important

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: Name, Path, and Tier.

For examples of CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the AWS Systems Manager User Guide.

Contents

Key

The name of the filter.

Type: String

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

Pattern: tag:.+|Name|Type|KeyId|Path|Label|Tier|DataType

Required: Yes

Option

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 the key Label, the only valid option is Equals.)

Type: String

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

Required: No

Values

The value you want to search for.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

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

Required: No

See Also

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