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

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::ParametersFilter>

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

Returns:



3416
3417
3418
3419
3420
3421
3422
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3416

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

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


3416
3417
3418
3419
3420
3421
3422
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3416

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

#next_tokenString

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

Returns:

  • (String)


3416
3417
3418
3419
3420
3421
3422
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3416

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

#parameter_filtersArray<Types::ParameterStringFilter>

Filters to limit the request results.

Returns:



3416
3417
3418
3419
3420
3421
3422
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3416

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