summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/boto_config_tut.rst25
-rw-r--r--docs/source/cloudwatch_tut.rst2
-rw-r--r--docs/source/elb_tut.rst2
-rw-r--r--docs/source/index.rst1
-rw-r--r--docs/source/releasenotes/v2.29.0.rst25
5 files changed, 50 insertions, 5 deletions
diff --git a/docs/source/boto_config_tut.rst b/docs/source/boto_config_tut.rst
index a2917a0d..37c22f04 100644
--- a/docs/source/boto_config_tut.rst
+++ b/docs/source/boto_config_tut.rst
@@ -10,9 +10,9 @@ Introduction
There is a growing list of configuration options for the boto library. Many of
these options can be passed into the constructors for top-level objects such as
connections. Some options, such as credentials, can also be read from
-environment variables (e.g. ``AWS_ACCESS_KEY_ID`` and ``AWS_SECRET_ACCESS_KEY``).
-It is also possible to manage these options in a central place through the use
-of boto config files.
+environment variables (e.g. ``AWS_ACCESS_KEY_ID``, ``AWS_SECRET_ACCESS_KEY``,
+``AWS_SECURITY_TOKEN`` and ``AWS_PROFILE``). It is also possible to manage
+these options in a central place through the use of boto config files.
Details
-------
@@ -24,6 +24,7 @@ and in the following order:
* /etc/boto.cfg - for site-wide settings that all users on this machine will use
* ~/.boto - for user-specific settings
+* ~/.aws/credentials - for credentials shared between SDKs
In Windows, create a text file that has any name (e.g. boto.config). It's
recommended that you put this file in your user folder. Then set
@@ -58,6 +59,8 @@ boto requests. The order of precedence for authentication credentials is:
* Credentials passed into the Connection class constructor.
* Credentials specified by environment variables
+* Credentials specified as named profiles in the shared credential file.
+* Credentials specified by default in the shared credential file.
* Credentials specified as named profiles in the config file.
* Credentials specified by default in the config file.
@@ -85,6 +88,22 @@ when you instantiate your connection. If you specify a profile that does not
exist in the configuration, the keys used under the ``[Credentials]`` heading
will be applied by default.
+The shared credentials file in ``~/.aws/credentials`` uses a slightly
+different format. For example::
+
+ [default]
+ aws_access_key_id = <your default access key>
+ aws_secret_access_key = <your default secret key>
+
+ [name_goes_here]
+ aws_access_key_id = <access key for this profile>
+ aws_secret_access_key = <secret key for this profile>
+
+ [another_profile]
+ aws_access_key_id = <access key for this profile>
+ aws_secret_access_key = <secret key for this profile>
+ aws_security_token = <optional security token for this profile>
+
For greater security, the secret key can be stored in a keyring and
retrieved via the keyring package. To use a keyring, use ``keyring``,
rather than ``aws_secret_access_key``::
diff --git a/docs/source/cloudwatch_tut.rst b/docs/source/cloudwatch_tut.rst
index c9302092..37263a8d 100644
--- a/docs/source/cloudwatch_tut.rst
+++ b/docs/source/cloudwatch_tut.rst
@@ -76,7 +76,7 @@ that we are interested in. For this example, let's say we want the
data for the previous hour::
>>> import datetime
- >>> end = datetime.datetime.now()
+ >>> end = datetime.datetime.utcnow()
>>> start = end - datetime.timedelta(hours=1)
We also need to supply the Statistic that we want reported and
diff --git a/docs/source/elb_tut.rst b/docs/source/elb_tut.rst
index 0cff8ac8..2b25e74d 100644
--- a/docs/source/elb_tut.rst
+++ b/docs/source/elb_tut.rst
@@ -74,7 +74,7 @@ Alternatively, edit your boto.cfg with the default ELB endpoint to use::
Getting Existing Load Balancers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-To retrieve any exiting load balancers:
+To retrieve any existing load balancers:
>>> conn.get_all_load_balancers()
[LoadBalancer:load-balancer-prod, LoadBalancer:load-balancer-staging]
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 2eed7c2a..4b805a6d 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -119,6 +119,7 @@ Release Notes
.. toctree::
:titlesonly:
+ releasenotes/v2.29.0
releasenotes/v2.28.0
releasenotes/v2.27.0
releasenotes/v2.26.1
diff --git a/docs/source/releasenotes/v2.29.0.rst b/docs/source/releasenotes/v2.29.0.rst
new file mode 100644
index 00000000..5e58781a
--- /dev/null
+++ b/docs/source/releasenotes/v2.29.0.rst
@@ -0,0 +1,25 @@
+boto v2.29.0
+============
+
+:date: 2014/05/29
+
+This release adds support for the AWS shared credentials file, adds support for Amazon Elastic Block Store (EBS) encryption, and contains a handful of fixes for Amazon EC2, AWS CloudFormation, AWS CloudWatch, AWS CloudTrail, Amazon DynamoDB and Amazon Relational Database Service (RDS). It also includes fixes for Python wheel support.
+
+A bug has been fixed such that a new exception is thrown when a profile name is explicitly passed either via code (``profile="foo"``) or an environment variable (``AWS_PROFILE=foo``) and that profile does not exist in any configuration file. Previously this was silently ignored, and the default credentials would be used without informing the user.
+
+Changes
+-------
+* Added support for shared credentials file. (:issue:`2292`, :sha:`d5ed49f`)
+* Added support for EBS encryption. (:issue:`2282`, :sha:`d85a449`)
+* Added GovCloud CloudFormation endpoint. (:issue:`2297`, :sha:`0f75fb9`)
+* Added new CloudTrail endpoints to endpoints.json. (:issue:`2269`, :sha:`1168580`)
+* Added 'name' param to documentation of ELB LoadBalancer. (:issue:`2291`, :sha:`86e1174`)
+* Fix typo in ELB docs. (:issue:`2294`, :sha:`37aaa0f`)
+* Fix typo in ELB tutorial. (:issue:`2290`, :sha:`40a758a`)
+* Fix OpsWorks ``connect_to_region`` exception. (:issue:`2288`, :sha:`26729c7`)
+* Fix timezones in CloudWatch date range example. (:issue:`2285`, :sha:`138a6d0`)
+* Fix description of param tags into ``rds2.create_db_subnet_group``. (:issue:`2279`, :sha:`dc1037f`)
+* Fix the incorrect name of a test case. (:issue:`2273`, :sha:`ee195a1`)
+* Fix "consistent" argument to ``boto.dynamodb2.table.Table.batch_get``. (:issue:`2272`, :sha:`c432b09`)
+* Update the wheel to be python 2 compatible only. (:issue:`2286`, :sha:`6ad0b75`)
+* Crate.io is no longer a package index. (:issue:`2289`, :sha:`7f23de0`)