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

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

#filtersArray<Types::ParametersFilter>

This data type is deprecated. Instead, use ParameterFilters.

Returns:



6033
6034
6035
6036
6037
6038
6039
6040
6041
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6033

class DescribeParametersRequest < Struct.new(
  :filters,
  :parameter_filters,
  :max_results,
  :next_token,
  :shared)
  SENSITIVE = []
  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)


6033
6034
6035
6036
6037
6038
6039
6040
6041
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6033

class DescribeParametersRequest < Struct.new(
  :filters,
  :parameter_filters,
  :max_results,
  :next_token,
  :shared)
  SENSITIVE = []
  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)


6033
6034
6035
6036
6037
6038
6039
6040
6041
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6033

class DescribeParametersRequest < Struct.new(
  :filters,
  :parameter_filters,
  :max_results,
  :next_token,
  :shared)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_filtersArray<Types::ParameterStringFilter>

Filters to limit the request results.

Returns:



6033
6034
6035
6036
6037
6038
6039
6040
6041
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6033

class DescribeParametersRequest < Struct.new(
  :filters,
  :parameter_filters,
  :max_results,
  :next_token,
  :shared)
  SENSITIVE = []
  include Aws::Structure
end

#sharedBoolean

Lists parameters that are shared with you.

By default when using this option, the command returns parameters that have been shared using a standard Resource Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy command to be returned, the associated RAM Resource Share Created From Policy must have been promoted to a standard Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.

For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

Returns:

  • (Boolean)


6033
6034
6035
6036
6037
6038
6039
6040
6041
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6033

class DescribeParametersRequest < Struct.new(
  :filters,
  :parameter_filters,
  :max_results,
  :next_token,
  :shared)
  SENSITIVE = []
  include Aws::Structure
end