Class: Aws::SSM::Types::GetParametersByPathRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass GetParametersByPathRequest data as a hash:

{
  path: "PSParameterName", # required
  recursive: false,
  parameter_filters: [
    {
      key: "ParameterStringFilterKey", # required
      option: "ParameterStringQueryOption",
      values: ["ParameterStringFilterValue"],
    },
  ],
  with_decryption: false,
  max_results: 1,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

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.

Returns:

  • (Integer)


8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8462

class GetParametersByPathRequest < Struct.new(
  :path,
  :recursive,
  :parameter_filters,
  :with_decryption,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8462

class GetParametersByPathRequest < Struct.new(
  :path,
  :recursive,
  :parameter_filters,
  :with_decryption,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_filtersArray<Types::ParameterStringFilter>

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.

Returns:



8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8462

class GetParametersByPathRequest < Struct.new(
  :path,
  :recursive,
  :parameter_filters,
  :with_decryption,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#pathString

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

Returns:

  • (String)


8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8462

class GetParametersByPathRequest < Struct.new(
  :path,
  :recursive,
  :parameter_filters,
  :with_decryption,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#recursiveBoolean

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.

Returns:

  • (Boolean)


8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8462

class GetParametersByPathRequest < Struct.new(
  :path,
  :recursive,
  :parameter_filters,
  :with_decryption,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#with_decryptionBoolean

Retrieve all parameters in a hierarchy with their value decrypted.

Returns:

  • (Boolean)


8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8462

class GetParametersByPathRequest < Struct.new(
  :path,
  :recursive,
  :parameter_filters,
  :with_decryption,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end