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

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

Overview

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)

8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
# File 'lib/aws-sdk-ssm/types.rb', line 8599

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)

8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
# File 'lib/aws-sdk-ssm/types.rb', line 8599

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.

<note markdown=“1”> The following `Key` values are supported for `GetParametersByPath`: `Type`, `KeyId`, and `Label`.

The following `Key` values aren't supported for

`GetParametersByPath`: `tag`, `DataType`, `Name`, `Path`, and `Tier`.

</note>

Returns:


8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
# File 'lib/aws-sdk-ssm/types.rb', line 8599

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 (/). 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 `

Returns:

  • (String)

8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
# File 'lib/aws-sdk-ssm/types.rb', line 8599

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

Returns:

  • (Boolean)

8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
# File 'lib/aws-sdk-ssm/types.rb', line 8599

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)

8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
# File 'lib/aws-sdk-ssm/types.rb', line 8599

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