diff options
Diffstat (limited to 'docs/source')
28 files changed, 641 insertions, 96 deletions
diff --git a/docs/source/apps_built_on_boto.rst b/docs/source/apps_built_on_boto.rst new file mode 100644 index 00000000..0fc40666 --- /dev/null +++ b/docs/source/apps_built_on_boto.rst @@ -0,0 +1,44 @@ +.. _apps_built_on_boto: + +========================== +Applications Built On Boto +========================== + +Many people have taken Boto and layered on additional functionality, then shared +them with the community. This is a (partial) list of applications that use Boto. + +If you have an application or utility you've open-sourced that uses Boto & +you'd like it listed here, please submit a `pull request`_ adding it! + +.. _`pull request`: https://github.com/boto/boto/pulls + +**botornado** + https://pypi.python.org/pypi/botornado + An asynchronous AWS client on Tornado. This is a dirty work to move boto + onto Tornado ioloop. Currently works with SQS and S3. + +**boto_rsync** + https://pypi.python.org/pypi/boto_rsync + boto-rsync is a rough adaptation of boto's s3put script which has been + reengineered to more closely mimic rsync. Its goal is to provide a familiar + rsync-like wrapper for boto's S3 and Google Storage interfaces. + +**boto_utils** + https://pypi.python.org/pypi/boto_utils + Command-line tools for interacting with Amazon Web Services, based on Boto. + Includes utils for S3, SES & Cloudwatch. + +**django-storages** + https://pypi.python.org/pypi/django-storages + A collection of storage backends for Django. Features the ``S3BotoStorage`` + backend for storing media on S3. + +**mr.awsome** + https://pypi.python.org/pypi/mr.awsome + mr.awsome is a commandline-tool (aws) to manage and control Amazon + Webservice's EC2 instances. Once configured with your AWS key, you can + create, delete, monitor and ssh into instances, as well as perform scripted + tasks on them (via fabfiles). Examples are adding additional, + pre-configured webservers to a cluster (including updating the load + balancer), performing automated software deployments and creating backups - + each with just one call from the commandline. diff --git a/docs/source/autoscale_tut.rst b/docs/source/autoscale_tut.rst index 86fc529f..d1eaf3f9 100644 --- a/docs/source/autoscale_tut.rst +++ b/docs/source/autoscale_tut.rst @@ -201,8 +201,7 @@ To retrieve the instances in your autoscale group: >>> ec2 = boto.ec2.connect_to_region('us-west-2) >>> conn.get_all_groups(names=['my_group'])[0] >>> instance_ids = [i.instance_id for i in group.instances] ->>> reservations = ec2.get_all_instances(instance_ids) ->>> instances = [i for r in reservations for i in r.instances] +>>> instances = ec2.get_only_instances(instance_ids) To delete your autoscale group, we first need to shutdown all the instances: diff --git a/docs/source/commandline.rst b/docs/source/commandline.rst new file mode 100644 index 00000000..6b604827 --- /dev/null +++ b/docs/source/commandline.rst @@ -0,0 +1,85 @@ +.. _ref-boto_commandline: + +================== +Command Line Tools +================== + +Introduction +============ + +Boto ships with a number of command line utilities, which are installed +when the package is installed. This guide outlines which ones are available +& what they do. + +.. note:: + + If you're not already depending on these utilities, you may wish to check + out the AWS-CLI (http://aws.amazon.com/cli/ - `User Guide`_ & + `Reference Guide`_). It provides much wider & complete access to the + AWS services. + + .. _`User Guide`: http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html + .. _`Reference Guide`: http://docs.aws.amazon.com/cli/latest/reference/ + +The included utilities available are: + +``asadmin`` + Works with Autoscaling + +``bundle_image`` + Creates a bundled AMI in S3 based on a EC2 instance + +``cfadmin`` + Works with CloudFront & invalidations + +``cq`` + Works with SQS queues + +``cwutil`` + Works with CloudWatch + +``dynamodb_dump`` +``dynamodb_load`` + Handle dumping/loading data from DynamoDB tables + +``elbadmin`` + Manages Elastic Load Balancer instances + +``fetch_file`` + Downloads an S3 key to disk + +``glacier`` + Lists vaults, jobs & uploads files to Glacier + +``instance_events`` + Lists all events for EC2 reservations + +``kill_instance`` + Kills a list of EC2 instances + +``launch_instance`` + Launches an EC2 instance + +``list_instances`` + Lists all of your EC2 instances + +``lss3`` + Lists what keys you have within a bucket in S3 + +``mturk`` + Provides a number of facilities for interacting with Mechanical Turk + +``pyami_sendmail`` + Sends an email from the Pyami instance + +``route53`` + Interacts with the Route53 service + +``s3put`` + Uploads a directory or a specific file(s) to S3 + +``sdbadmin`` + Allows for working with SimpleDB domains + +``taskadmin`` + A tool for working with the tasks in SimpleDB diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index ac9305a3..80821995 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -202,3 +202,26 @@ and uses `restructured text`_ for the markup language. .. _virtualenvwrapper: http://www.doughellmann.com/projects/virtualenvwrapper/ .. _sphinx: http://sphinx.pocoo.org/ .. _restructured text: http://sphinx.pocoo.org/rest.html + + +Merging A Branch (Core Devs) +============================ + +* All features/bugfixes should go through a review. + + * This includes new features added by core devs themselves. The usual + branch/pull-request/merge flow that happens for community contributions + should also apply to core. + +* Ensure there is proper test coverage. If there's a change in behavior, there + should be a test demonstrating the failure before the change & passing with + the change. + + * This helps ensure we don't regress in the future as well. + +* Merging of pull requests is typically done with + ``git merge --no-ff <remote/branch_name>``. + + * GitHub's big green button is probably OK for very small PRs (like doc + fixes), but you can't run tests on GH, so most things should get pulled + down locally. diff --git a/docs/source/dynamodb2_tut.rst b/docs/source/dynamodb2_tut.rst index b6e98118..3e37675c 100644 --- a/docs/source/dynamodb2_tut.rst +++ b/docs/source/dynamodb2_tut.rst @@ -73,8 +73,8 @@ Simple example:: A full example:: + >>> import boto.dynamodb2 >>> from boto.dynamodb2.fields import HashKey, RangeKey, KeysOnlyIndex, AllIndex - >>> from boto.dynamodb2.layer1 import DynamoDBConnection >>> from boto.dynamodb2.table import Table >>> from boto.dynamodb2.types import NUMBER @@ -90,11 +90,7 @@ A full example:: ... ]) ... ], ... # If you need to specify custom parameters like keys or region info... - ... connection=DynamoDBConnection( - ... aws_access_key_id='key', - ... aws_secret_access_key='key', - ... region='us-west-2' - ... )) + ... connection= boto.dynamodb2.connect_to_region('us-east-1')) Using an Existing Table diff --git a/docs/source/ec2_tut.rst b/docs/source/ec2_tut.rst index d9ffe38c..6e179262 100644 --- a/docs/source/ec2_tut.rst +++ b/docs/source/ec2_tut.rst @@ -88,7 +88,7 @@ Checking What Instances Are Running ----------------------------------- You can also get information on your currently running instances:: - >>> reservations = conn.get_all_instances() + >>> reservations = conn.get_all_reservations() >>> reservations [Reservation:r-00000000] diff --git a/docs/source/index.rst b/docs/source/index.rst index f720cf1b..92ee2bbd 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -24,8 +24,6 @@ Currently Supported Services * :doc:`Elastic Compute Cloud (EC2) <ec2_tut>` -- (:doc:`API Reference <ref/ec2>`) * :doc:`Elastic MapReduce (EMR) <emr_tut>` -- (:doc:`API Reference <ref/emr>`) * :doc:`Auto Scaling <autoscale_tut>` -- (:doc:`API Reference <ref/autoscale>`) - * Data Pipeline -- (:doc:`API Reference <ref/datapipeline>`) - * Elastic Transcoder -- (:doc:`API Reference <ref/elastictranscoder>`) * **Content Delivery** @@ -44,6 +42,8 @@ Currently Supported Services * CloudFormation -- (:doc:`API Reference <ref/cloudformation>`) * Elastic Beanstalk -- (:doc:`API Reference <ref/beanstalk>`) + * Data Pipeline -- (:doc:`API Reference <ref/datapipeline>`) + * Opsworks -- (:doc:`API Reference <ref/opsworks>`) * **Identity & Access** @@ -52,11 +52,12 @@ Currently Supported Services * **Application Services** + * :doc:`Cloudsearch <cloudsearch_tut>` -- (:doc:`API Reference <ref/cloudsearch>`) + * Elastic Transcoder -- (:doc:`API Reference <ref/elastictranscoder>`) * Simple Workflow Service (SWF) -- (:doc:`API Reference <ref/swf>`) * :doc:`Simple Queue Service (SQS) <sqs_tut>` -- (:doc:`API Reference <ref/sqs>`) * Simple Notification Service (SNS) -- (:doc:`API Reference <ref/sns>`) * :doc:`Simple Email Service (SES) <ses_tut>` -- (:doc:`API Reference <ref/ses>`) - * :doc:`Cloudsearch <cloudsearch_tut>` -- (:doc:`API Reference <ref/cloudsearch>`) * **Monitoring** @@ -90,6 +91,8 @@ Currently Supported Services Additional Resources -------------------- +* :doc:`Applications Built On Boto <apps_built_on_boto>` +* :doc:`Command Line Utilities <commandline>` * :doc:`Boto Config Tutorial <boto_config_tut>` * :doc:`Contributing to Boto <contributing>` * `Boto Source Repository`_ @@ -111,6 +114,13 @@ Release Notes .. toctree:: :titlesonly: + releasenotes/v2.13.3 + releasenotes/v2.13.2 + releasenotes/v2.13.0 + releasenotes/v2.12.0 + releasenotes/v2.11.0 + releasenotes/v2.10.0 + releasenotes/v2.9.9 releasenotes/v2.9.8 releasenotes/v2.9.7 releasenotes/v2.9.6 @@ -139,58 +149,34 @@ Release Notes .. toctree:: :hidden: + :glob: getting_started ec2_tut security_groups - ref/ec2 emr_tut - ref/emr autoscale_tut - ref/autoscale cloudfront_tut - ref/cloudfront simpledb_tut - ref/sdb - ref/sdb_db dynamodb_tut - ref/dynamodb rds_tut - ref/rds - ref/cloudformation - ref/iam - ref/mws sqs_tut - ref/sqs - ref/sns ses_tut - ref/ses cloudsearch_tut - ref/cloudsearch cloudwatch_tut - ref/cloudwatch - ref/route53 vpc_tut - ref/vpc elb_tut - ref/elb - ref/fps s3_tut - ref/s3 - ref/mturk boto_config_tut - ref/index documentation contributing - ref/datapipeline - ref/elasticache - ref/elastictranscoder - ref/redshift - ref/dynamodb2 + commandline support_tut - ref/support dynamodb2_tut migrations/dynamodb_v1_to_v2 + apps_built_on_boto + ref/* + releasenotes/* Indices and tables diff --git a/docs/source/ref/cloudwatch.rst b/docs/source/ref/cloudwatch.rst index 96c650ed..ae38d89b 100644 --- a/docs/source/ref/cloudwatch.rst +++ b/docs/source/ref/cloudwatch.rst @@ -25,3 +25,10 @@ boto.ec2.cloudwatch.metric :members: :undoc-members: +boto.ec2.cloudwatch.alarm +-------------------------- + +.. automodule:: boto.ec2.cloudwatch.alarm + :members: + :undoc-members: + diff --git a/docs/source/ref/contrib.rst b/docs/source/ref/contrib.rst index 9262a0dc..39ef54f8 100644 --- a/docs/source/ref/contrib.rst +++ b/docs/source/ref/contrib.rst @@ -8,25 +8,12 @@ boto.contrib ------------ .. automodule:: boto.contrib - :members: - :undoc-members: - -boto.contrib.m2helpers ----------------------- - -.. note:: - - This module requires installation of M2Crypto__ in your Python path. - - __ http://sandbox.rulemaker.net/ngps/m2/ - -.. automodule:: boto.contrib.m2helpers - :members: + :members: :undoc-members: boto.contrib.ymlmessage ----------------------- .. automodule:: boto.contrib.ymlmessage - :members: + :members: :undoc-members:
\ No newline at end of file diff --git a/docs/source/ref/elb.rst b/docs/source/ref/elb.rst index 74e77f33..aef0c5b4 100644 --- a/docs/source/ref/elb.rst +++ b/docs/source/ref/elb.rst @@ -8,40 +8,54 @@ boto.ec2.elb ------------ .. automodule:: boto.ec2.elb - :members: + :members: :undoc-members: boto.ec2.elb.healthcheck ------------------------ .. automodule:: boto.ec2.elb.healthcheck - :members: + :members: :undoc-members: boto.ec2.elb.instancestate -------------------------- .. automodule:: boto.ec2.elb.instancestate - :members: + :members: :undoc-members: boto.ec2.elb.listelement ------------------------ .. automodule:: boto.ec2.elb.listelement - :members: + :members: :undoc-members: boto.ec2.elb.listener --------------------- .. automodule:: boto.ec2.elb.listener - :members: + :members: :undoc-members: boto.ec2.elb.loadbalancer ------------------------- .. automodule:: boto.ec2.elb.loadbalancer - :members: + :members: + :undoc-members: + +boto.ec2.elb.policies +------------------------- + +.. automodule:: boto.ec2.elb.policies + :members: + :undoc-members: + +boto.ec2.elb.securitygroup +------------------------- + +.. automodule:: boto.ec2.elb.securitygroup + :members: :undoc-members: diff --git a/docs/source/ref/opsworks.rst b/docs/source/ref/opsworks.rst new file mode 100644 index 00000000..7c761e72 --- /dev/null +++ b/docs/source/ref/opsworks.rst @@ -0,0 +1,28 @@ +.. ref-opsworks + +======== +Opsworks +======== + +boto.opsworks +------------ + +.. automodule:: boto.opsworks + :members: + :undoc-members: + +boto.opsworks.layer1 +------------------- + +.. automodule:: boto.opsworks.layer1 + :members: + :undoc-members: + +boto.opsworks.exceptions +----------------------- + +.. automodule:: boto.opsworks.exceptions + :members: + :undoc-members: + + diff --git a/docs/source/ref/s3.rst b/docs/source/ref/s3.rst index ce5c9256..2cad0e95 100644 --- a/docs/source/ref/s3.rst +++ b/docs/source/ref/s3.rst @@ -88,13 +88,6 @@ boto.s3.lifecycle :members: :undoc-members: -boto.s3.prefix ------------------ - -.. automodule:: boto.s3.prefix - :members: - :undoc-members: - boto.s3.tagging --------------- diff --git a/docs/source/ref/sdb_db.rst b/docs/source/ref/sdb_db.rst index 5b77e2bc..a7594db5 100644 --- a/docs/source/ref/sdb_db.rst +++ b/docs/source/ref/sdb_db.rst @@ -10,74 +10,61 @@ boto.sdb.db ----------- .. automodule:: boto.sdb.db - :members: + :members: :undoc-members: boto.sdb.db.blob ---------------- .. automodule:: boto.sdb.db.blob - :members: + :members: :undoc-members: boto.sdb.db.key --------------- .. automodule:: boto.sdb.db.key - :members: + :members: :undoc-members: boto.sdb.db.manager ------------------- .. automodule:: boto.sdb.db.manager - :members: - :undoc-members: - -boto.sdb.db.manager.pgmanager ------------------------------ - -.. note:: - - This module requires psycopg2__ to be installed in the Python path. - - __ http://initd.org/ - -.. automodule:: boto.sdb.db.manager.pgmanager - :members: + :members: :undoc-members: boto.sdb.db.manager.sdbmanager ------------------------------ .. automodule:: boto.sdb.db.manager.sdbmanager - :members: + :members: :undoc-members: boto.sdb.db.manager.xmlmanager ------------------------------ .. automodule:: boto.sdb.db.manager.xmlmanager - :members: + :members: :undoc-members: boto.sdb.db.model ----------------- .. automodule:: boto.sdb.db.model - :members: + :members: :undoc-members: boto.sdb.db.property -------------------- .. automodule:: boto.sdb.db.property - :members: + :members: :undoc-members: boto.sdb.db.query ----------------- .. automodule:: boto.sdb.db.query - :members: + :members: :undoc-members: diff --git a/docs/source/ref/swf.rst b/docs/source/ref/swf.rst index d4b0ca36..892bc07a 100644 --- a/docs/source/ref/swf.rst +++ b/docs/source/ref/swf.rst @@ -18,5 +18,8 @@ boto.swf.layer1 :members: :undoc-members: +boto.swf.layer2 +-------------------- - +.. automodule:: boto.swf.layer2 + :members: diff --git a/docs/source/releasenotes/dev.rst b/docs/source/releasenotes/dev.rst new file mode 100644 index 00000000..39b096eb --- /dev/null +++ b/docs/source/releasenotes/dev.rst @@ -0,0 +1,21 @@ +boto v2.xx.x +============ + +:date: 2013/xx/xx + +This release adds ____. + + +Features +-------- + +* . (:issue:``, :sha:``) + + +Bugfixes +-------- + +* (:issue:``, :sha:``) +* Several documentation improvements/fixes: + + * (:issue:``, :sha:``) diff --git a/docs/source/releasenotes/releasenotes_template.rst b/docs/source/releasenotes/releasenotes_template.rst new file mode 100644 index 00000000..39b096eb --- /dev/null +++ b/docs/source/releasenotes/releasenotes_template.rst @@ -0,0 +1,21 @@ +boto v2.xx.x +============ + +:date: 2013/xx/xx + +This release adds ____. + + +Features +-------- + +* . (:issue:``, :sha:``) + + +Bugfixes +-------- + +* (:issue:``, :sha:``) +* Several documentation improvements/fixes: + + * (:issue:``, :sha:``) diff --git a/docs/source/releasenotes/v2.0.0.rst b/docs/source/releasenotes/v2.0.0.rst index 47e563a0..28d38536 100644 --- a/docs/source/releasenotes/v2.0.0.rst +++ b/docs/source/releasenotes/v2.0.0.rst @@ -10,7 +10,7 @@ There have been many, many changes since the 2.0b4 release. This overview highli * Fix connection pooling bug: don't close before reading. * Added AddInstanceGroup and ModifyInstanceGroup to boto.emr * Merge pull request #246 from chetan/multipart_s3put -AddInstanceGroupsResponse class to boto.emr.emrobject. +* AddInstanceGroupsResponse class to boto.emr.emrobject. * Removed extra print statement * Merge pull request #244 from ryansb/master * Added add_instance_groups function to boto.emr.connection. Built some helper methods for it, and added AddInstanceGroupsResponse class to boto.emr.emrobject. diff --git a/docs/source/releasenotes/v2.10.0.rst b/docs/source/releasenotes/v2.10.0.rst new file mode 100644 index 00000000..fda15b42 --- /dev/null +++ b/docs/source/releasenotes/v2.10.0.rst @@ -0,0 +1,54 @@ +boto v2.10.0 +============ + +:date: 2013/08/13 + +This release adds Mobile Push Notification support to Amazon Simple Notification +Service, better reporting for Amazon Redshift, SigV4 authorization for Amazon +Elastic MapReduce & lots of bugfixes. + + +Features +-------- + +* Added support for Mobile Push Notifications to SNS. This enables you to send + push notifications to mobile devices (such as iOS or Android) using SNS. + (:sha:`ccba574`) +* Added support for better reporting within Redshift. (:sha:`9d55dd3`) +* Switched Elastic MapReduce to use SigV4 for authorization. (:sha:`b80aa48`) + + +Bugfixes +-------- + +* Added the ``MinAdjustmentType`` parameter to EC2 Autoscaling. (:issue:`1562`, + :issue:`1619`, :sha:`1760284`, :sha:`2a11fd9`, :sha:`2d14006` & + :sha:`b7f1ae1`) +* Fixed how DynamoDB tracks changes to data in ``Item`` objects, fixing + failures with modified sets not being sent. (:issue:`1565`, + :sha:`b111fcf` & :sha:`812f9a6`) +* Updated the CA certificates Boto ships with. (:issue:`1578`, :sha:`4dfadc8`) +* Fixed how CloudSearch's ``Layer2`` object gets initialized. (:issue:`1629`, + :issue:`1630`, :sha:`40b3652` & :sha:`f797ff9`) +* Fixed the ``-w`` flag in ``s3put``. (:issue:`1637`, :sha:`0865004` & + :sha:`3fe70ca`) +* Added the ``ap-southeast-2`` endpoint for DynamoDB. (:issue:`1621`, + :sha:`501b637`) +* Fixed test suite to run faster. (:sha:`243a67e`) +* Fixed how non-JSON responses are caught from CloudSearch. (:issue:`1633`, + :issue:`1645`, :sha:`d5a5c01`, :sha:`954a50c`, :sha:`915d8ff` & + :sha:`4407fcb`) +* Fixed how ``DeviceIndex`` is parsed from EC2. (:issue:`1632`, :issue:`1646`, + :sha:`ff15e1f`, :sha:`8337a0b` & :sha:`27c9b04`) +* Fixed EC2's ``connect_to_region`` to respect the ``region`` parameter. ( + :issue:`1616`, :issue:`1654`, :sha:`9c37256`, :sha:`5950d12` & :sha:`b7eebe8`) +* Added ``modify_network_interface_atribute`` to EC2 connections. + (:issue:`1613`, :issue:`1656`, :sha:`e00b601`, :sha:`5b62f27`, :sha:`126f6e9`, + :sha:`bbfed1f` & :sha:`0c61293`) +* Added support for ``param_group`` within RDS. (:issue:`1639`, :sha:`c47baf0`) +* Added support for using ``Item.partial_save`` to create new records within + DynamoDBv2. (:issue:`1660`, :issue:`1521`, :sha:`bfa469f` & :sha:`58a13d7`) +* Several documentation improvements/fixes: + + * Updated guideline on how core should merge PRs. (:sha:`80a419c`) + * Fixed a typo in a CloudFront docstring. (:issue:`1657`, :sha:`1aa0621`)
\ No newline at end of file diff --git a/docs/source/releasenotes/v2.11.0.rst b/docs/source/releasenotes/v2.11.0.rst new file mode 100644 index 00000000..267d4a15 --- /dev/null +++ b/docs/source/releasenotes/v2.11.0.rst @@ -0,0 +1,62 @@ +boto v2.11.0 +============ + +:date: 2013/08/29 + +This release adds Public IP address support for VPCs created by EC2. It also +makes the GovCloud region available for all services. Finally, this release +also fixes a number of bugs. + + +Features +-------- + +* Added Public IP address support within VPCs created by EC2. (:sha:`be132d1`) +* All services can now easily use GovCloud. (:issue:`1651`, :sha:`542a301`, + :sha:`3c56121`, :sha:`9167d89`) +* Added ``db_subnet_group`` to + ``RDSConnection.restore_dbinstance_from_point_in_time``. (:issue:`1640`, + :sha:`06592b9`) +* Added ``monthly_backups`` to EC2's ``trim_snapshots``. (:issue:`1688`, + :sha:`a2ad606`, :sha:`2998c11`, :sha:`e32d033`) +* Added ``get_all_reservations`` & ``get_only_instances`` methods to EC2. + (:issue:`1572`, :sha:`ffc6cc0`) + + +Bugfixes +-------- + +* Fixed the parsing of CloudFormation's ``LastUpdatedTime``. (:issue:`1667`, + :sha:` 70f363a`) +* Fixed STS' ``assume_role_with_web_identity`` to work correctly. + (:issue:`1671`, :sha:`ed1f403`, :sha:`ca794d5`, :sha:`ed7e563`, + :sha:`859762d`) +* Fixed how VPC security group filtering is done in EC2. (:issue:`1665`, + :issue:`1677`, :sha:`be00956`, :sha:`5e85dd1`, :sha:`e63aae8`) +* Fixed fetching more than 100 records with ``ResourceRecordSet``. + (:issue:`1647`, :issue:`1648`, :issue:`1680`, :sha:`b64dd4f`, :sha:`276df7e`, + :sha:`e57cab0`, :sha:`e62a58b`, :sha:`4c81bea`, :sha:`a3c635b`) +* Fixed how VPC Security Groups are referred to when working with RDS. + (:issue:`1602`, :issue:`1683`, :issue:`1685`, :issue:`1694`, :sha:`012aa0c`, + :sha:`d5c6dfa`, :sha:`7841230`, :sha:`0a90627`, :sha:`ed4fd8c`, + :sha:`61d394b`, :sha:`ebe84c9`, :sha:`a6b0f7e`) +* Google Storage ``Key`` now uses transcoding-invariant headers where possible. + (:sha:`d36eac3`) +* Doing non-multipart uploads when using ``s3put`` no longer requires having + the ``ListBucket`` permission. (:issue:`1642`, :issue:`1693`, :sha:`f35e914`) +* Fixed the serialization of ``attributes`` in a variety of SNS methods. + (:issue:`1686`, :sha:`4afb3dd`, :sha:`a58af54`) +* Fixed SNS to be better behaved when constructing an mobile push notification. + (:issue:`1692`, :sha:`62fdf34`) +* Moved SWF to SigV4. (:sha:`ef7d255`) +* Several documentation improvements/fixes: + + * Updated the DynamoDB v2 docs to correct how the connection is built. + (:issue:`1662`, :sha:`047962d`) + * Fixed a typo in the DynamoDB v2 docstring for ``Table.create``. + (:sha:`be00956`) + * Fixed a typo in the DynamoDB v2 docstring for ``Table`` for custom + connections. (:issue:`1681`, :sha:`6a53020`) + * Fixed incorrect parameter names for ``DBParameterGroup`` in RDS. + (:issue:`1682`, :sha:`0d46aed`) + * Fixed a typo in the SQS tutorial. (:issue:`1684`, :sha:`38b7889`) diff --git a/docs/source/releasenotes/v2.12.0.rst b/docs/source/releasenotes/v2.12.0.rst new file mode 100644 index 00000000..8b713c4b --- /dev/null +++ b/docs/source/releasenotes/v2.12.0.rst @@ -0,0 +1,32 @@ +boto v2.12.0 +============ + +:date: 2013/09/04 + +This release adds support for Redis & replication groups to Elasticache as +well as several bug fixes. + + +Features +-------- + +* Added support for Redis & replication groups to Elasticache. (:sha:`f744ff6`) + + +Bugfixes +-------- + +* Boto's User-Agent string has changed. Mostly additive to include more + information. (:sha:`edb038a`) +* Headers that are part of S3's signing are now correctly coerced to the proper + case. (:issue:`1687`, :sha:`89eae8c`) +* Altered S3 so that it's possible to track what portions of a multipart upload + succeeded. (:issue:`1305`, :issue:`1675`, :sha:`e9a2c59`) +* Added ``create_lb_policy`` & ``set_lb_policies_of_backend_server`` to ELB. + (:issue:`1695`, :sha:`77a9458`) +* Fixed pagination when listing vaults in Glacier. (:issue:`1699`, + :sha:`9afecca`) +* Several documentation improvements/fixes: + + * Added some docs about what command-line utilities ship with boto. + (:sha:`5d7d54d`) diff --git a/docs/source/releasenotes/v2.13.0.rst b/docs/source/releasenotes/v2.13.0.rst new file mode 100644 index 00000000..b28e9ba7 --- /dev/null +++ b/docs/source/releasenotes/v2.13.0.rst @@ -0,0 +1,40 @@ +boto v2.13.0 +============ + +:date: 2013/09/12 + +This release adds support for VPC within AWS Opsworks, added dry-run support & +the ability to modify reserved instances in EC2 as well as several important +bugfixes for EC2, SNS & DynamoDBv2. + + +Features +-------- + +* Added support for VPC within Opsworks. (:sha:`56e1df3`) +* Added support for ``dry_run`` within EC2. (:sha:`dd7774c`) +* Added support for ``modify_reserved_instances`` & + ``describe_reserved_instances_modifications`` within EC2. (:sha:`7a08672`) + + +Bugfixes +-------- + +* Fixed EC2's ``associate_public_ip`` to work correctly. (:sha:`9db6101`) +* Fixed a bug with ``dynamodb_load`` when working with sets. (:issue:`1664`, + :sha:`ef2d28b`) +* Changed SNS ``publish`` to use POST. (:sha:`9c11772`) +* Fixed inability to create LaunchConfigurations when using Block Device + Mappings. (:issue:`1709`, :issue:`1710`, :sha:`5fd728e`) +* Fixed DynamoDBv2's ``batch_write`` to appropriately handle + ``UnprocessedItems``. (:issue:`1566`, :issue:`1679`, :issue:`1714`, + :sha:`2fc2369`) +* Several documentation improvements/fixes: + + * Added Opsworks docs to the index. (:sha:`5d48763`) + * Added docs on the correct string values for ``get_all_images``. + (:issue:`1674`, :sha:`1e4ed2e`) + * Removed a duplicate ``boto.s3.prefix`` entry from the docs. + (:issue:`1707`, :sha:`b42d34c`) + * Added an API reference for ``boto.swf.layer2``. (:issue:`1712`, + :sha:`9f7b15f`) diff --git a/docs/source/releasenotes/v2.13.2.rst b/docs/source/releasenotes/v2.13.2.rst new file mode 100644 index 00000000..4e3d6842 --- /dev/null +++ b/docs/source/releasenotes/v2.13.2.rst @@ -0,0 +1,39 @@ +boto v2.13.2 +============ + +:date: 2013/09/16 + +This release is a bugfix-only release, correcting several problems in EC2 as +well as S3, DynamoDB v2 & SWF. + +.. note:: + + There was no v2.13.1 release made public. There was a packaging error that + was discovered before it was published to PyPI. + + We apologise for the fault in the releases. Those responsible have been + sacked. + + +Bugfixes +-------- + +* Fixed test fallout from the EC2 dry-run change. (:sha:`2159456`) +* Added tests for more of SWF's ``layer2``. (:issue:`1718`, :sha:`35fb741`, + :sha:`a84d401`, :sha:`1cf1641`, :sha:`a36429c`) +* Changed EC2 to allow ``name`` to be optional in calls to ``copy_image``. + (:issue:`1672`, :sha:` 26285aa`) +* Added ``billingProducts`` support to EC2 ``Image``. (:issue:`1703`, + :sha:`cccadaf`, :sha:`3914e91`) +* Fixed a place where ``dry_run`` was handled in EC2. (:issue:`1722`, + :sha:`0a52c82`) +* Fixed ``run_instances`` with a block device mapping. (:issue:`1723`, + :sha:`974743f`, :sha:`9049f05`, :sha:`d7edafc`) +* Fixed ``s3put`` to accept headers with a ``=`` in them. (:issue:`1700`, + :sha:`7958c70`) +* Fixed a bug in DynamoDB v2 where scans with filters over large sets may not + return all values. (:issue:`1713`, :sha:`02893e1`) +* Cloudsearch now uses SigV4. (:sha:`b2bdbf5`) +* Several documentation improvements/fixes: + + * Added the "Apps Built On Boto" doc. (:sha:`3bd628c`) diff --git a/docs/source/releasenotes/v2.13.3.rst b/docs/source/releasenotes/v2.13.3.rst new file mode 100644 index 00000000..f145f75a --- /dev/null +++ b/docs/source/releasenotes/v2.13.3.rst @@ -0,0 +1,11 @@ +boto v2.13.3 +============ + +:date: 2013/09/16 + +This release fixes a packaging error with the previous version of boto. +The version ``v2.13.2`` was provided instead of ``2.13.2``, causing things +like ``pip`` to incorrectly resolve the latest release. + +That release was only available for several minutes & was removed from PyPI +due to the way it would break installation for users. diff --git a/docs/source/releasenotes/v2.14.0.rst b/docs/source/releasenotes/v2.14.0.rst new file mode 100644 index 00000000..4f235f04 --- /dev/null +++ b/docs/source/releasenotes/v2.14.0.rst @@ -0,0 +1,63 @@ +boto v2.14.0 +============ + +:date: 2013/10/09 + +This release makes ``s3put`` region-aware, adds some missing features to +EC2 and SNS, enables EPUB documentation output, and makes the HTTP(S) +connection pooling port-aware, which in turn enables connecting to +e.g. mock services running on ``localhost``. It also includes support +for the latest EC2 and OpsWorks features, as well as several +important bugfixes for EC2, DynamoDB, MWS, and Python 2.5 support. + + +Features +-------- + +* Add support for a ``--region`` argument to ``s3put`` and auto-detect bucket + regions if possible (:issue:`1731`, :sha:`d9c28f6`) +* Add ``delete_notification_configuration`` for EC2 autoscaling + (:issue:`1717`, :sha:`ebb7ace`) +* Add support for registering HVM instances (:issue:`1733`, :sha:`2afc68e`) +* Add support for ``ReplaceRouteTableAssociation`` for EC2 (:issue:`1736`, + :sha:`4296835`) +* Add ``sms`` as an option for SNS subscribe (:issue:`1744`, :sha:`8ff08e5`) +* Allow overriding ``has_google_credentials`` (:issue:`1752`, :sha:`052cc91`) +* Add EPUB output format for docs (:issue:`1759`, :sha:`def7c67`) +* Add handling of ``Connection: close`` HTTP headers in responses + (:issue:`1773`, :sha:`1a38f32`) +* Make connection pooling port-aware (:issue:`1764`, :issue:`1737`, + :sha:`b6c7330`) +* Add support for ``instance_type`` to ``modify_reserved_instances`` + (:sha:`bf07eee`) +* Add support for new OpsWorks features (:sha:`f512898`) + + +Bugfixes +-------- + +* Remove erroneous ``dry_run`` parameter (:issue:`1729`, :sha:`35a516e`) +* Fix task_list override in poll methods of SWF Deciders and Workers ( + :issue:`1724`, :sha:`fa8d871`) +* Remove Content-Encoding header from metadata test (:issue:`1735`, + :sha:`c8b0130`) +* Fix the ability to override DynamoDBv2 host and port when creating + connections (:issue:`1734`, :sha:`8d2b492`) +* Fix UnboundLocalError (:sha:`e0e6aeb`) +* ``self.rules`` is of type IPPermissionsList, remove takes no kwargs + (:sha:`3c56b3f`) +* Nicer error messages for 403s (:issue:`1753`, :sha:`d3d9eab`) +* Various documentation fixes (:issue:`1762`, :sha:`76aef10`) +* Various Python 2.5 fixes (:sha:`150aef6`, :sha:`67ae9ff`) +* Prevent certificate tests from failing for non-govcloud accounts + (:sha:`2d3d9f6`) +* Fix flaky resumable upload test (:issue:`1768`, :sha:`6aa8ae2`) +* Force the Host HTTP header to fix an issue with older httplibs + (:sha:`202c456`) +* Blacklist S3 from forced Host HTTP header (:sha:`9193226`) +* Fix ``propagate_at_launch`` spelling error (:issue:`1739`, :sha:`e78d88a`) +* Remove unused code that causes exceptions with bad response data + (:issue:`1771`, :sha:`bec5e70`) +* Fix ``detach_subnets`` typo (:issue:`1760`, :sha:`4424e1b`) +* Fix result list handling of ``GetMatchingProductForIdResponse`` for MWS + (:issue:`1751`, :sha:`977b7dc`) diff --git a/docs/source/releasenotes/v2.9.8.rst b/docs/source/releasenotes/v2.9.8.rst index 36432813..0398582d 100644 --- a/docs/source/releasenotes/v2.9.8.rst +++ b/docs/source/releasenotes/v2.9.8.rst @@ -12,7 +12,7 @@ Features -------- * Added support for the ``DecodeAuthorizationMessage`` in STS (:sha:`1ada5ac`). -* Added support for creating/deleting/describing ``OptionGroup``s in RDS. +* Added support for creating/deleting/describing ``OptionGroup`` in RDS. (:sha:`d629228` & :sha:`d059a3b`) * Added ``CancelUpdateStack`` to CloudFormation. (:issue:`1476`, :sha:`5bae130`) * Added support for getting/setting lifecycle configurations on GS buckets. diff --git a/docs/source/releasenotes/v2.9.9.rst b/docs/source/releasenotes/v2.9.9.rst new file mode 100644 index 00000000..e9a0bfd2 --- /dev/null +++ b/docs/source/releasenotes/v2.9.9.rst @@ -0,0 +1,50 @@ +boto v2.9.9 +=========== + +:date: 2013/07/24 + +This release updates Opsworks to add AMI & Chef 11 support, DBSubnetGroup +support in RDS & many other bugfixes. + + +Features +-------- + +* Added AMI, configuration manager & Chef 11 support to Opsworks. + (:sha:`55725fc`). +* Added ``in`` support for SQS messages. (:issue:`1593`, :sha:`e5fe1ed`) +* Added support for the ``ap-southeast-2`` region in Elasticache. + (:issue:`1607`, :sha:`9986b61`) +* Added support for block device mappings in ELB. (:issue:`1343`, :issue:`753`, + :issue:`1357`, :sha:`974a23a`) +* Added support for DBSubnetGroup in RDS. (:issue:`1500`, :sha:`01eef87`, + :sha:`45c60a0`, :sha:`c4c859e`) + + +Bugfixes +-------- + +* Fixed the canonicalization of paths on Windows. (:issue:`1609`, + :sha:`a1fa98c`) +* Fixed how ``BotoServerException`` uses ``message``. (:issue:`1353`, + :sha:`b944f4b`) +* Fixed ``DisableRollback`` always being ``True`` in a CloudFormation ``Stack``. + (:issue:`1379`, :sha:`32b3150`) +* Changed EMR instance groups to no longer require a string price (can now be + a ``Decimal``). (:issue:`1396`, :sha:`dfc39ff`) +* Altered ``Distribution._sign_string`` to accept any file-like object as well + within CloudFront. (:issue:`1349`, :sha:`8df6c14`) +* Fixed the ``detach_lb_from_subnets`` call within ELB. (:issue:`1417`, + :issue:`1418` :sha:`4a397bd`, :sha:`c11d72b`, :sha:`9e595b5`, :sha:`634469d`, + :sha:`586dd54`) +* Altered boto to obey ``no_proxy`` environment variables. (:issue:`1600`, + :issue:`1603`, :sha:`aaef5a9`) +* Fixed ELB connections to use HTTPS by default. (:issue:`1587`, :sha:`fe158c4`) +* Updated S3 to be Python 2.5 compatible again. (:issue:`1598`, :sha:`066009f`) +* All calls within SES will now return *all* DKIMTokens, instead of just one. + (:issue:`1550`, :issue:`1610`, :sha:`1a079da`, :sha:`1e82f85`, :sha:`5c8b6b8`) +* Fixed the ``logging`` parameter within ``DistributionConfig`` in CloudFront + to respect whatever is provided to the constructor. (:issue:`1457`, + :sha:`e76180d`) +* Fixed CloudSearch to no longer raise an error if a non-JSON response is received. + (:issue:`1555`, :issue:`1614`, :sha:`5e2c292`, :sha:`6510e1f`) diff --git a/docs/source/s3_tut.rst b/docs/source/s3_tut.rst index 2b40306a..aff667e3 100644 --- a/docs/source/s3_tut.rst +++ b/docs/source/s3_tut.rst @@ -384,7 +384,7 @@ under ``logs/*`` to transition to Glacier 30 days after the object is created. We can now configure the bucket with this lifecycle policy:: >>> bucket.configure_lifecycle(lifecycle) -True + True You can also retrieve the current lifecycle policy for the bucket:: diff --git a/docs/source/sqs_tut.rst b/docs/source/sqs_tut.rst index d4d69c98..72ccca1d 100644 --- a/docs/source/sqs_tut.rst +++ b/docs/source/sqs_tut.rst @@ -229,7 +229,7 @@ to count the number of messages in a queue: >>> q.count() 10 -This can be handy but is command as well as the other two utility methods +This can be handy but this command as well as the other two utility methods I'll describe in a minute are inefficient and should be used with caution on queues with lots of messages (e.g. many hundreds or more). Similarly, you can clear (delete) all messages in a queue with: |