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

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::DescribeParametersRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filters ⇒ Array<Types::ParametersFilter>

  This data type is deprecated.

• #max_results ⇒ Integer

  The maximum number of items to return for this call.

• #next_token ⇒ String

  The token for the next set of items to return.

• #parameter_filters ⇒ Array<Types::ParameterStringFilter>

  Filters to limit the request results.

• #shared ⇒ Boolean

  Lists parameters that are shared with you.

Instance Attribute Details

#filters ⇒ Array<Types::ParametersFilter>

This data type is deprecated. Instead, use ‘ParameterFilters`.

Returns:

• (Array<Types::ParametersFilter>)

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

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

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

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

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

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

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

#shared ⇒ Boolean

Lists parameters that are shared with you.

<note markdown=“1”> 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][1

API operation.

For more information about sharing parameters, see [Working with

shared parameters] in the *Amazon Web Services Systems Manager User Guide*.

</note>

[1]: docs.aws.amazon.com/ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html [2]: docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html

Returns:

• (Boolean)

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

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