Container for the parameters to the GetParametersByPath operation. Retrieve information about one or more parameters in a specific hierarchy.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the response includes information up to the limit specified. The number
of items returned, however, can be between zero and the value of MaxResults.
If the service reaches an internal limit while processing the results, it stops the
operation and returns the matching values up to that point and a NextToken.
You can specify the NextToken in a subsequent call to get the next set of results.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementRequest
Amazon.SimpleSystemsManagement.Model.GetParametersByPathRequest
Namespace: Amazon.SimpleSystemsManagement.Model
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z
Syntax
public class GetParametersByPathRequest : AmazonSimpleSystemsManagementRequest IAmazonWebServiceRequest
The GetParametersByPathRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GetParametersByPathRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
MaxResults | System.Int32 |
Gets and sets the property MaxResults. 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. |
|
|
NextToken | System.String |
Gets and sets the property NextToken. A token to start the list. Use this token to get the next set of results. |
|
|
ParameterFilters | System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.ParameterStringFilter> |
Gets and sets the property ParameterFilters. Filters to limit the request results.
The following
The following |
|
|
Path | System.String |
Gets and sets the property Path.
The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy
is the parameter name except the last part of the parameter. For the API call to succeed,
the last part of the parameter name can't be in the path. A parameter name hierarchy
can have a maximum of 15 levels. Here is an example of a hierarchy: |
|
|
Recursive | System.Boolean |
Gets and sets the property Recursive. Retrieve all parameters within a hierarchy.
If a user has access to a path, then the user can access all levels of that path.
For example, if a user has permission to access path |
|
|
WithDecryption | System.Boolean |
Gets and sets the property WithDecryption. Retrieve all parameters in a hierarchy with their value decrypted. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5