AWS Secrets
Read and write secrets in AWS Secrets Manager and parameters in SSM Parameter Store, with versions. Typical uses: read a database password at run time, store a generated key.
aws_secret pingaws_secret putaws_secret putaws_secret getaws_secret getaws_secret listaws_secret listaws_secret describeaws_secret versionsaws_secret deleteaws_secret deleteaws_secret restoreaws_secret operationaws_param pingaws_param putaws_param putaws_param getaws_param getaws_param listaws_param listaws_param delete

aws_secret ping <config>


Description

    Check the credentials and the endpoint (ListSecrets of 1 row): {ok: true}

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
admin
aws_secret ping "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}"
mentdb
{"ok": true}

aws_secret put <config> <secret_id> <value>


Description

    Write a new value (PutSecretValue); the secret is created when it does not exist (CreateSecret). Returns {created, arn, name, version_id}

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    secret_id:   The name or the ARN of the secret - String - required
    value:   The value (often a JSON object as text) - String - required
admin
aws_secret put "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "prod/db" "{\"user\": \"app\", \"password\": \"Pa55-word!\"}"
mentdb
{"created": true, "arn": "arn:aws:secretsmanager:eu-west-3:123456789012:secret:prod/db-OUtjyl", "name": "prod/db", "version_id": "7573935e-3e8e-44aa-9a75-29c937fc5e9e"}
a new value: the old one becomes AWSPREVIOUS (fixed result: moto 5.1.22, the AWS emulator, not a real AWS account)
admin
aws_secret put "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "prod/db" "{\"user\": \"app\", \"password\": \"N3w-pass!\"}"
mentdb
{"created": false, "arn": "arn:aws:secretsmanager:eu-west-3:123456789012:secret:prod/db-OUtjyl", "name": "prod/db", "version_id": "374f7cb3-9460-4ca9-8e9e-125ac6d28c7e"}

aws_secret put <config> <secret_id> <value> <json_params>


Description

    Write with options: create (true; false: an error if missing), binary (the value is base64: SecretBinary), description, kms_key_id, tags (object) at the creation, version_stages

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    secret_id:   The name or the ARN of the secret - String - required
    value:   The value - String - required
    json_params:   The options as a JSON object - String - required
admin
aws_secret put "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "prod/api-key" "k-8f2a" "{\"description\": \"Partner API\", \"tags\": {\"team\": \"data\"}}"
mentdb
{"created": true, "arn": "arn:aws:secretsmanager:eu-west-3:123456789012:secret:prod/api-key-qSeUyJ", "name": "prod/api-key", "version_id": "1d93cb1e-3174-4b51-90e2-f0f4a3f8afb9"}

aws_secret get <config> <secret_id>


Description

    Read the current value (AWSCURRENT): SecretString, or SecretBinary in base64; null when the secret does not exist

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    secret_id:   The name or the ARN of the secret - String - required
admin
aws_secret get "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "prod/db"
mentdb
{"user": "app", "password": "N3w-pass!"}
missing (fixed result: moto 5.1.22, the AWS emulator, not a real AWS account)
admin
aws_secret get "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "prod/nothing"
mentdb
null

aws_secret get <config> <secret_id> <json_params>


Description

    Read with options: field (one field of a JSON secret), version_stage (AWSPREVIOUS...), version_id

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    secret_id:   The name or the ARN of the secret - String - required
    json_params:   The options as a JSON object - String - required
admin
aws_secret get "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "prod/db" "{\"field\": \"password\"}"
mentdb
N3w-pass!
the previous value (fixed result: moto 5.1.22, the AWS emulator, not a real AWS account)
admin
aws_secret get "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "prod/db" "{\"field\": \"password\", \"version_stage\": \"AWSPREVIOUS\"}"
mentdb
Pa55-word!

aws_secret list <config>


Description

    The secrets as rows {name, arn, description, created_date, last_changed_date, last_accessed_date, deleted_date, rotation_enabled, tags}, 1000 at most

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
admin
aws_secret list "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}"
mentdb
[{"name": "billing/db", "arn": "arn:aws:secretsmanager:eu-west-3:123456789012:secret:billing/db-UIkwrc", "description": null, "created_date": "2026-11-17T16:23:27Z", "last_changed_date": "2026-11-17T16:23:27Z", "last_accessed_date": null, "deleted_date": null, "rotation_enabled": false, "tags": {}}, {"name": "prod/db", "arn": "arn:aws:secretsmanager:eu-west-3:123456789012:secret:prod/db-OUtjyl", "description": null, "created_date": "2026-11-17T16:24:04Z", "last_changed_date": "2026-11-17T16:24:05Z", "last_accessed_date": null, "deleted_date": null, "rotation_enabled": false, "tags": {}}, {"name": "prod/api-key", "arn": "arn:aws:secretsmanager:eu-west-3:123456789012:secret:prod/api-key-qSeUyJ", "description": "Partner API", "created_date": "2026-11-17T16:24:06Z", "last_changed_date": "2026-11-17T16:24:06Z", "last_accessed_date": null, "deleted_date": null, "rotation_enabled": false, "tags": {"team": "data"}}]

aws_secret list <config> <json_params>


Description

    List with options: name_prefix, filters (AWS filters), include_planned_deletion, limit (1000, 100000 at most; pages of 100 followed)

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    json_params:   The options as a JSON object - String - required
admin
aws_secret list "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "{\"name_prefix\": \"prod/api\"}"
mentdb
[{"name": "prod/api-key", "arn": "arn:aws:secretsmanager:eu-west-3:123456789012:secret:prod/api-key-qSeUyJ", "description": "Partner API", "created_date": "2026-11-17T16:24:06Z", "last_changed_date": "2026-11-17T16:24:06Z", "last_accessed_date": null, "deleted_date": null, "rotation_enabled": false, "tags": {"team": "data"}}]

aws_secret describe <config> <secret_id>


Description

    The description of a secret (DescribeSecret, dates in ISO 8601, tags as an object); null when it does not exist

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    secret_id:   The name or the ARN of the secret - String - required
admin
aws_secret describe "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "prod/db"
mentdb
{"ARN": "arn:aws:secretsmanager:eu-west-3:123456789012:secret:prod/db-OUtjyl", "Name": "prod/db", "LastChangedDate": "2026-11-17T16:24:05Z", "LastAccessedDate": null, "NextRotationDate": null, "DeletedDate": null, "CreatedDate": "2026-11-17T16:24:04Z", "KmsKeyId": null, "VersionIdsToStages": {"7573935e-3e8e-44aa-9a75-29c937fc5e9e": ["AWSPREVIOUS"], "374f7cb3-9460-4ca9-8e9e-125ac6d28c7e": ["AWSCURRENT"]}, "SecretVersionsToStages": {"7573935e-3e8e-44aa-9a75-29c937fc5e9e": ["AWSPREVIOUS"], "374f7cb3-9460-4ca9-8e9e-125ac6d28c7e": ["AWSCURRENT"]}}

aws_secret versions <config> <secret_id>


Description

    The versions of a secret as rows {version_id, stages, created_date, last_accessed_date}

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    secret_id:   The name or the ARN of the secret - String - required
admin
aws_secret versions "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "prod/db"
mentdb
[{"version_id": "7573935e-3e8e-44aa-9a75-29c937fc5e9e", "stages": ["AWSPREVIOUS"], "created_date": "2026-11-17T16:24:12Z", "last_accessed_date": "2026-11-17T16:24:12Z"}, {"version_id": "374f7cb3-9460-4ca9-8e9e-125ac6d28c7e", "stages": ["AWSCURRENT"], "created_date": "2026-11-17T16:24:12Z", "last_accessed_date": "2026-11-17T16:24:12Z"}]

aws_secret delete <config> <secret_id>


Description

    Schedule the deletion with a recovery window of 30 days. Returns {arn, name, deletion_date}

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    secret_id:   The name or the ARN of the secret - String - required
admin
aws_secret delete "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "prod/api-key"
mentdb
{"arn": "arn:aws:secretsmanager:eu-west-3:123456789012:secret:prod/api-key-qSeUyJ", "name": "prod/api-key", "deletion_date": "2026-12-17T16:24:12.945Z"}

aws_secret delete <config> <secret_id> <json_params>


Description

    Delete with options: recovery_days (7 to 30) or force (true: no recovery possible)

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    secret_id:   The name or the ARN of the secret - String - required
    json_params:   The options as a JSON object - String - required
admin
aws_secret delete "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "prod/db" "{\"recovery_days\": 7}"
mentdb
{"arn": "arn:aws:secretsmanager:eu-west-3:123456789012:secret:prod/db-OUtjyl", "name": "prod/db", "deletion_date": "2026-11-24T16:24:13.738Z"}

aws_secret restore <config> <secret_id>


Description

    Cancel a scheduled deletion. Returns {arn, name}

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    secret_id:   The name or the ARN of the secret - String - required
admin
aws_secret restore "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "prod/db"
mentdb
{"arn": "arn:aws:secretsmanager:eu-west-3:123456789012:secret:prod/db-OUtjyl", "name": "prod/db"}

aws_secret operation <config> <operation> <json_body>


Description

    Any operation of the Secrets Manager API with its JSON body; returns the raw JSON answer

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    operation:   The operation, like GetRandomPassword or RotateSecret - String - required
    json_body:   The request as JSON - String - required
admin
aws_secret operation "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "GetRandomPassword" "{\"PasswordLength\": 20, \"ExcludePunctuation\": true}"
mentdb
{"RandomPassword": "9ur8SKcyZKWeZvYbunJ5"}

aws_param ping <config>


Description

    Check the credentials and the endpoint of Parameter Store: {ok: true}

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
admin
aws_param ping "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}"
mentdb
{"ok": true}

aws_param put <config> <name> <value>


Description

    Write a parameter, SecureString by default, overwritten when it exists. Returns {version, tier}

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    name:   The name of the parameter, like /prod/app/db_password - String - required
    value:   The value (not empty) - String - required
admin
aws_param put "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "/prod/app/db_password" "Pa55-word!"
mentdb
{"version": 1, "tier": "Standard"}

aws_param put <config> <name> <value> <json_params>


Description

    Write with options: type (String, SecureString or StringList), overwrite (true), description, key_id (KMS), tier, allowed_pattern, tags (only with overwrite false)

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    name:   The name of the parameter, like /prod/app/db_password - String - required
    value:   The value - String - required
    json_params:   The options as a JSON object - String - required
admin
aws_param put "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "/prod/app/db_host" "db1.internal" "{\"type\": \"String\"}"
mentdb
{"version": 1, "tier": "Standard"}

aws_param get <config> <name>


Description

    Read a parameter, decrypted; null when it does not exist

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    name:   The name of the parameter, like /prod/app/db_password - String - required
admin
aws_param get "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "/prod/app/db_password"
mentdb
Pa55-word!

aws_param get <config> <name> <json_params>


Description

    Read with options: decrypt (true), version or label, field (one field of a JSON value)

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    name:   The name of the parameter, like /prod/app/db_password - String - required
    json_params:   The options as a JSON object - String - required
admin
aws_param get "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "/prod/app/db_password" "{\"version\": 1}"
mentdb
Pa55-word!

aws_param list <config> <path>


Description

    The parameters under a path as rows {name, value, type, version, last_modified_date, arn}, recursive and decrypted, 1000 at most

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    path:   The path, like /prod/app - String - required
admin
aws_param list "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "/prod/app"
mentdb
[{"name": "/prod/app/db_password", "value": "Pa55-word!", "type": "SecureString", "version": 1, "last_modified_date": "2026-11-17T16:24:16.830Z", "arn": "arn:aws:ssm:eu-west-3:123456789012:parameter/prod/app/db_password"}, {"name": "/prod/app/db_host", "value": "db1.internal", "type": "String", "version": 1, "last_modified_date": "2026-11-17T16:24:17.610Z", "arn": "arn:aws:ssm:eu-west-3:123456789012:parameter/prod/app/db_host"}]

aws_param list <config> <path> <json_params>


Description

    List with options: recursive (true), decrypt (true), limit (1000, 100000 at most)

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    path:   The path - String - required
    json_params:   The options as a JSON object - String - required
admin
aws_param list "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "/prod/app" "{}"
mentdb
[{"name": "/prod/app/db_password", "value": "Pa55-word!", "type": "SecureString", "version": 1, "last_modified_date": "2026-11-17T16:24:16.830Z", "arn": "arn:aws:ssm:eu-west-3:123456789012:parameter/prod/app/db_password"}, {"name": "/prod/app/db_host", "value": "db1.internal", "type": "String", "version": 1, "last_modified_date": "2026-11-17T16:24:17.610Z", "arn": "arn:aws:ssm:eu-west-3:123456789012:parameter/prod/app/db_host"}]

aws_param delete <config> <name>


Description

    Delete a parameter: {deleted: 1}, or {deleted: 0} when it does not exist

Parameters

    config:   The AWS configuration as JSON: access_key and secret_key (the name of a secret: secret set), session_token (the name of a secret: secret set), region (us-east-1), endpoint (https://secretsmanager..amazonaws.com or https://ssm..amazonaws.com; http only for localhost or with allow_plain), timeout_ms (30000), max_bytes (64 MB). Every secret field of a configuration (password, token, api_key, secret_key, client_secret...) gives the NAME of a secret kept with secret set, never the secret itself: a value that is not the name of a secret the user may use is refused, without being shown. A secret is usable by sys and by the members of the groups given to secret set. - String - required
    name:   The name of the parameter, like /prod/app/db_password - String - required
admin
aws_param delete "{\"access_key\": \"aws_access_key_id\", \"secret_key\": \"aws_secret_access_key\", \"region\": \"eu-west-3\"}" "/prod/app/db_host"
mentdb
{"deleted": 1}