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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_results ⇒ Integer

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)


9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9778

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

#next_token ⇒ String

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

Returns:

  • (String)


9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9778

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

#parameter_filters ⇒ Array<Types::ParameterStringFilter>

Filters to limit the request results.

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.

Returns:



9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9778

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

#path ⇒ String

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)


9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9778

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

#recursive ⇒ Boolean

Retrieve all parameters within a hierarchy.

Returns:

  • (Boolean)


9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9778

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

#with_decryption ⇒ Boolean

Retrieve all parameters in a hierarchy with their value decrypted.

Returns:

  • (Boolean)


9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9778

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