Metadata-Version: 2.1
Name: aws-ssm-tool
Version: 2024.3.14.3.39
Summary: AWS SSM tool
Home-page: https://github.com/Robot-Wranglers/aws-ssm-tool/
Author: Robot-Wranglers
License: MIT
Project-URL: Documentation, https://github.com/Robot-Wranglers/aws-ssm-tool/
Project-URL: Source, https://github.com/Robot-Wranglers/aws-ssm-tool/
Project-URL: Download, https://github.com/Robot-Wranglers/aws-ssm-tool/#files
Platform: any
Classifier: Programming Language :: Python
Requires-Python: >3.7
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Requires-Dist: click
Requires-Dist: pyyaml
Requires-Dist: termcolor
Requires-Dist: coloredlogs
Requires-Dist: boto ==2.49.0
Requires-Dist: boto3 ==1.17.97
Requires-Dist: botocore ==1.20.97
Requires-Dist: rich ==13.3.4
Provides-Extra: dev
Requires-Dist: IPython ; extra == 'dev'
Provides-Extra: lint
Requires-Dist: tox ==4.6.4 ; extra == 'lint'
Provides-Extra: publish
Requires-Dist: twine ==4.0.2 ; extra == 'publish'
Provides-Extra: testing
Requires-Dist: IPython ; extra == 'testing'
Requires-Dist: tox ==4.6.4 ; extra == 'testing'
Requires-Dist: pytest ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'
Requires-Dist: mock ; extra == 'testing'
Requires-Dist: flake8 ==5.0.4 ; extra == 'testing'
Requires-Dist: pynchon ==2024.3.10.15.27 ; extra == 'testing'

<table width=100%>
  <tr>
    <td colspan=2><strong>
    aws-ssm-tool
      </strong>&nbsp;&nbsp;&nbsp;&nbsp;
    </td>
  </tr>
  <tr>
    <td width=15%><img src=https://raw.githubusercontent.com/Robot-Wranglers/aws-ssm-tool/master/img/icon.png style="width:150px"></td>
    <td>
    SSM tool is a small helper for interacting with Amazon Simple Systems Manager, focusing on secrets storage/retrieval.
    <br/><br/>
    <a href=https://pypi.python.org/pypi/aws-ssm-tool/><img src="https://img.shields.io/pypi/l/aws-ssm-tool.svg"></a>
    <a href=https://pypi.python.org/pypi/aws-ssm-tool/><img src="https://badge.fury.io/py/aws-ssm-tool.svg"></a>
    <a href="https://github.com/Robot-Wranglers/aws-ssm-tool/actions/workflows/python-test.yml"><img src="https://github.com/Robot-Wranglers/aws-ssm-tool/actions/workflows/python-test.yml/badge.svg"></a>
    </td>
  </tr>
</table>

---------------------------------------------------------------------------------

<div class="toc">
<ul>
<li><a href="#overview">Overview</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#usage">Usage</a></li>
</ul>
</div>


---------------------------------------------------------------------------------

## Overview

The [AWS SSM Parameter-Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html) is great, but can be awkward to work with via the `awscli` tool.  This project provides the `ssm` tool as an alternative interface with simple CRUD.  It also supports moving or copying trees of multiple parameters, and performing those operations across multiple AWS profiles.

See [setup.cfg](setup.cfg) to find the latest info about required versions of boto.  There are other dependencies, including the popular [click](#) library for CLI support and [rich](#) for pretty output.

See the [Usage section](#usage) for more details.

---------------------------------------------------------------------------------

## Installation

See [pypi](https://pypi.org/project/aws-ssm-tool) for available releases.

```
pip install aws-ssm-tool
```

---------------------------------------------------------------------------------

## Usage

After installation, you can invoke this tool as either `ssm` or `python -m ssm`.

Usage info follows:

Usage info follows:

```bash
$ ssm --help

Usage: ssm [OPTIONS] COMMAND [ARGS]...

  SSM tool, a small helper for interacting with Amazon Simple Systems Manager
  for secrets storage/retrieval.

Options:
  --help  Show this message and exit.

Commands:
  copy       copies a secret from given source to destination
  delete     deletes secret (keeping a local-backup is default)
  get-many   gets many secrets from specified hierarchy/namespace
  list       Lists parameters with prefixes below the given path.
  list-dirs  lists subpaths (i.e.
  move       moves a secret from src to dest
  move-many  moves a whole path of secrets to a new location
  put-many   put many secrets
  read       reads a secret
  stat       reports status, including account details and metadata...
  update     updates secret in given location with new value
  cp         ALIAS for `copy`
  get        ALIAS for `read`
  get-path   ALIAS for `get-many`
  ls         ALIAS for `list`
  ls-dirs    ALIAS for `list-dirs`
  move-path  ALIAS for `move-many`
  mv         ALIAS for `move`
  mv-many    ALIAS for `move-many`
  mv-path    ALIAS for `move-many`
  put        ALIAS for `update`
  put-path   ALIAS for `put-many`
  rm         ALIAS for `delete`
  set        ALIAS for `update`
  st         ALIAS for `stat`
```



See [the integration tests](https://github.com/Robot-Wranglers/aws-ssm-tool/tree/master/tests/integration/test.sh) for more examples.

---------------------------------------------------------------------------------
