Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSM.Types.ParameterStringFilter

Description

Documentation

data ParameterStringFilter Source #

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

See: newParameterStringFilter smart constructor.

Constructors

ParameterStringFilter'

Fields

values :: Maybe (NonEmpty Text)
The value you want to search for.
option :: Maybe Text
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.)
key :: Text
The 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 DescribeActions, 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 Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

Instances

Instances details

Eq ParameterStringFilter Source #
Instance details Defined in Amazonka.SSM.Types.ParameterStringFilter Methods (==) :: ParameterStringFilter -> ParameterStringFilter -> Bool # (/=) :: ParameterStringFilter -> ParameterStringFilter -> Bool #
Read ParameterStringFilter Source #
Instance details Defined in Amazonka.SSM.Types.ParameterStringFilter Methods readsPrec :: Int -> ReadS ParameterStringFilter # readList :: ReadS [ParameterStringFilter] # readPrec :: ReadPrec ParameterStringFilter # readListPrec :: ReadPrec [ParameterStringFilter] #
Show ParameterStringFilter Source #
Instance details Defined in Amazonka.SSM.Types.ParameterStringFilter Methods showsPrec :: Int -> ParameterStringFilter -> ShowS # show :: ParameterStringFilter -> String # showList :: [ParameterStringFilter] -> ShowS #
Generic ParameterStringFilter Source #
Instance details Defined in Amazonka.SSM.Types.ParameterStringFilter Associated Types type Rep ParameterStringFilter :: Type -> Type # Methods from :: ParameterStringFilter -> Rep ParameterStringFilter x # to :: Rep ParameterStringFilter x -> ParameterStringFilter #
NFData ParameterStringFilter Source #
Instance details Defined in Amazonka.SSM.Types.ParameterStringFilter Methods rnf :: ParameterStringFilter -> () #
Hashable ParameterStringFilter Source #
Instance details Defined in Amazonka.SSM.Types.ParameterStringFilter Methods hashWithSalt :: Int -> ParameterStringFilter -> Int # hash :: ParameterStringFilter -> Int #
ToJSON ParameterStringFilter Source #
Instance details Defined in Amazonka.SSM.Types.ParameterStringFilter Methods toJSON :: ParameterStringFilter -> Value # toEncoding :: ParameterStringFilter -> Encoding # toJSONList :: [ParameterStringFilter] -> Value # toEncodingList :: [ParameterStringFilter] -> Encoding #
type Rep ParameterStringFilter Source #
Instance details Defined in Amazonka.SSM.Types.ParameterStringFilter type Rep ParameterStringFilter = D1 ('MetaData "ParameterStringFilter" "Amazonka.SSM.Types.ParameterStringFilter" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "ParameterStringFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: (S1 ('MetaSel ('Just "option") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newParameterStringFilter Source #

Arguments

:: Text	`$sel:key:ParameterStringFilter'`
-> ParameterStringFilter

Create a value of ParameterStringFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:values:ParameterStringFilter', parameterStringFilter_values - The value you want to search for.

$sel:option:ParameterStringFilter', parameterStringFilter_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 Label as the Key name, the only valid option is Equals.)

$sel:key:ParameterStringFilter', parameterStringFilter_key - The 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 DescribeActions, 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 Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

parameterStringFilter_values :: Lens' ParameterStringFilter (Maybe (NonEmpty Text)) Source #

The value you want to search for.

parameterStringFilter_option :: Lens' ParameterStringFilter (Maybe Text) Source #

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.)

parameterStringFilter_key :: Lens' ParameterStringFilter Text Source #

The 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 DescribeActions, 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 Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.