Metadata-Version: 1.1
Name: aws-ssm-invoke
Version: 1.0.0
Summary: A wrapper around an AWS SSM send-command that can optionally wait for execution success.
Home-page: https://github.com/stevemac007/aws-ssm-cli-invoke
Author: Steve Mactaggart
Author-email: steve@whitesquaresoft.com
License: MIT
Download-URL: https://github.com/stevemac007/aws-ssm-cli-invoke/archive/1.0.0.tar.gz
Description: aws-ssm-cli-invoke
        ==================
        
        |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.
        
        .. code:: bash
        
           $ 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.
        
        .. code:: bash
        
           $ 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
        ~~~~~~~~~~~~~~~~
        
        -  Project Bootstrapped from
           https://github.com/obi1kenobi/python-bootstrap
        
        .. |Build Status| image:: https://travis-ci.org/stevemac007/aws-ssm-cli-invoke.svg?branch=master
           :target: https://travis-ci.org/stevemac007/aws-ssm-cli-invoke
Keywords: aws ssm generation
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Operating System :: POSIX :: Linux
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
