parameter_histories

Creates, updates, deletes, gets or lists a parameter_histories resource.

Overview

Name	parameter_histories
Type	Resource
Id	aws.ssm.parameter_histories

Fields

The following fields are returned by SELECT queries:

get_parameter_history

Name	Datatype	Description
allowed_pattern	string	Parameter names can include the following letters and symbols. a-zA-Z0-9_.-
data_type	string	The data type of the parameter, such as text or aws:ec2:image. The default is text.
description	string	Information about the parameter.
key_id	string	The alias of the Key Management Service (KMS) key used to encrypt the parameter. Applies to SecureString parameters only (pattern: <code>^([a-zA-Z0-9:/_-]+)$</code>)
labels	array	Labels assigned to the parameter version.
last_modified_date	string (date-time)	Date the parameter was last changed or updated.
last_modified_user	string	Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.
name	string	The name of the parameter.
policies	array	Information about the policies assigned to a parameter. Assigning parameter policies in the Amazon Web Services Systems Manager User Guide.
tier	string	The parameter tier. (Standard, Advanced, Intelligent-Tiering)
type	string	The type of parameter used. (String, StringList, SecureString)
value	string	The parameter value.
version	integer (int64)	The parameter version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_parameter_history	select	region		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, GetParameterHistory retrieves whatever the original key alias was referencing.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_parameter_history

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, GetParameterHistory retrieves whatever the original key alias was referencing.

SELECT
allowed_pattern,
data_type,
description,
key_id,
labels,
last_modified_date,
last_modified_user,
name,
policies,
tier,
type,
value,
version
FROM aws.ssm.parameter_histories
WHERE region = '{{ region }}' -- required
;