AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the GetParametersByPath operation. Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters in the AWS Systems Manager User Guide.

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.

This API action doesn't support filtering by tags.

Inheritance Hierarchy


Namespace: Amazon.SimpleSystemsManagement.Model
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z


public class GetParametersByPathRequest : AmazonSimpleSystemsManagementRequest

The GetParametersByPathRequest type exposes the following members



Public Property 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.

Public Property 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.

Public Property ParameterFilters System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.ParameterStringFilter>

Gets and sets the property ParameterFilters.

Filters to limit the request results.

You can't filter using the parameter name.

Public Property Path System.String

Gets and sets the property Path.

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

Public Property 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 /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a, they can still call the GetParametersByPath API action recursively and view /a/b.

Public Property WithDecryption System.Boolean

Gets and sets the property WithDecryption.

Retrieve all parameters in a hierarchy with their value decrypted.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms