Skip to content

Get Parameters By Path

ssm_get_parameters_by_path R Documentation

Retrieve information about one or more parameters in a specific hierarchy

Description

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.

Usage

ssm_get_parameters_by_path(Path, Recursive, ParameterFilters,
  WithDecryption, MaxResults, NextToken)

Arguments

Path

[required] 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: ⁠/Finance/Prod/IAD/WinServ2016/license33 ⁠

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/b⁠, they can still call the GetParametersByPath API operation recursively for ⁠/a⁠ and view ⁠/a/b⁠.

ParameterFilters

Filters to limit the request results.

The following Key values are supported for get_parameters_by_path: Type, KeyId, and Label.

The following Key values aren't supported for get_parameters_by_path: tag, DataType, Name, Path, and Tier.

WithDecryption

Retrieve all parameters in a hierarchy with their value decrypted.

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

A token to start the list. Use this token to get the next set of results.

Value

A list with the following syntax: 

list(
  Parameters = list(
    list(
      Name = "string",
      Type = "String"|"StringList"|"SecureString",
      Value = "string",
      Version = 123,
      Selector = "string",
      SourceResult = "string",
      LastModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      ARN = "string",
      DataType = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_parameters_by_path(
  Path = "string",
  Recursive = TRUE|FALSE,
  ParameterFilters = list(
    list(
      Key = "string",
      Option = "string",
      Values = list(
        "string"
      )
    )
  ),
  WithDecryption = TRUE|FALSE,
  MaxResults = 123,
  NextToken = "string"
)