Get Parameters

ssm_get_parameters

R Documentation

Get information about one or more parameters by specifying multiple parameter names¶

Description¶

Get information about one or more parameters by specifying multiple parameter names.

To get information about a single parameter, you can use the get_parameter operation instead.

Usage¶

ssm_get_parameters(Names, WithDecryption)

Arguments¶

Names

[required] The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with you from another account, you must use the full ARNs.

To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version".

The results for get_parameters requests are listed in alphabetical order in query responses.

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

WithDecryption

Return decrypted secure string value. 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(
  Parameters = list(
    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"
    )
  ),
  InvalidParameters = list(
    "string"
  )
)

Request syntax¶

svc$get_parameters(
  Names = list(
    "string"
  ),
  WithDecryption = TRUE|FALSE
)