You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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",
}

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)


5008
5009
5010
5011
5012
5013
5014
5015
5016
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5008

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

#next_tokenString

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

Returns:

  • (String)


5008
5009
5010
5011
5012
5013
5014
5015
5016
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5008

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

#parameter_filtersArray<Types::ParameterStringFilter>

Filters to limit the request results.

Returns:



5008
5009
5010
5011
5012
5013
5014
5015
5016
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5008

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

#pathString

The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. A hierarchy can have a maximum of five levels. Examples: /Environment/Test/DBString003

/Finance/Prod/IAD/OS/WinServ2016/license15

Returns:

  • (String)


5008
5009
5010
5011
5012
5013
5014
5015
5016
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5008

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

#recursiveBoolean

Retrieve all parameters within a hierarchy.

Returns:

  • (Boolean)


5008
5009
5010
5011
5012
5013
5014
5015
5016
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5008

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

#with_decryptionBoolean

Retrieve all parameters in a hierarchy with their value decrypted.

Returns:

  • (Boolean)


5008
5009
5010
5011
5012
5013
5014
5015
5016
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5008

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