Class: Aws::SSM::Types::GetParameterRequest

Inherits:

Struct

Object
Struct
Aws::SSM::Types::GetParameterRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-ssm/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#name ⇒ String

The name or Amazon Resource Name (ARN) of the parameter that you want to query.
#with_decryption ⇒ Boolean

Return decrypted values for secure string parameters.

Instance Attribute Details

#name ⇒ `String`

The name or Amazon Resource Name (ARN) of the parameter that you want to query. For parameters shared with you from another account, you must use the full ARN.

To query by parameter label, use ‘“Name”: “name:label”`. To query by parameter version, use `“Name”: “name:version”`.

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

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/sharing.html

Returns:

(String)

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

class GetParameterRequest < Struct.new(
  :name,
  :with_decryption)
  SENSITIVE = []
  include Aws::Structure
end

#with_decryption ⇒ `Boolean`

Return decrypted values for secure string parameters. This flag is ignored for ‘String` and `StringList` parameter types.