Skip to content

Retrieves the history of all changes to a parameter

Description

Retrieves the history of all changes to a parameter.

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.

If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, get_parameter_history retrieves whatever the original key alias was referencing.

Usage

ssm_get_parameter_history(Name, WithDecryption, MaxResults, NextToken)

Arguments

  • Name

    [required] The name or Amazon Resource Name (ARN) of the parameter for which you want to review history. For parameters shared with you from another account, you must use the full ARN.

  • WithDecryption

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

  • MaxResults

    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.

  • NextToken

    The token for the next set of items to return. (You received this token from a previous call.)

Value

A list with the following syntax:

list(
  Parameters = list(
    list(
      Name = "string",
      Type = "String"|"StringList"|"SecureString",
      KeyId = "string",
      LastModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedUser = "string",
      Description = "string",
      Value = "string",
      AllowedPattern = "string",
      Version = 123,
      Labels = list(
        "string"
      ),
      Tier = "Standard"|"Advanced"|"Intelligent-Tiering",
      Policies = list(
        list(
          PolicyText = "string",
          PolicyType = "string",
          PolicyStatus = "string"
        )
      ),
      DataType = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_parameter_history(
  Name = "string",
  WithDecryption = TRUE|FALSE,
  MaxResults = 123,
  NextToken = "string"
)