OLD | NEW |
(Empty) | |
| 1 # Copyright (c) 2006-2008 Mitch Garnaat http://garnaat.org/ |
| 2 # |
| 3 # Permission is hereby granted, free of charge, to any person obtaining a |
| 4 # copy of this software and associated documentation files (the |
| 5 # "Software"), to deal in the Software without restriction, including |
| 6 # without limitation the rights to use, copy, modify, merge, publish, dis- |
| 7 # tribute, sublicense, and/or sell copies of the Software, and to permit |
| 8 # persons to whom the Software is furnished to do so, subject to the fol- |
| 9 # lowing conditions: |
| 10 # |
| 11 # The above copyright notice and this permission notice shall be included |
| 12 # in all copies or substantial portions of the Software. |
| 13 # |
| 14 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
| 15 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- |
| 16 # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT |
| 17 # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, |
| 18 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 19 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS |
| 20 # IN THE SOFTWARE. |
| 21 # |
| 22 """ |
| 23 This module provides an interface to the Elastic Compute Cloud (EC2) |
| 24 service from AWS. |
| 25 """ |
| 26 from boto.ec2.connection import EC2Connection |
| 27 |
| 28 |
| 29 def regions(**kw_params): |
| 30 """ |
| 31 Get all available regions for the EC2 service. |
| 32 You may pass any of the arguments accepted by the EC2Connection |
| 33 object's constructor as keyword arguments and they will be |
| 34 passed along to the EC2Connection object. |
| 35 |
| 36 :rtype: list |
| 37 :return: A list of :class:`boto.ec2.regioninfo.RegionInfo` |
| 38 """ |
| 39 c = EC2Connection(**kw_params) |
| 40 return c.get_all_regions() |
| 41 |
| 42 |
| 43 def connect_to_region(region_name, **kw_params): |
| 44 """ |
| 45 Given a valid region name, return a |
| 46 :class:`boto.ec2.connection.EC2Connection`. |
| 47 Any additional parameters after the region_name are passed on to |
| 48 the connect method of the region object. |
| 49 |
| 50 :type: str |
| 51 :param region_name: The name of the region to connect to. |
| 52 |
| 53 :rtype: :class:`boto.ec2.connection.EC2Connection` or ``None`` |
| 54 :return: A connection to the given region, or None if an invalid region |
| 55 name is given |
| 56 """ |
| 57 for region in regions(**kw_params): |
| 58 if region.name == region_name: |
| 59 return region.connect(**kw_params) |
| 60 return None |
| 61 |
| 62 |
| 63 def get_region(region_name, **kw_params): |
| 64 """ |
| 65 Find and return a :class:`boto.ec2.regioninfo.RegionInfo` object |
| 66 given a region name. |
| 67 |
| 68 :type: str |
| 69 :param: The name of the region. |
| 70 |
| 71 :rtype: :class:`boto.ec2.regioninfo.RegionInfo` |
| 72 :return: The RegionInfo object for the given region or None if |
| 73 an invalid region name is provided. |
| 74 """ |
| 75 for region in regions(**kw_params): |
| 76 if region.name == region_name: |
| 77 return region |
| 78 return None |
OLD | NEW |