Skip to main content

Universal Command Line Environment for AWS.

Project description

aws-cli
=======

This package provides a unified command line interface to many
Amazon Web Services.

The currently supported services include:

* Amazon Elastic Compute Cloud (Amazon EC2) including VPC
* Elastic Load Balancing
* Auto Scaling
* AWS CloudFormation
* AWS Elastic Beanstalk
* Amazon Simple Notification Service (Amazon SNS)
* Amazon Simple Queue Service (Amazon SQS)
* Amazon Relational Database Service (Amazon RDS)
* AWS Identity and Access Management (IAM)
* AWS Security Token Service (STS)
* Amazon CloudWatch
* Amazon Simple Email Service (Amazon SES)

The aws-cli package should work on Python versions 2.6.x - 3.3.x.

Installation
------------
The easiest way to install aws-cli is to use ``easy_install`` or ``pip``.

$ easy_install awscli

or, if you are not installing in a ``virtualenv``:

$ sudo easy_install awscli

Using ``pip``, it would simply be:

$ pip install awscli

or:

$ sudo pip install awscli

This will install the aws-cli package as well as all dependencies. You can
also just clone the git repo or download the tarball. Once you have the
awscli directory structure on your workstation, you can just:

$ cd <path_to_awscli>
$ python setup.py install

Command Completion
------------------
The aws-cli package includes a very useful command completion feature.
This feature is not automatically installed so you need to configure it manually.
To enable tab completion for bash use the built-in command ``complete``.

$ complete -C aws_completer aws

For tcsh:

$ complete aws 'p/*/`aws_completer`/'

You should add this to your startup scripts to enable it for future sessions.

Getting Started
---------------
Before using aws-cli, you need to tell it about your AWS credentials. You
can do this in several ways:

* Environment variables
* Config file
* IAM Role

To use environment variables, do the following:

$ export AWS_ACCESS_KEY_ID=<access_key>
$ export AWS_SECRET_ACCESS_KEY=<secret_key>

To use a config file, create a configuration file like this:

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

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

As you can see, you can have multiple ``profiles`` defined in this
configuration file and specify which profile to use by using the
``--profile`` option. If no profile is specified the ``default``
profile is used. Once you have created the config file, you need to
tell aws-cli where to find it. Do this by setting the appropriate
environment variable.

$ export AWS_CONFIG_FILE=/path/to/config_file

The final option for credentials is highly recommended if you are
using 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, aws-cli will find them and use
them automatically.

Other Important Environment Variables
-------------------------------------
The following additional environment variables can be useful in
configuring and customizing your environment.

AWS_DEFAULT_REGION can be used to specify a default region to use
if one is not provided explicitly on the command line with the
``--region`` option or in a config file.

$ export AWS_DEFAULT_REGION=us-west-2

AWS_DEFAULT_PROFILE can be used to specify which profile to use
if one is not explicitly specified on the command line via the
``--profile`` option.

$ export AWS_DEFAULT_PROFILE=testing

Complex Parameter Input
-----------------------
Many options that need to be provided are simple string or numeric
values. However, some operations require complex data structures
as input parameters. These options must be provided as JSON data
structures, either on the command line or in files.

For example, consider the command to authorize access to an EC2
security group. In this case, we will add ingress access to port 22
for all IP addresses.

$ aws ec2 authorize-security-group-ingress --group-name MySecurityGroup --ip-permissions '{"from_port":22,"to_port":22,"ip_protocol":"tcp","ip_ranges":["0.0.0.0/0"]}'

You could also place the JSON in a file, called port22.json for example,
and use this:

$ aws ec2 authorize-security-group-ingress --group-name MySecurityGroup --ip-permissions /path/to/port22.json

Command Output
==============

The default output for commands is currently JSON. This may change in the
future but for now it provides the most complete output. You may find the
[jq](http://stedolan.github.com/jq/) tool useful in processing the JSON
output for other uses.

Project details


Release history Release notifications

History Node

1.15.28

History Node

1.15.27

History Node

1.15.26

History Node

1.15.25

History Node

1.15.24

History Node

1.15.23

History Node

1.15.22

History Node

1.15.21

History Node

1.15.20

History Node

1.15.19

History Node

1.15.18

History Node

1.15.17

History Node

1.15.16

History Node

1.15.15

History Node

1.15.14

History Node

1.15.13

History Node

1.15.12

History Node

1.15.11

History Node

1.15.10

History Node

1.15.9

History Node

1.15.8

History Node

1.15.7

History Node

1.15.6

History Node

1.15.5

History Node

1.15.4

History Node

1.15.3

History Node

1.15.2

History Node

1.15.1

History Node

1.15.0

History Node

1.14.70

History Node

1.14.69

History Node

1.14.68

History Node

1.14.67

History Node

1.14.66

History Node

1.14.65

History Node

1.14.64

History Node

1.14.63

History Node

1.14.62

History Node

1.14.61

History Node

1.14.60

History Node

1.14.59

History Node

1.14.58

History Node

1.14.57

History Node

1.14.56

History Node

1.14.55

History Node

1.14.54

History Node

1.14.53

History Node

1.14.52

History Node

1.14.51

History Node

1.14.50

History Node

1.14.49

History Node

1.14.48

History Node

1.14.47

History Node

1.14.46

History Node

1.14.45

History Node

1.14.44

History Node

1.14.43

History Node

1.14.42

History Node

1.14.41

History Node

1.14.40

History Node

1.14.39

History Node

1.14.38

History Node

1.14.37

History Node

1.14.36

History Node

1.14.35

History Node

1.14.34

History Node

1.14.33

History Node

1.14.32

History Node

1.14.31

History Node

1.14.30

History Node

1.14.29

History Node

1.14.28

History Node

1.14.27

History Node

1.14.26

History Node

1.14.25

History Node

1.14.24

History Node

1.14.23

History Node

1.14.22

History Node

1.14.21

History Node

1.14.20

History Node

1.14.19

History Node

1.14.18

History Node

1.14.17

History Node

1.14.16

History Node

1.14.15

History Node

1.14.14

History Node

1.14.13

History Node

1.14.12

History Node

1.14.11

History Node

1.14.10

History Node

1.14.9

History Node

1.14.8

History Node

1.14.7

History Node

1.14.6

History Node

1.14.5

History Node

1.14.4

History Node

1.14.3

History Node

1.14.2

History Node

1.14.1

History Node

1.14.0

History Node

1.13.0

History Node

1.12.2

History Node

1.12.1

History Node

1.12.0

History Node

1.11.190

History Node

1.11.189

History Node

1.11.188

History Node

1.11.187

History Node

1.11.186

History Node

1.11.185

History Node

1.11.184

History Node

1.11.183

History Node

1.11.182

History Node

1.11.181

History Node

1.11.180

History Node

1.11.179

History Node

1.11.178

History Node

1.11.177

History Node

1.11.176

History Node

1.11.175

History Node

1.11.174

History Node

1.11.173

History Node

1.11.172

History Node

1.11.171

History Node

1.11.170

History Node

1.11.169

History Node

1.11.168

History Node

1.11.167

History Node

1.11.166

History Node

1.11.165

History Node

1.11.164

History Node

1.11.163

History Node

1.11.162

History Node

1.11.161

History Node

1.11.160

History Node

1.11.159

History Node

1.11.158

History Node

1.11.157

History Node

1.11.156

History Node

1.11.155

History Node

1.11.154

History Node

1.11.153

History Node

1.11.152

History Node

1.11.151

History Node

1.11.150

History Node

1.11.149

History Node

1.11.148

History Node

1.11.147

History Node

1.11.146

History Node

1.11.145

History Node

1.11.144

History Node

1.11.143

History Node

1.11.142

History Node

1.11.141

History Node

1.11.140

History Node

1.11.139

History Node

1.11.138

History Node

1.11.137

History Node

1.11.136

History Node

1.11.135

History Node

1.11.134

History Node

1.11.133

History Node

1.11.132

History Node

1.11.131

History Node

1.11.130

History Node

1.11.129

History Node

1.11.128

History Node

1.11.127

History Node

1.11.126

History Node

1.11.125

History Node

1.11.124

History Node

1.11.123

History Node

1.11.122

History Node

1.11.121

History Node

1.11.120

History Node

1.11.119

History Node

1.11.118

History Node

1.11.117

History Node

1.11.116

History Node

1.11.115

History Node

1.11.114

History Node

1.11.113

History Node

1.11.112

History Node

1.11.111

History Node

1.11.110

History Node

1.11.109

History Node

1.11.108

History Node

1.11.107

History Node

1.11.106

History Node

1.11.105

History Node

1.11.104

History Node

1.11.103

History Node

1.11.102

History Node

1.11.101

History Node

1.11.100

History Node

1.11.99

History Node

1.11.98

History Node

1.11.97

History Node

1.11.96

History Node

1.11.95

History Node

1.11.94

History Node

1.11.93

History Node

1.11.92

History Node

1.11.91

History Node

1.11.90

History Node

1.11.89

History Node

1.11.88

History Node

1.11.87

History Node

1.11.86

History Node

1.11.85

History Node

1.11.84

History Node

1.11.83

History Node

1.11.82

History Node

1.11.81

History Node

1.11.80

History Node

1.11.79

History Node

1.11.78

History Node

1.11.77

History Node

1.11.76

History Node

1.11.75

History Node

1.11.74

History Node

1.11.73

History Node

1.11.72

History Node

1.11.71

History Node

1.11.70

History Node

1.11.69

History Node

1.11.68

History Node

1.11.67

History Node

1.11.66

History Node

1.11.65

History Node

1.11.64

History Node

1.11.63

History Node

1.11.62

History Node

1.11.61

History Node

1.11.60

History Node

1.11.59

History Node

1.11.58

History Node

1.11.57

History Node

1.11.56

History Node

1.11.55

History Node

1.11.54

History Node

1.11.53

History Node

1.11.52

History Node

1.11.51

History Node

1.11.50

History Node

1.11.49

History Node

1.11.48

History Node

1.11.47

History Node

1.11.46

History Node

1.11.45

History Node

1.11.44

History Node

1.11.43

History Node

1.11.42

History Node

1.11.41

History Node

1.11.40

History Node

1.11.39

History Node

1.11.38

History Node

1.11.37

History Node

1.11.36

History Node

1.11.35

History Node

1.11.34

History Node

1.11.33

History Node

1.11.32

History Node

1.11.31

History Node

1.11.30

History Node

1.11.29

History Node

1.11.28

History Node

1.11.27

History Node

1.11.26

History Node

1.11.25

History Node

1.11.24

History Node

1.11.23

History Node

1.11.22

History Node

1.11.21

History Node

1.11.20

History Node

1.11.19

History Node

1.11.18

History Node

1.11.17

History Node

1.11.16

History Node

1.11.15

History Node

1.11.14

History Node

1.11.13

History Node

1.11.12

History Node

1.11.11

History Node

1.11.10

History Node

1.11.9

History Node

1.11.8

History Node

1.11.7

History Node

1.11.6

History Node

1.11.5

History Node

1.11.4

History Node

1.11.3

History Node

1.11.2

History Node

1.11.1

History Node

1.11.0

History Node

1.10.67

History Node

1.10.66

History Node

1.10.65

History Node

1.10.64

History Node

1.10.63

History Node

1.10.62

History Node

1.10.61

History Node

1.10.60

History Node

1.10.59

History Node

1.10.58

History Node

1.10.57

History Node

1.10.56

History Node

1.10.55

History Node

1.10.54

History Node

1.10.53

History Node

1.10.52

History Node

1.10.51

History Node

1.10.50

History Node

1.10.49

History Node

1.10.48

History Node

1.10.47

History Node

1.10.46

History Node

1.10.45

History Node

1.10.44

History Node

1.10.43

History Node

1.10.42

History Node

1.10.41

History Node

1.10.40

History Node

1.10.39

History Node

1.10.38

History Node

1.10.37

History Node

1.10.36

History Node

1.10.35

History Node

1.10.34

History Node

1.10.33

History Node

1.10.32

History Node

1.10.31

History Node

1.10.30

History Node

1.10.29

History Node

1.10.28

History Node

1.10.27

History Node

1.10.26

History Node

1.10.25

History Node

1.10.24

History Node

1.10.23

History Node

1.10.22

History Node

1.10.21

History Node

1.10.20

History Node

1.10.19

History Node

1.10.18

History Node

1.10.17

History Node

1.10.16

History Node

1.10.15

History Node

1.10.14

History Node

1.10.13

History Node

1.10.12

History Node

1.10.11

History Node

1.10.10

History Node

1.10.9

History Node

1.10.8

History Node

1.10.7

History Node

1.10.6

History Node

1.10.5

History Node

1.10.4

History Node

1.10.3

History Node

1.10.2

History Node

1.10.1

History Node

1.10.0

History Node

1.9.21

History Node

1.9.20

History Node

1.9.19

History Node

1.9.18

History Node

1.9.17

History Node

1.9.16

History Node

1.9.15

History Node

1.9.14

History Node

1.9.13

History Node

1.9.12

History Node

1.9.11

History Node

1.9.10

History Node

1.9.9

History Node

1.9.8

History Node

1.9.7

History Node

1.9.6

History Node

1.9.5

History Node

1.9.4

History Node

1.9.3

History Node

1.9.2

History Node

1.9.1

History Node

1.9.0

History Node

1.8.13

History Node

1.8.12

History Node

1.8.11

History Node

1.8.10

History Node

1.8.9

History Node

1.8.8

History Node

1.8.7

History Node

1.8.6

History Node

1.8.5

History Node

1.8.4

History Node

1.8.3

History Node

1.8.2

History Node

1.8.1

History Node

1.8.0

History Node

1.7.47

History Node

1.7.46

History Node

1.7.45

History Node

1.7.44

History Node

1.7.43

History Node

1.7.42

History Node

1.7.41

History Node

1.7.40

History Node

1.7.39

History Node

1.7.38

History Node

1.7.37

History Node

1.7.36

History Node

1.7.35

History Node

1.7.34

History Node

1.7.33

History Node

1.7.32

History Node

1.7.31

History Node

1.7.30

History Node

1.7.29

History Node

1.7.28

History Node

1.7.27

History Node

1.7.26

History Node

1.7.25

History Node

1.7.24

History Node

1.7.23

History Node

1.7.22

History Node

1.7.21

History Node

1.7.20

History Node

1.7.19

History Node

1.7.18

History Node

1.7.17

History Node

1.7.16

History Node

1.7.15

History Node

1.7.14

History Node

1.7.13

History Node

1.7.12

History Node

1.7.11

History Node

1.7.10

History Node

1.7.9

History Node

1.7.8

History Node

1.7.7

History Node

1.7.6

History Node

1.7.5

History Node

1.7.4

History Node

1.7.3

History Node

1.7.2

History Node

1.7.1

History Node

1.7.0

History Node

1.6.10

History Node

1.6.9

History Node

1.6.8

History Node

1.6.7

History Node

1.6.6

History Node

1.6.5

History Node

1.6.4

History Node

1.6.3

History Node

1.6.2

History Node

1.6.1

History Node

1.6.0

History Node

1.5.6

History Node

1.5.5

History Node

1.5.4

History Node

1.5.3

History Node

1.5.2

History Node

1.5.1

History Node

1.5.0

History Node

1.4.4

History Node

1.4.3

History Node

1.4.2

History Node

1.4.1

History Node

1.4.0

History Node

1.3.25

History Node

1.3.24

History Node

1.3.23

History Node

1.3.22

History Node

1.3.21

History Node

1.3.20

History Node

1.3.19

History Node

1.3.18

History Node

1.3.17

History Node

1.3.16

History Node

1.3.15

History Node

1.3.14

History Node

1.3.13

History Node

1.3.12

History Node

1.3.11

History Node

1.3.10

History Node

1.3.9

History Node

1.3.8

History Node

1.3.7

History Node

1.3.6

History Node

1.3.5

History Node

1.3.4

History Node

1.3.3

History Node

1.3.2

History Node

1.3.1

History Node

1.3.0

History Node

1.2.13

History Node

1.2.12

History Node

1.2.11

History Node

1.2.10

History Node

1.2.9

History Node

1.2.8

History Node

1.2.7

History Node

1.2.6

History Node

1.2.5

History Node

1.2.4

History Node

1.2.3

History Node

1.2.2

History Node

1.2.1

History Node

1.2.0

History Node

1.1.2

History Node

1.1.1

History Node

1.1.0

History Node

1.0.0

History Node

0.16.0

History Node

0.15.0

History Node

0.14.1

History Node

0.14.0

History Node

0.13.2

History Node

0.13.1

History Node

0.13.0

History Node

0.12.0

History Node

0.11.0

History Node

0.10.1

History Node

0.9.3

History Node

0.9.2

History Node

0.9.1

History Node

0.8.3

History Node

0.8.2

History Node

0.8.1

History Node

0.8.0

History Node

0.7.0

History Node

0.6.0

History Node

0.5.3

History Node

0.5.2

History Node

0.5.1

History Node

0.5.0

This version
History Node

0.4.5

History Node

0.4.4

History Node

0.4.3

History Node

0.4.2

History Node

0.4.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
awscli-0.4.5.tar.gz (15.7 kB) Copy SHA256 hash SHA256 Source None Jan 3, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page