GetParametersByPathRequest

public struct GetParametersByPathRequest : AWSShape
extension SSM.GetParametersByPathRequest: AWSPaginateStringToken

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let maxResults: Int?

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

    Declaration

    Swift

    public let nextToken: String?

  • Filters to limit the request results. For 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.

    Declaration

    Swift

    public let parameterFilters: [ParameterStringFilter]?

  • 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

    Declaration

    Swift

    public let path: String

  • 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 action recursively for /a and view /a/b.

    Declaration

    Swift

    public let recursive: Bool?

  • Retrieve all parameters in a hierarchy with their value decrypted.

    Declaration

    Swift

    public let withDecryption: Bool?

  • Undocumented

    Declaration

    Swift

    public init(maxResults: Int? = nil, nextToken: String? = nil, parameterFilters: [ParameterStringFilter]? = nil, path: String, recursive: Bool? = nil, withDecryption: Bool? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws

Paginators

  • Undocumented

    Declaration

    Swift

    public func usingPaginationToken(_ token: String) -> SSM.GetParametersByPathRequest