Skip to main content

Build Status

A wrapper around an AWS SSM send-command that can optionally wait for execution success.

Usage

Usage on the tool can be found by executing aws-ssm-invoke -h.

$ aws-ssm-invoke -h
usage: aws-ssm-invoke [-h] [--comment COMMENT]
                      (--instance-ids [INSTANCE_IDS [INSTANCE_IDS ...]] | --tags [TAGS [TAGS ...]])
                      [--wait] [--show-output]
                      command

positional arguments:
  command               The command to execute on all matching EC2 instances

optional xarguments:
  -h, --help            show this help message and exit
  --comment COMMENT
  --instance-ids [INSTANCE_IDS [INSTANCE_IDS ...]]
                        Instance ID's to execute on
  --tags [TAGS [TAGS ...]]
                        Key=Value pairs to execute on
  --wait                When supplied will poll the SSM command until it is
                        complete.
  --show-output         When supplied will show the output from each execution

Examples

Wait

Using the --wait flag polls for command status until complete and shows the state.

$ aws-ssm-invoke uptime --tags Name=database --wait
Executed command 'uptime' - 486a3994-db41-4817-b741-f374cffec294  (Pending)
   - tag:Name = ['database']
 - Pending (Pending) [0 total, 0 complete, 0 error]
 - Success (NoInstancesInTag) [0 total, 0 complete, 0 error]

Show output

Some commands you want to see the output of, to do so specify the --show-output flag.

$ aws-ssm-invoke uptime --tags Name=database --wait --show-output
Executed command 'uptime' - 0b8deb73-2677-47a6-9167-a0889929d542  (Pending)
   - tag:Business:Application = ['ecommerce']
 - Pending (Pending) [0 total, 0 complete, 0 error]
 - Success (Success) [1 total, 1 complete, 0 error]
Command output
 - [Success] i-0ddf60260170be3c7 (ip-172-31-9-100.ap-southeast-2.compute.internal)
 11:01:23 up 2 days,  5:41,  0 users,  load average: 0.00, 0.01, 0.05

Acknowledgements

Release files for aws-ssm-invoke 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aws-ssm-invoke 1.0.0
File Size Uploaded
aws-ssm-invoke-1.0.0.tar.gz 5.7 kB Details

Release files / aws-ssm-invoke-1.0.0.tar.gz

Download URL aws-ssm-invoke-1.0.0.tar.gz
Size 5.7 kB
Tags Source
SHA-256 checksum
How to use checksums
f24ba076eb48797ca513a7e1a598905e5919e194dbd294c0be3c828406b0a333
BLAKE2b-256 checksum
How to use checksums
e07fffcad902eb52194a47424981d93f02c53f159a7ad9e1318a727062fc9f50
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/2.7.10

Release history Release notifications | RSS feed

This release

1.0.0 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page