ssm_get_parameter: Get information about a parameter by using the parameter name

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

Description

Get information about a parameter by using the parameter name. Don't confuse this API action with the get_parameters API action.

Usage

1
ssm_get_parameter(Name, WithDecryption)

Arguments

Name

[required] The name of the parameter you want to query.

WithDecryption

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

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
list(
  Parameter = list(
    Name = "string",
    Type = "String"|"StringList"|"SecureString",
    Value = "string",
    Version = 123,
    Selector = "string",
    SourceResult = "string",
    LastModifiedDate = as.POSIXct(
      "2015-01-01"
    ),
    ARN = "string",
    DataType = "string"
  )
)

Request syntax

1
2
3
4
svc$get_parameter(
  Name = "string",
  WithDecryption = TRUE|FALSE
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.