ParameterStringFilter

public struct ParameterStringFilter : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]
  • key

    The name of the filter. The ParameterStringFilter object is used by the DescribeParameters and GetParametersByPath API actions. However, not all of the pattern values listed for Key can be used with both actions. For DescribeActions, all of the listed patterns are valid, with the exception of Label. For GetParametersByPath, the following patterns listed for Key are not valid: tag, Name, Path, and Tier. For examples of CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the AWS Systems Manager User Guide.

    Declaration

    Swift

    public let key: String
  • For all filters used with DescribeParameters, valid options include Equals and BeginsWith. The Name filter additionally supports the Contains option. (Exception: For filters using the key Path, valid options include Recursive and OneLevel.) For filters used with GetParametersByPath, valid options include Equals and BeginsWith. (Exception: For filters using Label as the Key name, the only valid option is Equals.)

    Declaration

    Swift

    public let option: String?
  • The value you want to search for.

    Declaration

    Swift

    public let values: [String]?
  • Undocumented

    Declaration

    Swift

    public init(key: String, option: String? = nil, values: [String]? = nil)
  • Declaration

    Swift

    public func validate(name: String) throws