Welcome to simple_aws_ssm_parameter_store Documentation
simple_aws_ssm_parameter_store is a small, Pythonic layer over the boto3 SSM client for AWS Systems Manager Parameter Store. It does not replace boto3: every function takes your own ssm_client and smooths over the parts of the raw API that are awkward to use.
What it gives you over the raw client:
Existence check without exceptions: get_parameter returns None instead of raising ParameterNotFound.
Idempotent delete: delete_parameter returns True or False and is safe to call twice.
Writes only on change: put_parameter_if_changed skips the write when the parameter already matches, so re-running a script does not use up the 100 versions SSM keeps per parameter.
Tags as a dict: get, add, replace, or remove tags with plain dict[str, str] instead of [{"Key": ..., "Value": ...}] lists.
A typed result: a Parameter object with properties such as value, version, arn, and aws_account_id.
Quick Tour
Every public name is imported from simple_aws_ssm_parameter_store.api:
import boto3
from simple_aws_ssm_parameter_store.api import ParameterType
from simple_aws_ssm_parameter_store.api import get_parameter
from simple_aws_ssm_parameter_store.api import put_parameter_if_changed
from simple_aws_ssm_parameter_store.api import delete_parameter
ssm_client = boto3.client("ssm")
Read a parameter, or learn that it does not exist
param = get_parameter(ssm_client, "/app/database/password", with_decryption=True)
if param is None:
print("not found")
else:
print(param.value, param.version, param.is_secure_string_type)
Write only when the value changed
before, after = put_parameter_if_changed(
ssm_client=ssm_client,
name="/app/database/host",
value="prod-db.example.com",
type=ParameterType.STRING,
tags={"Team": "platform"}, # the full tag set, synced on every call
)
The result tells you what happened:
(before, after) |
Meaning |
|---|---|
(None, Parameter) |
Created, after.version == 1 |
(Parameter, None) |
Already matched, nothing written |
(Parameter, Parameter) |
Changed, from before.version to after.version |
Every argument you pass is compared, not only the value, and a SecureString is compared by its decrypted value. Running the same call again writes nothing.
Delete, whether or not it exists
delete_parameter(ssm_client, "/app/temp/config") # True: it was deleted
delete_parameter(ssm_client, "/app/temp/config") # False: it was already gone
Manage tags as a dict
from simple_aws_ssm_parameter_store.api import get_parameter_tags
from simple_aws_ssm_parameter_store.api import update_parameter_tags
from simple_aws_ssm_parameter_store.api import put_parameter_tags
from simple_aws_ssm_parameter_store.api import remove_parameter_tags
name = "/app/config"
update_parameter_tags(ssm_client, name, {"Env": "prod", "Team": "platform"})
# tags are now {"Env": "prod", "Team": "platform"}
put_parameter_tags(ssm_client, name, {"Env": "prod", "Owner": "alice"})
# tags are now {"Env": "prod", "Owner": "alice"}
remove_parameter_tags(ssm_client, name, ["Owner"])
# tags are now {"Env": "prod"}
put_parameter_tags(ssm_client, name, {})
# tags are now {}
get_parameter_tags(ssm_client, name) # read them back as a dict
update_parameter_tags adds or overwrites the given keys and keeps the others.
put_parameter_tags makes the given dict the full tag set; {} removes every tag.
remove_parameter_tags removes only the given keys.
Learn more:
Getting Started: every function, run step by step with real output.
Design Notes: why the functions behave this way, and the cases to watch for.
API reference: every argument.
Install
simple_aws_ssm_parameter_store is released on PyPI and needs Python 3.11 or newer:
$ pip install simple-aws-ssm-parameter-store
To upgrade to latest version:
$ pip install --upgrade simple-aws-ssm-parameter-store
Use with AI Coding Agents
This repo ships an Agent Skill that documents the public API of simple_aws_ssm_parameter_store, so an AI coding agent such as Claude Code can use the library without reading its source. It lives in .claude/skills/pypi-simple_aws_ssm_parameter_store. To use it in your project, copy it into your project’s .claude/skills/ folder. Run this from your project’s root:
$ git clone --depth 1 https://github.com/MacHu-GWU/simple_aws_ssm_parameter_store-project.git /tmp/simple_aws_ssm_parameter_store-project
$ mkdir -p .claude/skills
$ cp -R /tmp/simple_aws_ssm_parameter_store-project/.claude/skills/pypi-simple_aws_ssm_parameter_store .claude/skills/
Metadata
Release files for simple_aws_ssm_parameter_store 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| simple_aws_ssm_parameter_store-0.3.0.tar.gz | 22.6 kB | Without provenance | Details for simple_aws_ssm_parameter_store-0.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| simple_aws_ssm_parameter_store-0.3.0-py3-none-any.whl | Python 3 | none | any | Details for simple_aws_ssm_parameter_store-0.3.0-py3-none-any.whl |
Total release size: 40.7 kB
Release files / simple_aws_ssm_parameter_store-0.3.0.tar.gz
| Download URL | simple_aws_ssm_parameter_store-0.3.0.tar.gz |
|---|---|
| Size | 22.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a57633d05cb7875ca133e1b2f0a7de1456d933b89088a2af50fb8202c30c6101
|
|
BLAKE2b-256 checksum How to use checksums |
d5195e59e7d4f9563ebf6fcdc37653998da5ecc362dcd614359cb6934062d700
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / simple_aws_ssm_parameter_store-0.3.0-py3-none-any.whl
| Download URL | simple_aws_ssm_parameter_store-0.3.0-py3-none-any.whl |
|---|---|
| Size | 18.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
720ae7d27ac2f0fa3bb9a147c110ead74d2f76674fddce7678353083f83b9803
|
|
BLAKE2b-256 checksum How to use checksums |
77c3b2f8ea193fe0ae0c3c783a11d846987d72e7852cf6347f40c2a6345fb3ae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for simple_aws_ssm_parameter_store 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.