Class: Aws::SSM::Types::DescribeParametersRequest

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

Overview

Note:

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

{
  filters: [
    {
      key: "Name", # required, accepts Name, Type, KeyId
      values: ["ParametersFilterValue"], # required
    },
  ],
  parameter_filters: [
    {
      key: "ParameterStringFilterKey", # required
      option: "ParameterStringQueryOption",
      values: ["ParameterStringFilterValue"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filters ⇒ Array<Types::ParametersFilter>

One or more filters. Use a filter to return a more specific list of results.

Returns:



4813
4814
4815
4816
4817
4818
4819
 
# File 'lib/aws-sdk-ssm/types.rb', line 4813

class DescribeParametersRequest < Struct.new(
  :filters,
  :parameter_filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#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) 


4813
4814
4815
4816
4817
4818
4819
 
# File 'lib/aws-sdk-ssm/types.rb', line 4813

class DescribeParametersRequest < Struct.new(
  :filters,
  :parameter_filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

  • (String) 


4813
4814
4815
4816
4817
4818
4819
 
# File 'lib/aws-sdk-ssm/types.rb', line 4813

class DescribeParametersRequest < Struct.new(
  :filters,
  :parameter_filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#parameter_filters ⇒ Array<Types::ParameterStringFilter>

Filters to limit the request results.

Returns:



4813
4814
4815
4816
4817
4818
4819
 
# File 'lib/aws-sdk-ssm/types.rb', line 4813

class DescribeParametersRequest < Struct.new(
  :filters,
  :parameter_filters,
  :max_results,
  :next_token)
  include Aws::Structure
end