Get Parameter

ssm_get_parameter

R Documentation

Get information about a single parameter by specifying the parameter name¶

Description¶

Get information about a single parameter by specifying the parameter name.

Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.

To get information about more than one parameter at a time, use the get_parameters operation.

Usage¶

ssm_get_parameter(Name, WithDecryption)

Arguments¶

Name

[required] 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.

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:

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¶

svc$get_parameter(
  Name = "string",
  WithDecryption = TRUE|FALSE
)