1 #### 2 boto 3 #### 4 boto 2.38.0 5 6 Released: 9-Apr-2015 7 8 .. image:: https://travis-ci.org/boto/boto.svg?branch=develop 9 :target: https://travis-ci.org/boto/boto 10 11 .. image:: https://pypip.in/d/boto/badge.svg 12 :target: https://pypi.python.org/pypi/boto/ 13 14 ************ 15 Introduction 16 ************ 17 18 Boto is a Python package that provides interfaces to Amazon Web Services. 19 Currently, all features work with Python 2.6 and 2.7. Work is under way to 20 support Python 3.3+ in the same codebase. Modules are being ported one at 21 a time with the help of the open source community, so please check below 22 for compatibility with Python 3.3+. 23 24 To port a module to Python 3.3+, please view our `Contributing Guidelines`_ 25 and the `Porting Guide`_. If you would like, you can open an issue to let 26 others know about your work in progress. Tests **must** pass on Python 27 2.6, 2.7, 3.3, and 3.4 for pull requests to be accepted. 28 29 ****** 30 Boto 3 31 ****** 32 The next major version of Boto is currently in developer preview and can 33 be found in the `Boto 3 <https://github.com/boto/boto3#readme>`__ 34 repository and installed via ``pip``. It supports the latest service APIs 35 and provides a high-level object-oriented interface to many services. 36 37 Please try Boto 3 and 38 `leave feedback <https://github.com/boto/boto3/issues>`__ with any issues, 39 suggestions, and feature requests you might have. 40 41 ******** 42 Services 43 ******** 44 45 At the moment, boto supports: 46 47 * Compute 48 49 * Amazon Elastic Compute Cloud (EC2) (Python 3) 50 * Amazon Elastic Map Reduce (EMR) (Python 3) 51 * AutoScaling (Python 3) 52 * Amazon Kinesis (Python 3) 53 * AWS Lambda (Python 3) 54 * Amazon EC2 Container Service (Python 3) 55 56 * Content Delivery 57 58 * Amazon CloudFront (Python 3) 59 60 * Database 61 62 * Amazon Relational Data Service (RDS) 63 * Amazon DynamoDB (Python 3) 64 * Amazon SimpleDB (Python 3) 65 * Amazon ElastiCache (Python 3) 66 * Amazon Redshift (Python 3) 67 68 * Deployment and Management 69 70 * AWS Elastic Beanstalk (Python 3) 71 * AWS CloudFormation (Python 3) 72 * AWS Data Pipeline (Python 3) 73 * AWS Opsworks (Python 3) 74 * AWS CloudTrail (Python 3) 75 * AWS CodeDeploy (Python 3) 76 77 * Administration & Security 78 79 * AWS Identity and Access Management (IAM) (Python 3) 80 * AWS Key Management Service (KMS) (Python 3) 81 * AWS Config (Python 3) 82 * AWS CloudHSM (Python 3) 83 84 * Application Services 85 86 * Amazon CloudSearch (Python 3) 87 * Amazon CloudSearch Domain (Python 3) 88 * Amazon Elastic Transcoder (Python 3) 89 * Amazon Simple Workflow Service (SWF) (Python 3) 90 * Amazon Simple Queue Service (SQS) (Python 3) 91 * Amazon Simple Notification Server (SNS) (Python 3) 92 * Amazon Simple Email Service (SES) (Python 3) 93 * Amazon Cognito Identity (Python 3) 94 * Amazon Cognito Sync (Python 3) 95 * Amazon Machine Learning (Python 3) 96 97 * Monitoring 98 99 * Amazon CloudWatch (EC2 Only) (Python 3) 100 * Amazon CloudWatch Logs (Python 3) 101 102 * Networking 103 104 * Amazon Route53 (Python 3) 105 * Amazon Route 53 Domains (Python 3) 106 * Amazon Virtual Private Cloud (VPC) (Python 3) 107 * Elastic Load Balancing (ELB) (Python 3) 108 * AWS Direct Connect (Python 3) 109 110 * Payments and Billing 111 112 * Amazon Flexible Payment Service (FPS) 113 114 * Storage 115 116 * Amazon Simple Storage Service (S3) (Python 3) 117 * Amazon Glacier (Python 3) 118 * Amazon Elastic Block Store (EBS) 119 * Google Cloud Storage 120 121 * Workforce 122 123 * Amazon Mechanical Turk 124 125 * Other 126 127 * Marketplace Web Services (Python 3) 128 * AWS Support (Python 3) 129 130 The goal of boto is to support the full breadth and depth of Amazon 131 Web Services. In addition, boto provides support for other public 132 services such as Google Storage in addition to private cloud systems 133 like Eucalyptus, OpenStack and Open Nebula. 134 135 Boto is developed mainly using Python 2.6.6 and Python 2.7.3 on Mac OSX 136 and Ubuntu Maverick. It is known to work on other Linux distributions 137 and on Windows. Most of Boto requires no additional libraries or packages 138 other than those that are distributed with Python. Efforts are made 139 to keep boto compatible with Python 2.5.x but no guarantees are made. 140 141 ************ 142 Installation 143 ************ 144 145 Install via `pip`_: 146 147 :: 148 149 $ pip install boto 150 151 Install from source: 152 153 :: 154 155 $ git clone git://github.com/boto/boto.git 156 $ cd boto 157 $ python setup.py install 158 159 ********** 160 ChangeLogs 161 ********** 162 163 To see what has changed over time in boto, you can check out the 164 release notes at `http://docs.pythonboto.org/en/latest/#release-notes` 165 166 *************************** 167 Finding Out More About Boto 168 *************************** 169 170 The main source code repository for boto can be found on `github.com`_. 171 The boto project uses the `gitflow`_ model for branching. 172 173 `Online documentation`_ is also available. The online documentation includes 174 full API documentation as well as Getting Started Guides for many of the boto 175 modules. 176 177 Boto releases can be found on the `Python Cheese Shop`_. 178 179 Join our IRC channel `#boto` on FreeNode. 180 Webchat IRC channel: http://webchat.freenode.net/?channels=boto 181 182 Join the `boto-users Google Group`_. 183 184 ************************* 185 Getting Started with Boto 186 ************************* 187 188 Your credentials can be passed into the methods that create 189 connections. Alternatively, boto will check for the existence of the 190 following environment variables to ascertain your credentials: 191 192 **AWS_ACCESS_KEY_ID** - Your AWS Access Key ID 193 194 **AWS_SECRET_ACCESS_KEY** - Your AWS Secret Access Key 195 196 Credentials and other boto-related settings can also be stored in a 197 boto config file. See `this`_ for details. 198 199 .. _Contributing Guidelines: https://github.com/boto/boto/blob/develop/CONTRIBUTING 200 .. _Porting Guide: http://boto.readthedocs.org/en/latest/porting_guide.html 201 .. _pip: http://www.pip-installer.org/ 202 .. _release notes: https://github.com/boto/boto/wiki 203 .. _github.com: http://github.com/boto/boto 204 .. _Online documentation: http://docs.pythonboto.org 205 .. _Python Cheese Shop: http://pypi.python.org/pypi/boto 206 .. _this: http://docs.pythonboto.org/en/latest/boto_config_tut.html 207 .. _gitflow: http://nvie.com/posts/a-successful-git-branching-model/ 208 .. _neo: https://github.com/boto/boto/tree/neo 209 .. _boto-users Google Group: https://groups.google.com/forum/?fromgroups#!forum/boto-users 210
