[](https://github.com/SUSE-Enceladus/aws-regions/actions/workflows/ci.yml)
Overview
========
This package provides a very simple API for retrieving the most up-to-date
region list. The region info is pulled from the botocore Github project so
this requires a network connection. The advantage to using botocore directly
is that the region list is not reliant on the botocore version which is
installed. This can be an issue if you are using system packages for example,
which may get updates very infrequently and thus may be missing new regions.
Requirements
============
- requests
Installation
============
```shell
pip install aws-regions
```
Usage
=====
There are two main functions in aws-regions. The first function will provide
a list of regions based on the AWS partition. By default this is this public
AWS partition:
```python
from aws_regions.endpoints import get_regions
# Defaults to "aws" partition
regions = get_regions()
# "aws-cn" partition
cn_region = get_regions(partition='aws-cn')
```
The second function will return a list of all regions from all three
partitions:
```python
from aws_regions.endpoints import get_all_regions
all_regions = get_all_regions() # From aws, aws-cn and aws-us-gov
```
Issues/Enhancements
===================
Please submit issues and requests to
[Github](https://github.com/SUSE-Enceladus/aws-regions/issues).
Contributing
============
Contributions to **aws-regions** are welcome and encouraged. See
[CONTRIBUTING](https://github.com/SUSE-Enceladus/aws-regions/blob/master/CONTRIBUTING.md)
for info on getting started.
License
=======
Copyright (c) 2021 SUSE LLC.
Distributed under the terms of MIT license, see
[LICENSE](https://github.com/SUSE-Enceladus/aws-regions/blob/master/LICENSE)
for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/SUSE-Enceladus/aws-regions",
"name": "aws-regions",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "aws-regions aws_regions",
"author": "SUSE",
"author_email": "public-cloud-dev@susecloud.net",
"download_url": "https://files.pythonhosted.org/packages/eb/43/0d0d251c6c8ec42f4a88c882097c19084f7eaa2b7b5fc017911194c39fe4/aws_regions-0.2.0.tar.gz",
"platform": null,
"description": "[](https://github.com/SUSE-Enceladus/aws-regions/actions/workflows/ci.yml)\n\nOverview\n========\n\nThis package provides a very simple API for retrieving the most up-to-date\nregion list. The region info is pulled from the botocore Github project so\nthis requires a network connection. The advantage to using botocore directly\nis that the region list is not reliant on the botocore version which is\ninstalled. This can be an issue if you are using system packages for example,\nwhich may get updates very infrequently and thus may be missing new regions.\n\n\nRequirements\n============\n\n- requests\n\nInstallation\n============\n\n```shell\npip install aws-regions\n```\n\nUsage\n=====\n\nThere are two main functions in aws-regions. The first function will provide\na list of regions based on the AWS partition. By default this is this public\nAWS partition:\n\n```python\nfrom aws_regions.endpoints import get_regions\n\n\n# Defaults to \"aws\" partition\nregions = get_regions()\n\n# \"aws-cn\" partition\ncn_region = get_regions(partition='aws-cn')\n```\n\nThe second function will return a list of all regions from all three\npartitions:\n\n```python\nfrom aws_regions.endpoints import get_all_regions\n\nall_regions = get_all_regions() # From aws, aws-cn and aws-us-gov\n```\n\nIssues/Enhancements\n===================\n\nPlease submit issues and requests to\n[Github](https://github.com/SUSE-Enceladus/aws-regions/issues).\n\nContributing\n============\n\nContributions to **aws-regions** are welcome and encouraged. See\n[CONTRIBUTING](https://github.com/SUSE-Enceladus/aws-regions/blob/master/CONTRIBUTING.md)\nfor info on getting started.\n\nLicense\n=======\n\nCopyright (c) 2021 SUSE LLC.\n\nDistributed under the terms of MIT license, see\n[LICENSE](https://github.com/SUSE-Enceladus/aws-regions/blob/master/LICENSE)\nfor details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Provides functions to get up-to-date AWS regions lists.",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/SUSE-Enceladus/aws-regions"
},
"split_keywords": [
"aws-regions",
"aws_regions"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fe0f358a47b019b3444b94732ab54730cd9de2b2f576565dfe3e4ab6351980df",
"md5": "4c9919a6bf8eb5828381a8ec67d3bbc2",
"sha256": "5a5ff57f3b10c7fd597eb49b1a71c2bec86c011ca4cd3c3c4688fdc99ef81782"
},
"downloads": -1,
"filename": "aws_regions-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4c9919a6bf8eb5828381a8ec67d3bbc2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 5765,
"upload_time": "2024-05-22T19:19:55",
"upload_time_iso_8601": "2024-05-22T19:19:55.036933Z",
"url": "https://files.pythonhosted.org/packages/fe/0f/358a47b019b3444b94732ab54730cd9de2b2f576565dfe3e4ab6351980df/aws_regions-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eb430d0d251c6c8ec42f4a88c882097c19084f7eaa2b7b5fc017911194c39fe4",
"md5": "802064c9da0c14b98b09de4fc478b6a2",
"sha256": "9bfdb02f1c429b567e0b2afb76f8486b2c7c856e7f2b51ca8b24da98e86125c2"
},
"downloads": -1,
"filename": "aws_regions-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "802064c9da0c14b98b09de4fc478b6a2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 52335,
"upload_time": "2024-05-22T19:19:56",
"upload_time_iso_8601": "2024-05-22T19:19:56.771657Z",
"url": "https://files.pythonhosted.org/packages/eb/43/0d0d251c6c8ec42f4a88c882097c19084f7eaa2b7b5fc017911194c39fe4/aws_regions-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-22 19:19:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SUSE-Enceladus",
"github_project": "aws-regions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "aws-regions"
}
JSON
