One or more filters. Use a filter to return a more specific list of results.
ContentsThe name of the filter.
The ParameterStringFilter
object is used by the DescribeParameters and GetParametersByPath API operations. However, not all of the pattern values listed for Key
can be used with both operations.
For DescribeParameters
, all of the listed patterns are valid except Label
.
For GetParametersByPath
, the following patterns listed for Key
aren't valid: tag
, DataType
, Name
, Path
, and Tier
.
For examples of AWS 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
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
.)
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10.
Required: No
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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
ParametersFilter
ParentStepDetails
Did this page help you? - Yes
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Did this page help you? - No
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4