Universal Command Line Interface for Amazon Web Services
.. image:: https://github.com/aws/aws-cli/actions/workflows/run-tests.yml/badge.svg :target: https://github.com/aws/aws-cli/actions/workflows/run-tests.yml :alt: Build Status
.. image:: https://badges.gitter.im/aws/aws-cli.svg :target: https://gitter.im/aws/aws-cli :alt: Gitter
This package provides a unified command line interface to Amazon Web Services.
This README is for the AWS CLI version 1. If you are looking for information about the AWS CLI version 2, please visit the
The aws-cli package works on Python versions:
On 01/15/2021 deprecation for Python 2.7 was announced and support will be dropped on 07/15/2021. To avoid disruption, customers using the AWS CLI on Python 2.7 may need to upgrade their version of Python or pin the version of the AWS CLI. For more information, see this
On 10/29/2020 support for Python 3.4 and Python 3.5 was deprecated and support was dropped on 02/01/2021. Customers using the AWS CLI on Python 3.4 or 3.5 will need to upgrade their version of Python to continue receiving feature and security updates. For more information, see this
We recommend that all customers regularly monitor the
Amazon Web Services Security Bulletins website__ for any important security bulletins related to aws-cli.
Maintenance and Support for CLI Major Versions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The AWS CLI version 1 was made generally available on 09/02/2013 and is currently in the full support phase of the availability life cycle.
For information about maintenance and support for SDK major versions and their underlying dependencies, see the
Maintenance Policy__ section in the AWS SDKs and Tools Shared Configuration and Credentials Reference Guide.
Installation of the AWS CLI and its dependencies use a range of packaging features provided by
setuptools. To ensure smooth installation, it's recommended to use:
pip: 9.0.2 or greater
setuptools: 36.2.0 or greater
The safest way to install the AWS CLI is to use
pip__ in a
$ python -m pip install awscli
or, if you are not installing in a
virtualenv, to install globally:
$ sudo python -m pip install awscli
or for your user:
$ python -m pip install --user awscli
If you have the aws-cli package installed and want to upgrade to the latest version you can run:
$ python -m pip install --upgrade awscli
This will install the aws-cli package as well as all dependencies.
.. note:: On macOS, if you see an error regarding the version of
sixthat came with
distutilsin El Capitan, use the
$ sudo python -m pip install awscli --ignore-installed six
On Linux and Mac OS, the AWS CLI can be installed using a
bundled installer. The AWS CLI can also be installed on Windows via an
If you want to run the
developbranch of the AWS CLI, see the
Development Version__ section of the contributing guide.
installation__ section of the AWS CLI User Guide for more information.
Before using the AWS CLI, you need to configure your AWS credentials. You can do this in several ways:
The quickest way to get started is to run the
$ aws configure AWS Access Key ID: MYACCESSKEY AWS Secret Access Key: MYSECRETKEY Default region name [us-west-2]: us-west-2 Default output format [None]: json
To use environment variables, do the following:
$ export AWSACCESSKEYID=<accesskey> $ export AWSSECRETACCESSKEY=<secretkey>
To use the shared credentials file, create an INI formatted file like this:
[default] awsaccesskeyid=MYACCESSKEY awssecretaccesskey=MYSECRETKEY
[testing] awsaccesskeyid=MYACCESKEY awssecretaccesskey=MYSECRETKEY
and place it in
%UserProfile%\.aws/credentialson Windows). If you wish to place the shared credentials file in a different location than the one specified above, you need to tell aws-cli where to find it. Do this by setting the appropriate environment variable:
$ export AWSSHAREDCREDENTIALSFILE=/path/to/sharedcredentials_file
To use a config file, create an INI formatted file like this:
[default] awsaccesskeyid= awssecretaccesskey= # Optional, to define default region for this profile. region=us-west-1
[profile testing] awsaccesskeyid= awssecretaccesskey= region=us-west-2
and place it in
%UserProfile%\.aws\configon Windows). If you wish to place the config file in a different location than the one specified above, you need to tell the AWS CLI where to find it. Do this by setting the appropriate environment variable:
$ export AWSCONFIGFILE=/path/to/config_file
As you can see, you can have multiple
profilesdefined in both the shared credentials file and the configuration file. You can then specify which profile to use by using the
--profileoption. If no profile is specified the
defaultprofile is used.
In the config file, except for the default profile, you must prefix each config section of a profile group with
profile. For example, if you have a profile named "testing" the section header would be
The final option for credentials is highly recommended if you are using the AWS CLI on an EC2 instance.
IAM Roles__ are a great way to have credentials installed automatically on your instance. If you are using IAM Roles, the AWS CLI will find and use them automatically.
In addition to credentials, a number of other variables can be configured either with environment variables, configuration file entries, or both. See the
AWS Tools and SDKs Shared Configuration and Credentials Reference Guide__ for more information.
For more information about configuration options, please refer to the
AWS CLI Configuration Variables topic__. You can access this topic from the AWS CLI as well by running
aws help config-vars.
Basic Commands ~~~~~~~~~~~~~~
An AWS CLI command has the following structure:
$ aws [options and parameters]
For example, to list S3 buckets, the command would be:
$ aws s3 ls
To view help documentation, use one of the following:
$ aws help $ aws help $ aws help
To get the version of the AWS CLI:
$ aws --version
To turn on debugging output:
$ aws --debug
You can read more information on the
Using the AWS CLI__ chapter of the AWS CLI User Guide.
Command Completion ~~~~~~~~~~~~~~~~~~
The aws-cli package includes a command completion feature for Unix-like systems. This feature is not automatically installed so you need to configure it manually. To learn more, read the
AWS CLI Command completion topic__.
The best way to interact with our team is through GitHub. You can
open an issue__ and choose from one of our templates for guidance, bug reports, or feature requests.
You may find help from the community on
Stack Overflow__ with the tag
aws-cli__ or on the
AWS Discussion Forum for CLI. If you have a support plan with
AWS Support, you can also create a new support case.
Please check for open similar
issues__ before opening another one.
The AWS CLI implements AWS service APIs. For general issues regarding the services or their limitations, you may find the
Amazon Web Services Discussion Forums__ helpful.
AWS CLI Documentation__
AWS CLI User Guide__
AWS CLI Command Reference__
Amazon Web Services Discussion Forums__
.. |Build Status| image:: https://travis-ci.org/aws/aws-cli.svg?branch=develop :target: https://travis-ci.org/aws/aws-cli .. |Gitter| image:: https://badges.gitter.im/aws/aws-cli.svg :target: https://gitter.im/aws/aws-cli