parameters_by_paths

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

Overview

Name	parameters_by_paths
Type	Resource
Id	aws.ssm.parameters_by_paths

Fields

The following fields are returned by SELECT queries:

get_parameters_by_path

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the parameter.
data_type	string	The data type of the parameter, such as text or aws:ec2:image. The default is text.
last_modified_date	string (date-time)	Date the parameter was last changed or updated and the parameter version was created.
name	string	The name of the parameter.
selector	string	Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats: parameter_name:version parameter_name:label
source_result	string	Applies to parameters that reference information in other Amazon Web Services services. SourceResult is the raw result or response from the source.
type	string	The type of parameter. Valid values include the following: String, StringList, and SecureString. If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field. (String, StringList, SecureString)
value	string	The parameter value. If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
version	integer (int64)	The parameter version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_parameters_by_path	select	region		Retrieve information about one or more parameters under a specified level in a hierarchy. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results. 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.

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_parameters_by_path

Retrieve information about one or more parameters under a specified level in a hierarchy. Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results. 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.

SELECT
arn,
data_type,
last_modified_date,
name,
selector,
source_result,
type,
value,
version
FROM aws.ssm.parameters_by_paths
WHERE region = '{{ region }}' -- required
;