Commits

Kim Scheibel  committed fd92e3e

add documentation for set_region

  • Participants
  • Parent commits a1576ee

Comments (0)

Files changed (2)

File docs/api/model.rst

 
 For more informations on the connection manager, pease see :py:class:`~.ConnectionBorg`
 
+Region
+------
+
+To channge the AWS region from the the default ``us-east-1``, use 
+:py:meth:`~.ConnectionBorg.set_region` before any method that creates a
+connection. You can list the currently available regions like this:
+
+::
+
+    >>> import boto.dynamodb
+    >>> boto.dynamodb.regions()
+    [RegionInfo:us-east-1, RegionInfo:us-west-1, RegionInfo:us-west-2,
+    RegionInfo:ap-northeast-1, RegionInfo:ap-southeast-1, RegionInfo:eu-west-1]
+
 .. TODO: more documentations/features on table lifecycle
 
 Advanced usage

File docs/raw_api/connection.rst

 --------------
 
 .. automethod:: dynamodb_mapper.model.ConnectionBorg.set_credentials
+.. automethod:: dynamodb_mapper.model.ConnectionBorg.set_region
 
 Create a table
 --------------