{ "info": { "author": "Amazon Web Services", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "Intended Audience :: System Administrators", "License :: OSI Approved :: Apache Software License", "Natural Language :: English", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "=======\naws-cli\n=======\n\n.. image:: https://travis-ci.org/aws/aws-cli.svg?branch=develop\n :target: https://travis-ci.org/aws/aws-cli\n :alt: Build Status\n\n.. image:: https://badges.gitter.im/aws/aws-cli.svg\n :target: https://gitter.im/aws/aws-cli\n :alt: Gitter\n\n\nThis package provides a unified command line interface to Amazon Web Services.\n\nThe aws-cli package works on Python versions:\n\n* 2.6.5 and greater\n* 2.7.x and greater\n* 3.3.x and greater\n* 3.4.x and greater\n* 3.5.x and greater\n* 3.6.x and greater\n* 3.7.x and greater\n\n.. attention::\n We recommend that all customers regularly monitor the\n `Amazon Web Services Security Bulletins website`_ for any important security bulletins related to\n aws-cli.\n\n\n------------\nInstallation\n------------\n\nThe easiest way to install aws-cli is to use `pip`_ in a ``virtualenv``::\n\n $ pip install awscli\n\nor, if you are not installing in a ``virtualenv``, to install globally::\n\n $ sudo pip install awscli\n\nor for your user::\n\n $ pip install --user awscli\n\nIf you have the aws-cli installed and want to upgrade to the latest version\nyou can run::\n\n $ pip install --upgrade awscli\n\n.. note::\n\n On OS X, if you see an error regarding the version of six that came with\n distutils in El Capitan, use the ``--ignore-installed`` option::\n\n $ sudo pip install awscli --ignore-installed six\n\n\nThis will install the aws-cli package as well as all dependencies. You can\nalso just `download the tarball`_. Once you have the\nawscli directory structure on your workstation, you can just run::\n\n $ cd \n $ python setup.py install\n\nIf you want to run the ``develop`` branch of the CLI, see the\n\"CLI Dev Version\" section below.\n\n\n------------\nCLI Releases\n------------\n\nThe release notes for the AWS CLI can be found `here `__.\n\n\n------------------\nCommand Completion\n------------------\n\nThe aws-cli package includes a very useful command completion feature.\nThis feature is not automatically installed so you need to configure it manually.\nTo enable tab completion for bash either use the built-in command ``complete``::\n\n $ complete -C aws_completer aws\n\nOr add ``bin/aws_bash_completer`` file under ``/etc/bash_completion.d``,\n``/usr/local/etc/bash_completion.d`` or any other ``bash_completion.d`` location.\n\nFor tcsh::\n\n $ complete aws 'p/*/`aws_completer`/'\n\nYou should add this to your startup scripts to enable it for future sessions.\n\nFor zsh please refer to ``bin/aws_zsh_completer.sh``. Source that file, e.g.\nfrom your ``~/.zshrc``, and make sure you run ``compinit`` before::\n\n $ source bin/aws_zsh_completer.sh\n\nFor now the bash compatibility auto completion (``bashcompinit``) is used.\nFor further details please refer to the top of ``bin/aws_zsh_completer.sh``.\n\n---------------\nGetting Started\n---------------\n\nBefore using aws-cli, you need to tell it about your AWS credentials. You\ncan do this in several ways:\n\n* Environment variables\n* Shared credentials file\n* Config file\n* IAM Role\n\nThe quickest way to get started is to run the ``aws configure`` command::\n\n $ aws configure\n AWS Access Key ID: foo\n AWS Secret Access Key: bar\n Default region name [us-west-2]: us-west-2\n Default output format [None]: json\n\nTo use environment variables, do the following::\n\n $ export AWS_ACCESS_KEY_ID=\n $ export AWS_SECRET_ACCESS_KEY=\n\nTo use the shared credentials file, create an INI formatted file like this::\n\n [default]\n aws_access_key_id=foo\n aws_secret_access_key=bar\n\n [testing]\n aws_access_key_id=foo\n aws_secret_access_key=bar\n\nand place it in ``~/.aws/credentials`` (or in\n``%UserProfile%\\.aws/credentials`` on Windows). If you wish to place the\nshared credentials file in a different location than the one specified above,\nyou need to tell aws-cli where to find it. Do this by setting\nthe appropriate environment variable::\n\n $ export AWS_SHARED_CREDENTIALS_FILE=/path/to/shared_credentials_file\n\nTo use a config file, create a configuration file like this::\n\n [default]\n aws_access_key_id=\n aws_secret_access_key=\n # Optional, to define default region for this profile.\n region=us-west-1\n\n [profile testing]\n aws_access_key_id=\n aws_secret_access_key=\n region=us-west-2\n\nand place it in ``~/.aws/config`` (or in ``%UserProfile%\\.aws\\config`` on Windows). If you wish to place the config file in a different location than the one\nspecified above, you need to tell aws-cli where to find it. Do this by setting\nthe appropriate environment variable::\n\n $ export AWS_CONFIG_FILE=/path/to/config_file\n\nAs you can see, you can have multiple ``profiles`` defined in both the shared\ncredentials file and the configuration file. You can then specify which\nprofile to use by using the ``--profile`` option. If no profile is specified\nthe ``default`` profile is used.\n\nIn the config file, except for the default profile, you\n**must** prefix each config section of a profile group with ``profile``.\nFor example, if you have a profile named \"testing\" the section header would\nbe ``[profile testing]``.\n\nThe final option for credentials is highly recommended if you are\nusing aws-cli on an EC2 instance. IAM Roles are\na great way to have credentials installed automatically on your\ninstance. If you are using IAM Roles, aws-cli will find them and use\nthem automatically.\n\n----------------------------\nOther Configurable Variables\n----------------------------\n\nIn addition to credentials, a number of other variables can be\nconfigured either with environment variables, configuration file\nentries or both. The following table documents these.\n\n============================= =========== ============================= ================================= ==================================\nVariable Option Config Entry Environment Variable Description\n============================= =========== ============================= ================================= ==================================\nprofile --profile profile AWS_PROFILE Default profile name\n----------------------------- ----------- ----------------------------- --------------------------------- ----------------------------------\nregion --region region AWS_DEFAULT_REGION Default AWS Region\n----------------------------- ----------- ----------------------------- --------------------------------- ----------------------------------\nconfig_file AWS_CONFIG_FILE Alternate location of config\n----------------------------- ----------- ----------------------------- --------------------------------- ----------------------------------\ncredentials_file AWS_SHARED_CREDENTIALS_FILE Alternate location of credentials\n----------------------------- ----------- ----------------------------- --------------------------------- ----------------------------------\noutput --output output AWS_DEFAULT_OUTPUT Default output style\n----------------------------- ----------- ----------------------------- --------------------------------- ----------------------------------\nca_bundle --ca-bundle ca_bundle AWS_CA_BUNDLE CA Certificate Bundle\n----------------------------- ----------- ----------------------------- --------------------------------- ----------------------------------\naccess_key aws_access_key_id AWS_ACCESS_KEY_ID AWS Access Key\n----------------------------- ----------- ----------------------------- --------------------------------- ----------------------------------\nsecret_key aws_secret_access_key AWS_SECRET_ACCESS_KEY AWS Secret Key\n----------------------------- ----------- ----------------------------- --------------------------------- ----------------------------------\ntoken aws_session_token AWS_SESSION_TOKEN AWS Token (temp credentials)\n----------------------------- ----------- ----------------------------- --------------------------------- ----------------------------------\ncli_timestamp_format cli_timestamp_format Output format of timestamps\n----------------------------- ----------- ----------------------------- --------------------------------- ----------------------------------\nmetadata_service_timeout metadata_service_timeout AWS_METADATA_SERVICE_TIMEOUT EC2 metadata timeout\n----------------------------- ----------- ----------------------------- --------------------------------- ----------------------------------\nmetadata_service_num_attempts metadata_service_num_attempts AWS_METADATA_SERVICE_NUM_ATTEMPTS EC2 metadata retry count\n----------------------------- ----------- ----------------------------- --------------------------------- ----------------------------------\nparameter_validation parameter_validation Toggles local parameter validation\n============================= =========== ============================= ================================= ==================================\n\n^^^^^^^^\nExamples\n^^^^^^^^\n\nIf you get tired of specifying a ``--region`` option on the command line\nall of the time, you can specify a default region to use whenever no\nexplicit ``--region`` option is included using the ``region`` variable.\nTo specify this using an environment variable::\n\n $ export AWS_DEFAULT_REGION=us-west-2\n\nTo include it in your config file::\n\n [default]\n aws_access_key_id=\n aws_secret_access_key=\n region=us-west-1\n\nSimilarly, the ``profile`` variable can be used to specify which profile to use\nif one is not explicitly specified on the command line via the\n``--profile`` option. To set this via environment variable::\n\n $ export AWS_PROFILE=testing\n\nThe ``profile`` variable can not be specified in the configuration file\nsince it would have to be associated with a profile and would defeat the\npurpose.\n\n^^^^^^^^^^^^^^^^^^^\nFurther Information\n^^^^^^^^^^^^^^^^^^^\n\nFor more information about configuration options, please refer the\n`AWS CLI Configuration Variables topic `_. You can access this topic\nfrom the CLI as well by running ``aws help config-vars``.\n\n\n----------------------------------------\nAccessing Services With Global Endpoints\n----------------------------------------\n\nSome services, such as *AWS Identity and Access Management* (IAM)\nhave a single, global endpoint rather than different endpoints for\neach region.\n\nTo make access to these services simpler, aws-cli will automatically\nuse the global endpoint unless you explicitly supply a region (using\nthe ``--region`` option) or a profile (using the ``--profile`` option).\nTherefore, the following::\n\n $ aws iam list-users\n\nwill automatically use the global endpoint for the IAM service\nregardless of the value of the ``AWS_DEFAULT_REGION`` environment\nvariable or the ``region`` variable specified in your profile.\n\n--------------------\nJSON Parameter Input\n--------------------\n\nMany options that need to be provided are simple string or numeric\nvalues. However, some operations require JSON data structures\nas input parameters either on the command line or in files.\n\nFor example, consider the command to authorize access to an EC2\nsecurity group. In this case, we will add ingress access to port 22\nfor all IP addresses::\n\n $ aws ec2 authorize-security-group-ingress --group-name MySecurityGroup \\\n --ip-permissions '{\"FromPort\":22,\"ToPort\":22,\"IpProtocol\":\"tcp\",\"IpRanges\":[{\"CidrIp\": \"0.0.0.0/0\"}]}'\n\n--------------------------\nFile-based Parameter Input\n--------------------------\n\nSome parameter values are so large or so complex that it would be easier\nto place the parameter value in a file and refer to that file rather than\nentering the value directly on the command line.\n\nLet's use the ``authorize-security-group-ingress`` command shown above.\nRather than provide the value of the ``--ip-permissions`` parameter directly\nin the command, you could first store the values in a file. Let's call\nthe file ``ip_perms.json``::\n\n {\"FromPort\":22,\n \"ToPort\":22,\n \"IpProtocol\":\"tcp\",\n \"IpRanges\":[{\"CidrIp\":\"0.0.0.0/0\"}]}\n\nThen, we could make the same call as above like this::\n\n $ aws ec2 authorize-security-group-ingress --group-name MySecurityGroup \\\n --ip-permissions file://ip_perms.json\n\nThe ``file://`` prefix on the parameter value signals that the parameter value\nis actually a reference to a file that contains the actual parameter value.\naws-cli will open the file, read the value and use that value as the\nparameter value.\n\nThis is also useful when the parameter is really referring to file-based\ndata. For example, the ``--user-data`` option of the ``aws ec2 run-instances``\ncommand or the ``--public-key-material`` parameter of the\n``aws ec2 import-key-pair`` command.\n\n-------------------------\nURI-based Parameter Input\n-------------------------\n\nSimilar to the file-based input described above, aws-cli also includes a\nway to use data from a URI as the value of a parameter. The idea is exactly\nthe same except the prefix used is ``https://`` or ``http://``::\n\n $ aws ec2 authorize-security-group-ingress --group-name MySecurityGroup \\\n --ip-permissions http://mybucket.s3.amazonaws.com/ip_perms.json\n\n--------------\nCommand Output\n--------------\n\nThe default output for commands is currently JSON. You can use the\n``--query`` option to extract the output elements from this JSON document.\nFor more information on the expression language used for the ``--query``\nargument, you can read the\n`JMESPath Tutorial `__.\n\n^^^^^^^^\nExamples\n^^^^^^^^\n\nGet a list of IAM user names::\n\n $ aws iam list-users --query Users[].UserName\n\nGet a list of key names and their sizes in an S3 bucket::\n\n $ aws s3api list-objects --bucket b --query Contents[].[Key,Size]\n\nGet a list of all EC2 instances and include their Instance ID, State Name,\nand their Name (if they've been tagged with a Name)::\n\n $ aws ec2 describe-instances --query \\\n 'Reservations[].Instances[].[InstanceId,State.Name,Tags[?Key==`Name`] | [0].Value]'\n\n\nYou may also find the `jq `_ tool useful in\nprocessing the JSON output for other uses.\n\nThere is also an ASCII table format available. You can select this style with\nthe ``--output table`` option or you can make this style your default output\nstyle via environment variable or config file entry as described above.\nTry adding ``--output table`` to the above commands.\n\n\n---------------\nCLI Dev Version\n---------------\n\nIf you are just interested in using the latest released version of the AWS CLI,\nplease see the Installation_ section above. This section is for anyone who\nwants to install the development version of the CLI. You normally would not\nneed to do this unless:\n\n* You are developing a feature for the CLI and plan on submitting a Pull\n Request.\n* You want to test the latest changes of the CLI before they make it into an\n official release.\n\nThe latest changes to the CLI are in the ``develop`` branch on github. This is\nthe default branch when you clone the git repository.\n\nAdditionally, there are several other packages that are developed in lockstep\nwith the CLI. This includes:\n\n* `botocore `__\n* `jmespath `__\n\nIf you just want to install a snapshot of the latest development version of\nthe CLI, you can use the ``requirements.txt`` file included in this repo.\nThis file points to the development version of the above packages::\n\n cd \n pip install -r requirements.txt\n pip install -e .\n\nHowever, to keep up to date, you will continually have to run the\n``pip install -r requirements.txt`` file to pull in the latest changes\nfrom the develop branches of botocore, jmespath, etc.\n\nYou can optionally clone each of those repositories and run \"pip install -e .\"\nfor each repository::\n\n git clone && cd jmespath/\n pip install -e . && cd ..\n git clone && cd botocore/\n pip install -e . && cd ..\n git clone && cd aws-cli/\n pip install -e .\n\n\n------------\nGetting Help\n------------\n\nWe use GitHub issues for tracking bugs and feature requests and have limited\nbandwidth to address them. Please use these community resources for getting\nhelp:\n\n* Ask a question on `Stack Overflow `__ and tag it with `aws-cli `__\n* Come join the AWS CLI community chat on `gitter `__\n* Open a support ticket with `AWS Support `__\n* If it turns out that you may have found a bug, please `open an issue `__\n\n\n\n.. _`Amazon Web Services Security Bulletins website`: https://aws.amazon.com/security/security-bulletins\n.. _pip: http://www.pip-installer.org/en/latest/\n.. _`download the tarball`: https://pypi.org/project/awscli/\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://aws.amazon.com/cli/", "keywords": "", "license": "Apache License 2.0", "maintainer": "", "maintainer_email": "", "name": "awscli42", "package_url": "https://pypi.org/project/awscli42/", "platform": "", "project_url": "https://pypi.org/project/awscli42/", "project_urls": { "Homepage": "http://aws.amazon.com/cli/" }, "release_url": "https://pypi.org/project/awscli42/1.16.135.3/", "requires_dist": [ "botocore (>=1.12.125)", "colorama (<=0.3.9,>=0.2.5)", "docutils (>=0.10)", "rsa (<=3.5.0,>=3.1.2)", "s3transfer (<0.3.0,>=0.2.0)", "PyYAML (>=4.2b1)", "argparse (>=1.1) ; python_version==\"2.6\"" ], "requires_python": "", "summary": "Universal Command Line Environment for AWS.", "version": "1.16.135.3" }, "last_serial": 5082152, "releases": { "1.16.135": [ { "comment_text": "", "digests": { "md5": "076a15327e35e2db080dfcf723aa127b", "sha256": "7efc81f568dc09cc21cec072a341ef6089a779c6cd0149c57cec72b684a0bd6f" }, "downloads": -1, "filename": "awscli42-1.16.135-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "076a15327e35e2db080dfcf723aa127b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 1476170, "upload_time": "2019-04-01T04:58:55", "url": "https://files.pythonhosted.org/packages/76/5c/3a070169271e0e66b80336c339502012083e09ba35c86c29ef5a0b88e867/awscli42-1.16.135-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "81786a509418782842a40c4940dc8991", "sha256": "6dfe395e00205c3b324c0a52e31ddc572392c6e0ef6103cb75702d943d4c7d38" }, "downloads": -1, "filename": "awscli42-1.16.135.tar.gz", "has_sig": false, "md5_digest": "81786a509418782842a40c4940dc8991", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 679983, "upload_time": "2019-04-01T04:58:58", "url": "https://files.pythonhosted.org/packages/d1/06/30f17547c7fec11c7122fcbdf8c9bfe260b98a4b0e7c12c5398799b523e5/awscli42-1.16.135.tar.gz" } ], "1.16.135.1": [ { "comment_text": "", "digests": { "md5": "843e0271664f862b9379dc5adc21a088", "sha256": "459e260b64c7c8c48a8563c96fb9fe9e6c5d7cf6b0dcce40178ba9f507e7d21c" }, "downloads": -1, "filename": "awscli42-1.16.135.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "843e0271664f862b9379dc5adc21a088", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 1476219, "upload_time": "2019-04-03T04:06:28", "url": "https://files.pythonhosted.org/packages/00/a8/1ac7904807ecaa758a940bef151ac7c78182b0093b02912274a4cc617877/awscli42-1.16.135.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "29718ed92b5bf4b393b3997120ea68ed", "sha256": "3c9e962222d5f4e43da9ae69f847696baf16f5ddc18b7fa9c12675eb5698f51c" }, "downloads": -1, "filename": "awscli42-1.16.135.1.tar.gz", "has_sig": false, "md5_digest": "29718ed92b5bf4b393b3997120ea68ed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 679865, "upload_time": "2019-04-03T04:06:30", "url": "https://files.pythonhosted.org/packages/59/0b/f19087b3c495bf086316bb6337922da13eb4fa3215f40e97d385dc9c357e/awscli42-1.16.135.1.tar.gz" } ], "1.16.135.2": [ { "comment_text": "", "digests": { "md5": "a06839645699cb9cc30483f0dce75565", "sha256": "00bb7bed84e32655bf7ba07ab83a18f4ac4de3c81b0ab29366176684fab9f94c" }, "downloads": -1, "filename": "awscli42-1.16.135.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a06839645699cb9cc30483f0dce75565", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 1476215, "upload_time": "2019-04-03T04:16:35", "url": "https://files.pythonhosted.org/packages/16/74/7943545333ec5dcd33fe9732d70aeb3bb819dcadfe8c0a60d67c712634aa/awscli42-1.16.135.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "082acf9c488593358ba33011e382d8e4", "sha256": "7a19c3fb92e5e8c08afad302a8c266aeb963f2c46600cc448e4a6b59296d264f" }, "downloads": -1, "filename": "awscli42-1.16.135.2.tar.gz", "has_sig": false, "md5_digest": "082acf9c488593358ba33011e382d8e4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 679847, "upload_time": "2019-04-03T04:16:37", "url": "https://files.pythonhosted.org/packages/de/40/9621548b4a943ff8fc95aba8a3dc5cd8ad57520463d15830fcb567c8be67/awscli42-1.16.135.2.tar.gz" } ], "1.16.135.3": [ { "comment_text": "", "digests": { "md5": "7d3c7cef611a28d72cb06d0091afdb62", "sha256": "036d7ee1912b610a015320fe3444dddf2db3c990ea744f69cae8cef90ede40e4" }, "downloads": -1, "filename": "awscli42-1.16.135.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "7d3c7cef611a28d72cb06d0091afdb62", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 1476218, "upload_time": "2019-04-03T04:20:44", "url": "https://files.pythonhosted.org/packages/15/7e/b1feb1d7166fa19df68451c7b8720837449e195508e023f0a609ffe9a79e/awscli42-1.16.135.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c56c71e1795dacf1d135703748868749", "sha256": "865d5935d58470e53a64be8a04ee8a679eeb5eca7ea37fa92fbbbf6e5a487c41" }, "downloads": -1, "filename": "awscli42-1.16.135.3.tar.gz", "has_sig": false, "md5_digest": "c56c71e1795dacf1d135703748868749", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 679922, "upload_time": "2019-04-03T04:20:46", "url": "https://files.pythonhosted.org/packages/00/f0/1ed4957fa313eae1b867018a2cdd6620d281a084c60b5d163d6c7e73f505/awscli42-1.16.135.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7d3c7cef611a28d72cb06d0091afdb62", "sha256": "036d7ee1912b610a015320fe3444dddf2db3c990ea744f69cae8cef90ede40e4" }, "downloads": -1, "filename": "awscli42-1.16.135.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "7d3c7cef611a28d72cb06d0091afdb62", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 1476218, "upload_time": "2019-04-03T04:20:44", "url": "https://files.pythonhosted.org/packages/15/7e/b1feb1d7166fa19df68451c7b8720837449e195508e023f0a609ffe9a79e/awscli42-1.16.135.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c56c71e1795dacf1d135703748868749", "sha256": "865d5935d58470e53a64be8a04ee8a679eeb5eca7ea37fa92fbbbf6e5a487c41" }, "downloads": -1, "filename": "awscli42-1.16.135.3.tar.gz", "has_sig": false, "md5_digest": "c56c71e1795dacf1d135703748868749", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 679922, "upload_time": "2019-04-03T04:20:46", "url": "https://files.pythonhosted.org/packages/00/f0/1ed4957fa313eae1b867018a2cdd6620d281a084c60b5d163d6c7e73f505/awscli42-1.16.135.3.tar.gz" } ] }