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

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::GetParametersByPathRequest

Includes:

Aws::Structure

Defined in:

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

See Also:

• AWS API Documentation

Instance Attribute Summary

• #max_results ⇒ Integer

  The maximum number of items to return for this call.

• #next_token ⇒ String

  A token to start the list.

• #parameter_filters ⇒ Array<Types::ParameterStringFilter>

  Filters to limit the request results.

• #path ⇒ String

  The hierarchy for the parameter.

• #recursive ⇒ Boolean

  Retrieve all parameters within a hierarchy.

• #with_decryption ⇒ Boolean

  Retrieve all parameters in a hierarchy with their value decrypted.

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)

# File 'lib/aws-sdk-ssm/types.rb', line 7872

class GetParametersByPathRequest < Struct.new(
  :path,
  :recursive,
  :parameter_filters,
  :with_decryption,
  :max_results,
  :next_token)
  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)

# File 'lib/aws-sdk-ssm/types.rb', line 7872

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

#parameter_filters ⇒ Array<Types::ParameterStringFilter>

Filters to limit the request results.

Returns:

• (Array<Types::ParameterStringFilter>)

# File 'lib/aws-sdk-ssm/types.rb', line 7872

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

#path ⇒ String

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)

# File 'lib/aws-sdk-ssm/types.rb', line 7872

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

#recursive ⇒ Boolean

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)

# File 'lib/aws-sdk-ssm/types.rb', line 7872

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

#with_decryption ⇒ Boolean

Retrieve all parameters in a hierarchy with their value decrypted.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ssm/types.rb', line 7872

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