ParameterStringFilter
One or more filters. Use a filter to return a more specific list of results.
Contents
- Key
-
The name of the filter.
Note The
ParameterStringFilter
object is used by the DescribeParameters and GetParametersByPath API actions. However, not all of the pattern values listed forKey
can be used with both actions.For
DescribeActions
, all of the listed patterns are valid, with the exception ofLabel
.For
GetParametersByPath
, the following patterns listed forKey
are not valid:tag
,Name
,Path
, andTier
.For examples of CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the AWS Systems Manager User Guide.
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
andBeginsWith
. TheName
filter additionally supports theContains
option. (Exception: For filters using the keyPath
, valid options includeRecursive
andOneLevel
.)For filters used with GetParametersByPath, valid options include
Equals
andBeginsWith
. (Exception: For filters usingLabel
as the Key name, the only valid option isEquals
.)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: