You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SSM::Types::GetParametersByPathRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::GetParametersByPathRequest
- Defined in:
- (unknown)
Overview
When passing GetParametersByPathRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
path: "PSParameterName", # required
recursive: false,
parameter_filters: [
{
key: "ParameterStringFilterKey", # required
option: "ParameterStringQueryOption",
values: ["ParameterStringFilterValue"],
},
],
with_decryption: false,
max_results: 1,
next_token: "NextToken",
}
Instance Attribute Summary collapse
-
#max_results ⇒ Integer
The maximum number of items to return for this call.
-
#next_token ⇒ String
A token to start the list.
-
#parameter_filters ⇒ Array<Types::ParameterStringFilter>
Filters to limit the request results.
-
#path ⇒ String
The hierarchy for the parameter.
-
#recursive ⇒ Boolean
Retrieve all parameters within a hierarchy.
-
#with_decryption ⇒ Boolean
Retrieve all parameters in a hierarchy with their value decrypted.
Instance Attribute Details
#max_results ⇒ Integer
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
#next_token ⇒ String
A token to start the list. Use this token to get the next set of results.
#parameter_filters ⇒ Array<Types::ParameterStringFilter>
Filters to limit the request results.
GetParametersByPath
, the following filter Key
names are
supported: Type
, KeyId
, Label
, and DataType
.
The following Key
values are not supported for GetParametersByPath
:
tag
, Name
, Path
, and Tier
.
#path ⇒ String
The hierarchy for the parameter. Hierarchies start with a forward slash
(/) and end with the parameter name. A parameter name hierarchy can have
a maximum of 15 levels. Here is an example of a hierarchy:
/Finance/Prod/IAD/WinServ2016/license33
#recursive ⇒ Boolean
Retrieve all parameters within a hierarchy.
/a
,
then the user can also access /a/b
. Even if a user has explicitly been
denied access in IAM for parameter /a/b
, they can still call the
GetParametersByPath API action recursively for /a
and view /a/b
.
#with_decryption ⇒ Boolean
Retrieve all parameters in a hierarchy with their value decrypted.