aws-cli

This package provides a unified command line interface to Amazon WebServices.

Jump to:

• Getting Started
• Getting Help
• More Resources

Getting Started

This README is for the AWS CLI version 1. If you are looking forinformation about the AWS CLI version 2, please visit the v2branch.

Requirements

The aws-cli package works on Python versions:

• 3.6.x and greater
• 3.7.x and greater
• 3.8.x and greater
• 3.9.x and greater
• 3.10.x and greater

On 01/15/2021 deprecation for Python 2.7 was announced and support was droppedon 07/15/2021. To avoid disruption, customers using the AWS CLI on Python 2.7 mayneed to upgrade their version of Python or pin the version of the AWS CLI. Formore information, see this blog post.

On 10/29/2020 support for Python 3.4 and Python 3.5 was deprecated andsupport was dropped on 02/01/2021. Customers using the AWS CLI onPython 3.4 or 3.5 will need to upgrade their version of Python tocontinue receiving feature and security updates. For more information,see this blogpost.

Attention!

We recommend that all customers regularly monitor the Amazon WebServices Security Bulletinswebsite forany 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

Installation of the AWS CLI and its dependencies use a range of packagingfeatures provided by pip and 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 usepip in a virtualenv:

$ 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 thelatest version you can run:

$ python -m pip install --upgrade awscli

This will install the aws-cli package as well as all dependencies.

$ sudo python -m pip install awscli --ignore-installed six

On Linux and Mac OS, the AWS CLI can be installed using a bundledinstaller.The AWS CLI can also be installed on Windows via an MSIInstaller.

If you want to run the develop branch of the AWS CLI, see theDevelopment Version section ofthe contributing guide.

See theinstallationsection of the AWS CLI User Guide for more information.

Configuration

Before using the AWS CLI, you need to configure your AWS credentials.You can do this in several ways:

• Configuration command
• Environment variables
• Shared credentials file
• Config file
• IAM Role

The quickest way to get started is to run the aws configure command:

$ 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 AWS_ACCESS_KEY_ID=<access_key>
$ export AWS_SECRET_ACCESS_KEY=<secret_key>

To use the shared credentials file, create an INI formatted file likethis:

[default]
aws_access_key_id=MYACCESSKEY
aws_secret_access_key=MYSECRETKEY

[testing]
aws_access_key_id=MYACCESKEY
aws_secret_access_key=MYSECRETKEY

and place it in ~/.aws/credentials (or in%UserProfile%\.aws/credentials on Windows). If you wish to place theshared credentials file in a different location than the one specifiedabove, you need to tell aws-cli where to find it. Do this by setting theappropriate environment variable:

$ export AWS_SHARED_CREDENTIALS_FILE=/path/to/shared_credentials_file

To use a config file, create an INI formatted file like this:

[default]
aws_access_key_id=<default access key>
aws_secret_access_key=<default secret key>
# Optional, to define default region for this profile.
region=us-west-1

[profile testing]
aws_access_key_id=<testing access key>
aws_secret_access_key=<testing secret key>
region=us-west-2

and place it in ~/.aws/config (or in %UserProfile%\.aws\configon Windows). If you wish to place the config file in a differentlocation than the one specified above, you need to tell the AWS CLIwhere to find it. Do this by setting the appropriate environmentvariable:

$ export AWS_CONFIG_FILE=/path/to/config_file

As you can see, you can have multiple profiles defined in both theshared credentials file and the configuration file. You can then specifywhich profile to use by using the --profile option. If no profile isspecified the default profile is used.

In the config file, except for the default profile, you must prefixeach config section of a profile group with profile. For example, ifyou have a profile named "testing" the section header would be[profile testing].

The final option for credentials is highly recommended if you are usingthe AWS CLI on an EC2 instance. IAMRolesare a great way to have credentials installed automatically on yourinstance. If you are using IAM Roles, the AWS CLI will find and use themautomatically.

In addition to credentials, a number of other variables can beconfigured either with environment variables, configuration fileentries, or both. See the AWS Tools and SDKs Shared Configuration andCredentials ReferenceGuidefor more information.

For more information about configuration options, please refer to theAWS CLI Configuration Variablestopic.You can access this topic from the AWS CLI as well by runningaws help config-vars.

Basic Commands

An AWS CLI command has the following structure:

$ aws <command> <subcommand> [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 <command> help
$ aws <command> <subcommand> help

To get the version of the AWS CLI:

$ aws --version

To turn on debugging output:

$ aws --debug <command> <subcommand>

You can read more information on the Using the AWSCLIchapter of the AWS CLI User Guide.

Command Completion

The aws-cli package includes a command completion feature for Unix-likesystems. This feature is not automatically installed so you need toconfigure it manually. To learn more, read the AWS CLI Commandcompletiontopic.

Getting Help

The best way to interact with our team is through GitHub. You can openan issue andchoose from one of our templates for guidance, bug reports, or featurerequests.

You may find help from the community on StackOverflow with the tagaws-cli or onthe AWS Discussion Forum forCLI. If youhave a support plan with AWS Support, you can also createa new support case.

Please check for open similarissues before openinganother one.

The AWS CLI implements AWS service APIs. For general issues regardingthe services or their limitations, you may find the Amazon Web ServicesDiscussion Forums helpful.

More Resources

• Changelog
• AWS CLIDocumentation
• AWS CLI UserGuide
• AWS CLI CommandReference
• Amazon Web Services DiscussionForums
• AWS Support