parameters

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

Overview

Name	parameters
Type	Resource
Id	aws.ssm.parameters

Fields

The following fields are returned by SELECT queries:

get_parameters

Name	Datatype	Description
invalid_parameters	array	A list of parameters that aren't formatted correctly or don't run during an execution.
parameters	array	A list of details for a parameter.

describe_parameters

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the parameter.
allowed_pattern	string	A parameter name can include only 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	Description of the parameter actions.
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>)
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 parameter name.
policies	array	A list of policies associated with a parameter.
tier	string	The parameter tier. (Standard, Advanced, Intelligent-Tiering)
type	string	The type of parameter. Valid parameter types include the following: String, StringList, and SecureString. (String, StringList, SecureString)
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	select	region		Get information about one or more parameters by specifying multiple parameter names. To get information about a single parameter, you can use the GetParameter operation instead. 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. Parameter Store throughput defines the number of API transactions per second (TPS) that Systems Manager can process. This applies to GetParameter, GetParameters, and PutParameter API calls for your Amazon Web Services account and Amazon Web Services Region. By default, Parameter Store is configured with a standard throughput quota suitable for low- to moderate-volume workloads. Applications that retrieve configuration data infrequently or operate at smaller scale can use this default setting without additional cost. For higher-volume workloads, you can enable higher throughput. This increases the maximum number of supported transactions per second for your account and Region. Increased throughput supports applications and workloads that need concurrent access to multiple parameters. If you experience ThrottlingException: Rate exceeded errors, enable higher throughput. For more information, see Changing Parameter Store throughput.
describe_parameters	select	region		Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option. 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. 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, DescribeParameters retrieves whatever the original key alias was referencing.
put_parameter	replace	region, Value		Create or update a parameter in Parameter Store. Parameter Store throughput defines the number of API transactions per second (TPS) that Systems Manager can process. This applies to GetParameter, GetParameters, and PutParameter API calls for your Amazon Web Services account and Amazon Web Services Region. By default, Parameter Store is configured with a standard throughput quota suitable for low- to moderate-volume workloads. Applications that retrieve configuration data infrequently or operate at smaller scale can use this default setting without additional cost. For higher-volume workloads, you can enable higher throughput. This increases the maximum number of supported transactions per second for your account and Region. Increased throughput supports applications and workloads that need concurrent access to multiple parameters. If you experience ThrottlingException: Rate exceeded errors, enable higher throughput. For more information, see Changing Parameter Store throughput.
delete_parameters	delete	region		Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
delete_parameter	delete	region		Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
get_parameter	exec	region		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 GetParameters operation. Parameter Store throughput defines the number of API transactions per second (TPS) that Systems Manager can process. This applies to GetParameter, GetParameters, and PutParameter API calls for your Amazon Web Services account and Amazon Web Services Region. By default, Parameter Store is configured with a standard throughput quota suitable for low- to moderate-volume workloads. Applications that retrieve configuration data infrequently or operate at smaller scale can use this default setting without additional cost. For higher-volume workloads, you can enable higher throughput. This increases the maximum number of supported transactions per second for your account and Region. Increased throughput supports applications and workloads that need concurrent access to multiple parameters. If you experience ThrottlingException: Rate exceeded errors, enable higher throughput. For more information, see Changing Parameter Store throughput.

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

Get information about one or more parameters by specifying multiple parameter names. To get information about a single parameter, you can use the GetParameter operation instead. 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. Parameter Store throughput defines the number of API transactions per second (TPS) that Systems Manager can process. This applies to GetParameter, GetParameters, and PutParameter API calls for your Amazon Web Services account and Amazon Web Services Region. By default, Parameter Store is configured with a standard throughput quota suitable for low- to moderate-volume workloads. Applications that retrieve configuration data infrequently or operate at smaller scale can use this default setting without additional cost. For higher-volume workloads, you can enable higher throughput. This increases the maximum number of supported transactions per second for your account and Region. Increased throughput supports applications and workloads that need concurrent access to multiple parameters. If you experience ThrottlingException: Rate exceeded errors, enable higher throughput. For more information, see Changing Parameter Store throughput.

SELECT
invalid_parameters,
parameters
FROM aws.ssm.parameters
WHERE region = '{{ region }}' -- required
;

describe_parameters

Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option. 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. 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, DescribeParameters retrieves whatever the original key alias was referencing.

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

REPLACE examples

put_parameter

Create or update a parameter in Parameter Store. Parameter Store throughput defines the number of API transactions per second (TPS) that Systems Manager can process. This applies to GetParameter, GetParameters, and PutParameter API calls for your Amazon Web Services account and Amazon Web Services Region. By default, Parameter Store is configured with a standard throughput quota suitable for low- to moderate-volume workloads. Applications that retrieve configuration data infrequently or operate at smaller scale can use this default setting without additional cost. For higher-volume workloads, you can enable higher throughput. This increases the maximum number of supported transactions per second for your account and Region. Increased throughput supports applications and workloads that need concurrent access to multiple parameters. If you experience ThrottlingException: Rate exceeded errors, enable higher throughput. For more information, see Changing Parameter Store throughput.

REPLACE aws.ssm.parameters
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
Value = '{{ Value }}',
Type = '{{ Type }}',
KeyId = '{{ KeyId }}',
Overwrite = {{ Overwrite }},
AllowedPattern = '{{ AllowedPattern }}',
Tags = '{{ Tags }}',
Tier = '{{ Tier }}',
Policies = '{{ Policies }}',
DataType = '{{ DataType }}'
WHERE 
region = '{{ region }}' --required
AND Value = '{{ Value }}' --required
RETURNING
tier,
version;

DELETE examples

delete_parameters

Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

DELETE FROM aws.ssm.parameters
WHERE region = '{{ region }}' --required
;

delete_parameter

Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

DELETE FROM aws.ssm.parameters
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

get_parameter

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 GetParameters operation. Parameter Store throughput defines the number of API transactions per second (TPS) that Systems Manager can process. This applies to GetParameter, GetParameters, and PutParameter API calls for your Amazon Web Services account and Amazon Web Services Region. By default, Parameter Store is configured with a standard throughput quota suitable for low- to moderate-volume workloads. Applications that retrieve configuration data infrequently or operate at smaller scale can use this default setting without additional cost. For higher-volume workloads, you can enable higher throughput. This increases the maximum number of supported transactions per second for your account and Region. Increased throughput supports applications and workloads that need concurrent access to multiple parameters. If you experience ThrottlingException: Rate exceeded errors, enable higher throughput. For more information, see Changing Parameter Store throughput.

EXEC aws.ssm.parameters.get_parameter 
@region='{{ region }}' --required 
@@json=
'{
"Name": "{{ Name }}", 
"WithDecryption": {{ WithDecryption }}
}'
;